class SecurityAdvisoryTest

Same name in this branch
  1. 9 core/modules/system/tests/src/Unit/SecurityAdvisories/SecurityAdvisoryTest.php \Drupal\Tests\system\Unit\SecurityAdvisories\SecurityAdvisoryTest
Same name in other branches
  1. 10 core/modules/system/tests/src/Unit/SecurityAdvisories/SecurityAdvisoryTest.php \Drupal\Tests\system\Unit\SecurityAdvisories\SecurityAdvisoryTest
  2. 10 core/modules/system/tests/src/Functional/SecurityAdvisories/SecurityAdvisoryTest.php \Drupal\Tests\system\Functional\SecurityAdvisories\SecurityAdvisoryTest
  3. 11.x core/modules/system/tests/src/Unit/SecurityAdvisories/SecurityAdvisoryTest.php \Drupal\Tests\system\Unit\SecurityAdvisories\SecurityAdvisoryTest
  4. 11.x core/modules/system/tests/src/Functional/SecurityAdvisories/SecurityAdvisoryTest.php \Drupal\Tests\system\Functional\SecurityAdvisories\SecurityAdvisoryTest

Tests of security advisories functionality.

@group system

Hierarchy

Expanded class hierarchy of SecurityAdvisoryTest

File

core/modules/system/tests/src/Functional/SecurityAdvisories/SecurityAdvisoryTest.php, line 15

Namespace

