class RouteBuilderTest in Zircon Profile 8

Same name and namespace in other branches

8.0 core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php \Drupal\Tests\Core\Routing\RouteBuilderTest

@coversDefaultClass \Drupal\Core\Routing\RouteBuilder @group Routing

Hierarchy

class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
- class \Drupal\Tests\Core\Routing\RouteBuilderTest

Expanded class hierarchy of RouteBuilderTest

File

core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php, line 23: Contains \Drupal\Tests\Core\Routing\RouteBuilderTest.

Namespace

Drupal\Tests\Core\Routing

View source

class RouteBuilderTest extends UnitTestCase {

  /**
   * The actual tested route builder.
   *
   * @var \Drupal\Core\Routing\RouteBuilder
   */
  protected $routeBuilder;

  /**
   * The mocked matcher dumper.
   *
   * @var \Drupal\Core\Routing\MatcherDumperInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $dumper;

  /**
   * The mocked lock backend.
   *
   * @var \Drupal\Core\Lock\LockBackendInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $lock;

  /**
   * The mocked event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $dispatcher;

  /**
   * The mocked YAML discovery.
   *
   * @var \Drupal\Component\Discovery\YamlDiscovery|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $yamlDiscovery;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The controller resolver.
   *
   * @var \Drupal\Core\Controller\ControllerResolverInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $controllerResolver;

  /**
   * @var \Drupal\Core\Access\CheckProviderInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  protected $checkProvider;
  protected function setUp() {
    $this->dumper = $this
      ->getMock('Drupal\\Core\\Routing\\MatcherDumperInterface');
    $this->lock = $this
      ->getMock('Drupal\\Core\\Lock\\LockBackendInterface');
    $this->dispatcher = $this
      ->getMock('\\Symfony\\Component\\EventDispatcher\\EventDispatcherInterface');
    $this->moduleHandler = $this
      ->getMock('Drupal\\Core\\Extension\\ModuleHandlerInterface');
    $this->controllerResolver = $this
      ->getMock('Drupal\\Core\\Controller\\ControllerResolverInterface');
    $this->yamlDiscovery = $this
      ->getMockBuilder('\\Drupal\\Component\\Discovery\\YamlDiscovery')
      ->disableOriginalConstructor()
      ->getMock();
    $this->checkProvider = $this
      ->getMock('\\Drupal\\Core\\Access\\CheckProviderInterface');
    $this->routeBuilder = new TestRouteBuilder($this->dumper, $this->lock, $this->dispatcher, $this->moduleHandler, $this->controllerResolver, $this->checkProvider);
    $this->routeBuilder
      ->setYamlDiscovery($this->yamlDiscovery);
  }

  /**
   * Tests that the route rebuilding both locks and unlocks.
   */
  public function testRebuildLockingUnlocking() {
    $this->lock
      ->expects($this
      ->once())
      ->method('acquire')
      ->with('router_rebuild')
      ->will($this
      ->returnValue(TRUE));
    $this->lock
      ->expects($this
      ->once())
      ->method('release')
      ->with('router_rebuild');
    $this->yamlDiscovery
      ->expects($this
      ->any())
      ->method('findAll')
      ->will($this
      ->returnValue(array()));
    $this
      ->assertTrue($this->routeBuilder
      ->rebuild());
  }

  /**
   * Tests route rebuilding with a blocking lock.
   */
  public function testRebuildBlockingLock() {
    $this->lock
      ->expects($this
      ->once())
      ->method('acquire')
      ->with('router_rebuild')
      ->will($this
      ->returnValue(FALSE));
    $this->lock
      ->expects($this
      ->once())
      ->method('wait')
      ->with('router_rebuild');
    $this->lock
      ->expects($this
      ->never())
      ->method('release');
    $this->yamlDiscovery
      ->expects($this
      ->never())
      ->method('findAll');
    $this
      ->assertFalse($this->routeBuilder
      ->rebuild());
  }

  /**
   * Tests that provided routes by a module is put into the dumper/dispatcher.
   *
   * @see \Drupal\Core\Routing\RouteBuilder::rebuild()
   */
  public function testRebuildWithStaticModuleRoutes() {
    $this->lock
      ->expects($this
      ->once())
      ->method('acquire')
      ->with('router_rebuild')
      ->will($this
      ->returnValue(TRUE));
    $routing_fixtures = new RoutingFixtures();
    $routes = $routing_fixtures
      ->staticSampleRouteCollection();
    $this->yamlDiscovery
      ->expects($this
      ->once())
      ->method('findAll')
      ->will($this
      ->returnValue(array(
      'test_module' => $routes,
    )));
    $route_collection = $routing_fixtures
      ->sampleRouteCollection();
    $route_build_event = new RouteBuildEvent($route_collection);

    // Ensure that the alter routes events are fired.
    $this->dispatcher
      ->expects($this
      ->at(0))
      ->method('dispatch')
      ->with(RoutingEvents::DYNAMIC, $route_build_event);
    $this->dispatcher
      ->expects($this
      ->at(1))
      ->method('dispatch')
      ->with(RoutingEvents::ALTER, $route_build_event);

    // Ensure that access checks are set.
    $this->checkProvider
      ->expects($this
      ->once())
      ->method('setChecks')
      ->with($route_collection);

    // Ensure that the routes are set to the dumper and dumped.
    $this->dumper
      ->expects($this
      ->at(0))
      ->method('addRoutes')
      ->with($route_collection);
    $this->dumper
      ->expects($this
      ->at(1))
      ->method('dump')
      ->with();
    $this
      ->assertTrue($this->routeBuilder
      ->rebuild());
  }

