abstract class EntityCacheTagsTestBase in Drupal 8

Same name in this branch

8 core/modules/system/src/Tests/Entity/EntityCacheTagsTestBase.php \Drupal\system\Tests\Entity\EntityCacheTagsTestBase
8 core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase

Same name and namespace in other branches

9 core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase
10 core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase

Provides helper methods for Entity cache tags tests.

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\system\Functional\Cache\PageCacheTagsTestBase
  - class \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase

Expanded class hierarchy of EntityCacheTagsTestBase

3 files declare their use of EntityCacheTagsTestBase

BlockContentCacheTagsTest.php in core/modules/block_content/tests/src/Functional/BlockContentCacheTagsTest.php
ItemCacheTagsTest.php in core/modules/aggregator/tests/src/Functional/ItemCacheTagsTest.php
ShortcutCacheTagsTest.php in core/modules/shortcut/tests/src/Functional/ShortcutCacheTagsTest.php

File

core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php, line 20

Namespace

Drupal\Tests\system\Functional\Entity

View source

abstract class EntityCacheTagsTestBase extends PageCacheTagsTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'entity_test',
    'field_test',
  ];

  /**
   * The main entity used for testing.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  protected $entity;

  /**
   * The entity instance referencing the main entity.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  protected $referencingEntity;

  /**
   * The entity instance not referencing the main entity.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  protected $nonReferencingEntity;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Give anonymous users permission to view test entities, so that we can
    // verify the cache tags of cached versions of test entity pages.
    $user_role = Role::load(RoleInterface::ANONYMOUS_ID);
    $user_role
      ->grantPermission('view test entity');
    $user_role
      ->save();

    // Create an entity.
    $this->entity = $this
      ->createEntity();

    // If this is an entity with field UI enabled, then add a configurable
    // field. We will use this configurable field in later tests to ensure that
    // field configuration invalidate render cache entries.
    if ($this->entity
      ->getEntityType()
      ->get('field_ui_base_route')) {

      // Add field, so we can modify the field storage and field entities to
      // verify that changes to those indeed clear cache tags.
      FieldStorageConfig::create([
        'field_name' => 'configurable_field',
        'entity_type' => $this->entity
          ->getEntityTypeId(),
        'type' => 'test_field',
        'settings' => [],
      ])
        ->save();
      FieldConfig::create([
        'entity_type' => $this->entity
          ->getEntityTypeId(),
        'bundle' => $this->entity
          ->bundle(),
        'field_name' => 'configurable_field',
        'label' => 'Configurable field',
        'settings' => [],
      ])
        ->save();

      // Reload the entity now that a new field has been added to it.
      $storage = $this->container
        ->get('entity_type.manager')
        ->getStorage($this->entity
        ->getEntityTypeId());
      $storage
        ->resetCache();
      $this->entity = $storage
        ->load($this->entity
        ->id());
    }

    // Create a referencing and a non-referencing entity.
    list($this->referencingEntity, $this->nonReferencingEntity, ) = $this
      ->createReferenceTestEntities($this->entity);
  }

  /**
   * Generates standardized entity cache tags test info.
   *
   * @param string $entity_type_label
   *   The label of the entity type whose cache tags to test.
   * @param string $group
   *   The test group.
   *
   * @return array
   *
   * @see \Drupal\simpletest\TestBase::getInfo()
   */
  protected static function generateStandardizedInfo($entity_type_label, $group) {
    return [
      'name' => "{$entity_type_label} entity cache tags",
      'description' => "Test the {$entity_type_label} entity's cache tags.",
      'group' => $group,
    ];
  }

  /**
   * Creates the entity to be tested.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The entity to be tested.
   */
  protected abstract function createEntity();

  /**
   * Returns the access cache contexts for the tested entity.
   *
   * Only list cache contexts that aren't part of the required cache contexts.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to be tested, as created by createEntity().
   *
   * @return string[]
   *   An array of the additional cache contexts.
   *
   * @see \Drupal\Core\Entity\EntityAccessControlHandlerInterface
   */
  protected function getAccessCacheContextsForEntity(EntityInterface $entity) {
    return [];
  }

  /**
   * Returns the additional (non-standard) cache contexts for the tested entity.
   *
   * Only list cache contexts that aren't part of the required cache contexts.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to be tested, as created by createEntity().
   *
   * @return string[]
   *   An array of the additional cache contexts.
   *
   * @see \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase::createEntity()
   */
  protected function getAdditionalCacheContextsForEntity(EntityInterface $entity) {
    return [];
  }

  /**
   * Returns the additional (non-standard) cache tags for the tested entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to be tested, as created by createEntity().
   *
   * @return array
   *   An array of the additional cache tags.
   *
   * @see \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase::createEntity()
   */
  protected function getAdditionalCacheTagsForEntity(EntityInterface $entity) {
    return [];
  }

  /**
   * Returns the additional cache tags for the tested entity's listing by type.
   *
   * @return string[]
   *   An array of the additional cache contexts.
   */
  protected function getAdditionalCacheContextsForEntityListing() {
    return [];
  }

  /**
   * Returns the additional cache tags for the tested entity's listing by type.
   *
   * Necessary when there are unavoidable default entities of this type, e.g.
   * the anonymous and administrator User entities always exist.
   *
   * @return array
   *   An array of the additional cache tags.
   */
  protected function getAdditionalCacheTagsForEntityListing() {
    return [];
  }

  /**
   * Selects the preferred view mode for the given entity type.
   *
   * Prefers 'full', picks the first one otherwise, and if none are available,
   * chooses 'default'.
   */
  protected function selectViewMode($entity_type) {
    $view_modes = \Drupal::entityTypeManager()
      ->getStorage('entity_view_mode')
      ->loadByProperties([
      'targetEntityType' => $entity_type,
    ]);
    if (empty($view_modes)) {
      return 'default';
    }
    else {

      // Prefer the "full" display mode.
      if (isset($view_modes[$entity_type . '.full'])) {
        return 'full';
      }
      else {
        $view_modes = array_keys($view_modes);
        return substr($view_modes[0], strlen($entity_type) + 1);
      }
    }
  }

  /**
   * Creates a referencing and a non-referencing entity for testing purposes.
   *
   * @param \Drupal\Core\Entity\EntityInterface $referenced_entity
   *   The entity that the referencing entity should reference.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]
   *   An array containing a referencing entity and a non-referencing entity.
   */
  protected function createReferenceTestEntities($referenced_entity) {

    // All referencing entities should be of the type 'entity_test'.
    $entity_type = 'entity_test';

    // Create a "foo" bundle for the given entity type.
    $bundle = 'foo';
    entity_test_create_bundle($bundle, NULL, $entity_type);

    // Add a field of the given type to the given entity type's "foo" bundle.
    $field_name = $referenced_entity
      ->getEntityTypeId() . '_reference';
    FieldStorageConfig::create([
      'field_name' => $field_name,
      'entity_type' => $entity_type,
      'type' => 'entity_reference',
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
      'settings' => [
        'target_type' => $referenced_entity
          ->getEntityTypeId(),
      ],
    ])
      ->save();
    FieldConfig::create([
      'field_name' => $field_name,
      'entity_type' => $entity_type,
      'bundle' => $bundle,
      'settings' => [
        'handler' => 'default',
        'handler_settings' => [
          'target_bundles' => [
            $referenced_entity
              ->bundle() => $referenced_entity
              ->bundle(),
          ],
          'sort' => [
            'field' => '_none',
          ],
          'auto_create' => FALSE,
        ],
      ],
    ])
      ->save();

    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
    $display_repository = \Drupal::service('entity_display.repository');
    if (!$this->entity
      ->getEntityType()
      ->hasHandlerClass('view_builder')) {
      $display_repository
        ->getViewDisplay($entity_type, $bundle, 'full')
        ->setComponent($field_name, [
        'type' => 'entity_reference_label',
      ])
        ->save();
    }
    else {
      $referenced_entity_view_mode = $this
        ->selectViewMode($this->entity
        ->getEntityTypeId());
      $display_repository
        ->getViewDisplay($entity_type, $bundle, 'full')
        ->setComponent($field_name, [
        'type' => 'entity_reference_entity_view',
        'settings' => [
          'view_mode' => $referenced_entity_view_mode,
        ],
      ])
        ->save();
    }

    // Create an entity that does reference the entity being tested.
    $label_key = \Drupal::entityTypeManager()
      ->getDefinition($entity_type)
      ->getKey('label');
    $referencing_entity = $this->container
      ->get('entity_type.manager')
      ->getStorage($entity_type)
      ->create([
      $label_key => 'Referencing ' . $entity_type,
      'status' => 1,
      'type' => $bundle,
      $field_name => [
        'target_id' => $referenced_entity
          ->id(),
      ],
    ]);
    $referencing_entity
      ->save();

    // Create an entity that does not reference the entity being tested.
    $non_referencing_entity = $this->container
      ->get('entity_type.manager')
      ->getStorage($entity_type)
      ->create([
      $label_key => 'Non-referencing ' . $entity_type,
      'status' => 1,
      'type' => $bundle,
    ]);
    $non_referencing_entity
      ->save();
    return [
      $referencing_entity,
      $non_referencing_entity,
    ];
  }

  /**
   * Tests cache tags presence and invalidation of the entity when referenced.
   *
   * Tests the following cache tags:
   * - entity type view cache tag: "<entity type>_view"
   * - entity cache tag: "<entity type>:<entity ID>"
   * - entity type list cache tag: "<entity type>_list"
   * - referencing entity type view cache tag: "<referencing entity type>_view"
   * - referencing entity type cache tag: "<referencing entity type>:<referencing entity ID>"
   */
  public function testReferencedEntity() {
    $entity_type = $this->entity
      ->getEntityTypeId();
    $referencing_entity_url = $this->referencingEntity
      ->toUrl('canonical');
    $non_referencing_entity_url = $this->nonReferencingEntity
      ->toUrl('canonical');
    $listing_url = Url::fromRoute('entity.entity_test.collection_referencing_entities', [
      'entity_reference_field_name' => $entity_type . '_reference',
      'referenced_entity_type' => $entity_type,
      'referenced_entity_id' => $this->entity
        ->id(),
    ]);
    $empty_entity_listing_url = Url::fromRoute('entity.entity_test.collection_empty', [
      'entity_type_id' => $entity_type,
    ]);
    $nonempty_entity_listing_url = Url::fromRoute('entity.entity_test.collection_labels_alphabetically', [
      'entity_type_id' => $entity_type,
    ]);

    // The default cache contexts for rendered entities.
    $default_cache_contexts = [
      'languages:' . LanguageInterface::TYPE_INTERFACE,
      'theme',
      'user.permissions',
    ];
    $entity_cache_contexts = $default_cache_contexts;
    $page_cache_contexts = Cache::mergeContexts($default_cache_contexts, [
      'url.query_args:' . MainContentViewSubscriber::WRAPPER_FORMAT,
    ]);

    // Cache tags present on every rendered page.
    // 'user.permissions' is a required cache context, and responses that vary
    // by this cache context when requested by anonymous users automatically
    // also get this cache tag, to ensure correct invalidation.
    $page_cache_tags = Cache::mergeTags([
      'http_response',
      'rendered',
    ], [
      'config:user.role.anonymous',
    ]);

    // If the block module is used, the Block page display variant is used,
    // which adds the block config entity type's list cache tags.
    $page_cache_tags = Cache::mergeTags($page_cache_tags, \Drupal::moduleHandler()
      ->moduleExists('block') ? [
      'config:block_list',
    ] : []);
    $page_cache_tags_referencing_entity = in_array('user.permissions', $this
      ->getAccessCacheContextsForEntity($this->referencingEntity)) ? [
      'config:user.role.anonymous',
    ] : [];
    $view_cache_tag = [];
    if ($this->entity
      ->getEntityType()
      ->hasHandlerClass('view_builder')) {
      $view_cache_tag = \Drupal::entityTypeManager()
        ->getViewBuilder($entity_type)
        ->getCacheTags();
    }
    $context_metadata = \Drupal::service('cache_contexts_manager')
      ->convertTokensToKeys($entity_cache_contexts);
    $cache_context_tags = $context_metadata
      ->getCacheTags();

    // Generate the cache tags for the (non) referencing entities.
    $referencing_entity_cache_tags = Cache::mergeTags($this->referencingEntity
      ->getCacheTags(), \Drupal::entityTypeManager()
      ->getViewBuilder('entity_test')
      ->getCacheTags());

    // Includes the main entity's cache tags, since this entity references it.
    $referencing_entity_cache_tags = Cache::mergeTags($referencing_entity_cache_tags, $this->entity
      ->getCacheTags());
    $referencing_entity_cache_tags = Cache::mergeTags($referencing_entity_cache_tags, $this
      ->getAdditionalCacheTagsForEntity($this->entity));
    $referencing_entity_cache_tags = Cache::mergeTags($referencing_entity_cache_tags, $view_cache_tag);
    $referencing_entity_cache_tags = Cache::mergeTags($referencing_entity_cache_tags, $cache_context_tags);
    $referencing_entity_cache_tags = Cache::mergeTags($referencing_entity_cache_tags, [
      'rendered',
    ]);
    $non_referencing_entity_cache_tags = Cache::mergeTags($this->nonReferencingEntity
      ->getCacheTags(), \Drupal::entityTypeManager()
      ->getViewBuilder('entity_test')
      ->getCacheTags());
    $non_referencing_entity_cache_tags = Cache::mergeTags($non_referencing_entity_cache_tags, [
      'rendered',
    ]);

    // Generate the cache tags for all two possible entity listing paths.
    // 1. list cache tag only (listing query has no match)
    // 2. list cache tag plus entity cache tag (listing query has a match)
    $empty_entity_listing_cache_tags = Cache::mergeTags($this->entity
      ->getEntityType()
      ->getListCacheTags(), $page_cache_tags);
    $nonempty_entity_listing_cache_tags = Cache::mergeTags($this->entity
      ->getEntityType()
      ->getListCacheTags(), $this->entity
      ->getCacheTags());
    $nonempty_entity_listing_cache_tags = Cache::mergeTags($nonempty_entity_listing_cache_tags, $this
      ->getAdditionalCacheTagsForEntityListing($this->entity));
    $nonempty_entity_listing_cache_tags = Cache::mergeTags($nonempty_entity_listing_cache_tags, $page_cache_tags);
    $this
      ->verifyPageCache($referencing_entity_url, 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags.
    $expected_tags = Cache::mergeTags($referencing_entity_cache_tags, $page_cache_tags);
    $expected_tags = Cache::mergeTags($expected_tags, $page_cache_tags_referencing_entity);
    $this
      ->verifyPageCache($referencing_entity_url, 'HIT', $expected_tags);

    // Also verify the existence of an entity render cache entry.
    $cache_keys = [
      'entity_view',
      'entity_test',
      $this->referencingEntity
        ->id(),
      'full',
    ];
    $cid = $this
      ->createCacheId($cache_keys, $entity_cache_contexts);
    $access_cache_contexts = $this
      ->getAccessCacheContextsForEntity($this->entity);
    $additional_cache_contexts = $this
      ->getAdditionalCacheContextsForEntity($this->referencingEntity);
    $redirected_cid = NULL;
    if (count($access_cache_contexts) || count($additional_cache_contexts)) {
      $cache_contexts = Cache::mergeContexts($entity_cache_contexts, $additional_cache_contexts);
      $cache_contexts = Cache::mergeContexts($cache_contexts, $access_cache_contexts);
      $redirected_cid = $this
        ->createCacheId($cache_keys, $cache_contexts);
      $context_metadata = \Drupal::service('cache_contexts_manager')
        ->convertTokensToKeys($cache_contexts);
      $referencing_entity_cache_tags = Cache::mergeTags($referencing_entity_cache_tags, $context_metadata
        ->getCacheTags());
    }
    $this
      ->verifyRenderCache($cid, $referencing_entity_cache_tags, $redirected_cid);
    $this
      ->verifyPageCache($non_referencing_entity_url, 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->verifyPageCache($non_referencing_entity_url, 'HIT', Cache::mergeTags($non_referencing_entity_cache_tags, $page_cache_tags));

    // Also verify the existence of an entity render cache entry.
    $cache_keys = [
      'entity_view',
      'entity_test',
      $this->nonReferencingEntity
        ->id(),
      'full',
    ];
    $cid = $this
      ->createCacheId($cache_keys, $entity_cache_contexts);
    $this
      ->verifyRenderCache($cid, $non_referencing_entity_cache_tags);

    // Prime the page cache for the listing of referencing entities.
    $this
      ->verifyPageCache($listing_url, 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags.
    $expected_tags = Cache::mergeTags($referencing_entity_cache_tags, $page_cache_tags);
    $expected_tags = Cache::mergeTags($expected_tags, $page_cache_tags_referencing_entity);
    $this
      ->verifyPageCache($listing_url, 'HIT', $expected_tags);

    // Prime the page cache for the empty listing.
    $this
      ->verifyPageCache($empty_entity_listing_url, 'MISS');

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->verifyPageCache($empty_entity_listing_url, 'HIT', $empty_entity_listing_cache_tags);

    // Verify the entity type's list cache contexts are present.
    $contexts_in_header = $this
      ->drupalGetHeader('X-Drupal-Cache-Contexts');
    $this
      ->assertEqual(Cache::mergeContexts($page_cache_contexts, $this
      ->getAdditionalCacheContextsForEntityListing()), empty($contexts_in_header) ? [] : explode(' ', $contexts_in_header));

    // Prime the page cache for the listing containing the referenced entity.
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'MISS', $nonempty_entity_listing_cache_tags);

    // Verify a cache hit, but also the presence of the correct cache tags.
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'HIT', $nonempty_entity_listing_cache_tags);

    // Verify the entity type's list cache contexts are present.
    $contexts_in_header = $this
      ->drupalGetHeader('X-Drupal-Cache-Contexts');
    $this
      ->assertEqual(Cache::mergeContexts($page_cache_contexts, $this
      ->getAdditionalCacheContextsForEntityListing()), empty($contexts_in_header) ? [] : explode(' ', $contexts_in_header));

    // Verify that after modifying the referenced entity, there is a cache miss
    // for every route except the one for the non-referencing entity.
    $this->entity
      ->save();
    $this
      ->verifyPageCache($referencing_entity_url, 'MISS');
    $this
      ->verifyPageCache($listing_url, 'MISS');
    $this
      ->verifyPageCache($empty_entity_listing_url, 'MISS');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'MISS');
    $this
      ->verifyPageCache($non_referencing_entity_url, 'HIT');

    // Verify cache hits.
    $this
      ->verifyPageCache($referencing_entity_url, 'HIT');
    $this
      ->verifyPageCache($listing_url, 'HIT');
    $this
      ->verifyPageCache($empty_entity_listing_url, 'HIT');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'HIT');

    // Verify that after modifying the referencing entity, there is a cache miss
    // for every route except the ones for the non-referencing entity and the
    // empty entity listing.
    $this->referencingEntity
      ->save();
    $this
      ->verifyPageCache($referencing_entity_url, 'MISS');
    $this
      ->verifyPageCache($listing_url, 'MISS');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'HIT');
    $this
      ->verifyPageCache($non_referencing_entity_url, 'HIT');
    $this
      ->verifyPageCache($empty_entity_listing_url, 'HIT');

    // Verify cache hits.
    $this
      ->verifyPageCache($referencing_entity_url, 'HIT');
    $this
      ->verifyPageCache($listing_url, 'HIT');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'HIT');

    // Verify that after modifying the non-referencing entity, there is a cache
    // miss only for the non-referencing entity route.
    $this->nonReferencingEntity
      ->save();
    $this
      ->verifyPageCache($referencing_entity_url, 'HIT');
    $this
      ->verifyPageCache($listing_url, 'HIT');
    $this
      ->verifyPageCache($empty_entity_listing_url, 'HIT');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'HIT');
    $this
      ->verifyPageCache($non_referencing_entity_url, 'MISS');

    // Verify cache hits.
    $this
      ->verifyPageCache($non_referencing_entity_url, 'HIT');
    if ($this->entity
      ->getEntityType()
      ->hasHandlerClass('view_builder')) {

      // Verify that after modifying the entity's display, there is a cache miss
      // for both the referencing entity, and the listing of referencing
      // entities, but not for any other routes.
      $referenced_entity_view_mode = $this
        ->selectViewMode($this->entity
        ->getEntityTypeId());

      /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
      $display_repository = \Drupal::service('entity_display.repository');
      $entity_display = $display_repository
        ->getViewDisplay($entity_type, $this->entity
        ->bundle(), $referenced_entity_view_mode);
      $entity_display
        ->save();
      $this
        ->verifyPageCache($referencing_entity_url, 'MISS');
      $this
        ->verifyPageCache($listing_url, 'MISS');
      $this
        ->verifyPageCache($non_referencing_entity_url, 'HIT');
      $this
        ->verifyPageCache($empty_entity_listing_url, 'HIT');
      $this
        ->verifyPageCache($nonempty_entity_listing_url, 'HIT');

      // Verify cache hits.
      $this
        ->verifyPageCache($referencing_entity_url, 'HIT');
      $this
        ->verifyPageCache($listing_url, 'HIT');
    }
    if ($bundle_entity_type_id = $this->entity
      ->getEntityType()
      ->getBundleEntityType()) {

      // Verify that after modifying the corresponding bundle entity, there is a
      // cache miss for both the referencing entity, and the listing of
      // referencing entities, but not for any other routes.
      $bundle_entity = $this->container
        ->get('entity_type.manager')
        ->getStorage($bundle_entity_type_id)
        ->load($this->entity
        ->bundle());
      $bundle_entity
        ->save();
      $this
        ->verifyPageCache($referencing_entity_url, 'MISS');
      $this
        ->verifyPageCache($listing_url, 'MISS');
      $this
        ->verifyPageCache($non_referencing_entity_url, 'HIT');

      // Special case: entity types may choose to use their bundle entity type
      // cache tags, to avoid having excessively granular invalidation.
      $is_special_case = $bundle_entity
        ->getCacheTags() == $this->entity
        ->getCacheTags() && $bundle_entity
        ->getEntityType()
        ->getListCacheTags() == $this->entity
        ->getEntityType()
        ->getListCacheTags();
      if ($is_special_case) {
        $this
          ->verifyPageCache($empty_entity_listing_url, 'MISS');
        $this
          ->verifyPageCache($nonempty_entity_listing_url, 'MISS');
      }
      else {
        $this
          ->verifyPageCache($empty_entity_listing_url, 'HIT');
        $this
          ->verifyPageCache($nonempty_entity_listing_url, 'HIT');
      }

      // Verify cache hits.
      $this
        ->verifyPageCache($referencing_entity_url, 'HIT');
      $this
        ->verifyPageCache($listing_url, 'HIT');
      if ($is_special_case) {
        $this
          ->verifyPageCache($empty_entity_listing_url, 'HIT');
        $this
          ->verifyPageCache($nonempty_entity_listing_url, 'HIT');
      }
    }
    if ($this->entity
      ->getEntityType()
      ->get('field_ui_base_route')) {

      // Verify that after modifying a configurable field on the entity, there
      // is a cache miss.
      $field_storage_name = $this->entity
        ->getEntityTypeId() . '.configurable_field';
      $field_storage = FieldStorageConfig::load($field_storage_name);
      $field_storage
        ->save();
      $this
        ->verifyPageCache($referencing_entity_url, 'MISS');
      $this
        ->verifyPageCache($listing_url, 'MISS');
      $this
        ->verifyPageCache($empty_entity_listing_url, 'HIT');
      $this
        ->verifyPageCache($nonempty_entity_listing_url, 'HIT');
      $this
        ->verifyPageCache($non_referencing_entity_url, 'HIT');

      // Verify cache hits.
      $this
        ->verifyPageCache($referencing_entity_url, 'HIT');
      $this
        ->verifyPageCache($listing_url, 'HIT');

      // Verify that after modifying a configurable field on the entity, there
      // is a cache miss.
      $field_name = $this->entity
        ->getEntityTypeId() . '.' . $this->entity
        ->bundle() . '.configurable_field';
      $field = FieldConfig::load($field_name);
      $field
        ->save();
      $this
        ->verifyPageCache($referencing_entity_url, 'MISS');
      $this
        ->verifyPageCache($listing_url, 'MISS');
      $this
        ->verifyPageCache($empty_entity_listing_url, 'HIT');
      $this
        ->verifyPageCache($nonempty_entity_listing_url, 'HIT');
      $this
        ->verifyPageCache($non_referencing_entity_url, 'HIT');

      // Verify cache hits.
      $this
        ->verifyPageCache($referencing_entity_url, 'HIT');
      $this
        ->verifyPageCache($listing_url, 'HIT');
    }

    // Verify that after invalidating the entity's cache tag directly, there is
    // a cache miss for every route except the ones for the non-referencing
    // entity and the empty entity listing.
    Cache::invalidateTags($this->entity
      ->getCacheTagsToInvalidate());
    $this
      ->verifyPageCache($referencing_entity_url, 'MISS');
    $this
      ->verifyPageCache($listing_url, 'MISS');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'MISS');
    $this
      ->verifyPageCache($non_referencing_entity_url, 'HIT');
    $this
      ->verifyPageCache($empty_entity_listing_url, 'HIT');

    // Verify cache hits.
    $this
      ->verifyPageCache($referencing_entity_url, 'HIT');
    $this
      ->verifyPageCache($listing_url, 'HIT');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'HIT');

    // Verify that after invalidating the entity's list cache tag directly,
    // there is a cache miss for both the empty entity listing and the non-empty
    // entity listing routes, but not for other routes.
    Cache::invalidateTags($this->entity
      ->getEntityType()
      ->getListCacheTags());
    $this
      ->verifyPageCache($empty_entity_listing_url, 'MISS');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'MISS');
    $this
      ->verifyPageCache($referencing_entity_url, 'HIT');
    $this
      ->verifyPageCache($non_referencing_entity_url, 'HIT');
    $this
      ->verifyPageCache($listing_url, 'HIT');

    // Verify cache hits.
    $this
      ->verifyPageCache($empty_entity_listing_url, 'HIT');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'HIT');
    if (!empty($view_cache_tag)) {

      // Verify that after invalidating the generic entity type's view cache tag
      // directly, there is a cache miss for both the referencing entity, and the
      // listing of referencing entities, but not for other routes.
      Cache::invalidateTags($view_cache_tag);
      $this
        ->verifyPageCache($referencing_entity_url, 'MISS');
      $this
        ->verifyPageCache($listing_url, 'MISS');
      $this
        ->verifyPageCache($non_referencing_entity_url, 'HIT');
      $this
        ->verifyPageCache($empty_entity_listing_url, 'HIT');
      $this
        ->verifyPageCache($nonempty_entity_listing_url, 'HIT');

      // Verify cache hits.
      $this
        ->verifyPageCache($referencing_entity_url, 'HIT');
      $this
        ->verifyPageCache($listing_url, 'HIT');
    }

    // Verify that after deleting the entity, there is a cache miss for every
    // route except for the non-referencing entity one.
    $this->entity
      ->delete();
    $this
      ->verifyPageCache($referencing_entity_url, 'MISS');
    $this
      ->verifyPageCache($listing_url, 'MISS');
    $this
      ->verifyPageCache($empty_entity_listing_url, 'MISS');
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'MISS');
    $this
      ->verifyPageCache($non_referencing_entity_url, 'HIT');

    // Verify cache hits.
    $referencing_entity_cache_tags = Cache::mergeTags($this->referencingEntity
      ->getCacheTags(), \Drupal::entityTypeManager()
      ->getViewBuilder('entity_test')
      ->getCacheTags());
    $referencing_entity_cache_tags = Cache::mergeTags($referencing_entity_cache_tags, [
      'http_response',
      'rendered',
    ]);
    $nonempty_entity_listing_cache_tags = Cache::mergeTags($this->entity
      ->getEntityType()
      ->getListCacheTags(), $this
      ->getAdditionalCacheTagsForEntityListing());
    $nonempty_entity_listing_cache_tags = Cache::mergeTags($nonempty_entity_listing_cache_tags, $page_cache_tags);
    $this
      ->verifyPageCache($referencing_entity_url, 'HIT', Cache::mergeTags($referencing_entity_cache_tags, $page_cache_tags));
    $this
      ->verifyPageCache($listing_url, 'HIT', $page_cache_tags);
    $this
      ->verifyPageCache($empty_entity_listing_url, 'HIT', $empty_entity_listing_cache_tags);
    $this
      ->verifyPageCache($nonempty_entity_listing_url, 'HIT', $nonempty_entity_listing_cache_tags);
  }

  /**
   * Creates a cache ID from a list of cache keys and a set of cache contexts.
   *
   * @param string[] $keys
   *   A list of cache keys.
   * @param string[] $contexts
   *   A set of cache contexts.
   *
   * @return string
   *   The cache ID string.
   */
  protected function createCacheId(array $keys, array $contexts) {
    $cid_parts = $keys;
    $contexts = \Drupal::service('cache_contexts_manager')
      ->convertTokensToKeys($contexts);
    $cid_parts = array_merge($cid_parts, $contexts
      ->getKeys());
    return implode(':', $cid_parts);
  }

  /**
   * Verify that a given render cache entry exists, with the correct cache tags.
   *
   * @param string $cid
   *   The render cache item ID.
   * @param array $tags
   *   An array of expected cache tags.
   * @param string|null $redirected_cid
   *   (optional) The redirected render cache item ID.
   */
  protected function verifyRenderCache($cid, array $tags, $redirected_cid = NULL) {

    // Also verify the existence of an entity render cache entry.
    $cache_entry = \Drupal::cache('render')
      ->get($cid);
    $this
      ->assertInstanceOf(\stdClass::class, $cache_entry);
    sort($cache_entry->tags);
    sort($tags);
    $this
      ->assertIdentical($cache_entry->tags, $tags);
    $is_redirecting_cache_item = isset($cache_entry->data['#cache_redirect']);
    if ($redirected_cid === NULL) {
      $this
        ->assertFalse($is_redirecting_cache_item, 'Render cache entry is not a redirect.');

      // If this is a redirecting cache item unlike we expected, log it.
      if ($is_redirecting_cache_item) {
        debug($cache_entry->data);
      }
    }
    else {

      // Verify that $cid contains a cache redirect.
      $this
        ->assertTrue($is_redirecting_cache_item, 'Render cache entry is a redirect.');

      // If this is not a redirecting cache item unlike we expected, log it.
      if (!$is_redirecting_cache_item) {
        debug($cache_entry->data);
      }

      // Verify that the cache redirect points to the expected CID.
      $redirect_cache_metadata = $cache_entry->data['#cache'];
      $actual_redirection_cid = $this
        ->createCacheId($redirect_cache_metadata['keys'], $redirect_cache_metadata['contexts']);
      $this
        ->assertIdentical($redirected_cid, $actual_redirection_cid);

      // Finally, verify that the redirected CID exists and has the same cache
      // tags.
      $this
        ->verifyRenderCache($redirected_cid, $tags);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.	1
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.	1
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.	1
AssertLegacyTrait::assertResponse	protected	function	Asserts the page responds with the specified response code.	1
AssertLegacyTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.	1
AssertLegacyTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent	protected	function	Gets the current raw content.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$defaultTheme	protected	property	The theme to install as the default for testing.	1,597
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property
BrowserTestBase::$minkDefaultDriverClass	protected	property		1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated	protected	function	Returns all response headers.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct	public	function		1
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
EntityCacheTagsTestBase::$entity	protected	property	The main entity used for testing.
EntityCacheTagsTestBase::$modules	public static	property	Modules to enable. Overrides BrowserTestBase::$modules	9
EntityCacheTagsTestBase::$nonReferencingEntity	protected	property	The entity instance not referencing the main entity.
EntityCacheTagsTestBase::$referencingEntity	protected	property	The entity instance referencing the main entity.
EntityCacheTagsTestBase::createCacheId	protected	function	Creates a cache ID from a list of cache keys and a set of cache contexts.
EntityCacheTagsTestBase::createEntity	abstract protected	function	Creates the entity to be tested.	9
EntityCacheTagsTestBase::createReferenceTestEntities	protected	function	Creates a referencing and a non-referencing entity for testing purposes.
EntityCacheTagsTestBase::generateStandardizedInfo	protected static	function	Generates standardized entity cache tags test info.
EntityCacheTagsTestBase::getAccessCacheContextsForEntity	protected	function	Returns the access cache contexts for the tested entity.	1
EntityCacheTagsTestBase::getAdditionalCacheContextsForEntity	protected	function	Returns the additional (non-standard) cache contexts for the tested entity.	3
EntityCacheTagsTestBase::getAdditionalCacheContextsForEntityListing	protected	function	Returns the additional cache tags for the tested entity's listing by type.	1
EntityCacheTagsTestBase::getAdditionalCacheTagsForEntity	protected	function	Returns the additional (non-standard) cache tags for the tested entity.	4
EntityCacheTagsTestBase::getAdditionalCacheTagsForEntityListing	protected	function	Returns the additional cache tags for the tested entity's listing by type.	1
EntityCacheTagsTestBase::selectViewMode	protected	function	Selects the preferred view mode for the given entity type.
EntityCacheTagsTestBase::setUp	protected	function	Overrides PageCacheTagsTestBase::setUp	6
EntityCacheTagsTestBase::testReferencedEntity	public	function	Tests cache tags presence and invalidation of the entity when referenced.
EntityCacheTagsTestBase::verifyRenderCache	protected	function	Verify that a given render cache entry exists, with the correct cache tags.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated	protected	property	The config directories used in this test.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	2
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	23
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PageCacheTagsTestBase::$dumpHeaders	protected	property	Always enable header dumping in page cache tags tests, this aids debugging.
PageCacheTagsTestBase::verifyDynamicPageCache	protected	function	Verify that when loading a given page, it's a page cache hit or miss.
PageCacheTagsTestBase::verifyPageCache	protected	function	Verify that when loading a given page, it's a page cache hit or miss.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	3
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.
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.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	2
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	2
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	3
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

abstract class EntityCacheTagsTestBase in Drupal 8

Hierarchy

File

Namespace

Members

API Navigation