123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597 |
- <?php
- /**
- * @file
- * Contains \Drupal\Tests\Core\Entity\EntityResolverManagerTest.
- */
- namespace Drupal\Tests\Core\Entity;
- use Drupal\Core\Entity\EntityBase;
- use Drupal\Core\Entity\EntityInterface;
- use Drupal\Core\Entity\EntityResolverManager;
- use Drupal\Core\Form\FormBase;
- use Drupal\Core\Form\FormInterface;
- use Drupal\Core\Form\FormStateInterface;
- use Drupal\Tests\UnitTestCase;
- use Symfony\Component\Routing\Route;
- /**
- * @coversDefaultClass \Drupal\Core\Entity\EntityResolverManager
- * @group Entity
- */
- class EntityResolverManagerTest extends UnitTestCase {
- /**
- * The tested entity resolver manager.
- *
- * @var \Drupal\Core\Entity\EntityResolverManager
- */
- protected $entityResolverManager;
- /**
- * The mocked entity manager.
- *
- * @var \Drupal\Core\Entity\EntityTypeManagerInterface|\PHPUnit\Framework\MockObject\MockObject
- */
- protected $entityTypeManager;
- /**
- * The mocked class resolver.
- *
- * @var \Drupal\Core\DependencyInjection\ClassResolverInterface|\PHPUnit\Framework\MockObject\MockObject
- */
- protected $classResolver;
- /**
- * The mocked dependency injection container.
- *
- * @var \Symfony\Component\DependencyInjection\ContainerInterface|\PHPUnit\Framework\MockObject\MockObject
- */
- protected $container;
- /**
- * {@inheritdoc}
- *
- * @covers ::__construct
- */
- protected function setUp() {
- $this->entityTypeManager = $this->createMock('Drupal\Core\Entity\EntityTypeManagerInterface');
- $this->container = $this->createMock('Symfony\Component\DependencyInjection\ContainerInterface');
- $this->classResolver = $this->getClassResolverStub();
- $this->entityResolverManager = new EntityResolverManager($this->entityTypeManager, $this->classResolver);
- }
- /**
- * Tests setRouteOptions() with no parameter.
- *
- * We don't have any entity type involved, so we don't need any upcasting.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- *
- * @dataProvider providerTestSetRouteOptionsWithStandardRoute
- */
- public function testSetRouteOptionsWithStandardRoute($controller) {
- $route = new Route('/example', [
- '_controller' => $controller,
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $this->assertEmpty($route->getOption('parameters'));
- }
- /**
- * Data provider for testSetRouteOptionsWithStandardRoute.
- */
- public function providerTestSetRouteOptionsWithStandardRoute() {
- return [
- ['Drupal\Tests\Core\Entity\BasicControllerClass::exampleControllerMethod'],
- ['Drupal\Tests\Core\Entity\test_function_controller'],
- ];
- }
- /**
- * Tests setRouteOptions() with a controller with a non entity argument.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- *
- * @dataProvider providerTestSetRouteOptionsWithStandardRouteWithArgument
- */
- public function testSetRouteOptionsWithStandardRouteWithArgument($controller) {
- $route = new Route('/example/{argument}', [
- '_controller' => $controller,
- 'argument' => 'test',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $this->assertEmpty($route->getOption('parameters'));
- }
- /**
- * Data provider for testSetRouteOptionsWithStandardRouteWithArgument.
- */
- public function providerTestSetRouteOptionsWithStandardRouteWithArgument() {
- return [
- ['Drupal\Tests\Core\Entity\BasicControllerClass::exampleControllerMethodWithArgument'],
- ['Drupal\Tests\Core\Entity\test_function_controller_with_argument'],
- ];
- }
- /**
- * Tests setRouteOptions() with a _content default.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- *
- * @dataProvider providerTestSetRouteOptionsWithContentController
- */
- public function testSetRouteOptionsWithContentController($controller) {
- $route = new Route('/example/{argument}', [
- '_controller' => $controller,
- 'argument' => 'test',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $this->assertEmpty($route->getOption('parameters'));
- }
- /**
- * Data provider for testSetRouteOptionsWithContentController.
- */
- public function providerTestSetRouteOptionsWithContentController() {
- return [
- ['Drupal\Tests\Core\Entity\BasicControllerClass::exampleControllerMethodWithArgument'],
- ['Drupal\Tests\Core\Entity\test_function_controller_with_argument'],
- ];
- }
- /**
- * Tests setRouteOptions() with an entity type parameter.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- *
- * @dataProvider providerTestSetRouteOptionsWithEntityTypeNoUpcasting
- */
- public function testSetRouteOptionsWithEntityTypeNoUpcasting($controller) {
- $this->setupEntityTypes();
- $route = new Route('/example/{entity_test}', [
- '_controller' => $controller,
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $this->assertEmpty($route->getOption('parameters'));
- }
- /**
- * Data provider for testSetRouteOptionsWithEntityTypeNoUpcasting.
- */
- public function providerTestSetRouteOptionsWithEntityTypeNoUpcasting() {
- return [
- ['Drupal\Tests\Core\Entity\BasicControllerClass::exampleControllerWithEntityNoUpcasting'],
- ['Drupal\Tests\Core\Entity\test_function_controller_no_upcasting'],
- ];
- }
- /**
- * Tests setRouteOptions() with an entity type parameter, upcasting.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- *
- * @dataProvider providerTestSetRouteOptionsWithEntityTypeUpcasting
- */
- public function testSetRouteOptionsWithEntityTypeUpcasting($controller) {
- $this->setupEntityTypes();
- $route = new Route('/example/{entity_test}', [
- '_controller' => $controller,
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $parameters = $route->getOption('parameters');
- $this->assertEquals(['entity_test' => ['type' => 'entity:entity_test']], $parameters);
- }
- /**
- * Data provider for testSetRouteOptionsWithEntityTypeUpcasting.
- */
- public function providerTestSetRouteOptionsWithEntityTypeUpcasting() {
- return [
- ['Drupal\Tests\Core\Entity\BasicControllerClass::exampleControllerWithEntityUpcasting'],
- ['Drupal\Tests\Core\Entity\test_function_controller_entity_upcasting'],
- ];
- }
- /**
- * Tests setRouteOptions() with an entity type parameter form.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- */
- public function testSetRouteOptionsWithEntityFormUpcasting() {
- $this->setupEntityTypes();
- $route = new Route('/example/{entity_test}', [
- '_form' => 'Drupal\Tests\Core\Entity\BasicForm',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $parameters = $route->getOption('parameters');
- $this->assertEquals(['entity_test' => ['type' => 'entity:entity_test']], $parameters);
- }
- /**
- * Tests setRouteOptions() with entity form upcasting, no create method.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- */
- public function testSetRouteOptionsWithEntityUpcastingNoCreate() {
- $this->setupEntityTypes();
- $route = new Route('/example/{entity_test}', [
- '_form' => 'Drupal\Tests\Core\Entity\BasicFormNoContainerInjectionInterface',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $parameters = $route->getOption('parameters');
- $this->assertEquals(['entity_test' => ['type' => 'entity:entity_test']], $parameters);
- }
- /**
- * Tests setRouteOptions() with an form parameter without interface.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- */
- public function testSetRouteOptionsWithEntityFormNoUpcasting() {
- $this->setupEntityTypes();
- $route = new Route('/example/{entity_test}', [
- '_form' => 'Drupal\Tests\Core\Entity\BasicFormNoUpcasting',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $this->assertEmpty($route->getOption('parameters'));
- }
- /**
- * Tests setRouteOptions() with an _entity_view route.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- * @covers ::setParametersFromEntityInformation
- */
- public function testSetRouteOptionsWithEntityViewRouteAndManualParameters() {
- $this->setupEntityTypes();
- $route = new Route('/example/{foo}',
- [
- '_entity_view' => 'entity_test.view',
- ],
- [],
- [
- 'parameters' => [
- 'foo' => [
- 'type' => 'entity:entity_test',
- ],
- ],
- ]
- );
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $parameters = $route->getOption('parameters');
- $this->assertEquals(['foo' => ['type' => 'entity:entity_test']], $parameters);
- }
- /**
- * Tests setRouteOptions() with an _entity_view route.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- * @covers ::setParametersFromEntityInformation
- */
- public function testSetRouteOptionsWithEntityViewRoute() {
- $this->setupEntityTypes();
- $route = new Route('/example/{entity_test}', [
- '_entity_view' => 'entity_test.view',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $parameters = $route->getOption('parameters');
- $this->assertEquals(['entity_test' => ['type' => 'entity:entity_test']], $parameters);
- }
- /**
- * Tests setRouteOptions() with an _entity_list route.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- * @covers ::setParametersFromEntityInformation
- */
- public function testSetRouteOptionsWithEntityListRoute() {
- $this->setupEntityTypes();
- $route = new Route('/example/{entity_test}', [
- '_entity_list' => 'entity_test',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $parameters = $route->getOption('parameters');
- $this->assertNull($parameters);
- }
- /**
- * Tests setRouteOptions() with an _entity_form route.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- * @covers ::setParametersFromEntityInformation
- */
- public function testSetRouteOptionsWithEntityFormRoute() {
- $this->setupEntityTypes();
- $route = new Route('/example/{entity_test}', [
- '_entity_form' => 'entity_test.edit',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $parameters = $route->getOption('parameters');
- $this->assertEquals(['entity_test' => ['type' => 'entity:entity_test']], $parameters);
- }
- /**
- * Tests an _entity_form route where a non-entity parameter is first.
- *
- * The {argument} preceding {entity_test} in route path, is upcasting with a
- * custom param converter.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- * @covers ::setParametersFromEntityInformation
- */
- public function testSetRouteOptionsWithEntityFormRouteAndArgument() {
- $this->setupEntityTypes();
- $route = new Route('/example/{argument}/{entity_test}', [
- '_entity_form' => 'entity_test.edit',
- ]);
- // Add {argument} parameter configuration. In this case {argument} is
- // upcasted by a custom param converter 'argument_type'.
- $route->setOption('parameters', ['argument' => ['type' => 'argument_type']]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $parameters = $route->getOption('parameters');
- $expect = [
- 'argument' => ['type' => 'argument_type'],
- 'entity_test' => ['type' => 'entity:entity_test'],
- ];
- $this->assertEquals($expect, $parameters);
- }
- /**
- * Tests setRouteOptions() with an _entity_form route for an add form.
- *
- * @covers ::setRouteOptions
- * @covers ::getControllerClass
- * @covers ::getEntityTypes
- * @covers ::setParametersFromReflection
- * @covers ::setParametersFromEntityInformation
- */
- public function testSetRouteOptionsWithEntityAddFormRoute() {
- $this->setupEntityTypes();
- $route = new Route('/example/add', [
- '_entity_form' => 'entity_test.add',
- ]);
- $defaults = $route->getDefaults();
- $this->entityResolverManager->setRouteOptions($route);
- $this->assertEquals($defaults, $route->getDefaults());
- $this->assertFalse($route->hasOption('parameters'));
- }
- /**
- * Creates the entity manager mock returning entity type objects.
- */
- protected function setupEntityTypes() {
- $definition = $this->createMock('Drupal\Core\Entity\EntityTypeInterface');
- $definition->expects($this->any())
- ->method('getClass')
- ->will($this->returnValue('Drupal\Tests\Core\Entity\SimpleTestEntity'));
- $definition->expects($this->any())
- ->method('isRevisionable')
- ->willReturn(FALSE);
- $revisionable_definition = $this->createMock('Drupal\Core\Entity\EntityTypeInterface');
- $revisionable_definition->expects($this->any())
- ->method('getClass')
- ->will($this->returnValue('Drupal\Tests\Core\Entity\SimpleTestEntity'));
- $revisionable_definition->expects($this->any())
- ->method('isRevisionable')
- ->willReturn(TRUE);
- $this->entityTypeManager->expects($this->any())
- ->method('getDefinitions')
- ->will($this->returnValue([
- 'entity_test' => $definition,
- 'entity_test_rev' => $revisionable_definition,
- ]));
- $this->entityTypeManager->expects($this->any())
- ->method('getDefinition')
- ->will($this->returnCallback(function ($entity_type) use ($definition, $revisionable_definition) {
- if ($entity_type == 'entity_test') {
- return $definition;
- }
- elseif ($entity_type === 'entity_test_rev') {
- return $revisionable_definition;
- }
- else {
- return NULL;
- }
- }));
- }
- }
- /**
- * A class containing all kind of different controller methods.
- */
- class BasicControllerClass {
- public function exampleControllerMethod() {
- }
- public function exampleControllerMethodWithArgument($argument) {
- }
- public function exampleControllerWithEntityNoUpcasting($entity_test) {
- }
- public function exampleControllerWithEntityUpcasting(EntityInterface $entity_test) {
- }
- }
- /**
- * A concrete entity.
- */
- class SimpleTestEntity extends EntityBase {
- }
- /**
- * A basic form with a passed entity with an interface.
- *
- * @internal
- */
- class BasicForm extends FormBase {
- /**
- * {@inheritdoc}
- */
- public function getFormId() {
- }
- /**
- * {@inheritdoc}
- */
- public function buildForm(array $form, FormStateInterface $form_state, EntityInterface $entity_test = NULL) {
- }
- /**
- * {@inheritdoc}
- */
- public function submitForm(array &$form, FormStateInterface $form_state) {
- }
- }
- /**
- * A basic form with a passed entity without an interface.
- */
- class BasicFormNoUpcasting extends FormBase {
- /**
- * {@inheritdoc}
- */
- public function getFormId() {
- }
- /**
- * {@inheritdoc}
- */
- public function buildForm(array $form, FormStateInterface $form_state, $entity_test = NULL) {
- }
- /**
- * {@inheritdoc}
- */
- public function submitForm(array &$form, FormStateInterface $form_state) {
- }
- }
- class BasicFormNoContainerInjectionInterface implements FormInterface {
- /**
- * {@inheritdoc}
- */
- public function getFormId() {
- }
- /**
- * {@inheritdoc}
- */
- public function buildForm(array $form, FormStateInterface $form_state, EntityInterface $entity_test = NULL) {
- }
- /**
- * {@inheritdoc}
- */
- public function validateForm(array &$form, FormStateInterface $form_state) {
- }
- /**
- * {@inheritdoc}
- */
- public function submitForm(array &$form, FormStateInterface $form_state) {
- }
- }
- function test_function_controller() {
- }
- function test_function_controller_with_argument($argument) {
- }
- function test_function_controller_no_upcasting($entity_test) {
- }
- function test_function_controller_entity_upcasting(EntityInterface $entity_test) {
- }
|