You are here

Home » API reference » Zircon Profile 8.0 » RouteProviderTest.php

class RouteProviderTest in Zircon Profile 8.0

Same name in this branch
  1. 8.0 core/tests/Drupal/KernelTests/Core/Entity/RouteProviderTest.php \Drupal\KernelTests\Core\Entity\RouteProviderTest
  2. 8.0 core/modules/system/src/Tests/Routing/RouteProviderTest.php \Drupal\system\Tests\Routing\RouteProviderTest
Same name and namespace in other branches
  1. 8 core/modules/system/src/Tests/Routing/RouteProviderTest.php \Drupal\system\Tests\Routing\RouteProviderTest

Confirm that the default route provider is working correctly.

@group Routing

Hierarchy

Expanded class hierarchy of RouteProviderTest

File

core/modules/system/src/Tests/Routing/RouteProviderTest.php, line 32
Contains \Drupal\system\Tests\Routing\RouteProviderTest.

Namespace

Drupal\system\Tests\Routing
View source 
class RouteProviderTest extends KernelTestBase {

  /**
   * Modules to enable.
   */
  public static $modules = [
    'url_alter_test',
    'system',
  ];

  /**
   * A collection of shared fixture data for tests.
   *
   * @var RoutingFixtures
   */
  protected $fixtures;

  /**
   * The state.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * The current path.
   *
   * @var \Drupal\Core\Path\CurrentPathStack
   */
  protected $currentPath;

  /**
   * The cache backend.
   *
   * @var \Drupal\Core\Cache\MemoryBackend
   */
  protected $cache;

  /**
   * The inbound path processor.
   *
   * @var \Drupal\Core\PathProcessor\InboundPathProcessorInterface
   */
  protected $pathProcessor;

  /**
   * The cache tags invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $cacheTagsInvalidator;
  protected function setUp() {
    parent::setUp();
    $this->fixtures = new RoutingFixtures();
    $this->state = new State(new KeyValueMemoryFactory());
    $this->currentPath = new CurrentPathStack(new RequestStack());
    $this->cache = new MemoryBackend('data');
    $this->pathProcessor = \Drupal::service('path_processor_manager');
    $this->cacheTagsInvalidator = \Drupal::service('cache_tags.invalidator');
    $this
      ->installSchema('system', 'url_alias');
  }

  /**
   * {@inheritdoc}
   */
  public function containerBuild(ContainerBuilder $container) {
    parent::containerBuild($container);

    // TODO: Change the autogenerated stub
    // Readd the incoming path alias for these tests.
    if ($container
      ->hasDefinition('path_processor_alias')) {
      $definition = $container
        ->getDefinition('path_processor_alias');
      $definition
        ->addTag('path_processor_inbound');
    }
  }
  protected function tearDown() {
    $this->fixtures
      ->dropTables(Database::getConnection());
    parent::tearDown();
  }

  /**
   * Confirms that the correct candidate outlines are generated.
   */
  public function testCandidateOutlines() {
    $connection = Database::getConnection();
    $provider = new TestRouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $parts = array(
      'node',
      '5',
      'edit',
    );
    $candidates = $provider
      ->getCandidateOutlines($parts);
    $candidates = array_flip($candidates);
    $this
      ->assertTrue(count($candidates) == 7, 'Correct number of candidates found');
    $this
      ->assertTrue(array_key_exists('/node/5/edit', $candidates), 'First candidate found.');
    $this
      ->assertTrue(array_key_exists('/node/5/%', $candidates), 'Second candidate found.');
    $this
      ->assertTrue(array_key_exists('/node/%/edit', $candidates), 'Third candidate found.');
    $this
      ->assertTrue(array_key_exists('/node/%/%', $candidates), 'Fourth candidate found.');
    $this
      ->assertTrue(array_key_exists('/node/5', $candidates), 'Fifth candidate found.');
    $this
      ->assertTrue(array_key_exists('/node/%', $candidates), 'Sixth candidate found.');
    $this
      ->assertTrue(array_key_exists('/node', $candidates), 'Seventh candidate found.');
  }

