class RequestFormatRouteFilterTest in Drupal 8

@coversDefaultClass \Drupal\Core\Routing\RequestFormatRouteFilter @group Routing

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Routing\RequestFormatRouteFilterTest

File

core/tests/Drupal/Tests/Core/Routing/RequestFormatRouteFilterTest.php, line 19

Namespace

Drupal\Tests\Core\Routing

class RequestFormatRouteFilterTest extends UnitTestCase {

  /**
   * @covers ::filter
   * @dataProvider filterProvider
   */
  public function testFilter(RouteCollection $collection, $request_format, array $expected_filtered_collection) {
    $route_filter = new RequestFormatRouteFilter();
    $request = new Request();
    $request
      ->setRequestFormat($request_format);
    $collection = $route_filter
      ->filter($collection, $request);
    $this
      ->assertCount(count($expected_filtered_collection), $collection);
    $this
      ->assertSame($expected_filtered_collection, array_keys($collection
      ->all()));
  }
  public function filterProvider() {
    $route_without_format = new Route('/test');
    $route_with_format = new Route('/test');
    $route_with_format
      ->setRequirement('_format', 'json');
    $route_with_multiple_formats = new Route('/test');
    $route_with_multiple_formats
      ->setRequirement('_format', 'json|xml');
    $collection = new RouteCollection();
    $collection
      ->add('test_0', $route_without_format);
    $collection
      ->add('test_1', $route_with_format);
    $collection
      ->add('test_2', $route_with_multiple_formats);
    $sole_route_match_single_format = new RouteCollection();
    $sole_route_match_single_format
      ->add('sole_route_single_format', $route_with_format);
    return [
      'nothing requested' => [
        clone $collection,
        '',
        [
          'test_0',
        ],
      ],
      'xml requested' => [
        clone $collection,
        'xml',
        [
          'test_2',
          'test_0',
        ],
      ],
      'json requested' => [
        clone $collection,
        'json',
        [
          'test_1',
          'test_2',
          'test_0',
        ],
      ],
      'html format requested' => [
        clone $collection,
        'html',
        [
          'test_0',
        ],
      ],
      'no format requested, defaults to html' => [
        clone $collection,
        NULL,
        [
          'test_0',
        ],
      ],
      'no format requested, single route match with single format, defaults to that format' => [
        clone $sole_route_match_single_format,
        NULL,
        [
          'sole_route_single_format',
        ],
      ],
    ];
  }

  /**
   * @covers ::filter
   */
  public function testNoRouteFound() {
    $url = $this
      ->prophesize(GeneratedUrl::class);
    $url_assembler = $this
      ->prophesize(UnroutedUrlAssemblerInterface::class);
    $url_assembler
      ->assemble('http://localhost/test?_format=xml', [
      'query' => [
        '_format' => 'json',
      ],
      'external' => TRUE,
    ], TRUE)
      ->willReturn($url);
    $container = new ContainerBuilder();
    $container
      ->set('unrouted_url_assembler', $url_assembler
      ->reveal());
    \Drupal::setContainer($container);
    $collection = new RouteCollection();
    $route_with_format = new Route('/test');
    $route_with_format
      ->setRequirement('_format', 'json');
    $collection
      ->add('test_0', $route_with_format);
    $collection
      ->add('test_1', clone $route_with_format);
    $request = Request::create('test?_format=xml', 'GET');
    $request
      ->setRequestFormat('xml');
    $route_filter = new RequestFormatRouteFilter();
    $this
      ->expectException(NotAcceptableHttpException::class);
    $this
      ->expectExceptionMessage('No route found for the specified format xml.');
    $route_filter
      ->filter($collection, $request);
  }

  /**
   * @covers ::filter
   */
  public function testNoRouteFoundWhenNoRequestFormatAndSingleRouteWithMultipleFormats() {
    $this
      ->expectException(NotAcceptableHttpException::class);
    $this
      ->expectExceptionMessage('No route found for the specified format html.');
    $url = $this
      ->prophesize(GeneratedUrl::class);
    $url_assembler = $this
      ->prophesize(UnroutedUrlAssemblerInterface::class);
    $url_assembler
      ->assemble('http://localhost/test', [
      'query' => [
        '_format' => 'json',
      ],
      'external' => TRUE,
    ], TRUE)
      ->willReturn($url);
    $url_assembler
      ->assemble('http://localhost/test', [
      'query' => [
        '_format' => 'xml',
      ],
      'external' => TRUE,
    ], TRUE)
      ->willReturn($url);
    $container = new ContainerBuilder();
    $container
      ->set('unrouted_url_assembler', $url_assembler
      ->reveal());
    \Drupal::setContainer($container);
    $collection = new RouteCollection();
    $route_with_format = new Route('/test');
    $route_with_format
      ->setRequirement('_format', 'json|xml');
    $collection
      ->add('sole_route_multiple_formats', $route_with_format);
    $request = Request::create('test', 'GET');
    $route_filter = new RequestFormatRouteFilter();
    $route_filter
      ->filter($collection, $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.
RequestFormatRouteFilterTest::filterProvider	public	function
RequestFormatRouteFilterTest::testFilter	public	function	@covers ::filter @dataProvider filterProvider
RequestFormatRouteFilterTest::testNoRouteFound	public	function	@covers ::filter
RequestFormatRouteFilterTest::testNoRouteFoundWhenNoRequestFormatAndSingleRouteWithMultipleFormats	public	function	@covers ::filter
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.
UnitTestCase::setUp	protected	function		340