class TaxonomyTermContentModerationTest

Same name in other branches
  1. 11.x core/modules/taxonomy/tests/src/Functional/TaxonomyTermContentModerationTest.php \Drupal\Tests\taxonomy\Functional\TaxonomyTermContentModerationTest

Tests taxonomy terms with Content Moderation.

@group content_moderation @group taxonomy

Hierarchy

Expanded class hierarchy of TaxonomyTermContentModerationTest

File

core/modules/taxonomy/tests/src/Functional/TaxonomyTermContentModerationTest.php, line 17

Namespace

Drupal\Tests\taxonomy\Functional
View source
class TaxonomyTermContentModerationTest extends TaxonomyTestBase {
    use ContentModerationTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The vocabulary used for creating terms.
     *
     * @var \Drupal\taxonomy\VocabularyInterface
     */
    protected $vocabulary;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'content_moderation',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->createEditorialWorkflow();
        $this->drupalLogin($this->drupalCreateUser([
            'administer taxonomy',
            'use editorial transition create_new_draft',
            'use editorial transition publish',
            'view any unpublished content',
            'view latest version',
        ]));
        $this->vocabulary = $this->createVocabulary();
        // Set the vocabulary as moderated.
        $workflow = Workflow::load('editorial');
        $workflow->getTypePlugin()
            ->addEntityTypeAndBundle('taxonomy_term', $this->vocabulary
            ->id());
        $workflow->save();
    }
    
    /**
     * Tests taxonomy term parents on a moderated vocabulary.
     */
    public function testTaxonomyTermParents() : void {
        $assert_session = $this->assertSession();
        // Create a simple hierarchy in the vocabulary, a root term and three parent
        // terms.
        $root = $this->createTerm($this->vocabulary, [
            'langcode' => 'en',
            'moderation_state' => 'published',
        ]);
        $parent_1 = $this->createTerm($this->vocabulary, [
            'langcode' => 'en',
            'moderation_state' => 'published',
            'parent' => $root->id(),
        ]);
        $parent_2 = $this->createTerm($this->vocabulary, [
            'langcode' => 'en',
            'moderation_state' => 'published',
            'parent' => $root->id(),
        ]);
        $parent_3 = $this->createTerm($this->vocabulary, [
            'langcode' => 'en',
            'moderation_state' => 'published',
            'parent' => $root->id(),
        ]);
        // Create a child term and assign one of the parents above.
        $child = $this->createTerm($this->vocabulary, [
            'langcode' => 'en',
            'moderation_state' => 'published',
            'parent' => $parent_1->id(),
        ]);
        
        /** @var \Drupal\taxonomy\TermStorageInterface $taxonomy_storage */
        $taxonomy_storage = \Drupal::entityTypeManager()->getStorage('taxonomy_term');
        $validation_message = 'You can only change the hierarchy for the published version of this term.';
        // Add a pending revision without changing the term parent.
        $this->drupalGet($child->toUrl('edit-form'));
        $this->submitForm([
            'moderation_state[0][state]' => 'draft',
        ], 'Save');
        $assert_session->pageTextNotContains($validation_message);
        // Add a pending revision and change the parent.
        $this->drupalGet($child->toUrl('edit-form'));
        $this->submitForm([
            'parent[]' => [
                $parent_2->id(),
            ],
            'moderation_state[0][state]' => 'draft',
        ], 'Save');
        // Check that parents were not changed.
        $assert_session->pageTextContains($validation_message);
        $taxonomy_storage->resetCache();
        $this->assertEquals([
            $parent_1->id(),
        ], array_keys($taxonomy_storage->loadParents($child->id())));
        // Add a pending revision and add a new parent.
        $this->drupalGet($child->toUrl('edit-form'));
        $this->submitForm([
            'parent[]' => [
                $parent_1->id(),
                $parent_3->id(),
            ],
            'moderation_state[0][state]' => 'draft',
        ], 'Save');
        // Check that parents were not changed.
        $assert_session->pageTextContains($validation_message);
        $taxonomy_storage->resetCache();
        $this->assertEquals([
            $parent_1->id(),
        ], array_keys($taxonomy_storage->loadParents($child->id())));
        // Add a pending revision and use the root term as a parent.
        $this->drupalGet($child->toUrl('edit-form'));
        $this->submitForm([
            'parent[]' => [
                $root->id(),
            ],
            'moderation_state[0][state]' => 'draft',
        ], 'Save');
        // Check that parents were not changed.
        $assert_session->pageTextContains($validation_message);
        $taxonomy_storage->resetCache();
        $this->assertEquals([
            $parent_1->id(),
        ], array_keys($taxonomy_storage->loadParents($child->id())));
        // Add a pending revision and remove the parent.
        $this->drupalGet($child->toUrl('edit-form'));
        $this->submitForm([
            'parent[]' => [],
            'moderation_state[0][state]' => 'draft',
        ], 'Save');
        // Check that parents were not changed.
        $assert_session->pageTextContains($validation_message);
        $taxonomy_storage->resetCache();
        $this->assertEquals([
            $parent_1->id(),
        ], array_keys($taxonomy_storage->loadParents($child->id())));
        // Add a published revision.
        $this->drupalGet($child->toUrl('edit-form'));
        $this->submitForm([
            'moderation_state[0][state]' => 'published',
        ], 'Save');
        // Change the parents.
        $this->drupalGet($child->toUrl('edit-form'));
        $this->submitForm([
            'parent[]' => [
                $parent_2->id(),
            ],
        ], 'Save');
        // Check that parents were changed.
        $assert_session->pageTextNotContains($validation_message);
        $taxonomy_storage->resetCache();
        $this->assertNotEquals([
            $parent_1->id(),
        ], array_keys($taxonomy_storage->loadParents($child->id())));
        // Add a pending revision and change the weight.
        $this->drupalGet($child->toUrl('edit-form'));
        $this->submitForm([
            'weight' => 10,
            'moderation_state[0][state]' => 'draft',
        ], 'Save');
        // Check that weight was not changed.
        $assert_session->pageTextContains($validation_message);
        // Add a new term without any parent and publish it.
        $edit = [
            'name[0][value]' => $this->randomMachineName(),
            'moderation_state[0][state]' => 'published',
        ];
        $this->drupalGet(Url::fromRoute('entity.taxonomy_term.add_form', [
            'taxonomy_vocabulary' => $this->vocabulary
                ->id(),
        ]));
        $this->submitForm($edit, 'Save');
        // Add a pending revision without any changes.
        $terms = \Drupal::entityTypeManager()->getStorage('taxonomy_term')
            ->loadByProperties([
            'name' => $edit['name[0][value]'],
        ]);
        $term = reset($terms);
        $this->drupalGet($term->toUrl('edit-form'));
        $this->submitForm([
            'moderation_state[0][state]' => 'draft',
        ], 'Save');
        $assert_session->pageTextNotContains($validation_message);
    }
    
    /**
     * Tests changing field values in pending revisions of taxonomy terms.
     */
    public function testTaxonomyTermPendingRevisions() : void {
        $assert_session = $this->assertSession();
        $default_term_name = 'term - default revision';
        $default_term_description = 'The default revision of a term.';
        $term = $this->createTerm($this->vocabulary, [
            'name' => $default_term_name,
            'description' => $default_term_description,
            'langcode' => 'en',
            'moderation_state' => 'published',
        ]);
        // Add a pending revision without changing the term parent.
        $this->drupalGet($term->toUrl('edit-form'));
        $assert_session->pageTextContains($default_term_name);
        $assert_session->pageTextContains($default_term_description);
        // Check the revision log message field appears on the term edit page.
        $this->drupalGet($term->toUrl('edit-form'));
        $assert_session->fieldExists('revision_log_message[0][value]');
        $pending_term_name = 'term - pending revision';
        $pending_term_description = 'The pending revision of a term.';
        $edit = [
            'name[0][value]' => $pending_term_name,
            'description[0][value]' => $pending_term_description,
            'moderation_state[0][state]' => 'draft',
        ];
        $this->drupalGet($term->toUrl('edit-form'));
        $this->submitForm($edit, 'Save');
        $assert_session->pageTextContains($pending_term_name);
        $assert_session->pageTextContains($pending_term_description);
        $assert_session->pageTextNotContains($default_term_description);
        // Check that the default revision of the term contains the correct values.
        $this->drupalGet('taxonomy/term/' . $term->id());
        $assert_session->pageTextContains($default_term_name);
        $assert_session->pageTextContains($default_term_description);
    }

}

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.
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.
ContentModerationTestTrait::addEntityTypeAndBundleToWorkflow protected function Adds an entity type ID / bundle ID to the given workflow. 1
ContentModerationTestTrait::createEditorialWorkflow protected function Creates the editorial workflow. 1
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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
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.
TaxonomyTermContentModerationTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
TaxonomyTermContentModerationTest::$modules protected static property Modules to install. Overrides TaxonomyTestBase::$modules
TaxonomyTermContentModerationTest::$vocabulary protected property The vocabulary used for creating terms.
TaxonomyTermContentModerationTest::setUp protected function Overrides TaxonomyTestBase::setUp
TaxonomyTermContentModerationTest::testTaxonomyTermParents public function Tests taxonomy term parents on a moderated vocabulary.
TaxonomyTermContentModerationTest::testTaxonomyTermPendingRevisions public function Tests changing field values in pending revisions of taxonomy terms.
TaxonomyTestTrait::createTaxonomyTermRevision protected function Creates a new revision for a given taxonomy term.
TaxonomyTestTrait::createTerm protected function Returns a new term with random properties given a vocabulary.
TaxonomyTestTrait::createVocabulary protected function Returns a new vocabulary with random properties.
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. 5
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.