  /**
   * Confirms that we can find routes with the exact incoming path.
   */
  function testExactPathMatch() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($this->fixtures
      ->sampleRouteCollection());
    $dumper
      ->dump();
    $path = '/path/one';
    $request = Request::create($path, 'GET');
    $routes = $provider
      ->getRouteCollectionForRequest($request);
    foreach ($routes as $route) {
      $this
        ->assertEqual($route
        ->getPath(), $path, 'Found path has correct pattern');
    }
  }

  /**
   * Confirms that we can find routes whose pattern would match the request.
   */
  function testOutlinePathMatch() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($this->fixtures
      ->complexRouteCollection());
    $dumper
      ->dump();
    $path = '/path/1/one';
    $request = Request::create($path, 'GET');
    $routes = $provider
      ->getRouteCollectionForRequest($request);

    // All of the matching paths have the correct pattern.
    foreach ($routes as $route) {
      $this
        ->assertEqual($route
        ->compile()
        ->getPatternOutline(), '/path/%/one', 'Found path has correct pattern');
    }
    $this
      ->assertEqual(count($routes), 2, 'The correct number of routes was found.');
    $this
      ->assertNotNull($routes
      ->get('route_a'), 'The first matching route was found.');
    $this
      ->assertNotNull($routes
      ->get('route_b'), 'The second matching route was not found.');
  }

  /**
   * Confirms that a trailing slash on the request doesn't result in a 404.
   */
  function testOutlinePathMatchTrailingSlash() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($this->fixtures
      ->complexRouteCollection());
    $dumper
      ->dump();
    $path = '/path/1/one/';
    $request = Request::create($path, 'GET');
    $routes = $provider
      ->getRouteCollectionForRequest($request);

    // All of the matching paths have the correct pattern.
    foreach ($routes as $route) {
      $this
        ->assertEqual($route
        ->compile()
        ->getPatternOutline(), '/path/%/one', 'Found path has correct pattern');
    }
    $this
      ->assertEqual(count($routes), 2, 'The correct number of routes was found.');
    $this
      ->assertNotNull($routes
      ->get('route_a'), 'The first matching route was found.');
    $this
      ->assertNotNull($routes
      ->get('route_b'), 'The second matching route was not found.');
  }

  /**
   * Confirms that we can find routes whose pattern would match the request.
   */
  function testOutlinePathMatchDefaults() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $collection = new RouteCollection();
    $collection
      ->add('poink', new Route('/some/path/{value}', array(
      'value' => 'poink',
    )));
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($collection);
    $dumper
      ->dump();
    $path = '/some/path';
    $request = Request::create($path, 'GET');
    try {
      $routes = $provider
        ->getRouteCollectionForRequest($request);

      // All of the matching paths have the correct pattern.
      foreach ($routes as $route) {
        $this
          ->assertEqual($route
          ->compile()
          ->getPatternOutline(), '/some/path', 'Found path has correct pattern');
      }
      $this
        ->assertEqual(count($routes), 1, 'The correct number of routes was found.');
      $this
        ->assertNotNull($routes
        ->get('poink'), 'The first matching route was found.');
    } catch (ResourceNotFoundException $e) {
      $this
        ->fail('No matching route found with default argument value.');
    }
  }

  /**
   * Confirms that we can find routes whose pattern would match the request.
   */
  function testOutlinePathMatchDefaultsCollision() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $collection = new RouteCollection();
    $collection
      ->add('poink', new Route('/some/path/{value}', array(
      'value' => 'poink',
    )));
    $collection
      ->add('narf', new Route('/some/path/here'));
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($collection);
    $dumper
      ->dump();
    $path = '/some/path';
    $request = Request::create($path, 'GET');
    try {
      $routes = $provider
        ->getRouteCollectionForRequest($request);

      // All of the matching paths have the correct pattern.
      foreach ($routes as $route) {
        $this
          ->assertEqual($route
          ->compile()
          ->getPatternOutline(), '/some/path', 'Found path has correct pattern');
      }
      $this
        ->assertEqual(count($routes), 1, 'The correct number of routes was found.');
      $this
        ->assertNotNull($routes
        ->get('poink'), 'The first matching route was found.');
    } catch (ResourceNotFoundException $e) {
      $this
        ->fail('No matching route found with default argument value.');
    }
  }

  /**
   * Confirms that we can find routes whose pattern would match the request.
   */
  function testOutlinePathMatchDefaultsCollision2() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $collection = new RouteCollection();
    $collection
      ->add('poink', new Route('/some/path/{value}', array(
      'value' => 'poink',
    )));
    $collection
      ->add('narf', new Route('/some/path/here'));
    $collection
      ->add('eep', new Route('/something/completely/different'));
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($collection);
    $dumper
      ->dump();
    $path = '/some/path/here';
    $request = Request::create($path, 'GET');
    try {
      $routes = $provider
        ->getRouteCollectionForRequest($request);
      $routes_array = $routes
        ->all();
      $this
        ->assertEqual(count($routes), 2, 'The correct number of routes was found.');
      $this
        ->assertEqual(array(
        'narf',
        'poink',
      ), array_keys($routes_array), 'Ensure the fitness was taken into account.');
      $this
        ->assertNotNull($routes
        ->get('narf'), 'The first matching route was found.');
      $this
        ->assertNotNull($routes
        ->get('poink'), 'The second matching route was found.');
      $this
        ->assertNull($routes
        ->get('eep'), 'Non-matching route was not found.');
    } catch (ResourceNotFoundException $e) {
      $this
        ->fail('No matching route found with default argument value.');
    }
  }

  /**
   * Confirms that we can find multiple routes that match the request equally.
   */
  function testOutlinePathMatchDefaultsCollision3() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $collection = new RouteCollection();
    $collection
      ->add('poink', new Route('/some/{value}/path'));

    // Add a second route matching the same path pattern.
    $collection
      ->add('poink2', new Route('/some/{object}/path'));
    $collection
      ->add('narf', new Route('/some/here/path'));
    $collection
      ->add('eep', new Route('/something/completely/different'));
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($collection);
    $dumper
      ->dump();
    $path = '/some/over-there/path';
    $request = Request::create($path, 'GET');
    try {
      $routes = $provider
        ->getRouteCollectionForRequest($request);
      $routes_array = $routes
        ->all();
      $this
        ->assertEqual(count($routes), 2, 'The correct number of routes was found.');
      $this
        ->assertEqual(array(
        'poink',
        'poink2',
      ), array_keys($routes_array), 'Ensure the fitness and name were taken into account in the sort.');
      $this
        ->assertNotNull($routes
        ->get('poink'), 'The first matching route was found.');
      $this
        ->assertNotNull($routes
        ->get('poink2'), 'The second matching route was found.');
      $this
        ->assertNull($routes
        ->get('eep'), 'Non-matching route was not found.');
    } catch (ResourceNotFoundException $e) {
      $this
        ->fail('No matching route found with default argument value.');
    }
  }

  /**
   * Tests a route with a 0 as value.
   */
  public function testOutlinePathMatchZero() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $collection = new RouteCollection();
    $collection
      ->add('poink', new Route('/some/path/{value}'));
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($collection);
    $dumper
      ->dump();
    $path = '/some/path/0';
    $request = Request::create($path, 'GET');
    try {
      $routes = $provider
        ->getRouteCollectionForRequest($request);

      // All of the matching paths have the correct pattern.
      foreach ($routes as $route) {
        $this
          ->assertEqual($route
          ->compile()
          ->getPatternOutline(), '/some/path/%', 'Found path has correct pattern');
      }
      $this
        ->assertEqual(count($routes), 1, 'The correct number of routes was found.');
    } catch (ResourceNotFoundException $e) {
      $this
        ->fail('No matchout route found with 0 as argument value');
    }
  }

  /**
   * Confirms that an exception is thrown when no matching path is found.
   */
  function testOutlinePathNoMatch() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($this->fixtures
      ->complexRouteCollection());
    $dumper
      ->dump();
    $path = '/no/such/path';
    $request = Request::create($path, 'GET');
    $routes = $provider
      ->getRoutesByPattern($path);
    $this
      ->assertFalse(count($routes), 'No path found with this pattern.');
    $collection = $provider
      ->getRouteCollectionForRequest($request);
    $this
      ->assertTrue(count($collection) == 0, 'Empty route collection found with this pattern.');
  }

  /**
   * Tests that route caching works.
   */
  public function testRouteCaching() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($this->fixtures
      ->sampleRouteCollection());
    $dumper
      ->addRoutes($this->fixtures
      ->complexRouteCollection());
    $dumper
      ->dump();

    // A simple path.
    $path = '/path/add/one';
    $request = Request::create($path, 'GET');
    $provider
      ->getRouteCollectionForRequest($request);
    $cache = $this->cache
      ->get('route:/path/add/one:');
    $this
      ->assertEqual('/path/add/one', $cache->data['path']);
    $this
      ->assertEqual([], $cache->data['query']);
    $this
      ->assertEqual(3, count($cache->data['routes']));

    // A path with query parameters.
    $path = '/path/add/one?foo=bar';
    $request = Request::create($path, 'GET');
    $provider
      ->getRouteCollectionForRequest($request);
    $cache = $this->cache
      ->get('route:/path/add/one:foo=bar');
    $this
      ->assertEqual('/path/add/one', $cache->data['path']);
    $this
      ->assertEqual([
      'foo' => 'bar',
    ], $cache->data['query']);
    $this
      ->assertEqual(3, count($cache->data['routes']));

    // A path with placeholders.
    $path = '/path/1/one';
    $request = Request::create($path, 'GET');
    $provider
      ->getRouteCollectionForRequest($request);
    $cache = $this->cache
      ->get('route:/path/1/one:');
    $this
      ->assertEqual('/path/1/one', $cache->data['path']);
    $this
      ->assertEqual([], $cache->data['query']);
    $this
      ->assertEqual(2, count($cache->data['routes']));

    // A path with a path alias.

    /** @var \Drupal\Core\Path\AliasStorageInterface $path_storage */
    $path_storage = \Drupal::service('path.alias_storage');
    $path_storage
      ->save('/path/add/one', '/path/add-one');

    /** @var \Drupal\Core\Path\AliasManagerInterface $alias_manager */
    $alias_manager = \Drupal::service('path.alias_manager');
    $alias_manager
      ->cacheClear();
    $path = '/path/add-one';
    $request = Request::create($path, 'GET');
    $provider
      ->getRouteCollectionForRequest($request);
    $cache = $this->cache
      ->get('route:/path/add-one:');
    $this
      ->assertEqual('/path/add/one', $cache->data['path']);
    $this
      ->assertEqual([], $cache->data['query']);
    $this
      ->assertEqual(3, count($cache->data['routes']));
  }

  /**
   * Test RouteProvider::getRouteByName() and RouteProvider::getRoutesByNames().
   */
  public function testRouteByName() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($this->fixtures
      ->sampleRouteCollection());
    $dumper
      ->dump();
    $route = $provider
      ->getRouteByName('route_a');
    $this
      ->assertEqual($route
      ->getPath(), '/path/one', 'The right route pattern was found.');
    $this
      ->assertEqual($route
      ->getMethods(), [
      'GET',
    ], 'The right route method was found.');
    $route = $provider
      ->getRouteByName('route_b');
    $this
      ->assertEqual($route
      ->getPath(), '/path/one', 'The right route pattern was found.');
    $this
      ->assertEqual($route
      ->getMethods(), [
      'PUT',
    ], 'The right route method was found.');
    $exception_thrown = FALSE;
    try {
      $provider
        ->getRouteByName('invalid_name');
    } catch (RouteNotFoundException $e) {
      $exception_thrown = TRUE;
    }
    $this
      ->assertTrue($exception_thrown, 'Random route was not found.');
    $routes = $provider
      ->getRoutesByNames(array(
      'route_c',
      'route_d',
      $this
        ->randomMachineName(),
    ));
    $this
      ->assertEqual(count($routes), 2, 'Only two valid routes found.');
    $this
      ->assertEqual($routes['route_c']
      ->getPath(), '/path/two');
    $this
      ->assertEqual($routes['route_d']
      ->getPath(), '/path/three');
  }

  /**
   * Ensures that the routing system is capable of extreme long patterns.
   */
  public function testGetRoutesByPatternWithLongPatterns() {
    $connection = Database::getConnection();
    $provider = new TestRouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);

    // This pattern has only 3 parts, so we will get candidates, but no routes,
    // even though we have not dumped the routes yet.
    $shortest = '/test/1/test2';
    $result = $provider
      ->getRoutesByPattern($shortest);
    $this
      ->assertEqual($result
      ->count(), 0);
    $candidates = $provider
      ->getCandidateOutlines(explode('/', trim($shortest, '/')));
    $this
      ->assertEqual(count($candidates), 7);

    // A longer patten is not found and returns no candidates
    $path_to_test = '/test/1/test2/2/test3/3/4/5/6/test4';
    $result = $provider
      ->getRoutesByPattern($path_to_test);
    $this
      ->assertEqual($result
      ->count(), 0);
    $candidates = $provider
      ->getCandidateOutlines(explode('/', trim($path_to_test, '/')));
    $this
      ->assertEqual(count($candidates), 0);

    // Add a matching route and dump it.
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $collection = new RouteCollection();
    $collection
      ->add('long_pattern', new Route('/test/{v1}/test2/{v2}/test3/{v3}/{v4}/{v5}/{v6}/test4'));
    $dumper
      ->addRoutes($collection);
    $dumper
      ->dump();
    $result = $provider
      ->getRoutesByPattern($path_to_test);
    $this
      ->assertEqual($result
      ->count(), 1);

    // We can't compare the values of the routes directly, nor use
    // spl_object_hash() because they are separate instances.
    $this
      ->assertEqual(serialize($result
      ->get('long_pattern')), serialize($collection
      ->get('long_pattern')), 'The right route was found.');

    // We now have a single candidate outline.
    $candidates = $provider
      ->getCandidateOutlines(explode('/', trim($path_to_test, '/')));
    $this
      ->assertEqual(count($candidates), 1);

    // Longer and shorter patterns are not found. Both are longer than 3, so
    // we should not have any candidates either. The fact that we do not
    // get any candidates for a longer path is a security feature.
    $longer = '/test/1/test2/2/test3/3/4/5/6/test4/trailing/more/parts';
    $result = $provider
      ->getRoutesByPattern($longer);
    $this
      ->assertEqual($result
      ->count(), 0);
    $candidates = $provider
      ->getCandidateOutlines(explode('/', trim($longer, '/')));
    $this
      ->assertEqual(count($candidates), 1);
    $shorter = '/test/1/test2/2/test3';
    $result = $provider
      ->getRoutesByPattern($shorter);
    $this
      ->assertEqual($result
      ->count(), 0);
    $candidates = $provider
      ->getCandidateOutlines(explode('/', trim($shorter, '/')));
    $this
      ->assertEqual(count($candidates), 0);

    // This pattern has only 3 parts, so we will get candidates, but no routes.
    // This result is unchanged by running the dumper.
    $result = $provider
      ->getRoutesByPattern($shortest);
    $this
      ->assertEqual($result
      ->count(), 0);
    $candidates = $provider
      ->getCandidateOutlines(explode('/', trim($shortest, '/')));
    $this
      ->assertEqual(count($candidates), 7);
  }

  /**
   * Tests getRoutesPaged().
   */
  public function testGetRoutesPaged() {
    $connection = Database::getConnection();
    $provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
    $this->fixtures
      ->createTables($connection);
    $dumper = new MatcherDumper($connection, $this->state, 'test_routes');
    $dumper
      ->addRoutes($this->fixtures
      ->sampleRouteCollection());
    $dumper
      ->dump();
    $fixture_routes = $this->fixtures
      ->staticSampleRouteCollection();

    // Query all the routes.
    $routes = $provider
      ->getRoutesPaged(0);
    $this
      ->assertEqual(array_keys($routes), array_keys($fixture_routes));

    // Query non routes.
    $routes = $provider
      ->getRoutesPaged(0, 0);
    $this
      ->assertEqual(array_keys($routes), []);

    // Query a limited sets of routes.
    $routes = $provider
      ->getRoutesPaged(1, 2);
    $this
      ->assertEqual(array_keys($routes), array_slice(array_keys($fixture_routes), 1, 2));
  }

}

