class UpdateContribTest

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

Tests how the Update Manager handles contributed modules and themes.

@group update

Hierarchy

Expanded class hierarchy of UpdateContribTest

File

core/modules/update/tests/src/Functional/UpdateContribTest.php, line 13

Namespace

Drupal\Tests\update\Functional
View source
class UpdateContribTest extends UpdateTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $updateTableLocator = 'table.update:nth-of-type(2)';
    
    /**
     * {@inheritdoc}
     */
    protected $updateProject = 'aaa_update_test';
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'update_test',
        'update',
        'aaa_update_test',
        'bbb_update_test',
        'ccc_update_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $admin_user = $this->drupalCreateUser([
            'administer site configuration',
        ]);
        $this->drupalLogin($admin_user);
    }
    
    /**
     * Tests when there is no available release data for a contrib module.
     */
    public function testNoReleasesAvailable() {
        $system_info = [
            '#all' => [
                'version' => '8.0.0',
            ],
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            'aaa_update_test' => 'no-releases',
        ]);
        // Cannot use $this->standardTests() because we need to check for the
        // 'No available releases found' string.
        $this->assertSession()
            ->responseContains('<h3>Drupal core</h3>');
        $this->assertSession()
            ->linkExists('Drupal');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/drupal');
        $this->assertSession()
            ->pageTextContains('Up to date');
        $this->assertSession()
            ->responseContains('<h3>Modules</h3>');
        $this->assertSession()
            ->pageTextNotContains('Update available');
        $this->assertSession()
            ->pageTextContains('No available releases found');
        $this->assertSession()
            ->linkNotExists('AAA Update test');
        $this->assertSession()
            ->linkByHrefNotExists('http://example.com/project/aaa_update_test');
        $available = update_get_available();
        $this->assertFalse(isset($available['aaa_update_test']['fetch_status']), 'Results are cached even if no releases are available.');
    }
    
    /**
     * Tests the basic functionality of a contrib module on the status report.
     */
    public function testUpdateContribBasic() {
        $system_info = [
            '#all' => [
                'version' => '8.0.0',
            ],
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            'aaa_update_test' => '1_0',
        ]);
        $this->standardTests();
        $this->assertSession()
            ->pageTextContains('Up to date');
        $this->assertSession()
            ->responseContains('<h3>Modules</h3>');
        $this->assertSession()
            ->pageTextNotContains('Update available');
        $this->assertSession()
            ->linkExists('AAA Update test');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/aaa_update_test');
        // Since aaa_update_test is installed the fact it is hidden and in the
        // Testing package means it should not appear.
        $system_info['aaa_update_test']['hidden'] = TRUE;
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            'aaa_update_test' => '1_0',
        ]);
        $this->assertSession()
            ->linkNotExists('AAA Update test');
        $this->assertSession()
            ->linkByHrefNotExists('http://example.com/project/aaa_update_test');
        // A hidden and installed project not in the Testing package should appear.
        $system_info['aaa_update_test']['package'] = 'aaa_update_test';
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            'aaa_update_test' => '1_0',
        ]);
        $this->assertSession()
            ->linkExists('AAA Update test');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/aaa_update_test');
    }
    
    /**
     * Tests that contrib projects are ordered by project name.
     *
     * If a project contains multiple modules, we want to make sure that the
     * available updates report is sorted by the parent project names, not by the
     * names of the modules included in each project. In this test case, we have
     * two contrib projects, "BBB Update test" and "CCC Update test". However, we
     * have a module called "aaa_update_test" that's part of the "CCC Update test"
     * project. We need to make sure that we see the "BBB" project before the
     * "CCC" project, even though "CCC" includes a module that's processed first
     * if you sort alphabetically by module name (which is the order we see things
     * inside \Drupal\Core\Extension\ExtensionList::getList() for example).
     */
    public function testUpdateContribOrder() {
        // We want core to be version 8.0.0.
        $system_info = [
            '#all' => [
                'version' => '8.0.0',
            ],
            // All the rest should be visible as contrib modules at version 8.x-1.0.
            // aaa_update_test needs to be part of the "CCC Update test" project,
            // which would throw off the report if we weren't properly sorting by
            // the project names.
'aaa_update_test' => [
                'project' => 'ccc_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
            // This should be its own project, and listed first on the report.
'bbb_update_test' => [
                'project' => 'bbb_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
            // This will contain both aaa_update_test and ccc_update_test, and
            // should come after the bbb_update_test project.
'ccc_update_test' => [
                'project' => 'ccc_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            '#all' => '1_0',
        ]);
        $this->standardTests();
        // We're expecting the report to say all projects are up to date.
        $this->assertSession()
            ->pageTextContains('Up to date');
        $this->assertSession()
            ->pageTextNotContains('Update available');
        // We want to see all 3 module names listed, since they'll show up either
        // as project names or as modules under the "Includes" listing.
        $this->assertSession()
            ->pageTextContains('AAA Update test');
        $this->assertSession()
            ->pageTextContains('BBB Update test');
        $this->assertSession()
            ->pageTextContains('CCC Update test');
        // We want aaa_update_test included in the ccc_update_test project, not as
        // its own project on the report.
        $this->assertSession()
            ->linkNotExists('AAA Update test');
        $this->assertSession()
            ->linkByHrefNotExists('http://example.com/project/aaa_update_test');
        // The other two should be listed as projects.
        $this->assertSession()
            ->linkExists('BBB Update test');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/bbb_update_test');
        $this->assertSession()
            ->linkExists('CCC Update test');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/ccc_update_test');
        // We want to make sure we see the BBB project before the CCC project.
        // Instead of just searching for 'BBB Update test' or something, we want
        // to use the full markup that starts the project entry itself, so that
        // we're really testing that the project listings are in the right order.
        $bbb_project_link = '<div class="project-update__title"><a href="http://example.com/project/bbb_update_test">BBB Update test</a>';
        $ccc_project_link = '<div class="project-update__title"><a href="http://example.com/project/ccc_update_test">CCC Update test</a>';
        // Verify that the 'BBB Update test' project is listed before the
        // 'CCC Update test' project.
        $this->assertLessThan(strpos($this->getSession()
            ->getPage()
            ->getContent(), $ccc_project_link), strpos($this->getSession()
            ->getPage()
            ->getContent(), $bbb_project_link));
    }
    
    /**
     * Tests that subthemes are notified about security updates for base themes.
     */
    public function testUpdateBaseThemeSecurityUpdate() {
        // @todo https://www.drupal.org/node/2338175 base themes have to be
        //   installed.
        // Only install the subtheme, not the base theme.
        \Drupal::service('theme_installer')->install([
            'update_test_subtheme',
        ]);
        // Define the initial state for core and the subtheme.
        $system_info = [
            // We want core to be version 8.0.0.
'#all' => [
                'version' => '8.0.0',
            ],
            // Show the update_test_basetheme
'update_test_basetheme' => [
                'project' => 'update_test_basetheme',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
            // Show the update_test_subtheme
'update_test_subtheme' => [
                'project' => 'update_test_subtheme',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $xml_mapping = [
            'drupal' => '0.0',
            'update_test_subtheme' => '1_0',
            'update_test_basetheme' => '1_1-sec',
        ];
        $this->refreshUpdateStatus($xml_mapping);
        $this->assertSession()
            ->pageTextContains('Security update required!');
        $this->updateProject = 'update_test_basetheme';
        $this->assertVersionUpdateLinks('Security update', '8.x-1.1');
    }
    
    /**
     * Tests the Update Manager module when one normal update is available.
     */
    public function testNormalUpdateAvailable() {
        $assert_session = $this->assertSession();
        // Ensure that the update check requires a token.
        $this->drupalGet('admin/reports/updates/check');
        $assert_session->statusCodeEquals(403);
        $system_info = [
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        foreach ([
            '1.1',
            '1.2',
            '2.0',
        ] as $version) {
            foreach ([
                '-beta1',
                '-alpha1',
                '',
            ] as $extra_version) {
                $full_version = "8.x-{$version}{$extra_version}";
                $this->refreshUpdateStatus([
                    'drupal' => '0.0',
                    'aaa_update_test' => str_replace('.', '_', $version) . $extra_version,
                ]);
                $this->standardTests();
                $assert_session->pageTextNotContains('Security update required!');
                // The XML test fixtures for this method all contain the '8.x-3.0'
                // release but because '8.x-3.0' is not in a supported branch it will
                // not be in the available updates.
                $this->assertSession()
                    ->responseNotContains('8.x-3.0');
                // Set a CSS selector in order for assertions to target the 'Modules'
                // table and not Drupal core updates.
                $this->updateTableLocator = 'table.update:nth-of-type(2)';
                switch ($version) {
                    case '1.1':
                        // Both stable and unstable releases are available.
                        // A stable release is the latest.
                        if ($extra_version == '') {
                            $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Up to date');
                            $assert_session->elementTextContains('css', $this->updateTableLocator, 'Update available');
                            $this->assertVersionUpdateLinks('Recommended version', $full_version);
                            $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Latest version:');
                            $assert_session->elementContains('css', $this->updateTableLocator, 'warning.svg');
                        }
                        else {
                            $assert_session->elementTextContains('css', $this->updateTableLocator, 'Up to date');
                            $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Update available');
                            $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Recommended version:');
                            $this->assertVersionUpdateLinks('Latest version', $full_version);
                            $assert_session->elementContains('css', $this->updateTableLocator, 'check.svg');
                        }
                        break;
                    case '1.2':
                        // Both stable and unstable releases are available.
                        // A stable release is the latest.
                        if ($extra_version == '') {
                            $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Up to date');
                            $assert_session->elementTextContains('css', $this->updateTableLocator, 'Update available');
                            $this->assertVersionUpdateLinks('Recommended version:', $full_version);
                            $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Latest version:');
                            $assert_session->elementContains('css', $this->updateTableLocator, 'warning.svg');
                        }
                        else {
                            $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Up to date');
                            $assert_session->elementTextContains('css', $this->updateTableLocator, 'Update available');
                            $this->assertVersionUpdateLinks('Recommended version:', '8.x-1.1');
                            $this->assertVersionUpdateLinks('Latest version:', $full_version);
                            $assert_session->elementTextContains('css', $this->updateTableLocator, 'Latest version:');
                            $assert_session->elementContains('css', $this->updateTableLocator, 'warning.svg');
                        }
                        break;
                    case '2.0':
                        // When next major release (either stable or unstable) is available
                        // and the current major is still supported, the next major will be
                        // listed as "Also available".
                        $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Up to date');
                        $assert_session->elementTextContains('css', $this->updateTableLocator, 'Update available');
                        $this->assertVersionUpdateLinks('Recommended version', '8.x-1.2');
                        $this->assertVersionUpdateLinks('Also available', $full_version);
                        $assert_session->elementTextNotContains('css', $this->updateTableLocator, 'Latest version:');
                        $assert_session->elementContains('css', $this->updateTableLocator, 'warning.svg');
                }
            }
        }
    }
    
    /**
     * Tests that disabled themes are only shown when desired.
     *
     * @todo https://www.drupal.org/node/2338175 extensions can not be hidden and
     *   base themes have to be installed.
     */
    public function testUpdateShowDisabledThemes() {
        $update_settings = $this->config('update.settings');
        // Make sure all the update_test_* themes are disabled.
        $extension_config = $this->config('core.extension');
        foreach ($extension_config->get('theme') as $theme => $weight) {
            if (preg_match('/^update_test_/', $theme)) {
                $extension_config->clear("theme.{$theme}");
            }
        }
        $extension_config->save();
        // Define the initial state for core and the test contrib themes.
        $system_info = [
            // We want core to be version 8.0.0.
'#all' => [
                'version' => '8.0.0',
            ],
            // The update_test_basetheme should be visible and up to date.
'update_test_basetheme' => [
                'project' => 'update_test_basetheme',
                'version' => '8.x-1.1',
                'hidden' => FALSE,
            ],
            // The update_test_subtheme should be visible and up to date.
'update_test_subtheme' => [
                'project' => 'update_test_subtheme',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        // When there are contributed modules in the site's file system, the
        // total number of attempts made in the test may exceed the default value
        // of update_max_fetch_attempts. Therefore this variable is set very high
        // to avoid test failures in those cases.
        $update_settings->set('fetch.max_attempts', 99999)
            ->save();
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $xml_mapping = [
            'drupal' => '0.0',
            'update_test_subtheme' => '1_0',
            'update_test_basetheme' => '1_1-sec',
        ];
        foreach ([
            TRUE,
            FALSE,
        ] as $check_disabled) {
            $update_settings->set('check.disabled_extensions', $check_disabled)
                ->save();
            $this->refreshUpdateStatus($xml_mapping);
            // In neither case should we see the "Themes" heading for installed
            // themes.
            // Use regex pattern because we need to match 'Themes' case sensitively.
            $this->assertSession()
                ->pageTextNotMatches('/Themes/');
            if ($check_disabled) {
                $this->assertSession()
                    ->pageTextContains('Uninstalled themes');
                $this->assertSession()
                    ->linkExists('Update test base theme');
                $this->assertSession()
                    ->linkByHrefExists('http://example.com/project/update_test_basetheme');
                $this->assertSession()
                    ->linkExists('Update test subtheme');
                $this->assertSession()
                    ->linkByHrefExists('http://example.com/project/update_test_subtheme');
            }
            else {
                $this->assertSession()
                    ->pageTextNotContains('Uninstalled themes');
                $this->assertSession()
                    ->linkNotExists('Update test base theme');
                $this->assertSession()
                    ->linkByHrefNotExists('http://example.com/project/update_test_basetheme');
                $this->assertSession()
                    ->linkNotExists('Update test subtheme');
                $this->assertSession()
                    ->linkByHrefNotExists('http://example.com/project/update_test_subtheme');
            }
        }
    }
    
    /**
     * Tests updates with a hidden base theme.
     */
    public function testUpdateHiddenBaseTheme() {
        \Drupal::moduleHandler()->loadInclude('update', 'inc', 'update.compare');
        // Install the subtheme.
        \Drupal::service('theme_installer')->install([
            'update_test_subtheme',
        ]);
        // Add a project and initial state for base theme and subtheme.
        $system_info = [
            // Hide the update_test_basetheme.
'update_test_basetheme' => [
                'project' => 'update_test_basetheme',
                'hidden' => TRUE,
            ],
            // Show the update_test_subtheme.
'update_test_subtheme' => [
                'project' => 'update_test_subtheme',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $projects = \Drupal::service('update.manager')->getProjects();
        $theme_data = \Drupal::service('theme_handler')->rebuildThemeData();
        $project_info = new ProjectInfo();
        $project_info->processInfoList($projects, $theme_data, 'theme', TRUE);
        $this->assertNotEmpty($projects['update_test_basetheme'], 'Valid base theme (update_test_basetheme) was found.');
    }
    
    /**
     * Makes sure that if we fetch from a broken URL, sane things happen.
     */
    public function testUpdateBrokenFetchURL() {
        $system_info = [
            '#all' => [
                'version' => '8.0.0',
            ],
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
            'bbb_update_test' => [
                'project' => 'bbb_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
            'ccc_update_test' => [
                'project' => 'ccc_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        // Ensure that the update information is correct before testing.
        $this->drupalGet('admin/reports/updates');
        $xml_mapping = [
            'drupal' => '0.0',
            'aaa_update_test' => '1_0',
            'bbb_update_test' => 'does-not-exist',
            'ccc_update_test' => '1_0',
        ];
        $this->refreshUpdateStatus($xml_mapping);
        $this->assertSession()
            ->pageTextContains('Up to date');
        // We're expecting the report to say most projects are up to date, so we
        // hope that 'Up to date' is not unique.
        $this->assertSession()
            ->pageTextMatchesCount(3, '/Up to date/');
        // It should say we failed to get data, not that we're missing an update.
        $this->assertSession()
            ->pageTextNotContains('Update available');
        // We need to check that this string is found as part of a project row, not
        // just in the "Failed to get available update data" message at the top of
        // the page.
        $this->assertSession()
            ->responseContains('<div class="project-update__status">Failed to get available update data');
        // We should see the output messages from fetching manually.
        $this->assertSession()
            ->pageTextContainsOnce('Checked available update data for 3 projects.');
        $this->assertSession()
            ->pageTextContainsOnce('Failed to get available update data for one project.');
        // The other two should be listed as projects.
        $this->assertSession()
            ->linkExists('AAA Update test');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/aaa_update_test');
        $this->assertSession()
            ->linkNotExists('BBB Update test');
        $this->assertSession()
            ->linkByHrefNotExists('http://example.com/project/bbb_update_test');
        $this->assertSession()
            ->linkExists('CCC Update test');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/ccc_update_test');
    }
    
    /**
     * Checks that hook_update_status_alter() works to change a status.
     *
     * We provide the same external data as if aaa_update_test 8.x-1.0 were
     * installed and that was the latest release. Then we use
     * hook_update_status_alter() to try to mark this as missing a security
     * update, then assert if we see the appropriate warnings on the right pages.
     */
    public function testHookUpdateStatusAlter() {
        $update_test_config = $this->config('update_test.settings');
        $update_admin_user = $this->drupalCreateUser([
            'administer site configuration',
            'administer software updates',
        ]);
        $this->drupalLogin($update_admin_user);
        $system_info = [
            '#all' => [
                'version' => '8.0.0',
            ],
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $update_test_config->set('system_info', $system_info)
            ->save();
        $update_status = [
            'aaa_update_test' => [
                'status' => UpdateManagerInterface::NOT_SECURE,
            ],
        ];
        $update_test_config->set('update_status', $update_status)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            'aaa_update_test' => '1_0',
        ]);
        $this->assertSession()
            ->responseContains('<h3>Modules</h3>');
        $this->assertSession()
            ->pageTextContains('Security update required!');
        $this->assertSession()
            ->linkExists('AAA Update test');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/aaa_update_test');
        // Visit the reports page again without the altering and make sure the
        // status is back to normal.
        $update_test_config->set('update_status', [])
            ->save();
        $this->drupalGet('admin/reports/updates');
        $this->assertSession()
            ->responseContains('<h3>Modules</h3>');
        $this->assertSession()
            ->pageTextNotContains('Security update required!');
        $this->assertSession()
            ->linkExists('AAA Update test');
        $this->assertSession()
            ->linkByHrefExists('http://example.com/project/aaa_update_test');
        // Turn the altering back on and visit the Update manager UI.
        $update_test_config->set('update_status', $update_status)
            ->save();
        $this->drupalGet('admin/modules/update');
        $this->assertSession()
            ->pageTextContains('Security update');
        // Turn the altering back off and visit the Update manager UI.
        $update_test_config->set('update_status', [])
            ->save();
        $this->drupalGet('admin/modules/update');
        $this->assertSession()
            ->pageTextNotContains('Security update');
    }
    
    /**
     * Tests that core compatibility messages are displayed.
     */
    public function testCoreCompatibilityMessage() {
        $system_info = [
            '#all' => [
                'version' => '8.0.0',
            ],
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        // Confirm that messages are displayed for recommended and latest updates.
        // @todo In https://www.drupal.org/project/drupal/issues/3112962:
        //   Change the calls to 'refreshUpdateStatus()' to use:
        //   - '1.1' instead of '1.1-core_compatibility'.
        //   - '1.1-alpha1' instead of '1.1-alpha1-core_compatibility'.
        //   Delete the files:
        //   - core/modules/update/tests/modules/update_test/drupal.1.1-alpha1-core_compatibility.xml
        //   - core/modules/update/tests/modules/update_test/drupal.1.1-core_compatibility.xml
        $this->refreshUpdateStatus([
            'drupal' => '1.1-core_compatibility',
            'aaa_update_test' => '8.x-1.2',
        ]);
        $this->assertCoreCompatibilityMessage('8.x-1.2', '8.0.0 to 8.1.1', 'Recommended version:');
        $this->assertCoreCompatibilityMessage('8.x-1.3-beta1', '8.0.0, 8.1.1', 'Latest version:');
        // Change the available core releases and confirm that the messages change.
        $this->refreshUpdateStatus([
            'drupal' => '1.1-alpha1-core_compatibility',
            'aaa_update_test' => '8.x-1.2',
        ]);
        $this->assertCoreCompatibilityMessage('8.x-1.2', '8.0.0 to 8.1.0', 'Recommended version:');
        $this->assertCoreCompatibilityMessage('8.x-1.3-beta1', '8.0.0', 'Latest version:');
        // Confirm that messages are displayed for security and 'Also available'
        // updates.
        $this->refreshUpdateStatus([
            'drupal' => '1.1-core_compatibility',
            'aaa_update_test' => 'core_compatibility.8.x-1.2_8.x-2.2',
        ]);
        $this->assertCoreCompatibilityMessage('8.x-1.2', '8.1.0 to 8.1.1', 'Security update:', FALSE);
        $this->assertCoreCompatibilityMessage('8.x-2.2', '8.1.1', 'Also available:', FALSE);
    }
    
    /**
     * Tests update status of security releases.
     *
     * @param string $module_version
     *   The module version the site is using.
     * @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 fixture file to use.
     *
     * @dataProvider securityUpdateAvailabilityProvider
     */
    public function testSecurityUpdateAvailability($module_version, array $expected_security_releases, $expected_update_message_type, $fixture) {
        $system_info = [
            '#all' => [
                'version' => '8.0.0',
            ],
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => $module_version,
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            'aaa_update_test' => $fixture,
        ]);
        $this->assertSecurityUpdates('aaa_update_test', $expected_security_releases, $expected_update_message_type, 'table.update:nth-of-type(2)');
    }
    
    /**
     * Data provider method for testSecurityUpdateAvailability().
     *
     * These test cases rely on the following fixtures containing the following
     * releases:
     * - aaa_update_test.sec.8.x-1.2.xml
     *   - 8.x-1.2 Security update
     *   - 8.x-1.1 Insecure
     *   - 8.x-1.0 Insecure
     * - aaa_update_test.sec.8.x-1.1_8.x-1.2.xml
     *   - 8.x-1.2 Security update
     *   - 8.x-1.1 Security update, Insecure
     *   - 8.x-1.0 Insecure
     * - aaa_update_test.sec.8.x-1.2_8.x-2.2.xml
     *   - 8.x-3.0-beta2
     *   - 8.x-3.0-beta1 Insecure
     *   - 8.x-2.2 Security update
     *   - 8.x-2.1 Security update, Insecure
     *   - 8.x-2.0 Insecure
     *   - 8.x-1.2 Security update
     *   - 8.x-1.1 Insecure
     *   - 8.x-1.0 Insecure
     * - aaa_update_test.sec.8.x-2.2_1.x_secure.xml
     *   - 8.x-2.2 Security update
     *   - 8.x-2.1 Security update, Insecure
     *   - 8.x-2.0 Insecure
     *   - 8.x-1.2
     *   - 8.x-1.1
     *   - 8.x-1.0
     */
    public function securityUpdateAvailabilityProvider() {
        return [
            // Security releases available for module major release 1.
            // No releases for next major.
'8.x-1.0, 8.x-1.2' => [
                'module_patch_version' => '8.x-1.0',
                'expected_security_releases' => [
                    '8.x-1.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.8.x-1.2',
            ],
            // Two security releases available for module major release 1.
            // 8.x-1.1 security release marked as insecure.
            // No releases for next major.
'8.x-1.0, 8.x-1.1 8.x-1.2' => [
                'module_patch_version' => '8.x-1.0',
                'expected_security_releases' => [
                    '8.x-1.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.8.x-1.1_8.x-1.2',
            ],
            // Security release available for module major release 2.
            // No releases for next major.
'8.x-2.0, 8.x-2.2' => [
                'module_patch_version' => '8.x-2.0',
                'expected_security_releases' => [
                    '8.x-2.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.8.x-2.2_1.x_secure',
            ],
            '8.x-2.2, 8.x-1.2 8.x-2.2' => [
                'module_patch_version' => '8.x-2.2',
                'expected_security_releases' => [],
                'expected_update_message_type' => static::UPDATE_NONE,
                'fixture' => 'sec.8.x-1.2_8.x-2.2',
            ],
            // Security release available for module major release 1.
            // Security release also available for next major.
'8.x-1.0, 8.x-1.2 8.x-2.2' => [
                'module_patch_version' => '8.x-1.0',
                'expected_security_releases' => [
                    '8.x-1.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.8.x-1.2_8.x-2.2',
            ],
            // No security release available for module major release 1 but 1.x
            // releases are not marked as insecure.
            // Security release available for next major.
'8.x-1.0, 8.x-2.2, not insecure' => [
                'module_patch_version' => '8.x-1.0',
                'expected_security_releases' => [],
                'expected_update_message_type' => static::UPDATE_AVAILABLE,
                'fixture' => 'sec.8.x-2.2_1.x_secure',
            ],
            // On latest security release for module major release 1.
            // Security release also available for next major.
'8.x-1.2, 8.x-1.2 8.x-2.2' => [
                'module_patch_version' => '8.x-1.2',
                'expected_security_release' => [],
                'expected_update_message_type' => static::UPDATE_NONE,
                'fixture' => 'sec.8.x-1.2_8.x-2.2',
            ],
            '8.x-2.0, 8.x-1.2 8.x-2.2' => [
                'module_patch_version' => '8.x-2.0',
                'expected_security_releases' => [
                    '8.x-2.2',
                ],
                'expected_update_message_type' => static::SECURITY_UPDATE_REQUIRED,
                'fixture' => 'sec.8.x-1.2_8.x-2.2',
            ],
        ];
    }
    
    /**
     * 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:
     * - aaa_update_test.1_0-supported.xml
     *    'supported_branches' is '8.x-1.,8.x-2.'.
     * - aaa_update_test.1_0-unsupported.xml
     *    'supported_branches' is '8.x-2.'.
     * They both have an '8.x-1.0' release that is unpublished and an '8.x-2.0'
     * release that is published and is the expected update.
     */
    public function testRevokedRelease() {
        $system_info = [
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => '8.x-1.0',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            $this->updateProject => '1_0-supported',
        ]);
        // @todo Change the version label to 'Recommended version:' in
        // https://www.drupal.org/node/3114408.
        $this->confirmRevokedStatus('8.x-1.0', '8.x-2.0', 'Also available:');
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            $this->updateProject => '1_0-unsupported',
        ]);
        $this->confirmRevokedStatus('8.x-1.0', '8.x-2.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:
     * - aaa_update_test.1_0-supported.xml
     *    'supported_branches' is '8.x-1.,8.x-2.'.
     * - aaa_update_test.1_0-unsupported.xml
     *    'supported_branches' is '8.x-2.'.
     * They both have an '8.x-1.1' release that has the 'Release type' value of
     * 'unsupported' and an '8.x-2.0' release that has the 'Release type' value of
     * 'supported' and is the expected update.
     */
    public function testUnsupportedRelease() {
        $system_info = [
            'aaa_update_test' => [
                'project' => 'aaa_update_test',
                'version' => '8.x-1.1',
                'hidden' => FALSE,
            ],
        ];
        $this->config('update_test.settings')
            ->set('system_info', $system_info)
            ->save();
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            $this->updateProject => '1_0-supported',
        ]);
        // @todo Change the version label to 'Recommended version:' in
        // https://www.drupal.org/node/3114408.
        $this->confirmUnsupportedStatus('8.x-1.1', '8.x-2.0', 'Also available:');
        $this->refreshUpdateStatus([
            'drupal' => '0.0',
            $this->updateProject => '1_0-unsupported',
        ]);
        $this->confirmUnsupportedStatus('8.x-1.1', '8.x-2.0', 'Recommended version:');
    }
    
    /**
     * Tests messages for invalid, empty and missing version strings.
     */
    public function testNonStandardVersionStrings() {
        $version_infos = [
            'invalid' => [
                'version' => 'llama',
                'expected' => 'Invalid version: llama',
            ],
            'empty' => [
                'version' => '',
                'expected' => 'Empty version',
            ],
            'null' => [
                'expected' => 'Invalid version: Unknown',
            ],
        ];
        foreach ($version_infos as $version_info) {
            $system_info = [
                'aaa_update_test' => [
                    'project' => 'aaa_update_test',
                    'hidden' => FALSE,
                ],
            ];
            if (isset($version_info['version'])) {
                $system_info['aaa_update_test']['version'] = $version_info['version'];
            }
            $this->config('update_test.settings')
                ->set('system_info', $system_info)
                ->save();
            $this->refreshUpdateStatus([
                'drupal' => '0.0',
                $this->updateProject => '1_0-supported',
            ]);
            $this->standardTests();
            $this->assertSession()
                ->elementTextContains('css', $this->updateTableLocator, $version_info['expected']);
        }
    }
    
    /**
     * Asserts that a core compatibility message is correct for an update.
     *
     * @param string $version
     *   The version of the update.
     * @param string $expected_range
     *   The expected core compatibility range.
     * @param string $expected_release_title
     *   The expected release title.
     * @param bool $is_compatible
     *   If the update is compatible with the installed version of Drupal.
     *
     * @internal
     */
    protected function assertCoreCompatibilityMessage(string $version, string $expected_range, string $expected_release_title, bool $is_compatible = TRUE) : void {
        $update_element = $this->findUpdateElementByLabel($expected_release_title);
        $this->assertTrue($update_element->hasLink($version));
        $compatibility_details = $update_element->find('css', '.project-update__compatibility-details details');
        $this->assertStringContainsString("Requires Drupal core: {$expected_range}", $compatibility_details->getText());
        $details_summary_element = $compatibility_details->find('css', 'summary');
        if ($is_compatible) {
            // If an update is compatible with the installed version of Drupal core,
            // the details element should be closed by default.
            $this->assertFalse($compatibility_details->hasAttribute('open'));
            $this->assertSame('Compatible', $details_summary_element->getText());
        }
        else {
            // If an update is not compatible with the installed version of Drupal
            // core, the details element should be open by default.
            $this->assertTrue($compatibility_details->hasAttribute('open'));
            $this->assertSame('Not compatible', $details_summary_element->getText());
        }
        $this->assertFalse($update_element->hasLink('Download'));
    }

}

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&#039;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
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::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.
UpdateContribTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
UpdateContribTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
UpdateContribTest::$updateProject protected property The project that is being tested. Overrides UpdateTestBase::$updateProject
UpdateContribTest::$updateTableLocator protected property The CSS locator for the update table run asserts on. Overrides UpdateTestBase::$updateTableLocator
UpdateContribTest::assertCoreCompatibilityMessage protected function Asserts that a core compatibility message is correct for an update.
UpdateContribTest::securityUpdateAvailabilityProvider public function Data provider method for testSecurityUpdateAvailability().
UpdateContribTest::setUp protected function Overrides BrowserTestBase::setUp
UpdateContribTest::testCoreCompatibilityMessage public function Tests that core compatibility messages are displayed.
UpdateContribTest::testHookUpdateStatusAlter public function Checks that hook_update_status_alter() works to change a status.
UpdateContribTest::testNonStandardVersionStrings public function Tests messages for invalid, empty and missing version strings.
UpdateContribTest::testNoReleasesAvailable public function Tests when there is no available release data for a contrib module.
UpdateContribTest::testNormalUpdateAvailable public function Tests the Update Manager module when one normal update is available.
UpdateContribTest::testRevokedRelease public function Tests messages when a project release is unpublished.
UpdateContribTest::testSecurityUpdateAvailability public function Tests update status of security releases.
UpdateContribTest::testUnsupportedRelease public function Tests messages when a project release is marked unsupported.
UpdateContribTest::testUpdateBaseThemeSecurityUpdate public function Tests that subthemes are notified about security updates for base themes.
UpdateContribTest::testUpdateBrokenFetchURL public function Makes sure that if we fetch from a broken URL, sane things happen.
UpdateContribTest::testUpdateContribBasic public function Tests the basic functionality of a contrib module on the status report.
UpdateContribTest::testUpdateContribOrder public function Tests that contrib projects are ordered by project name.
UpdateContribTest::testUpdateHiddenBaseTheme public function Tests updates with a hidden base theme.
UpdateContribTest::testUpdateShowDisabledThemes public function Tests that disabled themes are only shown when desired.
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::refreshUpdateStatus protected function Refreshes the update status based on the desired available update scenario. 1
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.