class RoutesTest
Same name in other branches
- 9 core/modules/jsonapi/tests/src/Unit/Routing/RoutesTest.php \Drupal\Tests\jsonapi\Unit\Routing\RoutesTest
- 8.9.x core/modules/jsonapi/tests/src/Unit/Routing/RoutesTest.php \Drupal\Tests\jsonapi\Unit\Routing\RoutesTest
- 10 core/modules/jsonapi/tests/src/Unit/Routing/RoutesTest.php \Drupal\Tests\jsonapi\Unit\Routing\RoutesTest
@coversDefaultClass \Drupal\jsonapi\Routing\Routes @group jsonapi
@internal
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\jsonapi\Unit\Routing\RoutesTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of RoutesTest
File
-
core/
modules/ jsonapi/ tests/ src/ Unit/ Routing/ RoutesTest.php, line 22
Namespace
Drupal\Tests\jsonapi\Unit\RoutingView source
class RoutesTest extends UnitTestCase {
/**
* List of routes objects for the different scenarios.
*
* @var \Drupal\jsonapi\Routing\Routes[]
*/
protected $routes;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$relationship_fields = [
'external' => new ResourceTypeRelationship('external'),
'internal' => new ResourceTypeRelationship('internal'),
'both' => new ResourceTypeRelationship('both'),
];
$type_1 = new ResourceType('entity_type_1', 'bundle_1_1', EntityInterface::class, FALSE, TRUE, TRUE, FALSE, $relationship_fields);
$type_2 = new ResourceType('entity_type_2', 'bundle_2_1', EntityInterface::class, TRUE, TRUE, TRUE, FALSE, $relationship_fields);
$relatable_resource_types = [
'external' => [
$type_1,
],
'internal' => [
$type_2,
],
'both' => [
$type_1,
$type_2,
],
];
$type_1->setRelatableResourceTypes($relatable_resource_types);
$type_2->setRelatableResourceTypes($relatable_resource_types);
// This type ensures that we can create routes for bundle IDs which might be
// cast from strings to integers. It should not affect related resource
// routing.
$type_3 = new ResourceType('entity_type_3', '123', EntityInterface::class, TRUE);
$type_3->setRelatableResourceTypes([]);
$resource_type_repository = $this->prophesize(ResourceTypeRepository::class);
$resource_type_repository->all()
->willReturn([
$type_1,
$type_2,
$type_3,
]);
$container = $this->prophesize(ContainerInterface::class);
$container->get('jsonapi.resource_type.repository')
->willReturn($resource_type_repository->reveal());
$container->getParameter('jsonapi.base_path')
->willReturn('/jsonapi');
$container->getParameter('authentication_providers')
->willReturn([
'lorem' => [],
'ipsum' => [],
]);
$this->routes['ok'] = Routes::create($container->reveal());
}
/**
* @covers ::routes
*/
public function testRoutesCollection() : void {
// Get the route collection and start making assertions.
$routes = $this->routes['ok']
->routes();
// - 2 collection routes; GET & POST for the non-internal resource type.
// - 3 individual routes; GET, PATCH & DELETE for the non-internal resource
// type.
// - 2 related routes; GET for the non-internal resource type relationships
// fields: external & both.
// - 12 relationship routes; 3 fields * 4 HTTP methods.
// `relationship` routes are generated even for internal target resource
// types (`related` routes are not).
// - 1 for the JSON:API entry point.
$this->assertEquals(20, $routes->count());
$iterator = $routes->getIterator();
// Check the collection route.
/** @var \Symfony\Component\Routing\Route $route */
$route = $iterator->offsetGet('jsonapi.entity_type_1--bundle_1_1.collection');
$this->assertSame('/jsonapi/entity_type_1/bundle_1_1', $route->getPath());
$this->assertSame([
'lorem',
'ipsum',
], $route->getOption('_auth'));
$this->assertSame('entity_type_1--bundle_1_1', $route->getDefault(Routes::RESOURCE_TYPE_KEY));
$this->assertEquals([
'GET',
], $route->getMethods());
$this->assertSame(Routes::CONTROLLER_SERVICE_NAME . ':getCollection', $route->getDefault(RouteObjectInterface::CONTROLLER_NAME));
// Check the collection POST route.
$route = $iterator->offsetGet('jsonapi.entity_type_1--bundle_1_1.collection.post');
$this->assertSame('/jsonapi/entity_type_1/bundle_1_1', $route->getPath());
$this->assertSame([
'lorem',
'ipsum',
], $route->getOption('_auth'));
$this->assertSame('entity_type_1--bundle_1_1', $route->getDefault(Routes::RESOURCE_TYPE_KEY));
$this->assertEquals([
'POST',
], $route->getMethods());
$this->assertSame(Routes::CONTROLLER_SERVICE_NAME . ':createIndividual', $route->getDefault(RouteObjectInterface::CONTROLLER_NAME));
}
/**
* @covers ::routes
*/
public function testRoutesIndividual() : void {
// Get the route collection and start making assertions.
$iterator = $this->routes['ok']
->routes()
->getIterator();
// Check the individual route.
/** @var \Symfony\Component\Routing\Route $route */
$route = $iterator->offsetGet('jsonapi.entity_type_1--bundle_1_1.individual');
$this->assertSame('/jsonapi/entity_type_1/bundle_1_1/{entity}', $route->getPath());
$this->assertSame('entity_type_1--bundle_1_1', $route->getDefault(Routes::RESOURCE_TYPE_KEY));
$this->assertEquals([
'GET',
], $route->getMethods());
$this->assertSame(Routes::CONTROLLER_SERVICE_NAME . ':getIndividual', $route->getDefault(RouteObjectInterface::CONTROLLER_NAME));
$this->assertSame([
'lorem',
'ipsum',
], $route->getOption('_auth'));
$this->assertEquals([
'entity' => [
'type' => 'entity:entity_type_1',
],
'resource_type' => [
'type' => 'jsonapi_resource_type',
],
], $route->getOption('parameters'));
$route = $iterator->offsetGet('jsonapi.entity_type_1--bundle_1_1.individual.patch');
$this->assertSame('/jsonapi/entity_type_1/bundle_1_1/{entity}', $route->getPath());
$this->assertSame('entity_type_1--bundle_1_1', $route->getDefault(Routes::RESOURCE_TYPE_KEY));
$this->assertEquals([
'PATCH',
], $route->getMethods());
$this->assertSame(Routes::CONTROLLER_SERVICE_NAME . ':patchIndividual', $route->getDefault(RouteObjectInterface::CONTROLLER_NAME));
$this->assertSame([
'lorem',
'ipsum',
], $route->getOption('_auth'));
$this->assertEquals([
'entity' => [
'type' => 'entity:entity_type_1',
],
'resource_type' => [
'type' => 'jsonapi_resource_type',
],
], $route->getOption('parameters'));
$route = $iterator->offsetGet('jsonapi.entity_type_1--bundle_1_1.individual.delete');
$this->assertSame('/jsonapi/entity_type_1/bundle_1_1/{entity}', $route->getPath());
$this->assertSame('entity_type_1--bundle_1_1', $route->getDefault(Routes::RESOURCE_TYPE_KEY));
$this->assertEquals([
'DELETE',
], $route->getMethods());
$this->assertSame(Routes::CONTROLLER_SERVICE_NAME . ':deleteIndividual', $route->getDefault(RouteObjectInterface::CONTROLLER_NAME));
$this->assertSame([
'lorem',
'ipsum',
], $route->getOption('_auth'));
$this->assertEquals([
'entity' => [
'type' => 'entity:entity_type_1',
],
'resource_type' => [
'type' => 'jsonapi_resource_type',
],
], $route->getOption('parameters'));
}
/**
* @covers ::routes
*/
public function testRoutesRelated() : void {
// Get the route collection and start making assertions.
$iterator = $this->routes['ok']
->routes()
->getIterator();
// Check the related route.
/** @var \Symfony\Component\Routing\Route $route */
$route = $iterator->offsetGet('jsonapi.entity_type_1--bundle_1_1.external.related');
$this->assertSame('/jsonapi/entity_type_1/bundle_1_1/{entity}/external', $route->getPath());
$this->assertSame('entity_type_1--bundle_1_1', $route->getDefault(Routes::RESOURCE_TYPE_KEY));
$this->assertEquals([
'GET',
], $route->getMethods());
$this->assertSame(Routes::CONTROLLER_SERVICE_NAME . ':getRelated', $route->getDefault(RouteObjectInterface::CONTROLLER_NAME));
$this->assertSame([
'lorem',
'ipsum',
], $route->getOption('_auth'));
$this->assertEquals([
'entity' => [
'type' => 'entity:entity_type_1',
],
'resource_type' => [
'type' => 'jsonapi_resource_type',
],
], $route->getOption('parameters'));
}
/**
* @covers ::routes
*/
public function testRoutesRelationships() : void {
// Get the route collection and start making assertions.
$iterator = $this->routes['ok']
->routes()
->getIterator();
// Check the relationships route.
/** @var \Symfony\Component\Routing\Route $route */
$route = $iterator->offsetGet('jsonapi.entity_type_1--bundle_1_1.both.relationship.get');
$this->assertSame('/jsonapi/entity_type_1/bundle_1_1/{entity}/relationships/both', $route->getPath());
$this->assertSame('entity_type_1--bundle_1_1', $route->getDefault(Routes::RESOURCE_TYPE_KEY));
$this->assertEquals([
'GET',
], $route->getMethods());
$this->assertSame(Routes::CONTROLLER_SERVICE_NAME . ':getRelationship', $route->getDefault(RouteObjectInterface::CONTROLLER_NAME));
$this->assertSame([
'lorem',
'ipsum',
], $route->getOption('_auth'));
$this->assertEquals([
'entity' => [
'type' => 'entity:entity_type_1',
],
'resource_type' => [
'type' => 'jsonapi_resource_type',
],
], $route->getOption('parameters'));
}
/**
* Ensures that the expected routes are created or not created.
*
* @dataProvider expectedRoutes
*/
public function testRoutes($route) : void {
$this->assertArrayHasKey($route, $this->routes['ok']
->routes()
->all());
}
/**
* Lists routes which should have been created.
*/
public static function expectedRoutes() {
return [
[
'jsonapi.entity_type_1--bundle_1_1.individual',
],
[
'jsonapi.entity_type_1--bundle_1_1.collection',
],
[
'jsonapi.entity_type_1--bundle_1_1.internal.relationship.get',
],
[
'jsonapi.entity_type_1--bundle_1_1.internal.relationship.post',
],
[
'jsonapi.entity_type_1--bundle_1_1.internal.relationship.patch',
],
[
'jsonapi.entity_type_1--bundle_1_1.internal.relationship.delete',
],
[
'jsonapi.entity_type_1--bundle_1_1.external.related',
],
[
'jsonapi.entity_type_1--bundle_1_1.external.relationship.get',
],
[
'jsonapi.entity_type_1--bundle_1_1.external.relationship.post',
],
[
'jsonapi.entity_type_1--bundle_1_1.external.relationship.patch',
],
[
'jsonapi.entity_type_1--bundle_1_1.external.relationship.delete',
],
[
'jsonapi.entity_type_1--bundle_1_1.both.related',
],
[
'jsonapi.entity_type_1--bundle_1_1.both.relationship.get',
],
[
'jsonapi.entity_type_1--bundle_1_1.both.relationship.post',
],
[
'jsonapi.entity_type_1--bundle_1_1.both.relationship.patch',
],
[
'jsonapi.entity_type_1--bundle_1_1.both.relationship.delete',
],
[
'jsonapi.resource_list',
],
];
}
/**
* Ensures that no routes are created for internal resources.
*
* @dataProvider notExpectedRoutes
*/
public function testInternalRoutes($route) : void {
$this->assertArrayNotHasKey($route, $this->routes['ok']
->routes()
->all());
}
/**
* Lists routes which should have been created.
*/
public static function notExpectedRoutes() {
return [
[
'jsonapi.entity_type_2--bundle_2_1.individual',
],
[
'jsonapi.entity_type_2--bundle_2_1.collection',
],
[
'jsonapi.entity_type_2--bundle_2_1.collection.post',
],
[
'jsonapi.entity_type_2--bundle_2_1.internal.related',
],
[
'jsonapi.entity_type_2--bundle_2_1.internal.relationship',
],
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
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. | |
RoutesTest::$routes | protected | property | List of routes objects for the different scenarios. | |
RoutesTest::expectedRoutes | public static | function | Lists routes which should have been created. | |
RoutesTest::notExpectedRoutes | public static | function | Lists routes which should have been created. | |
RoutesTest::setUp | protected | function | Overrides UnitTestCase::setUp | |
RoutesTest::testInternalRoutes | public | function | Ensures that no routes are created for internal resources. | |
RoutesTest::testRoutes | public | function | Ensures that the expected routes are created or not created. | |
RoutesTest::testRoutesCollection | public | function | @covers ::routes | |
RoutesTest::testRoutesIndividual | public | function | @covers ::routes | |
RoutesTest::testRoutesRelated | public | function | @covers ::routes | |
RoutesTest::testRoutesRelationships | public | function | @covers ::routes | |
UnitTestCase::$root | protected | property | The app root. | |
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.