class NodeRevisionsTest

Same name in other branches
  1. 9 core/modules/node/tests/src/Functional/NodeRevisionsTest.php \Drupal\Tests\node\Functional\NodeRevisionsTest
  2. 10 core/modules/node/tests/src/Functional/NodeRevisionsTest.php \Drupal\Tests\node\Functional\NodeRevisionsTest
  3. 11.x core/modules/node/tests/src/Functional/NodeRevisionsTest.php \Drupal\Tests\node\Functional\NodeRevisionsTest

Create a node with revisions and test viewing, saving, reverting, and deleting revisions for users with access for this content type.

@group node

Hierarchy

Expanded class hierarchy of NodeRevisionsTest

File

core/modules/node/tests/src/Functional/NodeRevisionsTest.php, line 20

Namespace

Drupal\Tests\node\Functional
View source
class NodeRevisionsTest extends NodeTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * An array of node revisions.
     *
     * @var \Drupal\node\NodeInterface[]
     */
    protected $nodes;
    
    /**
     * Revision log messages.
     *
     * @var array
     */
    protected $revisionLogs;
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'node',
        'contextual',
        'datetime',
        'language',
        'content_translation',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        // Enable additional languages.
        ConfigurableLanguage::createFromLangcode('de')->save();
        ConfigurableLanguage::createFromLangcode('it')->save();
        $field_storage_definition = [
            'field_name' => 'untranslatable_string_field',
            'entity_type' => 'node',
            'type' => 'string',
            'cardinality' => 1,
            'translatable' => FALSE,
        ];
        $field_storage = FieldStorageConfig::create($field_storage_definition);
        $field_storage->save();
        $field_definition = [
            'field_storage' => $field_storage,
            'bundle' => 'page',
        ];
        $field = FieldConfig::create($field_definition);
        $field->save();
        // Enable translation for page nodes.
        \Drupal::service('content_translation.manager')->setEnabled('node', 'page', TRUE);
        // Create and log in user.
        $web_user = $this->drupalCreateUser([
            'view page revisions',
            'revert page revisions',
            'delete page revisions',
            'edit any page content',
            'delete any page content',
            'access contextual links',
            'translate any entity',
            'administer content types',
        ]);
        $this->drupalLogin($web_user);
        // Create initial node.
        $node = $this->drupalCreateNode();
        $settings = get_object_vars($node);
        $settings['revision'] = 1;
        $settings['isDefaultRevision'] = TRUE;
        $nodes = [];
        $logs = [];
        // Get original node.
        $nodes[] = clone $node;
        // Create three revisions.
        $revision_count = 3;
        for ($i = 0; $i < $revision_count; $i++) {
            $logs[] = $node->revision_log = $this->randomMachineName(32);
            // Create revision with a random title and body and update variables.
            $node->title = $this->randomMachineName();
            $node->body = [
                'value' => $this->randomMachineName(32),
                'format' => filter_default_format(),
            ];
            $node->untranslatable_string_field->value = $this->randomString();
            $node->setNewRevision();
            // Edit the 1st and 2nd revision with a different user.
            if ($i < 2) {
                $editor = $this->drupalCreateUser();
                $node->setRevisionUserId($editor->id());
            }
            else {
                $node->setRevisionUserId($web_user->id());
            }
            $node->save();
            // Make sure we get revision information.
            $node = Node::load($node->id());
            $nodes[] = clone $node;
        }
        $this->nodes = $nodes;
        $this->revisionLogs = $logs;
    }
    
    /**
     * Checks node revision related operations.
     */
    public function testRevisions() {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $nodes = $this->nodes;
        $logs = $this->revisionLogs;
        // Get last node for simple checks.
        $node = $nodes[3];
        // Confirm the correct revision text appears on "view revisions" page.
        $this->drupalGet("node/" . $node->id() . "/revisions/" . $node->getRevisionId() . "/view");
        $this->assertText($node->body->value, 'Correct text displays for version.');
        // Confirm the correct log message appears on "revisions overview" page.
        $this->drupalGet("node/" . $node->id() . "/revisions");
        foreach ($logs as $revision_log) {
            $this->assertText($revision_log, 'Revision log message found.');
        }
        // Original author, and editor names should appear on revisions overview.
        $web_user = $nodes[0]->revision_uid->entity;
        $this->assertText(t('by @name', [
            '@name' => $web_user->getAccountName(),
        ]));
        $editor = $nodes[2]->revision_uid->entity;
        $this->assertText(t('by @name', [
            '@name' => $editor->getAccountName(),
        ]));
        // Confirm that this is the default revision.
        $this->assertTrue($node->isDefaultRevision(), 'Third node revision is the default one.');
        // Confirm that revisions revert properly.
        $this->drupalPostForm("node/" . $node->id() . "/revisions/" . $nodes[1]->getRevisionid() . "/revert", [], t('Revert'));
        $this->assertRaw(t('@type %title has been reverted to the revision from %revision-date.', [
            '@type' => 'Basic page',
            '%title' => $nodes[1]->label(),
            '%revision-date' => $this->container
                ->get('date.formatter')
                ->format($nodes[1]->getRevisionCreationTime()),
        ]), 'Revision reverted.');
        $node_storage->resetCache([
            $node->id(),
        ]);
        $reverted_node = $node_storage->load($node->id());
        $this->assertTrue($nodes[1]->body->value == $reverted_node->body->value, 'Node reverted correctly.');
        // Confirm the revision author is the user performing the revert.
        $this->assertTrue($reverted_node->getRevisionUserId() == $this->loggedInUser
            ->id(), 'Node revision author is user performing revert.');
        // And that its not the revision author.
        $this->assertTrue($reverted_node->getRevisionUserId() != $nodes[1]->getRevisionUserId(), 'Node revision author is not original revision author.');
        // Confirm that this is not the default version.
        $node = node_revision_load($node->getRevisionId());
        $this->assertFalse($node->isDefaultRevision(), 'Third node revision is not the default one.');
        // Confirm revisions delete properly.
        $this->drupalPostForm("node/" . $node->id() . "/revisions/" . $nodes[1]->getRevisionId() . "/delete", [], t('Delete'));
        $this->assertRaw(t('Revision from %revision-date of @type %title has been deleted.', [
            '%revision-date' => $this->container
                ->get('date.formatter')
                ->format($nodes[1]->getRevisionCreationTime()),
            '@type' => 'Basic page',
            '%title' => $nodes[1]->label(),
        ]), 'Revision deleted.');
        $connection = Database::getConnection();
        $nids = \Drupal::entityQuery('node')->accessCheck(FALSE)
            ->allRevisions()
            ->condition('nid', $node->id())
            ->condition('vid', $nodes[1]->getRevisionId())
            ->execute();
        $this->assertCount(0, $nids);
        // Set the revision timestamp to an older date to make sure that the
        // confirmation message correctly displays the stored revision date.
        $old_revision_date = REQUEST_TIME - 86400;
        $connection->update('node_revision')
            ->condition('vid', $nodes[2]->getRevisionId())
            ->fields([
            'revision_timestamp' => $old_revision_date,
        ])
            ->execute();
        $this->drupalPostForm("node/" . $node->id() . "/revisions/" . $nodes[2]->getRevisionId() . "/revert", [], t('Revert'));
        $this->assertRaw(t('@type %title has been reverted to the revision from %revision-date.', [
            '@type' => 'Basic page',
            '%title' => $nodes[2]->label(),
            '%revision-date' => $this->container
                ->get('date.formatter')
                ->format($old_revision_date),
        ]));
        // Make a new revision and set it to not be default.
        // This will create a new revision that is not "front facing".
        $new_node_revision = clone $node;
        $new_body = $this->randomMachineName();
        $new_node_revision->body->value = $new_body;
        // Save this as a non-default revision.
        $new_node_revision->setNewRevision();
        $new_node_revision->isDefaultRevision = FALSE;
        $new_node_revision->save();
        $this->drupalGet('node/' . $node->id());
        $this->assertNoText($new_body, 'Revision body text is not present on default version of node.');
        // Verify that the new body text is present on the revision.
        $this->drupalGet("node/" . $node->id() . "/revisions/" . $new_node_revision->getRevisionId() . "/view");
        $this->assertText($new_body, 'Revision body text is present when loading specific revision.');
        // Verify that the non-default revision vid is greater than the default
        // revision vid.
        $default_revision = $connection->select('node', 'n')
            ->fields('n', [
            'vid',
        ])
            ->condition('nid', $node->id())
            ->execute()
            ->fetchCol();
        $default_revision_vid = $default_revision[0];
        $this->assertTrue($new_node_revision->getRevisionId() > $default_revision_vid, 'Revision vid is greater than default revision vid.');
        // Create an 'EN' node with a revision log message.
        $node = $this->drupalCreateNode();
        $node->title = 'Node title in EN';
        $node->revision_log = 'Simple revision message (EN)';
        $node->save();
        $this->drupalGet("node/" . $node->id() . "/revisions");
        // Verify revisions is accessible since the type has revisions enabled.
        $this->assertSession()
            ->statusCodeEquals(200);
        // Check initial revision is shown on the node revisions overview page.
        $this->assertText('Simple revision message (EN)');
        // Verify that delete operation is inaccessible for the default revision.
        $this->drupalGet("node/" . $node->id() . "/revisions/" . $node->getRevisionId() . "/delete");
        $this->assertSession()
            ->statusCodeEquals(403);
        // Verify that revert operation is inaccessible for the default revision.
        $this->drupalGet("node/" . $node->id() . "/revisions/" . $node->getRevisionId() . "/revert");
        $this->assertSession()
            ->statusCodeEquals(403);
        // Create a new revision and new log message.
        $node = Node::load($node->id());
        $node->body->value = 'New text (EN)';
        $node->revision_log = 'New revision message (EN)';
        $node->setNewRevision();
        $node->save();
        // Check both revisions are shown on the node revisions overview page.
        $this->drupalGet("node/" . $node->id() . "/revisions");
        $this->assertText('Simple revision message (EN)');
        $this->assertText('New revision message (EN)');
        // Create an 'EN' node with a revision log message.
        $node = $this->drupalCreateNode();
        $node->langcode = 'en';
        $node->title = 'Node title in EN';
        $node->revision_log = 'Simple revision message (EN)';
        $node->save();
        $this->drupalGet("node/" . $node->id() . "/revisions");
        // Verify revisions is accessible since the type has revisions enabled.
        $this->assertSession()
            ->statusCodeEquals(200);
        // Check initial revision is shown on the node revisions overview page.
        $this->assertText('Simple revision message (EN)');
        // Add a translation in 'DE' and create a new revision and new log message.
        $translation = $node->addTranslation('de');
        $translation->title->value = 'Node title in DE';
        $translation->body->value = 'New text (DE)';
        $translation->revision_log = 'New revision message (DE)';
        $translation->setNewRevision();
        $translation->save();
        // View the revision UI in 'IT', only the original node revision is shown.
        $this->drupalGet("it/node/" . $node->id() . "/revisions");
        $this->assertText('Simple revision message (EN)');
        $this->assertNoText('New revision message (DE)');
        // View the revision UI in 'DE', only the translated node revision is shown.
        $this->drupalGet("de/node/" . $node->id() . "/revisions");
        $this->assertNoText('Simple revision message (EN)');
        $this->assertText('New revision message (DE)');
        // View the revision UI in 'EN', only the original node revision is shown.
        $this->drupalGet("node/" . $node->id() . "/revisions");
        $this->assertText('Simple revision message (EN)');
        $this->assertNoText('New revision message (DE)');
    }
    
    /**
     * Checks that revisions are correctly saved without log messages.
     */
    public function testNodeRevisionWithoutLogMessage() {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        // Create a node with an initial log message.
        $revision_log = $this->randomMachineName(10);
        $node = $this->drupalCreateNode([
            'revision_log' => $revision_log,
        ]);
        // Save over the same revision and explicitly provide an empty log message
        // (for example, to mimic the case of a node form submitted with no text in
        // the "log message" field), and check that the original log message is
        // preserved.
        $new_title = $this->randomMachineName(10) . 'testNodeRevisionWithoutLogMessage1';
        $node = clone $node;
        $node->title = $new_title;
        $node->revision_log = '';
        $node->setNewRevision(FALSE);
        $node->save();
        $this->drupalGet('node/' . $node->id());
        $this->assertText($new_title, 'New node title appears on the page.');
        $node_storage->resetCache([
            $node->id(),
        ]);
        $node_revision = $node_storage->load($node->id());
        $this->assertEqual($node_revision->revision_log->value, $revision_log, 'After an existing node revision is re-saved without a log message, the original log message is preserved.');
        // Create another node with an initial revision log message.
        $node = $this->drupalCreateNode([
            'revision_log' => $revision_log,
        ]);
        // Save a new node revision without providing a log message, and check that
        // this revision has an empty log message.
        $new_title = $this->randomMachineName(10) . 'testNodeRevisionWithoutLogMessage2';
        $node = clone $node;
        $node->title = $new_title;
        $node->setNewRevision();
        $node->revision_log = NULL;
        $node->save();
        $this->drupalGet('node/' . $node->id());
        $this->assertText($new_title, 'New node title appears on the page.');
        $node_storage->resetCache([
            $node->id(),
        ]);
        $node_revision = $node_storage->load($node->id());
        $this->assertTrue(empty($node_revision->revision_log->value), 'After a new node revision is saved with an empty log message, the log message for the node is empty.');
    }
    
    /**
     * Gets server-rendered contextual links for the given contextual links IDs.
     *
     * @param string[] $ids
     *   An array of contextual link IDs.
     * @param string $current_path
     *   The Drupal path for the page for which the contextual links are rendered.
     *
     * @return string
     *   The decoded JSON response body.
     */
    protected function renderContextualLinks(array $ids, $current_path) {
        $post = [];
        for ($i = 0; $i < count($ids); $i++) {
            $post['ids[' . $i . ']'] = $ids[$i];
        }
        $response = $this->drupalPost('contextual/render', 'application/json', $post, [
            'query' => [
                'destination' => $current_path,
            ],
        ]);
        return Json::decode($response);
    }
    
    /**
     * Tests the revision translations are correctly reverted.
     */
    public function testRevisionTranslationRevert() {
        // Create a node and a few revisions.
        $node = $this->drupalCreateNode([
            'langcode' => 'en',
        ]);
        $initial_revision_id = $node->getRevisionId();
        $initial_title = $node->label();
        $this->createRevisions($node, 2);
        // Translate the node and create a few translation revisions.
        $translation = $node->addTranslation('it');
        $this->createRevisions($translation, 3);
        $revert_id = $node->getRevisionId();
        $translated_title = $translation->label();
        $untranslatable_string = $node->untranslatable_string_field->value;
        // Create a new revision for the default translation in-between a series of
        // translation revisions.
        $this->createRevisions($node, 1);
        $default_translation_title = $node->label();
        // And create a few more translation revisions.
        $this->createRevisions($translation, 2);
        $translation_revision_id = $translation->getRevisionId();
        // Now revert the a translation revision preceding the last default
        // translation revision, and check that the desired value was reverted but
        // the default translation value was preserved.
        $revert_translation_url = Url::fromRoute('node.revision_revert_translation_confirm', [
            'node' => $node->id(),
            'node_revision' => $revert_id,
            'langcode' => 'it',
        ]);
        $this->drupalPostForm($revert_translation_url, [], t('Revert'));
        
        /** @var \Drupal\node\NodeStorage $node_storage */
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $node_storage->resetCache();
        
        /** @var \Drupal\node\NodeInterface $node */
        $node = $node_storage->load($node->id());
        $this->assertTrue($node->getRevisionId() > $translation_revision_id);
        $this->assertEqual($node->label(), $default_translation_title);
        $this->assertEqual($node->getTranslation('it')
            ->label(), $translated_title);
        $this->assertNotEqual($node->untranslatable_string_field->value, $untranslatable_string);
        $latest_revision_id = $translation->getRevisionId();
        // Now revert the a translation revision preceding the last default
        // translation revision again, and check that the desired value was reverted
        // but the default translation value was preserved. But in addition the
        // untranslated field will be reverted as well.
        $this->drupalPostForm($revert_translation_url, [
            'revert_untranslated_fields' => TRUE,
        ], t('Revert'));
        $node_storage->resetCache();
        
        /** @var \Drupal\node\NodeInterface $node */
        $node = $node_storage->load($node->id());
        $this->assertTrue($node->getRevisionId() > $latest_revision_id);
        $this->assertEqual($node->label(), $default_translation_title);
        $this->assertEqual($node->getTranslation('it')
            ->label(), $translated_title);
        $this->assertEqual($node->untranslatable_string_field->value, $untranslatable_string);
        $latest_revision_id = $translation->getRevisionId();
        // Now revert the entity revision to the initial one where the translation
        // didn't exist.
        $revert_url = Url::fromRoute('node.revision_revert_confirm', [
            'node' => $node->id(),
            'node_revision' => $initial_revision_id,
        ]);
        $this->drupalPostForm($revert_url, [], t('Revert'));
        $node_storage->resetCache();
        
        /** @var \Drupal\node\NodeInterface $node */
        $node = $node_storage->load($node->id());
        $this->assertTrue($node->getRevisionId() > $latest_revision_id);
        $this->assertEqual($node->label(), $initial_title);
        $this->assertFalse($node->hasTranslation('it'));
    }
    
    /**
     * Creates a series of revisions for the specified node.
     *
     * @param \Drupal\node\NodeInterface $node
     *   The node object.
     * @param $count
     *   The number of revisions to be created.
     */
    protected function createRevisions(NodeInterface $node, $count) {
        for ($i = 0; $i < $count; $i++) {
            $node->title = $this->randomString();
            $node->untranslatable_string_field->value = $this->randomString();
            $node->setNewRevision(TRUE);
            $node->save();
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can
be overridden in a derived class so it is possible to use a different
value for a subset of tests, e.g. the JavaScript tests.
1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
NodeRevisionsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
NodeRevisionsTest::$modules public static property Modules to enable. Overrides NodeTestBase::$modules
NodeRevisionsTest::$nodes protected property An array of node revisions.
NodeRevisionsTest::$revisionLogs protected property Revision log messages.
NodeRevisionsTest::createRevisions protected function Creates a series of revisions for the specified node.
NodeRevisionsTest::renderContextualLinks protected function Gets server-rendered contextual links for the given contextual links IDs.
NodeRevisionsTest::setUp protected function Overrides NodeTestBase::setUp
NodeRevisionsTest::testNodeRevisionWithoutLogMessage public function Checks that revisions are correctly saved without log messages.
NodeRevisionsTest::testRevisions public function Checks node revision related operations.
NodeRevisionsTest::testRevisionTranslationRevert public function Tests the revision translations are correctly reverted.
NodeTestBase::$accessHandler protected property The node access control handler.
NodeTestBase::assertNodeAccess public function Asserts that node access correctly grants or denies access.
NodeTestBase::assertNodeCreateAccess public function Asserts that node create access correctly grants or denies access.
NodeTestBase::nodeAccessAssertMessage public function Constructs an assert message to display which node access was tested.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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