You are here

Home » API reference » Drupal 8 » EntityCacheTagsTestBase.php

abstract class EntityCacheTagsTestBase in Drupal 8

Same name in this branch
  1. 8 core/modules/system/src/Tests/Entity/EntityCacheTagsTestBase.php \Drupal\system\Tests\Entity\EntityCacheTagsTestBase
  2. 8 core/modules/system/tests/src/Functional/Entity/EntityCacheTagsTestBase.php \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase

Provides helper methods for Entity cache tags tests.

Hierarchy

Expanded class hierarchy of EntityCacheTagsTestBase

Deprecated

in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\system\Functional\Entity\EntityCacheTagsTestBase instead.

See also

https://www.drupal.org/node/2946549

File

core/modules/system/src/Tests/Entity/EntityCacheTagsTestBase.php, line 27

Namespace

Drupal\system\Tests\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\system\Tests\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\system\Tests\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
      ->pass("Test referencing entity.", 'Debug');
    $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
      ->pass("Test non-referencing entity.", 'Debug');
    $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);
    $this
      ->pass("Test listing of referencing entities.", 'Debug');

    // 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);
    $this
      ->pass("Test empty listing.", 'Debug');

    // 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));
    $this
      ->pass("Test listing containing referenced entity.", 'Debug');

    // 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
      ->pass("Test modification of referenced entity.", 'Debug');
    $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
      ->pass("Test modification of referencing entity.", 'Debug');
    $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
      ->pass("Test modification of non-referencing entity.", 'Debug');
    $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());
      $this
        ->pass("Test modification of referenced entity's '{$referenced_entity_view_mode}' display.", 'Debug');
      $entity_display = \Drupal::service('entity_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.
      $this
        ->pass("Test modification of referenced entity's bundle entity.", 'Debug');
      $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.
      $this
        ->pass("Test modification of referenced entity's configurable field.", 'Debug');
      $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.
      $this
        ->pass("Test modification of referenced entity's configurable field.", 'Debug');
      $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.
    $this
      ->pass("Test invalidation of referenced entity's cache tag.", 'Debug');
    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.
    $this
      ->pass("Test invalidation of referenced entity's list cache tag.", 'Debug');
    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.
      $this
        ->pass("Test invalidation of referenced entity's 'view' cache tag.", 'Debug');
      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
      ->pass('Test deletion of referenced entity.', 'Debug');
    $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
      ->assertTrue($cache_entry, 'A render cache entry exists.');
    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

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. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if 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::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case. Aliased as: drupalGetMails
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::debugCacheTags protected function Provides debug information for cache tags.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
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
CronRunTrait::cronRun protected function Runs cron on the test site.
EntityCacheTagsTestBase::$entity protected property The main entity used for testing.
EntityCacheTagsTestBase::$modules public static property Modules to enable.
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.
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.
EntityCacheTagsTestBase::getAdditionalCacheContextsForEntity protected function Returns the additional (non-standard) cache contexts for the tested entity.
EntityCacheTagsTestBase::getAdditionalCacheContextsForEntityListing protected function Returns the additional cache tags for the tested entity's listing by type.
EntityCacheTagsTestBase::getAdditionalCacheTagsForEntity protected function Returns the additional (non-standard) cache tags for the tested entity.
EntityCacheTagsTestBase::getAdditionalCacheTagsForEntityListing protected function Returns the additional cache tags for the tested entity's listing by type.
EntityCacheTagsTestBase::selectViewMode protected function Selects the preferred view mode for the given entity type.
EntityCacheTagsTestBase::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides PageCacheTagsTestBase::setUp
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.
EntityViewTrait::buildEntityView protected function Builds the renderable view of an entity. Aliased as: drupalBuildEntityView
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.
GeneratePermutationsTrait::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
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. Overrides WebTestBase::$dumpHeaders
PageCacheTagsTestBase::verifyPageCache protected function Verify that when loading a given page, it's a page cache hit or miss.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a 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::$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::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$results public property Current results of this test case.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
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::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::checkRequirements protected function Checks the matching requirements for Test. 1
TestBase::checkTestHierarchyMismatch public function Fail the test if it belongs to a PHPUnit-based framework.
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
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.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert Deprecated public static function Store an assertion from outside the testing context. 1
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests. Overrides TestSetupTrait::prepareDatabasePrefix
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 2
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database. 1
TestBase::verbose protected function Logs a verbose message in a text file.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name. Aliased as: drupalCompareFiles
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 2
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code. 1
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 1
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header. 1
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. 1
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 1
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::__construct public function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.