Drupal\Tests\system\Functional\SecurityAdvisories
View source
class SecurityAdvisoryTest extends BrowserTestBase {
    use CronRunTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'generic_module1_test',
        'advisory_feed_test',
    ];
    
    /**
     * A user with permission to administer site configuration and updates.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $user;
    
    /**
     * A test PSA endpoint that will display both PSA and non-PSA advisories.
     *
     * @var string
     */
    protected $workingEndpointMixed;
    
    /**
     * A test PSA endpoint that will only display PSA advisories.
     *
     * @var string
     */
    protected $workingEndpointPsaOnly;
    
    /**
     * A test PSA endpoint that will only display non-PSA advisories.
     *
     * @var string
     */
    protected $workingEndpointNonPsaOnly;
    
    /**
     * A non-working test PSA endpoint.
     *
     * @var string
     */
    protected $nonWorkingEndpoint;
    
    /**
     * A test PSA endpoint that returns invalid JSON.
     *
     * @var string
     */
    protected $invalidJsonEndpoint;
    
    /**
     * The key/value store.
     *
     * @var \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface
     */
    protected $tempStore;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->user = $this->drupalCreateUser([
            'access administration pages',
            'administer site configuration',
            'administer software updates',
        ]);
        $this->drupalLogin($this->user);
        $fixtures_path = $this->baseUrl . '/core/modules/system/tests/fixtures/psa_feed';
        $this->workingEndpointMixed = $this->buildUrl('/advisory-feed-json/valid-mixed');
        $this->workingEndpointPsaOnly = $this->buildUrl('/advisory-feed-json/valid-psa-only');
        $this->workingEndpointNonPsaOnly = $this->buildUrl('/advisory-feed-json/valid-non-psa-only');
        $this->nonWorkingEndpoint = $this->buildUrl('/advisory-feed-json/missing');
        $this->invalidJsonEndpoint = "{$fixtures_path}/invalid.json";
        $this->tempStore = $this->container
            ->get('keyvalue.expirable')
            ->get('system');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function writeSettings(array $settings) : void {
        // Unset 'system.advisories' to allow testing enabling and disabling this
        // setting.
        unset($settings['config']['system.advisories']);
        parent::writeSettings($settings);
    }
    
    /**
     * Tests that a security advisory is displayed.
     */
    public function testPsa() : void {
        $assert = $this->assertSession();
        // Setup test PSA endpoint.
        AdvisoriesTestHttpClient::setTestEndpoint($this->workingEndpointMixed);
        $mixed_advisory_links = [
            'Critical Release - SA-2019-02-19',
            'Critical Release - PSA-Really Old',
            // The info for the test modules 'generic_module1_test' and
            // 'generic_module2_test' are altered for this test so match the items in
            // the test json feeds.
            // @see advisory_feed_test_system_info_alter()
'Generic Module1 Project - Moderately critical - Access bypass - SA-CONTRIB-2019-02-02',
            'Generic Module2 project - Moderately critical - Access bypass - SA-CONTRIB-2019-02-02',
        ];
        // Confirm that links are not displayed if they are enabled.
        $this->config('system.advisories')
            ->set('enabled', FALSE)
            ->save();
        $this->assertAdvisoriesNotDisplayed($mixed_advisory_links);
        $this->config('system.advisories')
            ->set('enabled', TRUE)
            ->save();
        // A new request for the JSON feed will not be made on admin pages besides
        // the status report.
        $this->assertAdvisoriesNotDisplayed($mixed_advisory_links, [
            'system.admin',
        ]);
        // If both PSA and non-PSA advisories are displayed they should be displayed
        // as errors.
        $this->assertStatusReportLinks($mixed_advisory_links, REQUIREMENT_ERROR);
        // The advisories will be displayed on admin pages if the response was
        // stored from the status report request.
        $this->assertAdminPageLinks($mixed_advisory_links, REQUIREMENT_ERROR);
        // Confirm that a user without the correct permission will not see the
        // advisories on admin pages.
        $this->drupalLogin($this->drupalCreateUser([
            'access administration pages',
        ]));
        $this->assertAdvisoriesNotDisplayed($mixed_advisory_links, [
            'system.admin',
        ]);
        // Log back in with user with permission to see the advisories.
        $this->drupalLogin($this->user);
        // Test cache.
        AdvisoriesTestHttpClient::setTestEndpoint($this->nonWorkingEndpoint);
        $this->assertAdminPageLinks($mixed_advisory_links, REQUIREMENT_ERROR);
        $this->assertStatusReportLinks($mixed_advisory_links, REQUIREMENT_ERROR);
        // Tests transmit errors with a JSON endpoint.
        $this->tempStore
            ->delete('advisories_response');
        $this->assertAdvisoriesNotDisplayed($mixed_advisory_links);
        // Test that the site status report displays an error.
        $this->drupalGet(Url::fromRoute('system.status'));
        $assert->pageTextContains('Failed to fetch security advisory data:');
        // Test a PSA endpoint that returns invalid JSON.
        AdvisoriesTestHttpClient::setTestEndpoint($this->invalidJsonEndpoint, TRUE);
        // Assert that are no logged error messages before attempting to fetch the
        // invalid endpoint.
        $this->assertServiceAdvisoryLoggedErrors([]);
        // On admin pages no message should be displayed if the feed is malformed.
        $this->assertAdvisoriesNotDisplayed($mixed_advisory_links);
        // Assert that there was an error logged for the invalid endpoint.
        $this->assertServiceAdvisoryLoggedErrors([
            'The security advisory JSON feed from Drupal.org could not be decoded.',
        ]);
        // On the status report there should be no announcements section.
        $this->drupalGet(Url::fromRoute('system.status'));
        $assert->pageTextNotContains('Failed to fetch security advisory data:');
        // Assert the error was logged again.
        $this->assertServiceAdvisoryLoggedErrors([
            'The security advisory JSON feed from Drupal.org could not be decoded.',
        ]);
        AdvisoriesTestHttpClient::setTestEndpoint($this->workingEndpointPsaOnly, TRUE);
        $psa_advisory_links = [
            'Critical Release - PSA-Really Old',
            'Generic Module2 project - Moderately critical - Access bypass - SA-CONTRIB-2019-02-02',
        ];
        // Admin page will not display the new links because a new feed request is
        // not attempted.
        $this->assertAdvisoriesNotDisplayed($psa_advisory_links, [
            'system.admin',
        ]);
        // If only PSA advisories are displayed they should be displayed as
        // warnings.
        $this->assertStatusReportLinks($psa_advisory_links, REQUIREMENT_WARNING);
        $this->assertAdminPageLinks($psa_advisory_links, REQUIREMENT_WARNING);
        AdvisoriesTestHttpClient::setTestEndpoint($this->workingEndpointNonPsaOnly, TRUE);
        $non_psa_advisory_links = [
            'Critical Release - SA-2019-02-19',
            'Generic Module1 Project - Moderately critical - Access bypass - SA-CONTRIB-2019-02-02',
        ];
        // If only non-PSA advisories are displayed they should be displayed as
        // errors.
        $this->assertStatusReportLinks($non_psa_advisory_links, REQUIREMENT_ERROR);
        $this->assertAdminPageLinks($non_psa_advisory_links, REQUIREMENT_ERROR);
        // Confirm that advisory fetching can be disabled after enabled.
        $this->config('system.advisories')
            ->set('enabled', FALSE)
            ->save();
        $this->assertAdvisoriesNotDisplayed($non_psa_advisory_links);
        // Assert no other errors were logged.
        $this->assertServiceAdvisoryLoggedErrors([]);
    }
    
    /**
     * Asserts the correct links appear on an admin page.
     *
     * @param string[] $expected_link_texts
     *   The expected links' text.
     * @param int $error_or_warning
     *   Whether the links are a warning or an error. Should be one of the REQUIREMENT_* constants.
     *
     * @internal
     */
    private function assertAdminPageLinks(array $expected_link_texts, int $error_or_warning) : void {
        $assert = $this->assertSession();
        $this->drupalGet(Url::fromRoute('system.admin'));
        if ($error_or_warning === REQUIREMENT_ERROR) {
            $assert->pageTextContainsOnce('Error message');
            $assert->pageTextNotContains('Warning message');
        }
        else {
            $assert->pageTextNotContains('Error message');
            $assert->pageTextContainsOnce('Warning message');
        }
        foreach ($expected_link_texts as $expected_link_text) {
            $assert->linkExists($expected_link_text);
        }
    }
    
    /**
     * Asserts the correct links appear on the status report page.
     *
     * @param string[] $expected_link_texts
     *   The expected links' text.
     * @param int $error_or_warning
     *   Whether the links are a warning or an error. Should be one of the REQUIREMENT_* constants.
     *
     * @internal
     */
    private function assertStatusReportLinks(array $expected_link_texts, int $error_or_warning) : void {
        $this->drupalGet(Url::fromRoute('system.status'));
        $assert = $this->assertSession();
        $selector = 'h3#' . ($error_or_warning === REQUIREMENT_ERROR ? 'error' : 'warning') . ' ~ details.system-status-report__entry:contains("Critical security announcements")';
        $assert->elementExists('css', $selector);
        foreach ($expected_link_texts as $expected_link_text) {
            $assert->linkExists($expected_link_text);
        }
    }
    
    /**
     * Asserts that security advisory links are not shown on admin pages.
     *
     * @param array $links
     *   The advisory links.
     * @param array $routes
     *   The routes to test.
     *
     * @internal
     */
    private function assertAdvisoriesNotDisplayed(array $links, array $routes = [
        'system.status',
        'system.admin',
    ]) : void {
        foreach ($routes as $route) {
            $this->drupalGet(Url::fromRoute($route));
            $this->assertSession()
                ->statusCodeEquals(200);
            foreach ($links as $link) {
                $this->assertSession()
                    ->linkNotExists($link, "'{$link}' not displayed on route '{$route}'.");
            }
        }
    }
    
    /**
     * Asserts the expected error messages were logged on the system logger.
     *
     * The test module 'advisory_feed_test' must be installed to use this method.
     * The stored error messages are cleared during this method.
     *
     * @param string[] $expected_messages
     *   The expected error messages.
     *
     * @see \Drupal\advisory_feed_test\TestSystemLoggerChannel::log()
     *
     * @internal
     */
    protected function assertServiceAdvisoryLoggedErrors(array $expected_messages) : void {
        $state = $this->container
            ->get('state');
        $messages = $state->get('advisory_feed_test.error_messages', []);
        $this->assertSame($expected_messages, $messages);
        $state->set('advisory_feed_test.error_messages', []);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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 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 drupal_rewrite_settings().
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. 37
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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Simpletest site. 1
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::__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
CronRunTrait::cronRun protected function Runs cron on the test site.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
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. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$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. 1
SecurityAdvisoryTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
SecurityAdvisoryTest::$invalidJsonEndpoint protected property A test PSA endpoint that returns invalid JSON.
SecurityAdvisoryTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
SecurityAdvisoryTest::$nonWorkingEndpoint protected property A non-working test PSA endpoint.
SecurityAdvisoryTest::$tempStore protected property The key/value store.
SecurityAdvisoryTest::$user protected property A user with permission to administer site configuration and updates.
SecurityAdvisoryTest::$workingEndpointMixed protected property A test PSA endpoint that will display both PSA and non-PSA advisories.
SecurityAdvisoryTest::$workingEndpointNonPsaOnly protected property A test PSA endpoint that will only display non-PSA advisories.
SecurityAdvisoryTest::$workingEndpointPsaOnly protected property A test PSA endpoint that will only display PSA advisories.
SecurityAdvisoryTest::assertAdminPageLinks private function Asserts the correct links appear on an admin page.
SecurityAdvisoryTest::assertAdvisoriesNotDisplayed private function Asserts that security advisory links are not shown on admin pages.
SecurityAdvisoryTest::assertServiceAdvisoryLoggedErrors protected function Asserts the expected error messages were logged on the system logger.
SecurityAdvisoryTest::assertStatusReportLinks private function Asserts the correct links appear on the status report page.
SecurityAdvisoryTest::setUp protected function Overrides BrowserTestBase::setUp
SecurityAdvisoryTest::testPsa public function Tests that a security advisory is displayed.
SecurityAdvisoryTest::writeSettings protected function Rewrites the settings.php file of the test site. Overrides FunctionalTestSetupTrait::writeSettings
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.
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. 1
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. 1
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. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::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.