Members

Namesort descending Modifiers Type Description 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. 2
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 the raw text IS NOT found escaped on the 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::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.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
KernelTestBase::$configDirectories protected property The configuration directories for this test run.
KernelTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles private property
KernelTestBase::$streamWrappers protected property Array of registered stream wrappers.
KernelTestBase::$themeFiles private property
KernelTestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::defaultLanguageData protected function Provides the data for setting the default language on the container. 1
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
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 a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
KernelTestBase::registerStreamWrapper protected function Registers a stream wrapper for this test.
KernelTestBase::render protected function Renders a render array.
KernelTestBase::__construct function Constructor for Test. Overrides TestBase::__construct
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.
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.
RouteProviderTest::$cache protected property The cache backend.
RouteProviderTest::$cacheTagsInvalidator protected property The cache tags invalidator.
RouteProviderTest::$currentPath protected property The current path.
RouteProviderTest::$fixtures protected property A collection of shared fixture data for tests.
RouteProviderTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
RouteProviderTest::$pathProcessor protected property The inbound path processor.
RouteProviderTest::$state protected property The state.
RouteProviderTest::containerBuild public function Sets up the base service container for this test. Overrides KernelTestBase::containerBuild
RouteProviderTest::setUp protected function Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp
RouteProviderTest::tearDown protected function Performs cleanup tasks after each individual test method has been run. Overrides KernelTestBase::tearDown
RouteProviderTest::testCandidateOutlines public function Confirms that the correct candidate outlines are generated.
RouteProviderTest::testExactPathMatch function Confirms that we can find routes with the exact incoming path.
RouteProviderTest::testGetRoutesByPatternWithLongPatterns public function Ensures that the routing system is capable of extreme long patterns.
RouteProviderTest::testGetRoutesPaged public function Tests getRoutesPaged().
RouteProviderTest::testOutlinePathMatch function Confirms that we can find routes whose pattern would match the request.
RouteProviderTest::testOutlinePathMatchDefaults function Confirms that we can find routes whose pattern would match the request.
RouteProviderTest::testOutlinePathMatchDefaultsCollision function Confirms that we can find routes whose pattern would match the request.
RouteProviderTest::testOutlinePathMatchDefaultsCollision2 function Confirms that we can find routes whose pattern would match the request.
RouteProviderTest::testOutlinePathMatchDefaultsCollision3 function Confirms that we can find multiple routes that match the request equally.
RouteProviderTest::testOutlinePathMatchTrailingSlash function Confirms that a trailing slash on the request doesn't result in a 404.
RouteProviderTest::testOutlinePathMatchZero public function Tests a route with a 0 as value.
RouteProviderTest::testOutlinePathNoMatch function Confirms that an exception is thrown when no matching path is found.
RouteProviderTest::testRouteByName public function Test RouteProvider::getRouteByName() and RouteProvider::getRoutesByNames().
RouteProviderTest::testRouteCaching public function Tests that route caching works.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel protected property The DrupalKernel instance used in the test. 1
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. 1
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$originalUser protected property The original user, before testing began. 1
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.