class UpdateSemverCoreTest

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

Tests the semantic version handling in the Update Manager.

@group update

Hierarchy

Expanded class hierarchy of UpdateSemverCoreTest

File

core/modules/update/tests/src/Functional/UpdateSemverCoreTest.php, line 12

Namespace

Drupal\Tests\update\Functional
View source 
class UpdateSemverCoreTest extends UpdateSemverTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $updateTableLocator = 'table.update';
    
    /**
     * {@inheritdoc}
     */
    protected $updateProject = 'drupal';
    
    /**
     * {@inheritdoc}
     */
    protected $projectTitle = 'Drupal';
    
    /**
     * Sets the version to x.x.x when no project-specific mapping is defined.
     *
     * @param string $version
     *   The version.
     */
    protected function setProjectInstalledVersion($version) {
        $setting = [
            '#all' => [
                'version' => $version,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $setting)
            ->save();
    }
    
    /**
     * Tests the security coverage messages for Drupal core versions.
     *
     * @param string $installed_version
     *   The installed Drupal version to test.
     * @param string $fixture
     *   The test fixture that contains the test XML.
     * @param string $requirements_section_heading
     *   The requirements section heading.
     * @param string $message
     *   The expected coverage message.
     * @param string $mock_date
     *   The mock date to use if needed in the format CCYY-MM-DD. If an empty
     *   string is provided, no mock date will be used.
     *
     * @dataProvider securityCoverageMessageProvider
     */
    public function testSecurityCoverageMessage($installed_version, $fixture, $requirements_section_heading, $message, $mock_date) {
        \Drupal::state()->set('update_test.mock_date', $mock_date);
        $this->setProjectInstalledVersion($installed_version);
        $this->refreshUpdateStatus([
            'drupal' => $fixture,
        ]);
        $this->drupalGet('admin/reports/status');
        if (empty($requirements_section_heading)) {
            $this->assertSession()
                ->pageTextNotContains('Drupal core security coverage');
            return;
        }
        $all_requirements_details = $this->getSession()
            ->getPage()
            ->findAll('css', 'details.system-status-report__entry:contains("Drupal core security coverage")');
        // Ensure we only have 1 security message section.
        $this->assertCount(1, $all_requirements_details);
        $requirements_details = $all_requirements_details[0];
        // Ensure that messages are under the correct heading which could be
        // 'Checked', 'Warnings found', or 'Errors found'.
        $requirements_section_element = $requirements_details->getParent();
        $this->assertCount(1, $requirements_section_element->findAll('css', "h3:contains('{$requirements_section_heading}')"));
        $actual_message = $requirements_details->find('css', 'div.system-status-report__entry__value')
            ->getText();
        $this->assertNotEmpty($actual_message);
        $this->assertEquals($message, $actual_message);
    }
    
    /**
     * Data provider for testSecurityCoverageMessage().
     *
     * These test cases rely on the following fixtures containing the following
     * releases:
     * - drupal.sec.2.0_3.0-rc1.xml
     *   - 8.2.0
     *   - 8.3.0-rc1
     * - drupal.sec.2.0.xml
     *   - 8.2.0
     * - drupal.sec.2.0_9.0.0.xml
     *   - 8.2.0
     *   - 9.0.0
     * - drupal.sec.9.5.0.xml
     *   - 9.4.0
     *   - 9.5.0
     * - drupal.sec.10.5.0.xml
     *   - 10.4.0
     *   - 10.5.0
     */
    public function securityCoverageMessageProvider() {
        $release_coverage_message = 'Visit the release cycle overview for more information on supported releases.';
        $coverage_ended_message = 'Coverage has ended';
        $update_asap_message = 'Update to a supported minor as soon as possible to continue receiving security updates.';
        $update_soon_message = 'Update to a supported minor version soon to continue receiving security updates.';
        $test_cases = [
            '8.0.0, unsupported' => [
                'installed_version' => '8.0.0',
                'fixture' => 'sec.2.0_3.0-rc1',
                'requirements_section_heading' => 'Errors found',
                'message' => "{$coverage_ended_message} {$update_asap_message} {$release_coverage_message}",
                'mock_date' => '',
            ],
            '8.1.0, supported with 3rc' => [
                'installed_version' => '8.1.0',
                'fixture' => 'sec.2.0_3.0-rc1',
                'requirements_section_heading' => 'Warnings found',
                'message' => "Covered until 8.3.0 Update to 8.2 or higher soon to continue receiving security updates. {$release_coverage_message}",
                'mock_date' => '',
            ],
            '8.1.0, supported' => [
                'installed_version' => '8.1.0',
                'fixture' => 'sec.2.0',
                'requirements_section_heading' => 'Warnings found',
                'message' => "Covered until 8.3.0 Update to 8.2 or higher soon to continue receiving security updates. {$release_coverage_message}",
                'mock_date' => '',
            ],
            '8.2.0, supported with 3rc' => [
                'installed_version' => '8.2.0',
                'fixture' => 'sec.2.0_3.0-rc1',
                'requirements_section_heading' => 'Checked',
                'message' => "Covered until 8.4.0 {$release_coverage_message}",
                'mock_date' => '',
            ],
            '8.2.0, supported' => [
                'installed_version' => '8.2.0',
                'fixture' => 'sec.2.0',
                'requirements_section_heading' => 'Checked',
                'message' => "Covered until 8.4.0 {$release_coverage_message}",
                'mock_date' => '',
            ],
            // Ensure we don't show messages for pre-release or dev versions.
'8.2.0-beta2, no message' => [
                'installed_version' => '8.2.0-beta2',
                'fixture' => 'sec.2.0_3.0-rc1',
                'requirements_section_heading' => '',
                'message' => '',
                'mock_date' => '',
            ],
            '8.1.0-dev, no message' => [
                'installed_version' => '8.1.0-dev',
                'fixture' => 'sec.2.0_3.0-rc1',
                'requirements_section_heading' => '',
                'message' => '',
                'mock_date' => '',
            ],
            // Ensures the message is correct if the next major version has been
            // released and the additional minors indicated by
            // CORE_MINORS_WITH_SECURITY_COVERAGE minors have been released.
'8.0.0, 9 unsupported' => [
                'installed_version' => '8.0.0',
                'fixture' => 'sec.2.0_9.0.0',
                'requirements_section_heading' => 'Errors found',
                'message' => "{$coverage_ended_message} {$update_asap_message} {$release_coverage_message}",
                'mock_date' => '',
            ],
            // Ensures the message is correct if the next major version has been
            // released and the additional minors indicated by
            // CORE_MINORS_WITH_SECURITY_COVERAGE minors have not been released.
'8.2.0, 9 warning' => [
                'installed_version' => '8.2.0',
                'fixture' => 'sec.2.0_9.0.0',
                'requirements_section_heading' => 'Warnings found',
                'message' => "Covered until 8.4.0 Update to 8.3 or higher soon to continue receiving security updates. {$release_coverage_message}",
                'mock_date' => '',
            ],
        ];
        // Drupal 9.4.x test cases.
        $test_cases += [
            // Ensure that a message is displayed during 9.4's active support.
'9.4.0, supported' => [
                'installed_version' => '9.4.0',
                'fixture' => 'sec.9.5.0',
                'requirements_section_heading' => 'Checked',
                'message' => "Covered until 2023-Jun-21 {$release_coverage_message}",
                'mock_date' => '2022-12-13',
            ],
            // Ensure a warning is displayed if less than six months remain until the
            // end of 9.4's security coverage.
'9.4.0, supported, 6 months warn' => [
                'installed_version' => '9.4.0',
                'fixture' => 'sec.9.5.0',
                'requirements_section_heading' => 'Warnings found',
                'message' => "Covered until 2023-Jun-21 {$update_soon_message} {$release_coverage_message}",
                'mock_date' => '2022-12-14',
            ],
        ];
        // Ensure that the message does not change, including on the last day of
        // security coverage.
        $test_cases['9.4.0, supported, last day warn'] = $test_cases['9.4.0, supported, 6 months warn'];
        $test_cases['9.4.0, supported, last day warn']['mock_date'] = '2023-06-20';
        // Ensure that if the 9.4 support window is finished a message is
        // displayed.
        $test_cases['9.4.0, support over'] = [
            'installed_version' => '9.4.0',
            'fixture' => 'sec.9.5.0',
            'requirements_section_heading' => 'Errors found',
            'message' => "{$coverage_ended_message} {$update_asap_message} {$release_coverage_message}",
            'mock_date' => '2023-06-22',
        ];
        // Drupal 9.5 test cases.
        $test_cases['9.5.0, supported'] = [
            'installed_version' => '9.5.0',
            'fixture' => 'sec.9.5.0',
            'requirements_section_heading' => 'Checked',
            'message' => "Covered until 2023-Nov {$release_coverage_message}",
            'mock_date' => '2023-01-01',
        ];
        // Ensure a warning is displayed if less than six months remain until the
        // end of 9.5's security coverage.
        $test_cases['9.5.0, supported, 6 months warn'] = [
            'installed_version' => '9.5.0',
            'fixture' => 'sec.9.5.0',
            'requirements_section_heading' => 'Warnings found',
            'message' => "Covered until 2023-Nov {$update_soon_message} {$release_coverage_message}",
            'mock_date' => '2023-05-15',
        ];
        // Ensure that the message does not change, including on the last day of
        // security coverage.
        $test_cases['9.5.0, supported, last day warn'] = $test_cases['9.5.0, supported, 6 months warn'];
        $test_cases['9.5.0, supported, last day warn']['mock_date'] = '2023-10-31';
        // Ensure that if the support window is finished a message is displayed.
        $test_cases['9.5.0, support over'] = [
            'installed_version' => '9.5.0',
            'fixture' => 'sec.9.5.0',
            'requirements_section_heading' => 'Errors found',
            'message' => "{$coverage_ended_message} {$update_asap_message} {$release_coverage_message}",
            'mock_date' => '2023-11-01',
        ];
        // Drupal 9 test cases.
        $test_cases += [
            // Ensure the end dates for 9.4 and 9.5 only apply to major version 9.
'10.5.0' => [
                'installed_version' => '10.5.0',
                'fixture' => 'sec.10.5.0',
                'requirements_section_heading' => 'Checked',
                'message' => "Covered until 10.7.0 {$release_coverage_message}",
                'mock_date' => '',
            ],
            '10.4.0' => [
                'installed_version' => '10.4.0',
                'fixture' => 'sec.10.5.0',
                'requirements_section_heading' => 'Warnings found',
                'message' => "Covered until 10.6.0 Update to 10.5 or higher soon to continue receiving security updates. {$release_coverage_message}",
                'mock_date' => '',
            ],
        ];
        return $test_cases;
    }
    
    /**
     * Ensures proper results where there are date mismatches among modules.
     */
    public function testDatestampMismatch() {
        $system_info = [
            '#all' => [
                // We need to think we're running a -dev snapshot to see dates.
'version' => '8.1.0-dev',
                'datestamp' => time(),
            ],
            'block' => [
                // This is 2001-09-09 01:46:40 GMT, so test for "2001-Sep-".
'datestamp' => '1000000000',
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => 'dev',
        ]);
        $this->assertSession()
            ->pageTextNotContains('2001-Sep-');
        $this->assertSession()
            ->pageTextContains('Up to date');
        $this->assertSession()
            ->pageTextNotContains('Update available');
        $this->assertSession()
            ->pageTextNotContains('Security update required!');
    }
    
    /**
     * Checks that running cron updates the list of available updates.
     */
    public function testModulePageRunCron() {
        $this->setProjectInstalledVersion('8.0.0');
        $this->config('update.settings')
            ->set('fetch.url', Url::fromRoute('update_test.update_test')->setAbsolute()
            ->toString())
            ->save();
        $this->config('update_test.settings')
            ->set('xml_map', [
            'drupal' => '0.0',
        ])
            ->save();
        $this->cronRun();
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->pageTextNotContains('No update information available.');
    }
    
    /**
     * Checks that clearing the disk cache works.
     */
    public function testClearDiskCache() {
        $directories = [
            _update_manager_cache_directory(FALSE),
            _update_manager_extract_directory(FALSE),
        ];
        // Check that update directories does not exists.
        foreach ($directories as $directory) {
            $this->assertDirectoryDoesNotExist($directory);
        }
        // Method must not fail if update directories do not exists.
        update_clear_update_disk_cache();
    }
    
    /**
     * Checks the messages at admin/modules when the site is up to date.
     */
    public function testModulePageUpToDate() {
        $this->setProjectInstalledVersion('8.0.0');
        // Instead of using refreshUpdateStatus(), set these manually.
        $this->config('update.settings')
            ->set('fetch.url', Url::fromRoute('update_test.update_test')->setAbsolute()
            ->toString())
            ->save();
        $this->config('update_test.settings')
            ->set('xml_map', [
            'drupal' => '0.0',
        ])
            ->save();
        $this->drupalGet('admin/reports/updates');
        $this->clickLink('Check manually');
        $this->checkForMetaRefresh();
        $this->assertSession()
            ->pageTextContains('Checked available update data for one project.');
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->pageTextNotContains('There are updates available for your version of Drupal.');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
    }
    
    /**
     * Checks the messages at admin/modules when an update is missing.
     */
    public function testModulePageRegularUpdate() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer site configuration',
            'administer modules',
            'view update notifications',
        ]));
        $this->setProjectInstalledVersion('8.0.0');
        // Instead of using refreshUpdateStatus(), set these manually.
        $this->config('update.settings')
            ->set('fetch.url', Url::fromRoute('update_test.update_test')->setAbsolute()
            ->toString())
            ->save();
        $this->config('update_test.settings')
            ->set('xml_map', [
            'drupal' => '0.1',
        ])
            ->save();
        $this->drupalGet('admin/reports/updates');
        $this->clickLink('Check manually');
        $this->checkForMetaRefresh();
        $this->assertSession()
            ->pageTextContains('Checked available update data for one project.');
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->pageTextContains('There are updates available for your version of Drupal.');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
        // A user without the "view update notifications" permission shouldn't be
        // notified about available updates.
        $this->drupalLogin($this->drupalCreateUser([
            'administer site configuration',
            'administer modules',
        ]));
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextNotContains('There are updates available for your version of Drupal.');
    }
    
    /**
     * Checks the messages at admin/modules when a security update is missing.
     */
    public function testModulePageSecurityUpdate() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer site configuration',
            'administer modules',
            'administer themes',
            'view update notifications',
        ]));
        $this->setProjectInstalledVersion('8.0.0');
        // Instead of using refreshUpdateStatus(), set these manually.
        $this->config('update.settings')
            ->set('fetch.url', Url::fromRoute('update_test.update_test')->setAbsolute()
            ->toString())
            ->save();
        $this->config('update_test.settings')
            ->set('xml_map', [
            'drupal' => 'sec.0.2',
        ])
            ->save();
        $this->drupalGet('admin/reports/updates');
        $this->clickLink('Check manually');
        $this->checkForMetaRefresh();
        $this->assertSession()
            ->pageTextContains('Checked available update data for one project.');
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->pageTextNotContains('There are updates available for your version of Drupal.');
        $this->assertSession()
            ->pageTextContains('There is a security update available for your version of Drupal.');
        // Make sure admin/appearance warns you you're missing a security update.
        $this->drupalGet('admin/appearance');
        $this->assertSession()
            ->pageTextNotContains('There are updates available for your version of Drupal.');
        $this->assertSession()
            ->pageTextContains('There is a security update available for your version of Drupal.');
        // Make sure duplicate messages don't appear on Update status pages.
        $this->drupalGet('admin/reports/status');
        $this->assertSession()
            ->pageTextContainsOnce('There is a security update available for your version of Drupal.');
        $this->drupalGet('admin/reports/updates');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
        $this->drupalGet('admin/reports/updates/settings');
        $this->assertSession()
            ->pageTextNotContains('There is a security update available for your version of Drupal.');
    }
    
    /**
     * Tests the Update Manager module when the update server returns 503 errors.
     */
    public function testServiceUnavailable() {
        $this->refreshUpdateStatus([], '503-error');
        // Ensure that no "Warning: SimpleXMLElement..." parse errors are found.
        $this->assertSession()
            ->pageTextNotContains('SimpleXMLElement');
        $this->assertSession()
            ->pageTextContainsOnce('Failed to get available update data for one project.');
    }
    
    /**
     * Tests that exactly one fetch task per project is created and not more.
     */
    public function testFetchTasks() {
        $projecta = [
            'name' => 'aaa_update_test',
        ];
        $projectb = [
            'name' => 'bbb_update_test',
        ];
        $queue = \Drupal::queue('update_fetch_tasks');
        $this->assertEquals(0, $queue->numberOfItems(), 'Queue is empty');
        update_create_fetch_task($projecta);
        $this->assertEquals(1, $queue->numberOfItems(), 'Queue contains one item');
        update_create_fetch_task($projectb);
        $this->assertEquals(2, $queue->numberOfItems(), 'Queue contains two items');
        // Try to add a project again.
        update_create_fetch_task($projecta);
        $this->assertEquals(2, $queue->numberOfItems(), 'Queue still contains two items');
        // Clear storage and try again.
        update_storage_clear();
        update_create_fetch_task($projecta);
        $this->assertEquals(2, $queue->numberOfItems(), 'Queue contains two items');
    }
    
    /**
     * Checks language module in core package at admin/reports/updates.
     */
    public function testLanguageModuleUpdate() {
        $this->setProjectInstalledVersion('8.0.0');
        // Instead of using refreshUpdateStatus(), set these manually.
        $this->config('update.settings')
            ->set('fetch.url', Url::fromRoute('update_test.update_test')->setAbsolute()
            ->toString())
            ->save();
        $this->config('update_test.settings')
            ->set('xml_map', [
            'drupal' => '0.1',
        ])
            ->save();
        $this->drupalGet('admin/reports/updates');
        $this->assertSession()
            ->pageTextContains('Language');
    }
    
    /**
     * Ensures that the local actions appear.
     */
    public function testLocalActions() {
        $admin_user = $this->drupalCreateUser([
            'administer site configuration',
            'administer modules',
            'administer software updates',
            'administer themes',
        ]);
        $this->drupalLogin($admin_user);
        $this->drupalGet('admin/modules');
        $this->clickLink('Add new module');
        $this->assertSession()
            ->addressEquals('admin/modules/install');
        $this->drupalGet('admin/appearance');
        $this->clickLink('Add new theme');
        $this->assertSession()
            ->addressEquals('admin/theme/install');
        $this->drupalGet('admin/reports/updates');
        $this->clickLink('Add new module or theme');
        $this->assertSession()
            ->addressEquals('admin/reports/updates/install');
    }
    
    /**
     * Checks that Drupal recovers after problems connecting to update server.
     */
    public function testBrokenThenFixedUpdates() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer site configuration',
            'view update notifications',
            'access administration pages',
        ]));
        $this->setProjectInstalledVersion('8.0.0');
        // Instead of using refreshUpdateStatus(), set these manually.
        $this->config('update.settings')
            ->set('fetch.url', Url::fromRoute('update_test.update_test')->setAbsolute()
            ->toString())
            ->save();
        // Use update XML that has no information to simulate a broken response from
        // the update server.
        $this->config('update_test.settings')
            ->set('xml_map', [
            'drupal' => 'broken',
        ])
            ->save();
        // This will retrieve broken updates.
        $this->cronRun();
        $this->drupalGet('admin/reports/status');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('There was a problem checking available updates for Drupal.');
        $this->config('update_test.settings')
            ->set('xml_map', [
            'drupal' => 'sec.0.2',
        ])
            ->save();
        // Simulate the update_available_releases state expiring before cron is run
        // and the state is used by \Drupal\update\UpdateManager::getProjects().
        \Drupal::keyValueExpirable('update_available_releases')->deleteAll();
        // This cron run should retrieve fixed updates.
        $this->cronRun();
        $this->drupalGet('admin/structure');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('There is a security update available for your version of Drupal.');
    }

}

