class UrlEncodeTest in Tamper 8

Tests the url encode plugin.

@coversDefaultClass \Drupal\tamper\Plugin\Tamper\UrlEncode @group tamper

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\tamper\Unit\Plugin\Tamper\TamperPluginTestBase
    • class \Drupal\Tests\tamper\Unit\Plugin\Tamper\UrlEncodeTest

File

tests/src/Unit/Plugin/Tamper/UrlEncodeTest.php, line 14

Namespace

Drupal\Tests\tamper\Unit\Plugin\Tamper

class UrlEncodeTest extends TamperPluginTestBase {

  /**
   * {@inheritdoc}
   */
  protected function instantiatePlugin() {
    return new UrlEncode([], 'url_encode', [], $this
      ->getMockSourceDefinition());
  }

  /**
   * Tests url encoding using the 'legacy' method.
   *
   * The legacy method uses the PHP function urlencode().
   *
   * The following cases are tested:
   * - encoding symbols;
   * - encoding a string with spaces;
   * - encoding special characters.
   */
  public function testUrlEncodeString() {
    $config = [
      UrlEncode::SETTING_METHOD => 'urlencode',
    ];
    $plugin = new UrlEncode($config, 'url_encode', [], $this
      ->getMockSourceDefinition());
    $this
      ->assertEquals('%24+%26+%3C+%3E+%3F+%3B+%23+%3A+%3D+%2C+%22+%27+%7E+%2B+%25', $plugin
      ->tamper('$ & < > ? ; # : = , " \' ~ + %'));
    $this
      ->assertEquals('String+with+spaces', $plugin
      ->tamper('String with spaces'));
    $this
      ->assertEquals('special+chars%3A+%26%25%2A', $plugin
      ->tamper('special chars: &%*'));
  }

  /**
   * Tests url encoding of array input using the legacy method.
   */
  public function testUrlEncodeArray() {
    $this
      ->expectException(TamperException::class);
    $this
      ->expectExceptionMessage('Input should be a string.');
    $config = [
      UrlEncode::SETTING_METHOD => 'urlencode',
    ];
    $plugin = new UrlEncode($config, 'url_encode', [], $this
      ->getMockSourceDefinition());
    $plugin
      ->tamper([
      'fOo',
      'BAR',
    ]);
  }

  /**
   * Tests url encoding of numeric input using the legacy method.
   */
  public function testUrlEncodeNumeric() {
    $this
      ->expectException(TamperException::class);
    $this
      ->expectExceptionMessage('Input should be a string.');
    $config = [
      UrlEncode::SETTING_METHOD => 'urlencode',
    ];
    $plugin = new UrlEncode($config, 'url_encode', [], $this
      ->getMockSourceDefinition());
    $plugin
      ->tamper(14567);
  }

  /**
   * Tests url encoding using the 'raw' method.
   *
   * The raw method uses the PHP function rawurlencode().
   *
   * The following cases are tested:
   * - encoding symbols;
   * - encoding a string with spaces;
   * - encoding special characters.
   */
  public function testRawUrlEncodeString() {
    $config = [
      UrlEncode::SETTING_METHOD => 'rawurlencode',
    ];
    $plugin = new UrlEncode($config, 'url_encode', [], $this
      ->getMockSourceDefinition());
    $this
      ->assertEquals('%24%20%26%20%3C%20%3E%20%3F%20%3B%20%23%20%3A%20%3D%20%2C%20%22%20%27%20~%20%2B%20%25', $plugin
      ->tamper('$ & < > ? ; # : = , " \' ~ + %'));
    $this
      ->assertEquals('String%20with%20spaces', $plugin
      ->tamper('String with spaces'));
    $this
      ->assertEquals('special%20chars%3A%20%26%25%2A', $plugin
      ->tamper('special chars: &%*'));
  }

  /**
   * Tests url encoding of array input using the raw method.
   */
  public function testRawUrlEncodeArray() {
    $this
      ->expectException(TamperException::class);
    $this
      ->expectExceptionMessage('Input should be a string.');
    $config = [
      UrlEncode::SETTING_METHOD => 'rawurlencode',
    ];
    $plugin = new UrlEncode($config, 'url_encode', [], $this
      ->getMockSourceDefinition());
    $plugin
      ->tamper([
      'fOo',
      'BAR',
    ]);
  }

  /**
   * Tests url encoding of number input using the raw method.
   */
  public function testRawUrlEncodeNumeric() {
    $this
      ->expectException(TamperException::class);
    $this
      ->expectExceptionMessage('Input should be a string.');
    $config = [
      UrlEncode::SETTING_METHOD => 'rawurlencode',
    ];
    $plugin = new UrlEncode($config, 'url_encode', [], $this
      ->getMockSourceDefinition());
    $plugin
      ->tamper(14567);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
TamperPluginTestBase::$plugin	protected	property	The tamper plugin under test.
TamperPluginTestBase::getMockSourceDefinition	protected	function	Returns a mocked source definition.
TamperPluginTestBase::setUp	protected	function	Overrides UnitTestCase::setUp	3
TamperPluginTestBase::testBuildConfigurationForm	public	function	@covers ::buildConfigurationForm
TamperPluginTestBase::testDefaultConfiguration	public	function	@covers ::defaultConfiguration
TamperPluginTestBase::testGetConfiguration	public	function	@covers ::getConfiguration
TamperPluginTestBase::testGetPluginDefinition	public	function	@covers ::getPluginDefinition
TamperPluginTestBase::testGetPluginId	public	function	@covers ::getPluginId
TamperPluginTestBase::testMultiple	public	function	@covers ::multiple
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UrlEncodeTest::instantiatePlugin	protected	function	Instantiates a plugin. Overrides TamperPluginTestBase::instantiatePlugin
UrlEncodeTest::testRawUrlEncodeArray	public	function	Tests url encoding of array input using the raw method.
UrlEncodeTest::testRawUrlEncodeNumeric	public	function	Tests url encoding of number input using the raw method.
UrlEncodeTest::testRawUrlEncodeString	public	function	Tests url encoding using the 'raw' method.
UrlEncodeTest::testUrlEncodeArray	public	function	Tests url encoding of array input using the legacy method.
UrlEncodeTest::testUrlEncodeNumeric	public	function	Tests url encoding of numeric input using the legacy method.
UrlEncodeTest::testUrlEncodeString	public	function	Tests url encoding using the 'legacy' method.