MatcherDumperTest.php in Drupal 8

Namespace

Drupal\KernelTests\Core\Routing

File

core/tests/Drupal/KernelTests/Core/Routing/MatcherDumperTest.php

<?php

namespace Drupal\KernelTests\Core\Routing;

use Drupal\Core\KeyValueStore\KeyValueMemoryFactory;
use Drupal\Core\Routing\RouteCompiler;
use Drupal\Core\State\State;
use Drupal\KernelTests\KernelTestBase;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;
use Drupal\Core\Database\Database;
use Drupal\Core\Routing\MatcherDumper;
use Drupal\Tests\Core\Routing\RoutingFixtures;

/**
 * Confirm that the matcher dumper is functioning properly.
 *
 * @group Routing
 */
class MatcherDumperTest extends KernelTestBase {

  /**
   * A collection of shared fixture data for tests.
   *
   * @var \Drupal\Tests\Core\Routing\RoutingFixtures
   */
  protected $fixtures;

  /**
   * The state.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;
  protected function setUp() {
    parent::setUp();
    $this->fixtures = new RoutingFixtures();
    $this->state = new State(new KeyValueMemoryFactory());
  }

  /**
   * Confirms that the dumper can be instantiated successfully.
   */
  public function testCreate() {
    $connection = Database::getConnection();
    $dumper = new MatcherDumper($connection, $this->state);
    $class_name = 'Drupal\\Core\\Routing\\MatcherDumper';
    $this
      ->assertInstanceOf($class_name, $dumper);
  }

  /**
   * Confirms that we can add routes to the dumper.
   */
  public function testAddRoutes() {
    $connection = Database::getConnection();
    $dumper = new MatcherDumper($connection, $this->state);
    $route = new Route('test');
    $collection = new RouteCollection();
    $collection
      ->add('test_route', $route);
    $dumper
      ->addRoutes($collection);
    $dumper_routes = $dumper
      ->getRoutes()
      ->all();
    $collection_routes = $collection
      ->all();
    foreach ($dumper_routes as $name => $route) {
      $this
        ->assertEqual($route
        ->getPath(), $collection_routes[$name]
        ->getPath(), 'Routes match');
    }
  }

  /**
   * Confirms that we can add routes to the dumper when it already has some.
   */
  public function testAddAdditionalRoutes() {
    $connection = Database::getConnection();
    $dumper = new MatcherDumper($connection, $this->state);
    $route = new Route('test');
    $collection = new RouteCollection();
    $collection
      ->add('test_route', $route);
    $dumper
      ->addRoutes($collection);
    $route = new Route('test2');
    $collection2 = new RouteCollection();
    $collection2
      ->add('test_route2', $route);
    $dumper
      ->addRoutes($collection2);

    // Merge the two collections together so we can test them.
    $collection
      ->addCollection(clone $collection2);
    $dumper_routes = $dumper
      ->getRoutes()
      ->all();
    $collection_routes = $collection
      ->all();
    foreach ($collection_routes as $name => $route) {
      $this
        ->assertNotEmpty($dumper_routes[$name], "Route {$name} should be present in the dumper.");
    }
  }

  /**
   * Confirm that we can dump a route collection to the database.
   */
  public function testDump() {
    $connection = Database::getConnection();
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $route = new Route('/test/{my}/path');
    $route
      ->setOption('compiler_class', RouteCompiler::class);
    $collection = new RouteCollection();
    $collection
      ->add('test_route', $route);
    $dumper
      ->addRoutes($collection);
    $this->fixtures
      ->createTables($connection);
    $dumper
      ->dump([
      'provider' => 'test',
    ]);
    $record = $connection
      ->query("SELECT * FROM {test_routes} WHERE name= :name", [
      ':name' => 'test_route',
    ])
      ->fetchObject();
    $loaded_route = unserialize($record->route);
    $this
      ->assertEqual($record->name, 'test_route', 'Dumped route has correct name.');
    $this
      ->assertEqual($record->path, '/test/{my}/path', 'Dumped route has correct pattern.');
    $this
      ->assertEqual($record->pattern_outline, '/test/%/path', 'Dumped route has correct pattern outline.');
    $this
      ->assertEqual($record->fit, 5, 'Dumped route has correct fit.');
    $this
      ->assertInstanceOf(Route::class, $loaded_route);
  }

  /**
   * Tests the determination of the masks generation.
   */
  public function testMenuMasksGeneration() {
    $connection = Database::getConnection();
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $collection = new RouteCollection();
    $collection
      ->add('test_route_1', new Route('/test-length-3/{my}/path'));
    $collection
      ->add('test_route_2', new Route('/test-length-3/hello/path'));
    $collection
      ->add('test_route_3', new Route('/test-length-5/{my}/path/marvin/magrathea'));
    $collection
      ->add('test_route_4', new Route('/test-length-7/{my}/path/marvin/magrathea/earth/ursa-minor'));
    $dumper
      ->addRoutes($collection);
    $this->fixtures
      ->createTables($connection);
    $dumper
      ->dump([
      'provider' => 'test',
    ]);

    // Using binary for readability, we expect a 0 at any wildcard slug. They
    // should be ordered from longest to shortest.
    $expected = [
      bindec('1011111'),
      bindec('10111'),
      bindec('111'),
      bindec('101'),
    ];
    $this
      ->assertEqual($this->state
      ->get('routing.menu_masks.test_routes'), $expected);
  }

}

Classes

Name	Description
MatcherDumperTest	Confirm that the matcher dumper is functioning properly.