class UpdateSemverTestBase

Same name in other branches
  1. 10 core/modules/update/tests/src/Functional/UpdateSemverTestBase.php \Drupal\Tests\update\Functional\UpdateSemverTestBase
  2. 11.x core/modules/update/tests/src/Functional/UpdateSemverTestBase.php \Drupal\Tests\update\Functional\UpdateSemverTestBase

Common test methods for projects that use semver version releases.

For classes that extend this class, the XML fixtures they will start with ::$projectTitle.

@group update

Hierarchy

Expanded class hierarchy of UpdateSemverTestBase

File

core/modules/update/tests/src/Functional/UpdateSemverTestBase.php, line 17

Namespace

Drupal\Tests\update\Functional
View source
abstract class UpdateSemverTestBase extends UpdateTestBase {
    use CronRunTrait;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'update_test',
        'update',
        'language',
        'block',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The title of the project being tested.
     *
     * @var string
     */
    protected $projectTitle;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $admin_user = $this->drupalCreateUser([
            'administer site configuration',
            'view update notifications',
        ]);
        $this->drupalLogin($admin_user);
        $this->drupalPlaceBlock('local_actions_block');
    }
    
    /**
     * Tests the Update Manager module when no updates are available.
     *
     * The XML fixture file 'drupal.1.0.xml' which is one of the XML files this
     * test uses also contains 2 extra releases that are newer than '8.0.1'. These
     * releases will not show as available updates because of the following
     * reasons:
     * - '8.0.2' is an unpublished release.
     * - '8.0.3' is marked as 'Release type' 'Unsupported'.
     */
    public function testNoUpdatesAvailable() {
        foreach ([
            0,
            1,
        ] as $minor_version) {
            foreach ([
                0,
                1,
            ] as $patch_version) {
                foreach ([
                    '-alpha1',
                    '-beta1',
                    '',
                ] as $extra_version) {
                    $this->setProjectInstalledVersion("8.{$minor_version}.{$patch_version}" . $extra_version);
                    $this->refreshUpdateStatus([
                        $this->updateProject => "{$minor_version}.{$patch_version}" . $extra_version,
                    ]);
                    $this->standardTests();
                    // The XML test fixtures for this method all contain the '8.2.0'
                    // release but because '8.2.0' is not in a supported branch it will
                    // not be in the available updates.
                    $this->assertUpdateTableElementNotContains('8.2.0');
                    $this->assertUpdateTableTextContains('Up to date');
                    $this->assertUpdateTableTextNotContains('Update available');
                    $this->assertUpdateTableTextNotContains('Security update required!');
                    $this->assertUpdateTableElementContains('check.svg');
                }
            }
        }
    }
    
    /**
     * Tests the Update Manager module when one normal update is available.
     */
    public function testNormalUpdateAvailable() {
        $this->setProjectInstalledVersion('8.0.0');
        // Ensure that the update check requires a token.
        $this->drupalGet('admin/reports/updates/check');
        $this->assertSession()
            ->statusCodeEquals(403);
        foreach ([
            0,
            1,
        ] as $minor_version) {
            foreach ([
                '-alpha1',
                '-beta1',
                '',
            ] as $extra_version) {
                $full_version = "8.{$minor_version}.1{$extra_version}";
                $this->refreshUpdateStatus([
                    $this->updateProject => "{$minor_version}.1" . $extra_version,
                ]);
                $this->standardTests();
                $this->assertUpdateTableTextNotContains('Security update required!');
                // The XML test fixtures for this method all contain the '8.2.0' release
                // but because '8.2.0' is not in a supported branch it will not be in
                // the available updates.
                $this->assertSession()
                    ->responseNotContains('8.2.0');
                switch ($minor_version) {
                    case 0:
                        // Both stable and unstable releases are available.
                        // A stable release is the latest.
                        if ($extra_version == '') {
                            $this->assertUpdateTableTextNotContains('Up to date');
                            $this->assertUpdateTableTextContains('Update available');
                            $this->assertVersionUpdateLinks('Recommended version:', $full_version);
                            $this->assertUpdateTableTextNotContains('Latest version:');
                            $this->assertUpdateTableElementContains('warning.svg');
                        }
                        else {
                            $this->assertUpdateTableTextContains('Up to date');
                            $this->assertUpdateTableTextNotContains('Update available');
                            $this->assertUpdateTableTextNotContains('Recommended version:');
                            $this->assertVersionUpdateLinks('Latest version:', $full_version);
                            $this->assertUpdateTableElementContains('check.svg');
                        }
                        break;
                    case 1:
                        // Both stable and unstable releases are available.
                        // A stable release is the latest.
                        if ($extra_version == '') {
                            $this->assertUpdateTableTextNotContains('Up to date');
                            $this->assertUpdateTableTextContains('Update available');
                            $this->assertVersionUpdateLinks('Recommended version:', $full_version);
                            $this->assertUpdateTableTextNotContains('Latest version:');
                            $this->assertUpdateTableElementContains('warning.svg');
                        }
                        else {
                            $this->assertUpdateTableTextNotContains('Up to date');
                            $this->assertUpdateTableTextContains('Update available');
                            $this->assertVersionUpdateLinks('Recommended version:', '8.1.0');
                            $this->assertVersionUpdateLinks('Latest version:', $full_version);
                            $this->assertUpdateTableElementContains('warning.svg');
                        }
                        break;
                }
            }
        }
    }
    
    /**
     * Tests the Update Manager module when a major update is available.
     */
    public function testMajorUpdateAvailable() {
        foreach ([
            0,
            1,
        ] as $minor_version) {
            foreach ([
                0,
                1,
            ] as $patch_version) {
                foreach ([
                    '-alpha1',
                    '-beta1',
                    '',
                ] as $extra_version) {
                    $this->setProjectInstalledVersion("8.{$minor_version}.{$patch_version}" . $extra_version);
                    $this->refreshUpdateStatus([
                        $this->updateProject => '9',
                    ]);
                    $this->standardTests();
                    $this->assertUpdateTableTextNotContains('Security update required!');
                    $this->assertUpdateTableElementContains(Link::fromTextAndUrl('9.0.0', Url::fromUri("http://example.com/{$this->updateProject}-9-0-0-release"))
                        ->toString());
                    $this->assertUpdateTableElementContains(Link::fromTextAndUrl('Release notes', Url::fromUri("http://example.com/{$this->updateProject}-9-0-0-release"))
                        ->toString());
                    $this->assertUpdateTableTextNotContains('Up to date');
                    $this->assertUpdateTableTextContains('Not supported!');
                    $this->assertUpdateTableTextContains('Recommended version:');
                    $this->assertUpdateTableTextNotContains('Latest version:');
                    $this->assertUpdateTableElementContains('error.svg');
                }
            }
        }
    }
    
    /**
     * Tests the Update Manager module when a security update is available.
     *
     * @param string $site_patch_version
     *   The patch version to set the site to for testing.
     * @param string[] $expected_security_releases
     *   The security releases, if any, that the status report should recommend.
     * @param string $expected_update_message_type
     *   The type of update message expected.
     * @param string $fixture
     *   The test fixture that contains the test XML.
     *
     * @dataProvider securityUpdateAvailabilityProvider
     */
    public function testSecurityUpdateAvailability($site_patch_version, array $expected_security_releases, $expected_update_message_type, $fixture) {
        $this->setProjectInstalledVersion("8.{$site_patch_version}");
        $this->refreshUpdateStatus([
            $this->updateProject => $fixture,
        ]);
        $this->assertSecurityUpdates("{$this->updateProject}-8", $expected_security_releases, $expected_update_message_type, $this->updateTableLocator);
    }
    
    /**
     * Data provider method for testSecurityUpdateAvailability().
     *
     * These test cases rely on the following fixtures containing the following
     * releases:
     * - [::$updateProject].sec.0.1_0.2.xml
     *   - 8.0.2 Security update
     *   - 8.0.1 Security update, Insecure
     *   - 8.0.0 Insecure
     * - [::$updateProject].sec.0.2.xml
     *   - 8.0.2 Security update
     *   - 8.0.1 Insecure
     *   - 8.0.0 Insecure
     * - [::$updateProject].sec.2.0-rc2.xml
     *   - 8.2.0-rc2 Security update
     *   - 8.2.0-rc1 Insecure
     *   - 8.2.0-beta2 Insecure
     *   - 8.2.0-beta1 Insecure
     *   - 8.2.0-alpha2 Insecure
     *   - 8.2.0-alpha1 Insecure
     *   - 8.1.2 Security update
     *   - 8.1.1 Insecure
     *   - 8.1.0 Insecure
     *   - 8.0.2 Security update
     *   - 8.0.1 Insecure
     *   - 8.0.0 Insecure
     * - [::$updateProject].sec.1.2.xml
     *   - 8.1.2 Security update
     *   - 8.1.1 Insecure
     *   - 8.1.0 Insecure
     *   - 8.0.2
     *   - 8.0.1
     *   - 8.0.0
     * - [::$updateProject].sec.1.2_insecure.xml
     *   - 8.1.2 Security update
     *   - 8.1.1 Insecure
     *   - 8.1.0 Insecure
     *   - 8.0.2 Insecure
     *   - 8.0.1 Insecure
     *   - 8.0.0 Insecure
     * - [::$updateProject].sec.1.2_insecure-unsupported
     *   This file has the exact releases as
     *   [::$updateProject].sec.1.2_insecure.xml. It has a different value for
     *   'supported_branches' that does not contain '8.0.'. It is used to ensure
     *   that the "Security update required!" is displayed even if the currently
     *   installed version is in an unsupported branch.
     * - [::$updateProject].sec.2.0-rc2-b.xml
     *   - 8.2.0-rc2
     *   - 8.2.0-rc1
     *   - 8.2.0-beta2
     *   - 8.2.0-beta1
     *   - 8.2.0-alpha2
     *   - 8.2.0-alpha1
     *   - 8.1.2 Security update
     *   - 8.1.1 Insecure
     *   - 8.1.0 Insecure
     *   - 8.0.2 Security update
     *   - 8.0.1 Insecure
     *   - 8.0.0 Insecure
     */
    public function securityUpdateAvailabilityProvider() {
        $test_cases = [
            // Security release available for site minor release 0.
            // No releases for next minor.
'0.0, 0.2' => [
                'site_patch_version' => '0.0',
                'expected_security_releases' => [
                    '0.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.0.2',
            ],
            // Site on latest security release available for site minor release 0.
            // Minor release 1 also has a security release, and the current release
            // is marked as insecure.
'0.2, 0.2' => [
                'site_patch_version' => '0.2',
                'expected_security_release' => [
                    '1.2',
                    '2.0-rc2',
                ],
                'expected_update_message_type' => static::UPDATE_AVAILABLE,
                'fixture' => 'sec.2.0-rc2',
            ],
            // Two security releases available for site minor release 0.
            // 0.1 security release marked as insecure.
            // No releases for next minor.
'0.0, 0.1 0.2' => [
                'site_patch_version' => '0.0',
                'expected_security_releases' => [
                    '0.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.0.1_0.2',
            ],
            // Security release available for site minor release 1.
            // No releases for next minor.
'1.0, 1.2' => [
                'site_patch_version' => '1.0',
                'expected_security_releases' => [
                    '1.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.1.2',
            ],
            // Security release available for site minor release 0.
            // Security release also available for next minor.
'0.0, 0.2 1.2' => [
                'site_patch_version' => '0.0',
                'expected_security_releases' => [
                    '0.2',
                    '1.2',
                    '2.0-rc2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.2.0-rc2',
            ],
            // No newer security release for site minor 1.
            // Previous minor has security release.
'1.2, 0.2 1.2' => [
                'site_patch_version' => '1.2',
                'expected_security_releases' => [],
                'expected_update_message_type' => static::UPDATE_NONE,
                'fixture' => 'sec.2.0-rc2',
            ],
            // No security release available for site minor release 0.
            // Security release available for next minor.
'0.0, 1.2, insecure' => [
                'site_patch_version' => '0.0',
                'expected_security_releases' => [
                    '1.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.1.2_insecure',
            ],
            // No security release available for site minor release 0.
            // Site minor is not a supported branch.
            // Security release available for next minor.
'0.0, 1.2, insecure-unsupported' => [
                'site_patch_version' => '0.0',
                'expected_security_releases' => [
                    '1.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.1.2_insecure-unsupported',
            ],
            // All releases for minor 0 are secure.
            // Security release available for next minor.
'0.0, 1.2, secure' => [
                'site_patch_version' => '0.0',
                'expected_security_release' => [
                    '1.2',
                ],
                'expected_update_message_type' => static::UPDATE_AVAILABLE,
                'fixture' => 'sec.1.2',
            ],
            '0.2, 1.2, secure' => [
                'site_patch_version' => '0.2',
                'expected_security_release' => [
                    '1.2',
                ],
                'expected_update_message_type' => static::UPDATE_AVAILABLE,
                'fixture' => 'sec.1.2',
            ],
            // Site on 2.0-rc2 which is a security release.
'2.0-rc2, 0.2 1.2' => [
                'site_patch_version' => '2.0-rc2',
                'expected_security_releases' => [],
                'expected_update_message_type' => static::UPDATE_NONE,
                'fixture' => 'sec.2.0-rc2',
            ],
            // Ensure that 8.0.2 security release is not shown because it is earlier
            // version than 1.0.
'1.0, 0.2 1.2' => [
                'site_patch_version' => '1.0',
                'expected_security_releases' => [
                    '1.2',
                    '2.0-rc2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.2.0-rc2',
            ],
        ];
        $pre_releases = [
            '2.0-alpha1',
            '2.0-alpha2',
            '2.0-beta1',
            '2.0-beta2',
            '2.0-rc1',
            '2.0-rc2',
        ];
        foreach ($pre_releases as $pre_release) {
            // If the site is on an alpha/beta/RC of an upcoming minor and none of the
            // alpha/beta/RC versions are marked insecure, no security update should
            // be required.
            $test_cases["Pre-release:{$pre_release}, no security update"] = [
                'site_patch_version' => $pre_release,
                'expected_security_releases' => [],
                'expected_update_message_type' => $pre_release === '2.0-rc2' ? static::UPDATE_NONE : static::UPDATE_AVAILABLE,
                'fixture' => 'sec.2.0-rc2-b',
            ];
            // If the site is on an alpha/beta/RC of an upcoming minor and there is
            // an RC version with a security update, it should be recommended.
            $test_cases["Pre-release:{$pre_release}, security update"] = [
                'site_patch_version' => $pre_release,
                'expected_security_releases' => $pre_release === '2.0-rc2' ? [] : [
                    '2.0-rc2',
                ],
                'expected_update_message_type' => $pre_release === '2.0-rc2' ? static::UPDATE_NONE : static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.2.0-rc2',
            ];
        }
        return $test_cases;
    }
    
    /**
     * Tests messages when a project release is unpublished.
     *
     * This test confirms that revoked messages are displayed regardless of
     * whether the installed version is in a supported branch or not. This test
     * relies on 2 test XML fixtures that are identical except for the
     * 'supported_branches' value:
     * - [::$updateProject].1.0.xml
     *    'supported_branches' is '8.0.,8.1.'.
     * - [::$updateProject].1.0-unsupported.xml
     *    'supported_branches' is '8.1.'.
     * They both have an '8.0.2' release that is unpublished and an '8.1.0'
     * release that is published and is the expected update.
     */
    public function testRevokedRelease() {
        foreach ([
            '1.0',
            '1.0-unsupported',
        ] as $fixture) {
            $this->setProjectInstalledVersion('8.0.2');
            $this->refreshUpdateStatus([
                $this->updateProject => $fixture,
            ]);
            $this->standardTests();
            $this->confirmRevokedStatus('8.0.2', '8.1.0', 'Recommended version:');
        }
    }
    
    /**
     * Tests messages when a project release is marked unsupported.
     *
     * This test confirms unsupported messages are displayed regardless of whether
     * the installed version is in a supported branch or not. This test relies on
     * 2 test XML fixtures that are identical except for the 'supported_branches'
     * value:
     * - [::$updateProject].1.0.xml
     *    'supported_branches' is '8.0.,8.1.'.
     * - [::$updateProject].1.0-unsupported.xml
     *    'supported_branches' is '8.1.'.
     * They both have an '8.0.3' release that has the 'Release type' value of
     * 'unsupported' and an '8.1.0' release that has the 'Release type' value of
     * 'supported' and is the expected update.
     */
    public function testUnsupportedRelease() {
        foreach ([
            '1.0',
            '1.0-unsupported',
        ] as $fixture) {
            $this->setProjectInstalledVersion('8.0.3');
            $this->refreshUpdateStatus([
                $this->updateProject => $fixture,
            ]);
            $this->standardTests();
            $this->confirmUnsupportedStatus('8.0.3', '8.1.0', 'Recommended version:');
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function refreshUpdateStatus($xml_map, $url = 'update-test') {
        if (!isset($xml_map['drupal'])) {
            $xml_map['drupal'] = '0.0';
        }
        parent::refreshUpdateStatus($xml_map, $url);
    }
    
    /**
     * Sets the project installed version.
     *
     * @param string $version
     *   The version number.
     */
    protected abstract function setProjectInstalledVersion($version);

}

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.
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
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
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.
UpdateSemverTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
UpdateSemverTestBase::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules 1
UpdateSemverTestBase::$projectTitle protected property The title of the project being tested. 2
UpdateSemverTestBase::refreshUpdateStatus protected function Refreshes the update status based on the desired available update scenario. Overrides UpdateTestBase::refreshUpdateStatus
UpdateSemverTestBase::securityUpdateAvailabilityProvider public function Data provider method for testSecurityUpdateAvailability().
UpdateSemverTestBase::setProjectInstalledVersion abstract protected function Sets the project installed version. 2
UpdateSemverTestBase::setUp protected function Overrides BrowserTestBase::setUp
UpdateSemverTestBase::testMajorUpdateAvailable public function Tests the Update Manager module when a major update is available.
UpdateSemverTestBase::testNormalUpdateAvailable public function Tests the Update Manager module when one normal update is available.
UpdateSemverTestBase::testNoUpdatesAvailable public function Tests the Update Manager module when no updates are available.
UpdateSemverTestBase::testRevokedRelease public function Tests messages when a project release is unpublished.
UpdateSemverTestBase::testSecurityUpdateAvailability public function Tests the Update Manager module when a security update is available.
UpdateSemverTestBase::testUnsupportedRelease public function Tests messages when a project release is marked unsupported.
UpdateTestBase::$updateProject protected property The project that is being tested. 3
UpdateTestBase::$updateTableLocator protected property The CSS locator for the update table run asserts on. 3
UpdateTestBase::assertSecurityUpdates protected function Asserts the expected security updates are displayed correctly on the page.
UpdateTestBase::assertUpdateTableElementContains protected function Asserts that the update table element HTML contains the specified text.
UpdateTestBase::assertUpdateTableElementNotContains protected function Asserts that the update table element HTML contains the specified text.
UpdateTestBase::assertUpdateTableTextContains protected function Asserts that the update table text contains the specified text.
UpdateTestBase::assertUpdateTableTextNotContains protected function Asserts that the update table text does not contain the specified text.
UpdateTestBase::assertVersionUpdateLinks protected function Asserts that an update version has the correct links.
UpdateTestBase::confirmRevokedStatus protected function Confirms messages are correct when a release has been unpublished/revoked.
UpdateTestBase::confirmUnsupportedStatus protected function Confirms messages are correct when a release has been marked unsupported.
UpdateTestBase::findUpdateElementByLabel protected function Finds an update page element by label.
UpdateTestBase::SECURITY_UPDATE_REQUIRED constant Denotes a security update will be required in the test case.
UpdateTestBase::standardTests protected function Runs a series of assertions that are applicable to all update statuses.
UpdateTestBase::UPDATE_AVAILABLE constant Denotes an update will be available in the test case.
UpdateTestBase::UPDATE_NONE constant Denotes no update will be available in the test case.
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.