class ContextualDynamicContextTest

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

Tests if contextual links are showing on the front page depending on permissions.

@group contextual

Hierarchy

Expanded class hierarchy of ContextualDynamicContextTest

File

core/modules/contextual/tests/src/Functional/ContextualDynamicContextTest.php, line 18

Namespace

Drupal\Tests\contextual\Functional
View source 
class ContextualDynamicContextTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'classy';
    
    /**
     * A user with permission to access contextual links and edit content.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $editorUser;
    
    /**
     * An authenticated user with permission to access contextual links.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $authenticatedUser;
    
    /**
     * A simulated anonymous user with access only to node content.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $anonymousUser;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'contextual',
        'node',
        'views',
        'views_ui',
        'language',
        'menu_test',
    ];
    protected function setUp() {
        parent::setUp();
        $this->drupalCreateContentType([
            'type' => 'page',
            'name' => 'Basic page',
        ]);
        $this->drupalCreateContentType([
            'type' => 'article',
            'name' => 'Article',
        ]);
        ConfigurableLanguage::createFromLangcode('it')->save();
        $this->rebuildContainer();
        $this->editorUser = $this->drupalCreateUser([
            'access content',
            'access contextual links',
            'edit any article content',
        ]);
        $this->authenticatedUser = $this->drupalCreateUser([
            'access content',
            'access contextual links',
        ]);
        $this->anonymousUser = $this->drupalCreateUser([
            'access content',
        ]);
    }
    
    /**
     * Tests contextual links with different permissions.
     *
     * Ensures that contextual link placeholders always exist, even if the user is
     * not allowed to use contextual links.
     */
    public function testDifferentPermissions() {
        $this->drupalLogin($this->editorUser);
        // Create three nodes in the following order:
        // - An article, which should be user-editable.
        // - A page, which should not be user-editable.
        // - A second article, which should also be user-editable.
        $node1 = $this->drupalCreateNode([
            'type' => 'article',
            'promote' => 1,
        ]);
        $node2 = $this->drupalCreateNode([
            'type' => 'page',
            'promote' => 1,
        ]);
        $node3 = $this->drupalCreateNode([
            'type' => 'article',
            'promote' => 1,
        ]);
        // Now, on the front page, all article nodes should have contextual links
        // placeholders, as should the view that contains them.
        $ids = [
            'node:node=' . $node1->id() . ':changed=' . $node1->getChangedTime() . '&langcode=en',
            'node:node=' . $node2->id() . ':changed=' . $node2->getChangedTime() . '&langcode=en',
            'node:node=' . $node3->id() . ':changed=' . $node3->getChangedTime() . '&langcode=en',
            'entity.view.edit_form:view=frontpage:location=page&name=frontpage&display_id=page_1&langcode=en',
        ];
        // Editor user: can access contextual links and can edit articles.
        $this->drupalGet('node');
        for ($i = 0; $i < count($ids); $i++) {
            $this->assertContextualLinkPlaceHolder($ids[$i]);
        }
        $response = $this->renderContextualLinks([], 'node');
        $this->assertSame(400, $response->getStatusCode());
        $this->assertStringContainsString('No contextual ids specified.', (string) $response->getBody());
        $response = $this->renderContextualLinks($ids, 'node');
        $this->assertSame(200, $response->getStatusCode());
        $json = Json::decode((string) $response->getBody());
        $this->assertIdentical($json[$ids[0]], '<ul class="contextual-links"><li class="entitynodeedit-form"><a href="' . base_path() . 'node/1/edit">Edit</a></li></ul>');
        $this->assertIdentical($json[$ids[1]], '');
        $this->assertIdentical($json[$ids[2]], '<ul class="contextual-links"><li class="entitynodeedit-form"><a href="' . base_path() . 'node/3/edit">Edit</a></li></ul>');
        $this->assertIdentical($json[$ids[3]], '');
        // Verify that link language is properly handled.
        $node3->addTranslation('it')
            ->set('title', $this->randomString())
            ->save();
        $id = 'node:node=' . $node3->id() . ':changed=' . $node3->getChangedTime() . '&langcode=it';
        $this->drupalGet('node', [
            'language' => ConfigurableLanguage::createFromLangcode('it'),
        ]);
        $this->assertContextualLinkPlaceHolder($id);
        // Authenticated user: can access contextual links, cannot edit articles.
        $this->drupalLogin($this->authenticatedUser);
        $this->drupalGet('node');
        for ($i = 0; $i < count($ids); $i++) {
            $this->assertContextualLinkPlaceHolder($ids[$i]);
        }
        $response = $this->renderContextualLinks([], 'node');
        $this->assertSame(400, $response->getStatusCode());
        $this->assertStringContainsString('No contextual ids specified.', (string) $response->getBody());
        $response = $this->renderContextualLinks($ids, 'node');
        $this->assertSame(200, $response->getStatusCode());
        $json = Json::decode((string) $response->getBody());
        $this->assertIdentical($json[$ids[0]], '');
        $this->assertIdentical($json[$ids[1]], '');
        $this->assertIdentical($json[$ids[2]], '');
        $this->assertIdentical($json[$ids[3]], '');
        // Anonymous user: cannot access contextual links.
        $this->drupalLogin($this->anonymousUser);
        $this->drupalGet('node');
        for ($i = 0; $i < count($ids); $i++) {
            $this->assertNoContextualLinkPlaceHolder($ids[$i]);
        }
        $response = $this->renderContextualLinks([], 'node');
        $this->assertSame(403, $response->getStatusCode());
        $this->renderContextualLinks($ids, 'node');
        $this->assertSame(403, $response->getStatusCode());
        // Get a page where contextual links are directly rendered.
        $this->drupalGet(Url::fromRoute('menu_test.contextual_test'));
        $this->assertEscaped("<script>alert('Welcome to the jungle!')</script>");
        $this->assertRaw('<li class="menu-testcontextual-hidden-manage-edit"><a href="' . base_path() . 'menu-test-contextual/1/edit" class="use-ajax" data-dialog-type="modal" data-is-something>Edit menu - contextual</a></li>');
    }
    
    /**
     * Tests the contextual placeholder content is protected by a token.
     */
    public function testTokenProtection() {
        $this->drupalLogin($this->editorUser);
        // Create a node that will have a contextual link.
        $node1 = $this->drupalCreateNode([
            'type' => 'article',
            'promote' => 1,
        ]);
        // Now, on the front page, all article nodes should have contextual links
        // placeholders, as should the view that contains them.
        $id = 'node:node=' . $node1->id() . ':changed=' . $node1->getChangedTime() . '&langcode=en';
        // Editor user: can access contextual links and can edit articles.
        $this->drupalGet('node');
        $this->assertContextualLinkPlaceHolder($id);
        $http_client = $this->getHttpClient();
        $url = Url::fromRoute('contextual.render', [], [
            'query' => [
                '_format' => 'json',
                'destination' => 'node',
            ],
        ])->setAbsolute()
            ->toString();
        $response = $http_client->request('POST', $url, [
            'cookies' => $this->getSessionCookies(),
            'form_params' => [
                'ids' => [
                    $id,
                ],
                'tokens' => [],
            ],
            'http_errors' => FALSE,
        ]);
        $this->assertEquals('400', $response->getStatusCode());
        $this->assertStringContainsString('No contextual ID tokens specified.', (string) $response->getBody());
        $response = $http_client->request('POST', $url, [
            'cookies' => $this->getSessionCookies(),
            'form_params' => [
                'ids' => [
                    $id,
                ],
                'tokens' => [
                    'wrong_token',
                ],
            ],
            'http_errors' => FALSE,
        ]);
        $this->assertEquals('400', $response->getStatusCode());
        $this->assertStringContainsString('Invalid contextual ID specified.', (string) $response->getBody());
        $response = $http_client->request('POST', $url, [
            'cookies' => $this->getSessionCookies(),
            'form_params' => [
                'ids' => [
                    $id,
                ],
                'tokens' => [
                    'wrong_key' => $this->createContextualIdToken($id),
                ],
            ],
            'http_errors' => FALSE,
        ]);
        $this->assertEquals('400', $response->getStatusCode());
        $this->assertStringContainsString('Invalid contextual ID specified.', (string) $response->getBody());
        $response = $http_client->request('POST', $url, [
            'cookies' => $this->getSessionCookies(),
            'form_params' => [
                'ids' => [
                    $id,
                ],
                'tokens' => [
                    $this->createContextualIdToken($id),
                ],
            ],
            'http_errors' => FALSE,
        ]);
        $this->assertEquals('200', $response->getStatusCode());
    }
    
    /**
     * Asserts that a contextual link placeholder with the given id exists.
     *
     * @param string $id
     *   A contextual link id.
     */
    protected function assertContextualLinkPlaceHolder($id) {
        $this->assertSession()
            ->elementAttributeContains('css', 'div[data-contextual-id="' . $id . '"]', 'data-contextual-token', $this->createContextualIdToken($id));
    }
    
    /**
     * Asserts that a contextual link placeholder with the given id does not exist.
     *
     * @param string $id
     *   A contextual link id.
     */
    protected function assertNoContextualLinkPlaceHolder($id) {
        $this->assertSession()
            ->elementNotExists('css', 'div[data-contextual-id="' . $id . '"]');
    }
    
    /**
     * Get server-rendered contextual links for the given contextual link ids.
     *
     * @param array $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 \Psr\Http\Message\ResponseInterface
     *   The response object.
     */
    protected function renderContextualLinks($ids, $current_path) {
        $tokens = array_map([
            $this,
            'createContextualIdToken',
        ], $ids);
        $http_client = $this->getHttpClient();
        $url = Url::fromRoute('contextual.render', [], [
            'query' => [
                '_format' => 'json',
                'destination' => $current_path,
            ],
        ]);
        return $http_client->request('POST', $this->buildUrl($url), [
            'cookies' => $this->getSessionCookies(),
            'form_params' => [
                'ids' => $ids,
                'tokens' => $tokens,
            ],
            'http_errors' => FALSE,
        ]);
    }
    
    /**
     * Creates a contextual ID token.
     *
     * @param string $id
     *   The contextual ID to create a token for.
     *
     * @return string
     *   The contextual ID token.
     */
    protected function createContextualIdToken($id) {
        return Crypt::hmacBase64($id, Settings::getHashSalt() . $this->container
            ->get('private_key')
            ->get());
    }

}

Members

Title 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
ContextualDynamicContextTest::$anonymousUser protected property A simulated anonymous user with access only to node content.
ContextualDynamicContextTest::$authenticatedUser protected property An authenticated user with permission to access contextual links.
ContextualDynamicContextTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ContextualDynamicContextTest::$editorUser protected property A user with permission to access contextual links and edit content.
ContextualDynamicContextTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
ContextualDynamicContextTest::assertContextualLinkPlaceHolder protected function Asserts that a contextual link placeholder with the given id exists.
ContextualDynamicContextTest::assertNoContextualLinkPlaceHolder protected function Asserts that a contextual link placeholder with the given id does not exist.
ContextualDynamicContextTest::createContextualIdToken protected function Creates a contextual ID token.
ContextualDynamicContextTest::renderContextualLinks protected function Get server-rendered contextual links for the given contextual link ids.
ContextualDynamicContextTest::setUp protected function Overrides BrowserTestBase::setUp
ContextualDynamicContextTest::testDifferentPermissions public function Tests contextual links with different permissions.
ContextualDynamicContextTest::testTokenProtection public function Tests the contextual placeholder content is protected by a token.
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
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.