class UnroutedUrlAssemblerTest in Drupal 8

@coversDefaultClass \Drupal\Core\Utility\UnroutedUrlAssembler @group Utility

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Utility\UnroutedUrlAssemblerTest

File

core/tests/Drupal/Tests/Core/Utility/UnroutedUrlAssemblerTest.php, line 16

Namespace

Drupal\Tests\Core\Utility

class UnroutedUrlAssemblerTest extends UnitTestCase {

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The mocked config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $configFactory;

  /**
   * The tested unrouted URL assembler.
   *
   * @var \Drupal\Core\Utility\UnroutedUrlAssembler
   */
  protected $unroutedUrlAssembler;

  /**
   * The mocked outbound path processor.
   *
   * @var \Drupal\Core\PathProcessor\OutboundPathProcessorInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $pathProcessor;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->requestStack = new RequestStack();
    $this->pathProcessor = $this
      ->createMock('Drupal\\Core\\PathProcessor\\OutboundPathProcessorInterface');
    $this->unroutedUrlAssembler = new UnroutedUrlAssembler($this->requestStack, $this->pathProcessor);
  }

  /**
   * @covers ::assemble
   */
  public function testAssembleWithNeitherExternalNorDomainLocalUri() {
    $this
      ->expectException(\InvalidArgumentException::class);
    $this->unroutedUrlAssembler
      ->assemble('wrong-url');
  }

  /**
   * @covers ::assemble
   */
  public function testAssembleWithLeadingSlash() {
    $this
      ->expectException(\InvalidArgumentException::class);
    $this->unroutedUrlAssembler
      ->assemble('/drupal.org');
  }

  /**
   * @covers ::assemble
   * @covers ::buildExternalUrl
   *
   * @dataProvider providerTestAssembleWithExternalUrl
   */
  public function testAssembleWithExternalUrl($uri, array $options, $expected) {
    $this
      ->setupRequestStack(FALSE);
    $this
      ->assertEquals($expected, $this->unroutedUrlAssembler
      ->assemble($uri, $options));
    $generated_url = $this->unroutedUrlAssembler
      ->assemble($uri, $options, TRUE);
    $this
      ->assertEquals($expected, $generated_url
      ->getGeneratedUrl());
    $this
      ->assertInstanceOf('\\Drupal\\Core\\Render\\BubbleableMetadata', $generated_url);
  }

  /**
   * Provides test data for testAssembleWithExternalUrl
   */
  public function providerTestAssembleWithExternalUrl() {
    return [
      [
        'http://example.com/test',
        [],
        'http://example.com/test',
      ],
      [
        'http://example.com/test',
        [
          'fragment' => 'example',
        ],
        'http://example.com/test#example',
      ],
      [
        'http://example.com/test',
        [
          'fragment' => 'example',
        ],
        'http://example.com/test#example',
      ],
      [
        'http://example.com/test',
        [
          'query' => [
            'foo' => 'bar',
          ],
        ],
        'http://example.com/test?foo=bar',
      ],
      [
        'http://example.com/test',
        [
          'https' => TRUE,
        ],
        'https://example.com/test',
      ],
      [
        'https://example.com/test',
        [
          'https' => FALSE,
        ],
        'http://example.com/test',
      ],
      [
        'https://example.com/test?foo=1#bar',
        [],
        'https://example.com/test?foo=1#bar',
      ],
      'override-query' => [
        'https://example.com/test?foo=1#bar',
        [
          'query' => [
            'foo' => 2,
          ],
        ],
        'https://example.com/test?foo=2#bar',
      ],
      'override-query-merge' => [
        'https://example.com/test?foo=1#bar',
        [
          'query' => [
            'bar' => 2,
          ],
        ],
        'https://example.com/test?foo=1&bar=2#bar',
      ],
      'override-deep-query-merge' => [
        'https://example.com/test?foo=1#bar',
        [
          'query' => [
            'bar' => [
              'baz' => 'foo',
            ],
          ],
        ],
        'https://example.com/test?foo=1&bar%5Bbaz%5D=foo#bar',
      ],
      'override-deep-query-merge-int-ket' => [
        'https://example.com/test?120=1',
        [
          'query' => [
            'bar' => [
              'baz' => 'foo',
            ],
          ],
        ],
        'https://example.com/test?120=1&bar%5Bbaz%5D=foo',
      ],
      'override-fragment' => [
        'https://example.com/test?foo=1#bar',
        [
          'fragment' => 'baz',
        ],
        'https://example.com/test?foo=1#baz',
      ],
      [
        '//www.drupal.org',
        [],
        '//www.drupal.org',
      ],
    ];
  }

  /**
   * @covers ::assemble
   * @covers::buildLocalUrl
   *
   * @dataProvider providerTestAssembleWithLocalUri
   */
  public function testAssembleWithLocalUri($uri, array $options, $subdir, $expected) {
    $this
      ->setupRequestStack($subdir);
    $this
      ->assertEquals($expected, $this->unroutedUrlAssembler
      ->assemble($uri, $options));
  }

