EntityRouteEnhancerTest.php in Drupal 9

Namespace

Drupal\Tests\Core\Entity\Enhancer

File

core/tests/Drupal/Tests/Core/Entity/Enhancer/EntityRouteEnhancerTest.php

<?php

namespace Drupal\Tests\Core\Entity\Enhancer;

use Drupal\Core\Entity\Enhancer\EntityRouteEnhancer;
use Drupal\Tests\UnitTestCase;
use Drupal\Core\Routing\RouteObjectInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Route;

/**
 * @coversDefaultClass \Drupal\Core\Entity\Enhancer\EntityRouteEnhancer
 * @group Entity
 */
class EntityRouteEnhancerTest extends UnitTestCase {

  /**
   * Tests the enhancer method.
   *
   * @see \Drupal\Core\Entity\Enhancer\EntityRouteEnhancer::enhancer()
   */
  public function testEnhancer() {
    $route_enhancer = new EntityRouteEnhancer();

    // Set a controller to ensure it is not overridden.
    $request = new Request();
    $defaults = [];
    $defaults['_controller'] = 'Drupal\\Tests\\Core\\Controller\\TestController::content';
    $defaults['_entity_form'] = 'entity_test.default';
    $defaults['_route_object'] = new Route('/test', $defaults);
    $new_defaults = $route_enhancer
      ->enhance($defaults, $request);
    $this
      ->assertEquals($defaults['_controller'], $new_defaults['_controller'], '_controller did not get overridden.');

    // Set _entity_form and ensure that the form is set.
    $defaults = [];
    $defaults['_entity_form'] = 'entity_test.default';
    $defaults['_route_object'] = new Route('/test', $defaults);
    $new_defaults = $route_enhancer
      ->enhance($defaults, $request);
    $this
      ->assertEquals('controller.entity_form:getContentResult', $new_defaults['_controller']);

    // Set _entity_list and ensure that the entity list controller is set.
    $defaults = [];
    $defaults['_entity_list'] = 'entity_test.default';
    $defaults['_route_object'] = new Route('/test', $defaults);
    $new_defaults = $route_enhancer
      ->enhance($defaults, $request);
    $this
      ->assertEquals('\\Drupal\\Core\\Entity\\Controller\\EntityListController::listing', $new_defaults['_controller'], 'The entity list controller was not set.');
    $this
      ->assertEquals('entity_test.default', $new_defaults['entity_type']);
    $this
      ->assertFalse(isset($new_defaults['_entity_list']));

    // Set _entity_view and ensure that the entity view controller is set.
    $defaults = [];
    $defaults['_entity_view'] = 'entity_test.full';
    $defaults['entity_test'] = 'Mock entity';
    $defaults['_route_object'] = new Route('/test', $defaults);
    $defaults = $route_enhancer
      ->enhance($defaults, $request);
    $this
      ->assertEquals('\\Drupal\\Core\\Entity\\Controller\\EntityViewController::view', $defaults['_controller'], 'The entity view controller was not set.');
    $this
      ->assertEquals('Mock entity', $defaults['_entity']);
    $this
      ->assertEquals('full', $defaults['view_mode']);
    $this
      ->assertFalse(isset($defaults['_entity_view']));

    // Set _entity_view and ensure that the entity view controller is set using
    // a converter.
    $defaults = [];
    $defaults['_entity_view'] = 'entity_test.full';
    $defaults['foo'] = 'Mock entity';

    // Add a converter.
    $options['parameters']['foo'] = [
      'type' => 'entity:entity_test',
    ];

    // Set the route.
    $route = new Route('/test');
    $route
      ->setOptions($options);
    $route
      ->setDefaults($defaults);
    $defaults[RouteObjectInterface::ROUTE_OBJECT] = $route;
    $defaults = $route_enhancer
      ->enhance($defaults, $request);
    $this
      ->assertEquals('\\Drupal\\Core\\Entity\\Controller\\EntityViewController::view', $defaults['_controller'], 'The entity view controller was not set.');
    $this
      ->assertEquals('Mock entity', $defaults['_entity']);
    $this
      ->assertEquals('full', $defaults['view_mode']);
    $this
      ->assertFalse(isset($defaults['_entity_view']));

    // Set _entity_view without a view mode.
    $defaults = [];
    $defaults['_entity_view'] = 'entity_test';
    $defaults['entity_test'] = 'Mock entity';
    $defaults['_route_object'] = new Route('/test', $defaults);
    $defaults = $route_enhancer
      ->enhance($defaults, $request);
    $this
      ->assertEquals('\\Drupal\\Core\\Entity\\Controller\\EntityViewController::view', $defaults['_controller'], 'The entity view controller was not set.');
    $this
      ->assertEquals('Mock entity', $defaults['_entity']);
    $this
      ->assertTrue(empty($defaults['view_mode']));
    $this
      ->assertFalse(isset($defaults['_entity_view']));
  }

}

Classes

Name	Description
EntityRouteEnhancerTest	@coversDefaultClass \Drupal\Core\Entity\Enhancer\EntityRouteEnhancer @group Entity