class CollectRoutesTest in Drupal 9

Tests the REST export view plugin.

@group rest

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\rest\Unit\CollectRoutesTest

File

core/modules/rest/tests/src/Unit/CollectRoutesTest.php, line 16

Namespace

Drupal\Tests\rest\Unit

class CollectRoutesTest extends UnitTestCase {

  /**
   * The REST export instance.
   *
   * @var \Drupal\rest\Plugin\views\display\RestExport
   */
  protected $restExport;

  /**
   * The RouteCollection.
   */
  protected $routes;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $container = new ContainerBuilder();
    $request = $this
      ->getMockBuilder('\\Symfony\\Component\\HttpFoundation\\Request')
      ->disableOriginalConstructor()
      ->getMock();
    $this->view = $this
      ->getMockBuilder('\\Drupal\\views\\Entity\\View')
      ->setMethods([
      'initHandlers',
    ])
      ->setConstructorArgs([
      [
        'id' => 'test_view',
      ],
      'view',
    ])
      ->getMock();
    $view_executable = $this
      ->getMockBuilder('\\Drupal\\views\\ViewExecutable')
      ->setMethods([
      'initHandlers',
      'getTitle',
    ])
      ->disableOriginalConstructor()
      ->getMock();
    $view_executable
      ->expects($this
      ->any())
      ->method('getTitle')
      ->willReturn('View title');
    $view_executable->storage = $this->view;
    $view_executable->argument = [];
    $display_manager = $this
      ->getMockBuilder('\\Drupal\\views\\Plugin\\ViewsPluginManager')
      ->disableOriginalConstructor()
      ->getMock();
    $container
      ->set('plugin.manager.views.display', $display_manager);
    $access_manager = $this
      ->getMockBuilder('\\Drupal\\views\\Plugin\\ViewsPluginManager')
      ->disableOriginalConstructor()
      ->getMock();
    $container
      ->set('plugin.manager.views.access', $access_manager);
    $route_provider = $this
      ->getMockBuilder('\\Drupal\\Core\\Routing\\RouteProviderInterface')
      ->disableOriginalConstructor()
      ->getMock();
    $container
      ->set('router.route_provider', $route_provider);
    $container
      ->setParameter('authentication_providers', [
      'basic_auth' => 'basic_auth',
    ]);
    $state = $this
      ->createMock('\\Drupal\\Core\\State\\StateInterface');
    $container
      ->set('state', $state);
    $style_manager = $this
      ->getMockBuilder('\\Drupal\\views\\Plugin\\ViewsPluginManager')
      ->disableOriginalConstructor()
      ->getMock();
    $container
      ->set('plugin.manager.views.style', $style_manager);
    $container
      ->set('renderer', $this
      ->createMock('Drupal\\Core\\Render\\RendererInterface'));
    $authentication_collector = $this
      ->createMock('\\Drupal\\Core\\Authentication\\AuthenticationCollectorInterface');
    $container
      ->set('authentication_collector', $authentication_collector);
    $authentication_collector
      ->expects($this
      ->any())
      ->method('getSortedProviders')
      ->will($this
      ->returnValue([
      'basic_auth' => 'data',
      'cookie' => 'data',
    ]));
    $container
      ->setParameter('serializer.format_providers', [
      'json',
    ]);
    \Drupal::setContainer($container);
    $this->restExport = RestExport::create($container, [], "test_routes", []);
    $this->restExport->view = $view_executable;

    // Initialize a display.
    $this->restExport->display = [
      'id' => 'page_1',
    ];

    // Set the style option.
    $this->restExport
      ->setOption('style', [
      'type' => 'serializer',
    ]);

    // Set the auth option.
    $this->restExport
      ->setOption('auth', [
      'basic_auth',
    ]);
    $display_manager
      ->expects($this
      ->once())
      ->method('getDefinition')
      ->will($this
      ->returnValue([
      'id' => 'test',
      'provider' => 'test',
    ]));
    $none = $this
      ->getMockBuilder('\\Drupal\\views\\Plugin\\views\\access\\None')
      ->disableOriginalConstructor()
      ->getMock();
    $access_manager
      ->expects($this
      ->once())
      ->method('createInstance')
      ->will($this
      ->returnValue($none));
    $style_plugin = $this
      ->getMockBuilder('\\Drupal\\rest\\Plugin\\views\\style\\Serializer')
      ->setMethods([
      'getFormats',
      'init',
    ])
      ->disableOriginalConstructor()
      ->getMock();
    $style_plugin
      ->expects($this
      ->once())
      ->method('getFormats')
      ->will($this
      ->returnValue([
      'json',
    ]));
    $style_plugin
      ->expects($this
      ->once())
      ->method('init')
      ->with($view_executable)
      ->will($this
      ->returnValue(TRUE));
    $style_manager
      ->expects($this
      ->once())
      ->method('createInstance')
      ->will($this
      ->returnValue($style_plugin));
    $this->routes = new RouteCollection();
    $this->routes
      ->add('test_1', new Route('/test/1'));
    $this->routes
      ->add('view.test_view.page_1', new Route('/test/2'));
    $this->view
      ->addDisplay('page', NULL, 'page_1');
  }

  /**
   * Tests if adding a requirement to a route only modify one route.
   */
  public function testRoutesRequirements() {
    $this->restExport
      ->collectRoutes($this->routes);
    $requirements_1 = $this->routes
      ->get('test_1')
      ->getRequirements();
    $requirements_2 = $this->routes
      ->get('view.test_view.page_1')
      ->getRequirements();
    $this
      ->assertCount(0, $requirements_1, 'First route has no requirement.');
    $this
      ->assertCount(1, $requirements_2, 'Views route with rest export had the format requirement added.');

    // Check auth options.
    $auth = $this->routes
      ->get('view.test_view.page_1')
      ->getOption('_auth');
    $this
      ->assertCount(1, $auth, 'View route with rest export has an auth option added');
    $this
      ->assertEquals('basic_auth', $auth[0], 'View route with rest export has the correct auth option added');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CollectRoutesTest::$restExport	protected	property	The REST export instance.
CollectRoutesTest::$routes	protected	property	The RouteCollection.
CollectRoutesTest::setUp	protected	function	Overrides UnitTestCase::setUp
CollectRoutesTest::testRoutesRequirements	public	function	Tests if adding a requirement to a route only modify one route.
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.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals Deprecated	protected	function	Asserts if two arrays are equal by sorting them first.
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::setUpBeforeClass	public static	function