class ContentTypeHeaderMatcherTest
Same name in other branches
- 9 core/tests/Drupal/Tests/Core/Routing/ContentTypeHeaderMatcherTest.php \Drupal\Tests\Core\Routing\ContentTypeHeaderMatcherTest
- 8.9.x core/tests/Drupal/Tests/Core/Routing/ContentTypeHeaderMatcherTest.php \Drupal\Tests\Core\Routing\ContentTypeHeaderMatcherTest
- 11.x core/tests/Drupal/Tests/Core/Routing/ContentTypeHeaderMatcherTest.php \Drupal\Tests\Core\Routing\ContentTypeHeaderMatcherTest
Confirm that the content types partial matcher is functioning properly.
@group Routing
@coversDefaultClass \Drupal\Core\Routing\ContentTypeHeaderMatcher
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Core\Routing\ContentTypeHeaderMatcherTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of ContentTypeHeaderMatcherTest
File
-
core/
tests/ Drupal/ Tests/ Core/ Routing/ ContentTypeHeaderMatcherTest.php, line 20
Namespace
Drupal\Tests\Core\RoutingView source
class ContentTypeHeaderMatcherTest extends UnitTestCase {
/**
* A collection of shared fixture data for tests.
*
* @var RoutingFixtures
*/
protected $fixtures;
/**
* The matcher object that is going to be tested.
*
* @var \Drupal\Core\Routing\ContentTypeHeaderMatcher
*/
protected $matcher;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->fixtures = new RoutingFixtures();
$this->matcher = new ContentTypeHeaderMatcher();
}
/**
* Tests that routes are not filtered on safe requests.
*
* @dataProvider providerTestSafeRequestFilter
*/
public function testSafeRequestFilter($method) : void {
$collection = $this->fixtures
->sampleRouteCollection();
$collection->addCollection($this->fixtures
->contentRouteCollection());
$request = Request::create('path/two', $method);
$routes = $this->matcher
->filter($collection, $request);
$this->assertCount(7, $routes, 'The correct number of routes was found.');
}
public static function providerTestSafeRequestFilter() {
return [
[
'GET',
],
[
'HEAD',
],
[
'OPTIONS',
],
[
'TRACE',
],
[
'DELETE',
],
];
}
/**
* Tests that XML-restricted routes get filtered out on JSON requests.
*/
public function testJsonRequest() : void {
$collection = $this->fixtures
->sampleRouteCollection();
$collection->addCollection($this->fixtures
->contentRouteCollection());
$request = Request::create('path/two', 'POST');
$request->headers
->set('Content-type', 'application/json');
$routes = $this->matcher
->filter($collection, $request);
$this->assertCount(6, $routes, 'The correct number of routes was found.');
$this->assertNotNull($routes->get('route_f'), 'The json route was found.');
$this->assertNull($routes->get('route_g'), 'The xml route was not found.');
foreach ($routes as $name => $route) {
$this->assertEquals('route_f', $name, 'The json route is the first one in the collection.');
break;
}
}
/**
* Tests route filtering on POST form submission requests.
*/
public function testPostForm() : void {
$collection = $this->fixtures
->sampleRouteCollection();
$collection->addCollection($this->fixtures
->contentRouteCollection());
// Test that all XML and JSON restricted routes get filtered out on a POST
// form submission.
$request = Request::create('path/two', 'POST');
$request->headers
->set('Content-type', 'application/www-form-urlencoded');
$routes = $this->matcher
->filter($collection, $request);
$this->assertCount(5, $routes, 'The correct number of routes was found.');
$this->assertNull($routes->get('route_f'), 'The json route was found.');
$this->assertNull($routes->get('route_g'), 'The xml route was not found.');
}
/**
* Confirms that the matcher throws an exception for no-route.
*
* @covers ::filter
*/
public function testNoRouteFound() : void {
$matcher = new ContentTypeHeaderMatcher();
$routes = $this->fixtures
->contentRouteCollection();
$request = Request::create('path/two', 'POST');
$request->headers
->set('Content-type', 'text/html');
$this->expectException(UnsupportedMediaTypeHttpException::class);
$this->expectExceptionMessage('No route found that matches "Content-Type: text/html"');
$matcher->filter($routes, $request);
}
/**
* Confirms that the matcher throws an exception for missing request header.
*
* @covers ::filter
*/
public function testContentTypeRequestHeaderMissing() : void {
$matcher = new ContentTypeHeaderMatcher();
$routes = $this->fixtures
->contentRouteCollection();
$request = Request::create('path/two', 'POST');
// Delete all request headers that Request::create() sets by default.
$request->headers = new HeaderBag();
$this->expectException(UnsupportedMediaTypeHttpException::class);
$this->expectExceptionMessage('No "Content-Type" request header specified');
$matcher->filter($routes, $request);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
ContentTypeHeaderMatcherTest::$fixtures | protected | property | A collection of shared fixture data for tests. | |||
ContentTypeHeaderMatcherTest::$matcher | protected | property | The matcher object that is going to be tested. | |||
ContentTypeHeaderMatcherTest::providerTestSafeRequestFilter | public static | function | ||||
ContentTypeHeaderMatcherTest::setUp | protected | function | Overrides UnitTestCase::setUp | |||
ContentTypeHeaderMatcherTest::testContentTypeRequestHeaderMissing | public | function | Confirms that the matcher throws an exception for missing request header. | |||
ContentTypeHeaderMatcherTest::testJsonRequest | public | function | Tests that XML-restricted routes get filtered out on JSON requests. | |||
ContentTypeHeaderMatcherTest::testNoRouteFound | public | function | Confirms that the matcher throws an exception for no-route. | |||
ContentTypeHeaderMatcherTest::testPostForm | public | function | Tests route filtering on POST form submission requests. | |||
ContentTypeHeaderMatcherTest::testSafeRequestFilter | public | function | Tests that routes are not filtered on safe requests. | |||
PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |||
PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |||
RandomGeneratorTrait::randomStringValidate | Deprecated | public | function | Callback for random string validation. | ||
UnitTestCase::$root | protected | property | The app root. | 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::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |||
UnitTestCase::setUpBeforeClass | public static | function | ||||
UnitTestCase::__get | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.