Members

Title 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.
UpdateSemverCoreTest::$projectTitle protected property The title of the project being tested. Overrides UpdateSemverTestBase::$projectTitle
UpdateSemverCoreTest::$updateProject protected property The project that is being tested. Overrides UpdateTestBase::$updateProject
UpdateSemverCoreTest::$updateTableLocator protected property The CSS locator for the update table run asserts on. Overrides UpdateTestBase::$updateTableLocator
UpdateSemverCoreTest::securityCoverageMessageProvider public function Data provider for testSecurityCoverageMessage().
UpdateSemverCoreTest::setProjectInstalledVersion protected function Sets the version to x.x.x when no project-specific mapping is defined. Overrides UpdateSemverTestBase::setProjectInstalledVersion
UpdateSemverCoreTest::testBrokenThenFixedUpdates public function Checks that Drupal recovers after problems connecting to update server.
UpdateSemverCoreTest::testClearDiskCache public function Checks that clearing the disk cache works.
UpdateSemverCoreTest::testDatestampMismatch public function Ensures proper results where there are date mismatches among modules.
UpdateSemverCoreTest::testFetchTasks public function Tests that exactly one fetch task per project is created and not more.
UpdateSemverCoreTest::testLanguageModuleUpdate public function Checks language module in core package at admin/reports/updates.
UpdateSemverCoreTest::testLocalActions public function Ensures that the local actions appear.
UpdateSemverCoreTest::testModulePageRegularUpdate public function Checks the messages at admin/modules when an update is missing.
UpdateSemverCoreTest::testModulePageRunCron public function Checks that running cron updates the list of available updates.
UpdateSemverCoreTest::testModulePageSecurityUpdate public function Checks the messages at admin/modules when a security update is missing.
UpdateSemverCoreTest::testModulePageUpToDate public function Checks the messages at admin/modules when the site is up to date.
UpdateSemverCoreTest::testSecurityCoverageMessage public function Tests the security coverage messages for Drupal core versions.
UpdateSemverCoreTest::testServiceUnavailable public function Tests the Update Manager module when the update server returns 503 errors.
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::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::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::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.