class ModerationLocaleTest

Same name and namespace in other branches
  1. 9 core/modules/content_moderation/tests/src/Functional/ModerationLocaleTest.php \Drupal\Tests\content_moderation\Functional\ModerationLocaleTest
  2. 8.9.x core/modules/content_moderation/tests/src/Functional/ModerationLocaleTest.php \Drupal\Tests\content_moderation\Functional\ModerationLocaleTest
  3. 10 core/modules/content_moderation/tests/src/Functional/ModerationLocaleTest.php \Drupal\Tests\content_moderation\Functional\ModerationLocaleTest

Test content_moderation functionality with localization and translation.

@group content_moderation @group #slow

Hierarchy

Expanded class hierarchy of ModerationLocaleTest

File

core/modules/content_moderation/tests/src/Functional/ModerationLocaleTest.php, line 16

Namespace

Drupal\Tests\content_moderation\Functional
View source 
class ModerationLocaleTest extends ModerationStateTestBase {
    use ContentTranslationTestTrait;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'node',
        'content_moderation',
        'locale',
        'content_translation',
    ];
    
    /**
     * {@inheritdoc}
     *
     * @todo Remove and fix test to not rely on super user.
     * @see https://www.drupal.org/project/drupal/issues/3437620
     */
    protected bool $usesSuperUserAccessPolicy = TRUE;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalLogin($this->rootUser);
        // Enable moderation on Article node type.
        $this->createContentTypeFromUi('Article', 'article', TRUE);
        // Add French and Italian languages.
        static::createLanguageFromLangcode('fr');
        static::createLanguageFromLangcode('it');
        // Enable content translation on articles.
        $this->enableContentTranslation('node', 'article');
        // Adding languages requires a container rebuild in the test running
        // environment so that multilingual services are used.
        $this->rebuildContainer();
    }
    
    /**
     * Tests article translations can be moderated separately.
     */
    public function testTranslateModeratedContent() : void {
        // Create a published article in English.
        $edit = [
            'title[0][value]' => 'Published English node',
            'langcode[0][value]' => 'en',
            'moderation_state[0][state]' => 'published',
        ];
        $this->drupalGet('node/add/article');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains('Article Published English node has been created.');
        $english_node = $this->drupalGetNodeByTitle('Published English node');
        // Add a French translation.
        $this->drupalGet('node/' . $english_node->id() . '/translations');
        $this->clickLink('Add');
        $edit = [
            'title[0][value]' => 'French node Draft',
            'moderation_state[0][state]' => 'draft',
        ];
        $this->submitForm($edit, 'Save (this translation)');
        // Here the error has occurred "The website encountered an unexpected error.
        // Try again later."
        // If the translation has got lost.
        $this->assertSession()
            ->pageTextContains('Article French node Draft has been updated.');
        // Create an article in English.
        $edit = [
            'title[0][value]' => 'English node',
            'langcode[0][value]' => 'en',
            'moderation_state[0][state]' => 'draft',
        ];
        $this->drupalGet('node/add/article');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains('Article English node has been created.');
        $english_node = $this->drupalGetNodeByTitle('English node');
        // Add a French translation.
        $this->drupalGet('node/' . $english_node->id() . '/translations');
        $this->clickLink('Add');
        $edit = [
            'title[0][value]' => 'French node',
            'moderation_state[0][state]' => 'draft',
        ];
        $this->submitForm($edit, 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article French node has been updated.');
        $english_node = $this->drupalGetNodeByTitle('English node', TRUE);
        // Publish the English article and check that the translation stays
        // unpublished.
        $this->drupalGet('node/' . $english_node->id() . '/edit');
        $this->submitForm([
            'moderation_state[0][state]' => 'published',
        ], 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article English node has been updated.');
        $english_node = $this->drupalGetNodeByTitle('English node', TRUE);
        $french_node = $english_node->getTranslation('fr');
        $this->assertEquals('French node', $french_node->label());
        $this->assertEquals('published', $english_node->moderation_state->value);
        $this->assertTrue($english_node->isPublished());
        $this->assertEquals('draft', $french_node->moderation_state->value);
        $this->assertFalse($french_node->isPublished());
        // Create another article with its translation. This time we will publish
        // the translation first.
        $edit = [
            'title[0][value]' => 'Another node',
            'moderation_state[0][state]' => 'draft',
        ];
        $this->drupalGet('node/add/article');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains('Article Another node has been created.');
        $english_node = $this->drupalGetNodeByTitle('Another node');
        // Add a French translation.
        $this->drupalGet('node/' . $english_node->id() . '/translations');
        $this->clickLink('Add');
        $edit = [
            'title[0][value]' => 'Translated node',
            'moderation_state[0][state]' => 'draft',
        ];
        $this->submitForm($edit, 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article Translated node has been updated.');
        $english_node = $this->drupalGetNodeByTitle('Another node', TRUE);
        // Publish the translation and check that the source language version stays
        // unpublished.
        $this->drupalGet('fr/node/' . $english_node->id() . '/edit');
        $this->submitForm([
            'moderation_state[0][state]' => 'published',
        ], 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article Translated node has been updated.');
        $english_node = $this->drupalGetNodeByTitle('Another node', TRUE);
        $french_node = $english_node->getTranslation('fr');
        $this->assertEquals('published', $french_node->moderation_state->value);
        $this->assertTrue($french_node->isPublished());
        $this->assertEquals('draft', $english_node->moderation_state->value);
        $this->assertFalse($english_node->isPublished());
        // Now check that we can create a new draft of the translation.
        $edit = [
            'title[0][value]' => 'New draft of translated node',
            'moderation_state[0][state]' => 'draft',
        ];
        $this->drupalGet('fr/node/' . $english_node->id() . '/edit');
        $this->submitForm($edit, 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article New draft of translated node has been updated.');
        $english_node = $this->drupalGetNodeByTitle('Another node', TRUE);
        $french_node = $english_node->getTranslation('fr');
        $this->assertEquals('published', $french_node->moderation_state->value);
        $this->assertTrue($french_node->isPublished());
        $this->assertEquals('Translated node', $french_node->getTitle(), 'The default revision of the published translation remains the same.');
        // Publish the French article before testing the archive transition.
        $this->drupalGet('fr/node/' . $english_node->id() . '/edit');
        $this->submitForm([
            'moderation_state[0][state]' => 'published',
        ], 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article New draft of translated node has been updated.');
        $english_node = $this->drupalGetNodeByTitle('Another node', TRUE);
        $french_node = $english_node->getTranslation('fr');
        $this->assertEquals('published', $french_node->moderation_state->value);
        $this->assertTrue($french_node->isPublished());
        $this->assertEquals('New draft of translated node', $french_node->getTitle(), 'The draft has replaced the published revision.');
        // Publish the English article before testing the archive transition.
        $this->drupalGet('node/' . $english_node->id() . '/edit');
        $this->submitForm([
            'moderation_state[0][state]' => 'published',
        ], 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article Another node has been updated.');
        $english_node = $this->drupalGetNodeByTitle('Another node', TRUE);
        $this->assertEquals('published', $english_node->moderation_state->value);
        // Archive the node and its translation.
        $this->drupalGet('node/' . $english_node->id() . '/edit');
        $this->submitForm([
            'moderation_state[0][state]' => 'archived',
        ], 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article Another node has been updated.');
        $this->drupalGet('fr/node/' . $english_node->id() . '/edit');
        $this->submitForm([
            'moderation_state[0][state]' => 'archived',
        ], 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article New draft of translated node has been updated.');
        $english_node = $this->drupalGetNodeByTitle('Another node', TRUE);
        $french_node = $english_node->getTranslation('fr');
        $this->assertEquals('archived', $english_node->moderation_state->value);
        $this->assertFalse($english_node->isPublished());
        $this->assertEquals('archived', $french_node->moderation_state->value);
        $this->assertFalse($french_node->isPublished());
    }
    
    /**
     * Tests that individual translations can be moderated independently.
     */
    public function testLanguageIndependentContentModeration() : void {
        // Create a published article in English (revision 1).
        $this->drupalGet('node/add/article');
        $node = $this->submitNodeForm('Test 1.1 EN', 'published');
        $this->assertNotLatestVersionPage($node);
        $edit_path = $node->toUrl('edit-form');
        $translate_path = $node->toUrl('drupal:content-translation-overview');
        // Create a new English draft (revision 2).
        $this->drupalGet($edit_path);
        $this->submitNodeForm('Test 1.2 EN', 'draft', TRUE);
        $this->assertLatestVersionPage($node);
        // Add a French translation draft (revision 3).
        $this->drupalGet($translate_path);
        $this->clickLink('Add');
        $this->submitNodeForm('Test 1.3 FR', 'draft');
        $fr_node = $this->loadTranslation($node, 'fr');
        $this->assertLatestVersionPage($fr_node);
        $this->assertModerationForm($node);
        // Add an Italian translation draft (revision 4).
        $this->drupalGet($translate_path);
        $this->clickLink('Add');
        $this->submitNodeForm('Test 1.4 IT', 'draft');
        $it_node = $this->loadTranslation($node, 'it');
        $this->assertLatestVersionPage($it_node);
        $this->assertModerationForm($node);
        $this->assertModerationForm($fr_node);
        // Publish the English draft (revision 5).
        $this->drupalGet($edit_path);
        $this->submitNodeForm('Test 1.5 EN', 'published', TRUE);
        $this->assertNotLatestVersionPage($node);
        $this->assertModerationForm($fr_node);
        $this->assertModerationForm($it_node);
        // Publish the Italian draft (revision 6).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 3);
        $this->submitNodeForm('Test 1.6 IT', 'published');
        $this->assertNotLatestVersionPage($it_node);
        $this->assertNoModerationForm($node);
        $this->assertModerationForm($fr_node);
        // Publish the French draft (revision 7).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 2);
        $this->submitNodeForm('Test 1.7 FR', 'published');
        $this->assertNotLatestVersionPage($fr_node);
        $this->assertNoModerationForm($node);
        $this->assertNoModerationForm($it_node);
        // Create an Italian draft (revision 8).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 3);
        $this->submitNodeForm('Test 1.8 IT', 'draft');
        $this->assertLatestVersionPage($it_node);
        $this->assertNoModerationForm($node);
        $this->assertNoModerationForm($fr_node);
        // Create a French draft (revision 9).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 2);
        $this->submitNodeForm('Test 1.9 FR', 'draft');
        $this->assertLatestVersionPage($fr_node);
        $this->assertNoModerationForm($node);
        $this->assertModerationForm($it_node);
        // Create an English draft (revision 10).
        $this->drupalGet($edit_path);
        $this->submitNodeForm('Test 1.10 EN', 'draft');
        $this->assertLatestVersionPage($node);
        $this->assertModerationForm($fr_node);
        $this->assertModerationForm($it_node);
        // Now start from a draft article in English (revision 1).
        $this->drupalGet('node/add/article');
        $node2 = $this->submitNodeForm('Test 2.1 EN', 'draft', TRUE);
        $this->assertNotLatestVersionPage($node2, TRUE);
        $edit_path = $node2->toUrl('edit-form');
        $translate_path = $node2->toUrl('drupal:content-translation-overview');
        // Add a French translation (revision 2).
        $this->drupalGet($translate_path);
        $this->clickLink('Add');
        $this->submitNodeForm('Test 2.2 FR', 'draft');
        $fr_node2 = $this->loadTranslation($node2, 'fr');
        $this->assertNotLatestVersionPage($fr_node2, TRUE);
        $this->assertModerationForm($node2, FALSE);
        // Add an Italian translation (revision 3).
        $this->drupalGet($translate_path);
        $this->clickLink('Add');
        $this->submitNodeForm('Test 2.3 IT', 'draft');
        $it_node2 = $this->loadTranslation($node2, 'it');
        $this->assertNotLatestVersionPage($it_node2, TRUE);
        $this->assertModerationForm($node2, FALSE);
        $this->assertModerationForm($fr_node2, FALSE);
        // Publish the English draft (revision 4).
        $this->drupalGet($edit_path);
        $this->submitNodeForm('Test 2.4 EN', 'published', TRUE);
        $this->assertNotLatestVersionPage($node2);
        $this->assertModerationForm($fr_node2, FALSE);
        $this->assertModerationForm($it_node2, FALSE);
        // Publish the Italian draft (revision 5).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 3);
        $this->submitNodeForm('Test 2.5 IT', 'published');
        $this->assertNotLatestVersionPage($it_node2);
        $this->assertNoModerationForm($node2);
        $this->assertModerationForm($fr_node2, FALSE);
        // Publish the French draft (revision 6).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 2);
        $this->submitNodeForm('Test 2.6 FR', 'published');
        $this->assertNotLatestVersionPage($fr_node2);
        $this->assertNoModerationForm($node2);
        $this->assertNoModerationForm($it_node2);
        // Now that all revision translations are published, verify that the
        // moderation form is never displayed on revision pages.
        
        /** @var \Drupal\node\NodeStorageInterface $storage */
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        foreach (range(11, 16) as $revision_id) {
            
            /** @var \Drupal\node\NodeInterface $revision */
            $revision = $storage->loadRevision($revision_id);
            foreach ($revision->getTranslationLanguages() as $langcode => $language) {
                if ($revision->isRevisionTranslationAffected()) {
                    $this->drupalGet($revision->toUrl('revision'));
                    $this->assertFalse($this->hasModerationForm(), 'Moderation form is not displayed correctly for revision ' . $revision_id);
                    break;
                }
            }
        }
        // Create an Italian draft (revision 7).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 3);
        $this->submitNodeForm('Test 2.7 IT', 'draft');
        $this->assertLatestVersionPage($it_node2);
        $this->assertNoModerationForm($node2);
        $this->assertNoModerationForm($fr_node2);
        // Create a French draft (revision 8).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 2);
        $this->submitNodeForm('Test 2.8 FR', 'draft');
        $this->assertLatestVersionPage($fr_node2);
        $this->assertNoModerationForm($node2);
        $this->assertModerationForm($it_node2);
        // Create an English draft (revision 9).
        $this->drupalGet($edit_path);
        $this->submitNodeForm('Test 2.9 EN', 'draft', TRUE);
        $this->assertLatestVersionPage($node2);
        $this->assertModerationForm($fr_node2);
        $this->assertModerationForm($it_node2);
        // Now publish a draft in another language first and verify that the
        // moderation form is not displayed on the English node view page.
        $this->drupalGet('node/add/article');
        $node3 = $this->submitNodeForm('Test 3.1 EN', 'published');
        $this->assertNotLatestVersionPage($node3);
        $edit_path = $node3->toUrl('edit-form');
        $translate_path = $node3->toUrl('drupal:content-translation-overview');
        // Create an English draft (revision 2).
        $this->drupalGet($edit_path);
        $this->submitNodeForm('Test 3.2 EN', 'draft', TRUE);
        $this->assertLatestVersionPage($node3);
        // Add a French translation (revision 3).
        $this->drupalGet($translate_path);
        $this->clickLink('Add');
        $this->submitNodeForm('Test 3.3 FR', 'draft');
        $fr_node3 = $this->loadTranslation($node3, 'fr');
        $this->assertLatestVersionPage($fr_node3);
        $this->assertModerationForm($node3);
        // Publish the French draft (revision 4).
        $this->drupalGet($translate_path);
        $this->clickLink('Edit', 2);
        $this->submitNodeForm('Test 3.4 FR', 'published');
        $this->assertNotLatestVersionPage($fr_node3);
        $this->assertModerationForm($node3);
    }
    
    /**
     * Checks that new translation values are populated properly.
     */
    public function testNewTranslationSourceValues() : void {
        // Create a published article in Italian (revision 1).
        $this->drupalGet('node/add/article');
        $node = $this->submitNodeForm('Test 1.1 IT', 'published', TRUE, 'it');
        $this->assertNotLatestVersionPage($node);
        // Create a new draft (revision 2).
        $this->drupalGet($node->toUrl('edit-form'));
        $this->submitNodeForm('Test 1.2 IT', 'draft', TRUE);
        $this->assertLatestVersionPage($node);
        // Create an English draft (revision 3) and verify that the Italian draft
        // values are used as source values.
        $url = $node->toUrl('drupal:content-translation-add');
        $url->setRouteParameter('source', 'it');
        $url->setRouteParameter('target', 'en');
        $this->drupalGet($url);
        $this->assertSession()
            ->pageTextContains('Test 1.2 IT');
        $this->submitNodeForm('Test 1.3 EN', 'draft');
        $this->assertLatestVersionPage($node);
        // Create a French draft (without saving) and verify that the Italian draft
        // values are used as source values.
        $url->setRouteParameter('target', 'fr');
        $this->drupalGet($url);
        $this->assertSession()
            ->pageTextContains('Test 1.2 IT');
        // Now switch source language and verify that the English draft values are
        // used as source values.
        $url->setRouteParameter('source', 'en');
        $this->drupalGet($url);
        $this->assertSession()
            ->pageTextContains('Test 1.3 EN');
    }
    
    /**
     * Tests article revision history shows revisions for the correct translation.
     */
    public function testTranslationRevisionsHistory() : void {
        // Create a published article in English.
        $edit = [
            'title[0][value]' => 'English node',
            'langcode[0][value]' => 'en',
            'moderation_state[0][state]' => 'published',
            'revision_log[0][value]' => 'Log Message - English - Published - Edit 1',
        ];
        $this->drupalGet('node/add/article');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains('Article English node has been created.');
        $node = $this->drupalGetNodeByTitle('English node');
        // Add a French translation.
        $this->drupalGet('node/' . $node->id() . '/translations');
        $this->clickLink('Add');
        $edit = [
            'title[0][value]' => 'French node',
            'moderation_state[0][state]' => 'draft',
            'revision_log[0][value]' => 'Log Message - French - Draft - Edit 1',
        ];
        $this->submitForm($edit, 'Save (this translation)');
        // Here the error has occurred "The website encountered an unexpected error.
        // Try again later."
        // If the translation has got lost.
        $this->assertSession()
            ->pageTextContains('Article French node has been updated.');
        $french_node = $this->loadTranslation($node, 'fr');
        $this->assertEquals('published', $node->moderation_state->value);
        $this->assertTrue($node->isPublished());
        $this->assertEquals('draft', $french_node->moderation_state->value);
        $this->assertFalse($french_node->isPublished());
        // Verify the revisions history for the English node.
        $this->drupalGet('node/' . $node->id() . '/revisions');
        $this->assertSession()
            ->pageTextContains('Log Message - English - Published - Edit 1');
        $this->assertSession()
            ->pageTextNotContains('Log Message - French');
        // Verify the revisions history for the French node.
        $this->drupalGet($french_node->language()
            ->getId() . '/node/' . $node->id() . '/revisions');
        $this->assertSession()
            ->pageTextContains('Log Message - French - Draft - Edit 1');
        $this->assertSession()
            ->pageTextNotContains('Log Message - English');
        // Create a new draft for the English article.
        $edit = [
            'moderation_state[0][state]' => 'draft',
            'revision_log[0][value]' => 'Log Message - English - Draft - Edit 2',
        ];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains('Article English node has been updated.');
        // Create a new draft for the French article.
        $edit = [
            'moderation_state[0][state]' => 'draft',
            'revision_log[0][value]' => 'Log Message - French - Draft - Edit 2',
        ];
        $this->drupalGet($french_node->language()
            ->getId() . '/node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article French node has been updated.');
        // Verify the revisions history for the English node.
        $this->drupalGet('node/' . $node->id() . '/revisions');
        $this->assertSession()
            ->pageTextContains('Log Message - English - Published - Edit 1');
        $this->assertSession()
            ->pageTextContains('Log Message - English - Draft - Edit 2');
        $this->assertSession()
            ->pageTextNotContains('Log Message - French');
        // Verify the revisions history for the French node.
        $this->drupalGet($french_node->language()
            ->getId() . '/node/' . $node->id() . '/revisions');
        $this->assertSession()
            ->pageTextContains('Log Message - French - Draft - Edit 1');
        $this->assertSession()
            ->pageTextContains('Log Message - French - Draft - Edit 2');
        $this->assertSession()
            ->pageTextNotContains('Log Message - English');
        // Publish the French Node.
        $edit = [
            'moderation_state[0][state]' => 'published',
            'revision_log[0][value]' => 'Log Message - French - Published - Edit 3',
        ];
        $this->drupalGet($french_node->language()
            ->getId() . '/node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save (this translation)');
        $this->assertSession()
            ->pageTextContains('Article French node has been updated.');
        // Verify the revisions history for the English node.
        $this->drupalGet('node/' . $node->id() . '/revisions');
        $this->assertSession()
            ->pageTextContains('Log Message - English - Published - Edit 1');
        $this->assertSession()
            ->pageTextContains('Log Message - English - Draft - Edit 2');
        $this->assertSession()
            ->pageTextNotContains('Log Message - French');
        // Verify the revisions history for the French node.
        $this->drupalGet($french_node->language()
            ->getId() . '/node/' . $node->id() . '/revisions');
        $this->assertSession()
            ->pageTextContains('Log Message - French - Draft - Edit 1');
        $this->assertSession()
            ->pageTextContains('Log Message - French - Draft - Edit 2');
        $this->assertSession()
            ->pageTextContains('Log Message - French - Published - Edit 3');
        $this->assertSession()
            ->pageTextNotContains('Log Message - English');
    }
    
    /**
     * Submits the node form at the current URL with the specified values.
     *
     * @param string $title
     *   The node title.
     * @param string $moderation_state
     *   The moderation state.
     * @param bool $default_translation
     *   (optional) Whether we are editing the default translation.
     * @param string|null $langcode
     *   (optional) The node language. Defaults to English.
     *
     * @return \Drupal\node\NodeInterface|null
     *   A node object if a new one is being created, NULL otherwise.
     */
    protected function submitNodeForm($title, $moderation_state, $default_translation = FALSE, $langcode = 'en') {
        $is_new = str_contains($this->getSession()
            ->getCurrentUrl(), '/node/add/');
        $edit = [
            'title[0][value]' => $title,
            'moderation_state[0][state]' => $moderation_state,
        ];
        if ($is_new) {
            $default_translation = TRUE;
            $edit['langcode[0][value]'] = $langcode;
        }
        $submit = $default_translation ? 'Save' : 'Save (this translation)';
        $this->submitForm($edit, $submit);
        $message = $is_new ? "Article {$title} has been created." : "Article {$title} has been updated.";
        $this->assertSession()
            ->pageTextContains($message);
        return $is_new ? $this->drupalGetNodeByTitle($title) : NULL;
    }
    
    /**
     * Loads the node translation for the specified language.
     *
     * @param \Drupal\node\NodeInterface $node
     *   A node object.
     * @param string $langcode
     *   The translation language code.
     *
     * @return \Drupal\node\NodeInterface
     *   The node translation object.
     */
    protected function loadTranslation(NodeInterface $node, $langcode) {
        
        /** @var \Drupal\node\NodeStorageInterface $storage */
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        // Explicitly invalidate the cache for that node, as the call below is
        // statically cached.
        $storage->resetCache([
            $node->id(),
        ]);
        
        /** @var \Drupal\node\NodeInterface $node */
        $node = $storage->loadRevision($storage->getLatestRevisionId($node->id()));
        return $node->getTranslation($langcode);
    }
    
    /**
     * Asserts that this is the "latest version" page for the specified node.
     *
     * @param \Drupal\node\NodeInterface $node
     *   A node object.
     *
     * @internal
     */
    public function assertLatestVersionPage(NodeInterface $node) : void {
        $this->assertEquals($node->toUrl('latest-version')
            ->setAbsolute()
            ->toString(), $this->getSession()
            ->getCurrentUrl());
        $this->assertModerationForm($node);
    }
    
    /**
     * Asserts that this is not the "latest version" page for the specified node.
     *
     * @param \Drupal\node\NodeInterface $node
     *   A node object.
     * @param bool $moderation_form
     *   (optional) Whether the page should contain the moderation form. Defaults
     *   to FALSE.
     *
     * @internal
     */
    public function assertNotLatestVersionPage(NodeInterface $node, bool $moderation_form = FALSE) : void {
        $this->assertNotEquals($node->toUrl('latest-version')
            ->setAbsolute()
            ->toString(), $this->getSession()
            ->getCurrentUrl());
        if ($moderation_form) {
            $this->assertModerationForm($node, FALSE);
        }
        else {
            $this->assertNoModerationForm($node);
        }
    }
    
    /**
     * Asserts that the moderation form is displayed for the specified node.
     *
     * @param \Drupal\node\NodeInterface $node
     *   A node object.
     * @param bool $latest_tab
     *   (optional) Whether the node form is expected to be displayed on the
     *   latest version page or on the node view page. Defaults to the former.
     *
     * @internal
     */
    public function assertModerationForm(NodeInterface $node, bool $latest_tab = TRUE) : void {
        $this->drupalGet($node->toUrl());
        $this->assertEquals(!$latest_tab, $this->hasModerationForm());
        $this->drupalGet($node->toUrl('latest-version'));
        $this->assertEquals($latest_tab, $this->hasModerationForm());
    }
    
    /**
     * Asserts that the moderation form is not displayed for the specified node.
     *
     * @param \Drupal\node\NodeInterface $node
     *   A node object.
     *
     * @internal
     */
    public function assertNoModerationForm(NodeInterface $node) : void {
        $this->drupalGet($node->toUrl());
        $this->assertFalse($this->hasModerationForm());
        $this->drupalGet($node->toUrl('latest-version'));
        $this->assertEquals(403, $this->getSession()
            ->getStatusCode());
    }
    
    /**
     * Checks whether the page contains the moderation form.
     *
     * @return bool
     *   TRUE if the moderation form could be find in the page, FALSE otherwise.
     */
    public function hasModerationForm() {
        return (bool) $this->xpath('//ul[@class="entity-moderation-form"]');
    }

}

Members

Title 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::$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::$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::__construct 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
ContentTranslationTestTrait::enableContentTranslation public function Enables content translation for the given entity type bundle.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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::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. 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
LanguageTestTrait::createLanguageFromLangcode public static function Creates a configurable language object from a langcode.
LanguageTestTrait::disableBundleTranslation public static function Disables translations for the given entity type bundle.
LanguageTestTrait::enableBundleTranslation public static function Enables translations for the given entity type bundle.
LanguageTestTrait::setFieldTranslatable public static function Sets and saves a given field instance translation status.
ModerationLocaleTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ModerationLocaleTest::$modules protected static property Modules to enable. Overrides ModerationStateTestBase::$modules
ModerationLocaleTest::$usesSuperUserAccessPolicy protected property @todo Remove and fix test to not rely on super user. Overrides FunctionalTestSetupTrait::$usesSuperUserAccessPolicy
ModerationLocaleTest::assertLatestVersionPage public function Asserts that this is the "latest version" page for the specified node.
ModerationLocaleTest::assertModerationForm public function Asserts that the moderation form is displayed for the specified node.
ModerationLocaleTest::assertNoModerationForm public function Asserts that the moderation form is not displayed for the specified node.
ModerationLocaleTest::assertNotLatestVersionPage public function Asserts that this is not the "latest version" page for the specified node.
ModerationLocaleTest::hasModerationForm public function Checks whether the page contains the moderation form.
ModerationLocaleTest::loadTranslation protected function Loads the node translation for the specified language.
ModerationLocaleTest::setUp protected function Sets the test up. Overrides ModerationStateTestBase::setUp
ModerationLocaleTest::submitNodeForm protected function Submits the node form at the current URL with the specified values.
ModerationLocaleTest::testLanguageIndependentContentModeration public function Tests that individual translations can be moderated independently.
ModerationLocaleTest::testNewTranslationSourceValues public function Checks that new translation values are populated properly.
ModerationLocaleTest::testTranslateModeratedContent public function Tests article translations can be moderated separately.
ModerationLocaleTest::testTranslationRevisionsHistory public function Tests article revision history shows revisions for the correct translation.
ModerationStateTestBase::$adminUser protected property Admin user.
ModerationStateTestBase::$permissions protected property Permissions to grant admin user. 1
ModerationStateTestBase::$profile protected property Profile to use. Overrides BrowserTestBase::$profile
ModerationStateTestBase::$workflow protected property The editorial workflow entity.
ModerationStateTestBase::createContentTypeFromUi protected function Creates a content-type from the UI.
ModerationStateTestBase::enableModerationThroughUi public function Enable moderation for a specified content type, using the UI.
ModerationStateTestBase::getWorkflowTransitionPermission protected function Gets the permission machine name for a transition.
ModerationStateTestBase::grantUserPermissionToCreateContentOfType protected function Grants given user permission to create content of given type.
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
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.
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::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::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::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.