  /**
   * @return array
   */
  public function providerTestAssembleWithLocalUri() {
    return [
      [
        'base:example',
        [],
        FALSE,
        '/example',
      ],
      [
        'base:example',
        [
          'query' => [
            'foo' => 'bar',
          ],
        ],
        FALSE,
        '/example?foo=bar',
      ],
      [
        'base:example',
        [
          'query' => [
            'foo' => '"bar"',
          ],
        ],
        FALSE,
        '/example?foo=%22bar%22',
      ],
      [
        'base:example',
        [
          'query' => [
            'foo' => '"bar"',
            'zoo' => 'baz',
          ],
        ],
        FALSE,
        '/example?foo=%22bar%22&zoo=baz',
      ],
      [
        'base:example',
        [
          'fragment' => 'example',
        ],
        FALSE,
        '/example#example',
      ],
      [
        'base:example',
        [],
        TRUE,
        '/subdir/example',
      ],
      [
        'base:example',
        [
          'query' => [
            'foo' => 'bar',
          ],
        ],
        TRUE,
        '/subdir/example?foo=bar',
      ],
      [
        'base:example',
        [
          'fragment' => 'example',
        ],
        TRUE,
        '/subdir/example#example',
      ],
      [
        'base:/drupal.org',
        [],
        FALSE,
        '/drupal.org',
      ],
    ];
  }

  /**
   * @covers ::assemble
   */
  public function testAssembleWithNotEnabledProcessing() {
    $this
      ->setupRequestStack(FALSE);
    $this->pathProcessor
      ->expects($this
      ->never())
      ->method('processOutbound');
    $result = $this->unroutedUrlAssembler
      ->assemble('base:test-uri', []);
    $this
      ->assertEquals('/test-uri', $result);
  }

  /**
   * @covers ::assemble
   */
  public function testAssembleWithEnabledProcessing() {
    $this
      ->setupRequestStack(FALSE);
    $this->pathProcessor
      ->expects($this
      ->exactly(2))
      ->method('processOutbound')
      ->willReturnCallback(function ($path, &$options = [], Request $request = NULL, BubbleableMetadata $bubbleable_metadata = NULL) {
      if ($bubbleable_metadata) {
        $bubbleable_metadata
          ->setCacheContexts([
          'some-cache-context',
        ]);
      }
      return 'test-other-uri';
    });
    $result = $this->unroutedUrlAssembler
      ->assemble('base:test-uri', [
      'path_processing' => TRUE,
    ]);
    $this
      ->assertEquals('/test-other-uri', $result);
    $result = $this->unroutedUrlAssembler
      ->assemble('base:test-uri', [
      'path_processing' => TRUE,
    ], TRUE);
    $expected_generated_url = new GeneratedUrl();
    $expected_generated_url
      ->setGeneratedUrl('/test-other-uri')
      ->setCacheContexts([
      'some-cache-context',
    ]);
    $this
      ->assertEquals($expected_generated_url, $result);
  }

  /**
   * Setups the request stack for a given subdir.
   *
   * @param string $subdir
   *   The wanted subdir.
   */
  protected function setupRequestStack($subdir) {
    $server = [];
    if ($subdir) {

      // Setup a fake request which looks like a Drupal installed under the
      // subdir "subdir" on the domain www.example.com.
      // To reproduce the values install Drupal like that and use a debugger.
      $server = [
        'SCRIPT_NAME' => '/subdir/index.php',
        'SCRIPT_FILENAME' => $this->root . '/index.php',
        'SERVER_NAME' => 'http://www.example.com',
      ];
      $request = Request::create('/subdir/');
    }
    else {
      $request = Request::create('/');
    }
    $request->server
      ->add($server);
    $this->requestStack
      ->push($request);
  }

}

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.
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.
UnroutedUrlAssemblerTest::$configFactory	protected	property	The mocked config factory.
UnroutedUrlAssemblerTest::$pathProcessor	protected	property	The mocked outbound path processor.
UnroutedUrlAssemblerTest::$requestStack	protected	property	The request stack.
UnroutedUrlAssemblerTest::$unroutedUrlAssembler	protected	property	The tested unrouted URL assembler.
UnroutedUrlAssemblerTest::providerTestAssembleWithExternalUrl	public	function	Provides test data for testAssembleWithExternalUrl
UnroutedUrlAssemblerTest::providerTestAssembleWithLocalUri	public	function
UnroutedUrlAssemblerTest::setUp	protected	function	Overrides UnitTestCase::setUp
UnroutedUrlAssemblerTest::setupRequestStack	protected	function	Setups the request stack for a given subdir.
UnroutedUrlAssemblerTest::testAssembleWithEnabledProcessing	public	function	@covers ::assemble
UnroutedUrlAssemblerTest::testAssembleWithExternalUrl	public	function	@covers ::assemble @covers ::buildExternalUrl
UnroutedUrlAssemblerTest::testAssembleWithLeadingSlash	public	function	@covers ::assemble
UnroutedUrlAssemblerTest::testAssembleWithLocalUri	public	function	@covers ::assemble @covers::buildLocalUrl
UnroutedUrlAssemblerTest::testAssembleWithNeitherExternalNorDomainLocalUri	public	function	@covers ::assemble
UnroutedUrlAssemblerTest::testAssembleWithNotEnabledProcessing	public	function	@covers ::assemble