class CommentCacheTagsTest

Same name in other branches
  1. 9 core/modules/comment/tests/src/Functional/CommentCacheTagsTest.php \Drupal\Tests\comment\Functional\CommentCacheTagsTest
  2. 8.9.x core/modules/comment/tests/src/Functional/CommentCacheTagsTest.php \Drupal\Tests\comment\Functional\CommentCacheTagsTest
  3. 11.x core/modules/comment/tests/src/Functional/CommentCacheTagsTest.php \Drupal\Tests\comment\Functional\CommentCacheTagsTest

Tests the Comment entity's cache tags.

@group comment

Hierarchy

Expanded class hierarchy of CommentCacheTagsTest

File

core/modules/comment/tests/src/Functional/CommentCacheTagsTest.php, line 26

Namespace

Drupal\Tests\comment\Functional
View source
class CommentCacheTagsTest extends EntityWithUriCacheTagsTestBase {
    use CommentTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'comment',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * @var \Drupal\entity_test\Entity\EntityTest
     */
    protected $entityTestCamelid;
    
    /**
     * @var \Drupal\entity_test\Entity\EntityTest
     */
    protected $entityTestHippopotamidae;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Give anonymous users permission to view comments, so that we can verify
        // the cache tags of cached versions of comment pages.
        $user_role = Role::load(RoleInterface::ANONYMOUS_ID);
        $user_role->grantPermission('access comments');
        $user_role->save();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createEntity() {
        // Create a "bar" bundle for the "entity_test" entity type and create.
        $bundle = 'bar';
        entity_test_create_bundle($bundle, NULL, 'entity_test');
        // Create a comment field on this bundle.
        $this->addDefaultCommentField('entity_test', 'bar', 'comment');
        // Display comments in a flat list; threaded comments are not render cached.
        $field = FieldConfig::loadByName('entity_test', 'bar', 'comment');
        $field->setSetting('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT);
        $field->save();
        // Create a "Camelids" test entity that the comment will be assigned to.
        $this->entityTestCamelid = EntityTest::create([
            'name' => 'Camelids',
            'type' => 'bar',
        ]);
        $this->entityTestCamelid
            ->save();
        // Create a "Llama" comment.
        $comment = Comment::create([
            'subject' => 'Llama',
            'comment_body' => [
                'value' => 'The name "llama" was adopted by European settlers from native Peruvians.',
                'format' => 'plain_text',
            ],
            'entity_id' => $this->entityTestCamelid
                ->id(),
            'entity_type' => 'entity_test',
            'field_name' => 'comment',
            'status' => CommentInterface::PUBLISHED,
        ]);
        $comment->save();
        return $comment;
    }
    
    /**
     * Tests that comments invalidate the cache tag of their host entity.
     */
    public function testCommentEntity() : void {
        $this->verifyPageCache($this->entityTestCamelid
            ->toUrl(), 'MISS');
        $this->verifyPageCache($this->entityTestCamelid
            ->toUrl(), 'HIT');
        // Create a "Hippopotamus" comment.
        $this->entityTestHippopotamidae = EntityTest::create([
            'name' => 'Hippopotamus',
            'type' => 'bar',
        ]);
        $this->entityTestHippopotamidae
            ->save();
        $this->verifyPageCache($this->entityTestHippopotamidae
            ->toUrl(), 'MISS');
        $this->verifyPageCache($this->entityTestHippopotamidae
            ->toUrl(), 'HIT');
        $hippo_comment = Comment::create([
            'subject' => 'Hippopotamus',
            'comment_body' => [
                'value' => 'The common hippopotamus (Hippopotamus amphibius), or hippo, is a large, mostly herbivorous mammal in sub-Saharan Africa',
                'format' => 'plain_text',
            ],
            'entity_id' => $this->entityTestHippopotamidae
                ->id(),
            'entity_type' => 'entity_test',
            'field_name' => 'comment',
            'status' => CommentInterface::PUBLISHED,
        ]);
        $hippo_comment->save();
        // Ensure that a new comment only invalidates the commented entity.
        $this->verifyPageCache($this->entityTestCamelid
            ->toUrl(), 'HIT');
        $this->verifyPageCache($this->entityTestHippopotamidae
            ->toUrl(), 'MISS');
        $this->assertSession()
            ->pageTextContains($hippo_comment->getSubject());
        // Ensure that updating an existing comment only invalidates the commented
        // entity.
        $this->entity
            ->save();
        $this->verifyPageCache($this->entityTestCamelid
            ->toUrl(), 'MISS');
        $this->verifyPageCache($this->entityTestHippopotamidae
            ->toUrl(), 'HIT');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getAdditionalCacheContextsForEntity(EntityInterface $entity) {
        return [];
    }
    
    /**
     * {@inheritdoc}
     *
     * Each comment must have a comment body, which always has a text format.
     */
    protected function getAdditionalCacheTagsForEntity(EntityInterface $entity) {
        
        /** @var \Drupal\comment\CommentInterface $entity */
        return [
            'config:filter.format.plain_text',
            'user:' . $entity->getOwnerId(),
            'user_view',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getDefaultCacheContexts() {
        return [
            'languages:' . LanguageInterface::TYPE_INTERFACE,
            'theme',
            'user.permissions',
        ];
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
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 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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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 SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 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. 40
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 test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
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 Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
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 test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentCacheTagsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentCacheTagsTest::$entityTestCamelid protected property
CommentCacheTagsTest::$entityTestHippopotamidae protected property
CommentCacheTagsTest::$modules protected static property Modules to install. Overrides EntityCacheTagsTestBase::$modules
CommentCacheTagsTest::createEntity protected function Creates the entity to be tested. Overrides EntityCacheTagsTestBase::createEntity
CommentCacheTagsTest::getAdditionalCacheContextsForEntity protected function Returns the additional (non-standard) cache contexts for the tested entity. Overrides EntityCacheTagsTestBase::getAdditionalCacheContextsForEntity
CommentCacheTagsTest::getAdditionalCacheTagsForEntity protected function Each comment must have a comment body, which always has a text format. Overrides EntityCacheTagsTestBase::getAdditionalCacheTagsForEntity
CommentCacheTagsTest::getDefaultCacheContexts protected function Gets the default cache contexts for rendered entities. Overrides EntityWithUriCacheTagsTestBase::getDefaultCacheContexts
CommentCacheTagsTest::setUp protected function Overrides EntityCacheTagsTestBase::setUp
CommentCacheTagsTest::testCommentEntity public function Tests that comments invalidate the cache tag of their host entity.
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
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::$nonReferencingEntity protected property The entity instance not referencing the main entity.
EntityCacheTagsTestBase::$referencingEntity protected property The entity instance referencing the main entity.
EntityCacheTagsTestBase::createCacheId Deprecated protected function Creates a cache ID from a list of cache keys and a set of cache contexts.
EntityCacheTagsTestBase::createReferenceTestEntities protected function Creates a referencing and a non-referencing entity for testing purposes.
EntityCacheTagsTestBase::getAccessCacheContextsForEntity protected function Returns the access cache contexts for the tested entity. 1
EntityCacheTagsTestBase::getAdditionalCacheContextsForEntityListing protected function Returns the additional cache tags for the tested entity's listing by type. 1
EntityCacheTagsTestBase::getAdditionalCacheTagsForEntityListing protected function Returns the additional cache tags for the tested entity's listing by type. 1
EntityCacheTagsTestBase::getRenderCacheBackend protected function Retrieves the render cache backend as a variation cache.
EntityCacheTagsTestBase::selectViewMode protected function Selects the preferred view mode for the given entity type.
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.
EntityWithUriCacheTagsTestBase::testEntityUri public function Tests cache tags presence and invalidation of the entity at its URI.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
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. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
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. 4
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. 1
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::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.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
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. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
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 Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
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::drupalResetSession protected function Resets the current active session back to Anonymous session.
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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
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.

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