class MatcherDumperTest

Same name in other branches
  1. 8.9.x core/tests/Drupal/KernelTests/Core/Routing/MatcherDumperTest.php \Drupal\KernelTests\Core\Routing\MatcherDumperTest
  2. 10 core/tests/Drupal/KernelTests/Core/Routing/MatcherDumperTest.php \Drupal\KernelTests\Core\Routing\MatcherDumperTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Routing/MatcherDumperTest.php \Drupal\KernelTests\Core\Routing\MatcherDumperTest

Confirm that the matcher dumper is functioning properly.

@group Routing

Hierarchy

Expanded class hierarchy of MatcherDumperTest

File

core/tests/Drupal/KernelTests/Core/Routing/MatcherDumperTest.php, line 20

Namespace

Drupal\KernelTests\Core\Routing
View source
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;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        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->assertEquals($collection_routes[$name]->getPath(), $route->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->select('test_routes', 'tr')
            ->fields('tr')
            ->condition('name', 'test_route')
            ->execute()
            ->fetchObject();
        $loaded_route = unserialize($record->route);
        $this->assertEquals('test_route', $record->name, 'Dumped route has correct name.');
        $this->assertEquals('/test/{my}/path', $record->path, 'Dumped route has correct pattern.');
        $this->assertEquals('/test/%/path', $record->pattern_outline, 'Dumped route has correct pattern outline.');
        // Verify that the dumped route has the correct fit. Note that 5 decimal
        // equals 101 binary.
        $this->assertEquals(5, $record->fit, '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->assertEquals($expected, $this->state
            ->get('routing.menu_masks.test_routes'));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$modules protected static property Modules to enable. 487
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
MatcherDumperTest::$fixtures protected property A collection of shared fixture data for tests.
MatcherDumperTest::$state protected property The state.
MatcherDumperTest::setUp protected function Overrides KernelTestBase::setUp
MatcherDumperTest::testAddAdditionalRoutes public function Confirms that we can add routes to the dumper when it already has some.
MatcherDumperTest::testAddRoutes public function Confirms that we can add routes to the dumper.
MatcherDumperTest::testCreate public function Confirms that the dumper can be instantiated successfully.
MatcherDumperTest::testDump public function Confirm that we can dump a route collection to the database.
MatcherDumperTest::testMenuMasksGeneration public function Tests the determination of the masks generation.
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.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.