class StatusTest

Same name in other branches
  1. 9 core/modules/system/tests/src/Functional/System/StatusTest.php \Drupal\Tests\system\Functional\System\StatusTest
  2. 8.9.x core/modules/system/tests/src/Functional/System/StatusTest.php \Drupal\Tests\system\Functional\System\StatusTest
  3. 10 core/modules/system/tests/src/Functional/System/StatusTest.php \Drupal\Tests\system\Functional\System\StatusTest

Tests output on the status overview page.

@group system

Hierarchy

Expanded class hierarchy of StatusTest

File

core/modules/system/tests/src/Functional/System/StatusTest.php, line 19

Namespace

Drupal\Tests\system\Functional\System
View source
class StatusTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'update_test_postupdate',
        'update',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Unset the sync directory in settings.php to trigger the error.
        $settings['settings']['config_sync_directory'] = (object) [
            'value' => '',
            'required' => TRUE,
        ];
        $this->writeSettings($settings);
        $admin_user = $this->drupalCreateUser([
            'administer site configuration',
            'access site reports',
        ]);
        $this->drupalLogin($admin_user);
    }
    
    /**
     * Tests that the status page returns.
     *
     * @group legacy
     */
    public function testStatusPage() : void {
        // Verify if the 'Status report' is the first item link.
        $this->drupalGet('admin/reports');
        $this->assertEquals('Status report', $this->cssSelect('.list-group :first-child')[0]
            ->getText());
        // Go to Administration.
        $this->drupalGet('admin/reports/status');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Verify that the PHP version is shown on the page.
        $this->assertSession()
            ->pageTextContains(phpversion());
        if (function_exists('phpinfo')) {
            $this->assertSession()
                ->linkByHrefExists(Url::fromRoute('system.php')->toString());
        }
        else {
            $this->assertSession()
                ->linkByHrefNotExists(Url::fromRoute('system.php')->toString());
        }
        // If a module is fully installed no pending updates exists.
        $this->assertSession()
            ->pageTextNotContains('Out of date');
        // The setting config_sync_directory is not properly formed.
        $this->assertSession()
            ->pageTextContains("Your {$this->siteDirectory}/settings.php file must define the \$settings['config_sync_directory'] setting");
        
        /** @var \Drupal\Core\Update\UpdateHookRegistry $update_registry */
        $update_registry = \Drupal::service('update.update_hook_registry');
        // Set the schema version of update_test_postupdate to a lower version, so
        // update_test_postupdate_update_8001() needs to be executed.
        $update_registry->setInstalledVersion('update_test_postupdate', 8000);
        $this->drupalGet('admin/reports/status');
        $this->assertSession()
            ->pageTextContains('Out of date');
        // Now cleanup the executed post update functions.
        $update_registry->setInstalledVersion('update_test_postupdate', 8001);
        
        /** @var \Drupal\Core\Update\UpdateRegistry $post_update_registry */
        $post_update_registry = \Drupal::service('update.post_update_registry');
        $post_update_registry->filterOutInvokedUpdatesByExtension('update_test_postupdate');
        $this->drupalGet('admin/reports/status');
        $this->assertSession()
            ->pageTextContains('Out of date');
        $this->drupalGet('admin/reports/status/php');
        $this->assertSession()
            ->statusCodeEquals(200);
        $settings['settings']['sa_core_2023_004_phpinfo_flags'] = (object) [
            'value' => INFO_ALL,
            'required' => TRUE,
        ];
        $this->writeSettings($settings);
        $this->drupalGet('admin/reports/status/php');
        $this->assertSession()
            ->pageTextContains('PHP');
        $this->assertSession()
            ->pageTextContains('$_COOKIE');
        // Check if cron error is displayed in errors section.
        $cron_last_run = \Drupal::state()->get('system.cron_last');
        \Drupal::state()->set('system.cron_last', 0);
        $this->drupalGet('admin/reports/status');
        $this->assertSession()
            ->elementExists('xpath', '//details[contains(@class, "system-status-report__entry")]//div[contains(text(), "Cron has not run recently")]');
        \Drupal::state()->set('system.cron_last', $cron_last_run);
        // Check if JSON database support is enabled.
        $this->assertSession()
            ->pageTextContains('Database support for JSON');
        $elements = $this->xpath('//details[@class="system-status-report__entry"]//div[contains(text(), :text)]', [
            ':text' => 'Is required in Drupal 10.0.',
        ]);
        $this->assertCount(1, $elements);
        $this->assertStringStartsWith('Available', $elements[0]->getParent()
            ->getText());
        // Test the page with deprecated extensions.
        $module_installer = \Drupal::service('module_installer');
        $session = $this->assertSession();
        // Install a deprecated module.
        $module_installer->install([
            'deprecated_module',
        ]);
        $this->drupalGet('admin/reports/status');
        // Confirm warning messages are displayed for the deprecated module.
        $session->pageTextContains('Deprecated modules installed');
        $session->pageTextContains('Deprecated modules found: Deprecated module.');
        // Check that the deprecated module link was rendered correctly.
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, 'http://example.com/deprecated')]");
        // Uninstall a deprecated module and confirm the warning is not displayed.
        $module_installer->uninstall([
            'deprecated_module',
        ]);
        $this->drupalGet('admin/reports/status');
        $session->pageTextNotContains('Deprecated modules installed');
        $session->pageTextNotContains('Deprecated modules found: Deprecated module.');
        $this->assertSession()
            ->elementNotExists('xpath', "//a[contains(@href, 'http://example.com/deprecated')]");
        // Make sure there are no warnings about obsolete modules.
        $session->pageTextNotContains('Obsolete extensions installed');
        $session->pageTextNotContains('Obsolete extensions found: System obsolete status test.');
        // Install an obsolete module. Normally this isn't possible, so write to
        // configuration directly.
        $this->config('core.extension')
            ->set('module.system_status_obsolete_test', 0)
            ->save();
        $this->rebuildAll();
        $this->drupalGet('admin/reports/status');
        $session->pageTextContains('Obsolete extensions installed');
        $session->pageTextContains('Obsolete extensions found: System obsolete status test.');
        $session->pageTextContains('Obsolete extensions are provided only so that they can be uninstalled cleanly. You should immediately uninstall these extensions since they may be removed in a future release.');
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, '/admin/modules/uninstall')]");
        // Make sure the warning is gone after uninstalling the module.
        $module_installer->uninstall([
            'system_status_obsolete_test',
        ]);
        $this->drupalGet('admin/reports/status');
        $session->pageTextNotContains('Obsolete extensions installed');
        $session->pageTextNotContains('Obsolete extensions found: System obsolete status test.');
        $session->pageTextNotContains('Obsolete extensions are provided only so that they can be uninstalled cleanly. You should immediately uninstall these extensions since they may be removed in a future release.');
        // Install deprecated theme and confirm warning message is displayed.
        $theme_installer = \Drupal::service('theme_installer');
        $theme_installer->install([
            'test_deprecated_theme',
        ]);
        $this->drupalGet('admin/reports/status');
        $session->pageTextContains('Deprecated themes installed');
        $session->pageTextContains('Deprecated themes found: Test deprecated theme.');
        // Check that the deprecated theme link was rendered correctly.
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, 'http://example.com/deprecated_theme')]");
        // Uninstall a deprecated theme and confirm the warning is not displayed.
        $theme_installer->uninstall([
            'test_deprecated_theme',
        ]);
        $this->drupalGet('admin/reports/status');
        $session->pageTextNotContains('Deprecated themes installed');
        $session->pageTextNotContains('Deprecated themes found: Test deprecated theme.');
        $this->assertSession()
            ->elementNotExists('xpath', "//a[contains(@href, 'http://example.com/deprecated_theme')]");
        // Check if pg_trgm extension is enabled on postgres.
        if (\Drupal::database()->databaseType() == 'pgsql') {
            $this->assertSession()
                ->pageTextContains('PostgreSQL pg_trgm extension');
            $elements = $this->xpath('//details[@class="system-status-report__entry"]//div[contains(text(), :text)]', [
                ':text' => 'The pg_trgm PostgreSQL extension is present.',
            ]);
            $this->assertCount(1, $elements);
            $this->assertStringStartsWith('Available', $elements[0]->getParent()
                ->getText());
        }
        // Test APCu status.
        $elements = $this->xpath('//details[summary[contains(@class, "system-status-report__status-title") and normalize-space(text()) = "PHP APCu caching"]]/div[@class="system-status-report__entry__value"]/text()');
        // Ensure the status is not a warning if APCu size is greater than or equal
        // to the recommended size.
        if (preg_match('/^Enabled \\((.*)\\)$/', $elements[0]->getText(), $matches)) {
            if (Bytes::toNumber($matches[1]) >= 1024 * 1024 * 32) {
                $this->assertFalse($elements[0]->find('xpath', '../../summary')
                    ->hasClass('system-status-report__status-icon--warning'));
            }
        }
    }
    
    /**
     * Tests that the Error counter matches the displayed number of errors.
     */
    public function testErrorElementCount() : void {
        // Trigger "cron has not run recently" error:
        $cron_config = \Drupal::config('system.cron');
        $time = \Drupal::time()->getRequestTime();
        \Drupal::state()->set('install_time', $time);
        $threshold_error = $cron_config->get('threshold.requirements_error');
        \Drupal::state()->set('system.cron_last', $time - $threshold_error - 1);
        $this->drupalGet('admin/reports/status');
        $error_elements = $this->cssSelect('.system-status-report__status-icon--error');
        $this->assertNotEquals(count($error_elements), 0, 'Errors are listed on the page.');
        $expected_text = new PluralTranslatableMarkup(count($error_elements), 'Error', 'Errors');
        $expected_text = count($error_elements) . ' ' . $expected_text;
        $this->assertSession()
            ->responseContains((string) $expected_text);
    }
    
    /**
     * Tests that the Warning counter matches the displayed number of warnings.
     */
    public function testWarningElementCount() : void {
        // Trigger "cron has not run recently" with warning threshold:
        $cron_config = \Drupal::config('system.cron');
        $time = \Drupal::time()->getRequestTime();
        \Drupal::state()->set('install_time', $time);
        $threshold_warning = $cron_config->get('threshold.requirements_warning');
        \Drupal::state()->set('system.cron_last', $time - $threshold_warning - 1);
        $this->drupalGet('admin/reports/status');
        $warning_elements = $this->cssSelect('.system-status-report__status-icon--warning');
        $this->assertNotEquals(count($warning_elements), 0, 'Warnings are listed on the page.');
        $expected_text = new PluralTranslatableMarkup(count($warning_elements), 'Warning', 'Warnings');
        $expected_text = count($warning_elements) . ' ' . $expected_text;
        $this->assertSession()
            ->responseContains((string) $expected_text);
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
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::$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 SettingsEditor::rewrite().
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::$profile protected property The profile to install as a basis for testing. 41
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 test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
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 test site. 2
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::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 8
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. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 29
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. 4
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
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.
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
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.
StatusTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
StatusTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
StatusTest::setUp protected function Overrides BrowserTestBase::setUp
StatusTest::testErrorElementCount public function Tests that the Error counter matches the displayed number of errors.
StatusTest::testStatusPage public function Tests that the status page returns.
StatusTest::testWarningElementCount public function Tests that the Warning counter matches the displayed number of warnings.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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. 3
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. 4
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::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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
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. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.