  /**
   * Tests the rebuild with routes provided by a callback.
   *
   * @see \Drupal\Core\Routing\RouteBuilder::rebuild()
   */
  public function testRebuildWithProviderBasedRoutes() {
    $this->lock
      ->expects($this
      ->once())
      ->method('acquire')
      ->with('router_rebuild')
      ->will($this
      ->returnValue(TRUE));
    $this->yamlDiscovery
      ->expects($this
      ->once())
      ->method('findAll')
      ->will($this
      ->returnValue(array(
      'test_module' => array(
        'route_callbacks' => array(
          '\\Drupal\\Tests\\Core\\Routing\\TestRouteSubscriber::routesFromArray',
          'test_module.route_service:routesFromCollection',
        ),
      ),
    )));
    $container = new ContainerBuilder();
    $container
      ->set('test_module.route_service', new TestRouteSubscriber());
    $this->controllerResolver
      ->expects($this
      ->any())
      ->method('getControllerFromDefinition')
      ->will($this
      ->returnCallback(function ($controller) use ($container) {
      $count = substr_count($controller, ':');
      if ($count == 1) {
        list($service, $method) = explode(':', $controller, 2);
        $object = $container
          ->get($service);
      }
      else {
        list($class, $method) = explode('::', $controller, 2);
        $object = new $class();
      }
      return array(
        $object,
        $method,
      );
    }));
    $route_collection_filled = new RouteCollection();
    $route_collection_filled
      ->add('test_route.1', new Route('/test-route/1'));
    $route_collection_filled
      ->add('test_route.2', new Route('/test-route/2'));
    $route_build_event = new RouteBuildEvent($route_collection_filled);

    // Ensure that the alter routes events are fired.
    $this->dispatcher
      ->expects($this
      ->at(0))
      ->method('dispatch')
      ->with(RoutingEvents::DYNAMIC, $route_build_event);
    $this->dispatcher
      ->expects($this
      ->at(1))
      ->method('dispatch')
      ->with(RoutingEvents::ALTER, $route_build_event);

    // Ensure that access checks are set.
    $this->checkProvider
      ->expects($this
      ->once())
      ->method('setChecks')
      ->with($route_collection_filled);

    // Ensure that the routes are set to the dumper and dumped.
    $this->dumper
      ->expects($this
      ->at(0))
      ->method('addRoutes')
      ->with($route_collection_filled);
    $this->dumper
      ->expects($this
      ->at(1))
      ->method('dump');
    $this
      ->assertTrue($this->routeBuilder
      ->rebuild());
  }

  /**
   * Tests \Drupal\Core\Routing\RouteBuilder::rebuildIfNeeded() method.
   */
  public function testRebuildIfNeeded() {
    $this->lock
      ->expects($this
      ->once())
      ->method('acquire')
      ->with('router_rebuild')
      ->will($this
      ->returnValue(TRUE));
    $this->lock
      ->expects($this
      ->once())
      ->method('release')
      ->with('router_rebuild');
    $this->yamlDiscovery
      ->expects($this
      ->any())
      ->method('findAll')
      ->will($this
      ->returnValue(array()));
    $this->routeBuilder
      ->setRebuildNeeded();

    // This will trigger a successful rebuild.
    $this
      ->assertTrue($this->routeBuilder
      ->rebuildIfNeeded());

    // This will not trigger a rebuild.
    $this
      ->assertFalse($this->routeBuilder
      ->rebuildIfNeeded());
  }

}

Members

Name	Modifiers	Type	Description
RouteBuilderTest::$checkProvider	protected	property
RouteBuilderTest::$controllerResolver	protected	property	The controller resolver.
RouteBuilderTest::$dispatcher	protected	property	The mocked event dispatcher.
RouteBuilderTest::$dumper	protected	property	The mocked matcher dumper.
RouteBuilderTest::$lock	protected	property	The mocked lock backend.
RouteBuilderTest::$moduleHandler	protected	property	The module handler.
RouteBuilderTest::$routeBuilder	protected	property	The actual tested route builder.
RouteBuilderTest::$yamlDiscovery	protected	property	The mocked YAML discovery.
RouteBuilderTest::setUp	protected	function	Overrides UnitTestCase::setUp
RouteBuilderTest::testRebuildBlockingLock	public	function	Tests route rebuilding with a blocking lock.
RouteBuilderTest::testRebuildIfNeeded	public	function	Tests \Drupal\Core\Routing\RouteBuilder::rebuildIfNeeded() method.
RouteBuilderTest::testRebuildLockingUnlocking	public	function	Tests that the route rebuilding both locks and unlocks.
RouteBuilderTest::testRebuildWithProviderBasedRoutes	public	function	Tests the rebuild with routes provided by a callback.
RouteBuilderTest::testRebuildWithStaticModuleRoutes	public	function	Tests that provided routes by a module is put into the dumper/dispatcher.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName	protected	function	Mocks a block with a block plugin.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed in 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.

You are here

class RouteBuilderTest in Zircon Profile 8

Hierarchy

File

Namespace

Members

API Navigation