class NodeRevisionsUiTest

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

Tests the UI for controlling node revision behavior.

@group node

Hierarchy

Expanded class hierarchy of NodeRevisionsUiTest

File

core/modules/node/tests/src/Functional/NodeRevisionsUiTest.php, line 17

Namespace

Drupal\Tests\node\Functional
View source
class NodeRevisionsUiTest extends NodeTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
    ];
    
    /**
     * @var \Drupal\user\Entity\User
     */
    protected $editor;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create users.
        $this->editor = $this->drupalCreateUser([
            'administer nodes',
            'edit any page content',
            'view page revisions',
            'access user profiles',
        ]);
    }
    
    /**
     * Checks that unchecking 'Create new revision' works when editing a node.
     */
    public function testNodeFormSaveWithoutRevision() : void {
        $this->drupalLogin($this->editor);
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        // Set page revision setting 'create new revision'. This will mean new
        // revisions are created by default when the node is edited.
        $type = NodeType::load('page');
        $type->setNewRevision(TRUE);
        $type->save();
        // Create the node.
        $node = $this->drupalCreateNode();
        // Verify the checkbox is checked on the node edit form.
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->assertSession()
            ->checkboxChecked('edit-revision');
        // Uncheck the create new revision checkbox and save the node.
        $edit = [
            'revision' => FALSE,
        ];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Load the node again and check the revision is the same as before.
        $node_storage->resetCache([
            $node->id(),
        ]);
        $node_revision = $node_storage->load($node->id(), TRUE);
        $this->assertEquals($node->getRevisionId(), $node_revision->getRevisionId(), "After an existing node is saved with 'Create new revision' unchecked, a new revision is not created.");
        // Verify the checkbox is checked on the node edit form.
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->assertSession()
            ->checkboxChecked('edit-revision');
        // Submit the form without changing the checkbox.
        $edit = [];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Load the node again and check the revision is different from before.
        $node_storage->resetCache([
            $node->id(),
        ]);
        $node_revision = $node_storage->load($node->id());
        $this->assertNotEquals($node->getRevisionId(), $node_revision->getRevisionId(), "After an existing node is saved with 'Create new revision' checked, a new revision is created.");
    }
    
    /**
     * Checks HTML double escaping of revision logs.
     */
    public function testNodeRevisionDoubleEscapeFix() : void {
        $this->drupalLogin($this->editor);
        $nodes = [];
        // Create the node.
        $node = $this->drupalCreateNode();
        $username = [
            '#theme' => 'username',
            '#account' => $this->editor,
        ];
        $editor = \Drupal::service('renderer')->renderInIsolation($username);
        // Get original node.
        $nodes[] = clone $node;
        // 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->setNewRevision();
        $revision_log = 'Revision <em>message</em> with markup.';
        $node->revision_log->value = $revision_log;
        $node->save();
        // Make sure we get revision information.
        $node = Node::load($node->id());
        $nodes[] = clone $node;
        $this->drupalGet('node/' . $node->id() . '/revisions');
        // Assert the old revision message.
        $date = $this->container
            ->get('date.formatter')
            ->format($nodes[0]->revision_timestamp->value, 'short');
        $url = new Url('entity.node.revision', [
            'node' => $nodes[0]->id(),
            'node_revision' => $nodes[0]->getRevisionId(),
        ]);
        $this->assertSession()
            ->responseContains(Link::fromTextAndUrl($date, $url)->toString() . ' by ' . $editor);
        // Assert the current revision message.
        $date = $this->container
            ->get('date.formatter')
            ->format($nodes[1]->revision_timestamp->value, 'short');
        $this->assertSession()
            ->responseContains($nodes[1]->toLink($date)
            ->toString() . ' by ' . $editor . '<p class="revision-log">' . $revision_log . '</p>');
    }
    
    /**
     * Checks the Revisions tab.
     */
    public function testNodeRevisionsTabWithDefaultRevision() : void {
        $this->drupalLogin($this->editor);
        // Create the node.
        $node = $this->drupalCreateNode();
        $storage = \Drupal::entityTypeManager()->getStorage($node->getEntityTypeId());
        // Create a new revision based on the default revision.
        // Revision 2.
        $node = $storage->load($node->id());
        $node->setNewRevision(TRUE);
        $node->save();
        // Revision 3.
        $node = $storage->load($node->id());
        $node->setNewRevision(TRUE);
        $node->save();
        // Revision 4.
        // Trigger translation changes in order to show the revision.
        $node = $storage->load($node->id());
        $node->setTitle($this->randomString());
        $node->isDefaultRevision(FALSE);
        $node->setNewRevision(TRUE);
        $node->save();
        // Revision 5.
        $node = $storage->load($node->id());
        $node->isDefaultRevision(FALSE);
        $node->setNewRevision(TRUE);
        $node->save();
        $node_id = $node->id();
        $this->drupalGet('node/' . $node_id . '/revisions');
        // Verify that the latest affected revision having been a default revision
        // is displayed as the current one.
        $this->assertSession()
            ->linkByHrefNotExists('/node/' . $node_id . '/revisions/1/revert');
        // The site may be installed in a subdirectory, so check if the URL is
        // contained in the retrieved one.
        $this->assertSession()
            ->elementAttributeContains('xpath', '//tr[contains(@class, "revision-current")]/td/a[1]', 'href', '/node/1');
        // Verify that the default revision can be an older revision than the latest
        // one.
        // Assert that the revisions with translations changes are shown.
        $this->assertSession()
            ->linkByHrefExists('/node/' . $node_id . '/revisions/4/revert');
        // Assert that the revisions without translations changes are filtered out:
        // 2, 3 and 5.
        $this->assertSession()
            ->linkByHrefNotExists('/node/' . $node_id . '/revisions/2/revert');
        $this->assertSession()
            ->linkByHrefNotExists('/node/' . $node_id . '/revisions/3/revert');
        $this->assertSession()
            ->linkByHrefNotExists('/node/' . $node_id . '/revisions/5/revert');
    }
    
    /**
     * Checks the Revisions tab.
     *
     * Tests two 'Revisions' local tasks are not added by both Node and
     * VersionHistoryLocalTasks.
     *
     * This can be removed after 'entity.node.version_history' local task is
     * removed by https://www.drupal.org/project/drupal/issues/3153559.
     *
     * @covers node_local_tasks_alter
     */
    public function testNodeDuplicateRevisionsTab() : void {
        $this->drupalPlaceBlock('local_tasks_block');
        $this->drupalLogin($this->editor);
        $node = $this->drupalCreateNode();
        $this->drupalGet($node->toUrl('edit-form'));
        // There must be exactly one 'Revisions' local task.
        $xpath = $this->assertSession()
            ->buildXPathQuery('//a[contains(@href, :href)]', [
            ':href' => $node->toUrl('version-history')
                ->toString(),
        ]);
        $this->assertSession()
            ->elementsCount('xpath', $xpath, 1);
    }

}

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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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
NodeRevisionsUiTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
NodeRevisionsUiTest::$editor protected property
NodeRevisionsUiTest::$modules protected static property Modules to install. Overrides NodeTestBase::$modules
NodeRevisionsUiTest::setUp protected function Overrides NodeTestBase::setUp
NodeRevisionsUiTest::testNodeDuplicateRevisionsTab public function Checks the Revisions tab.
NodeRevisionsUiTest::testNodeFormSaveWithoutRevision public function Checks that unchecking &#039;Create new revision&#039; works when editing a node.
NodeRevisionsUiTest::testNodeRevisionDoubleEscapeFix public function Checks HTML double escaping of revision logs.
NodeRevisionsUiTest::testNodeRevisionsTabWithDefaultRevision public function Checks the Revisions tab.
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.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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