class UpdateSemverContribTestBase

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

Base class for Update manager semantic versioning tests of contrib projects.

This wires up the protected data from UpdateSemverTestBase for a contrib module with semantic version releases.

Hierarchy

Expanded class hierarchy of UpdateSemverContribTestBase

File

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

Namespace

Drupal\Tests\update\Functional
View source
class UpdateSemverContribTestBase extends UpdateSemverTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $updateTableLocator = 'table.update:nth-of-type(2)';
    
    /**
     * {@inheritdoc}
     */
    protected $updateProject = 'semver_test';
    
    /**
     * {@inheritdoc}
     */
    protected $projectTitle = 'Semver Test';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'semver_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setProjectInstalledVersion($version) {
        $this->mockInstalledExtensionsInfo([
            $this->updateProject => [
                'project' => $this->updateProject,
                'version' => $version,
                'hidden' => FALSE,
            ],
            // Ensure Drupal core on the same version for all test runs.
'drupal' => [
                'project' => 'drupal',
                'version' => '8.0.0',
                'hidden' => FALSE,
            ],
        ]);
        $this->mockDefaultExtensionsInfo([
            'version' => '8.0.0',
        ]);
    }
    
    /**
     * Tests updates from legacy versions to the semver versions.
     */
    public function testUpdatesLegacyToSemver() : void {
        // Test cases where the legacy branch is in the XML 'supported_branches' and
        // when it is not.
        foreach ([
            TRUE,
            FALSE,
        ] as $legacy_supported) {
            // Test 2 legacy majors.
            foreach ([
                7,
                8,
            ] as $legacy_major) {
                $semver_major = $legacy_major + 1;
                $installed_versions = [
                    "8.x-{$legacy_major}.0-alpha1",
                    "8.x-{$legacy_major}.0-beta1",
                    "8.x-{$legacy_major}.0",
                    "8.x-{$legacy_major}.1-alpha1",
                    "8.x-{$legacy_major}.1-beta1",
                    "8.x-{$legacy_major}.1",
                ];
                foreach ($installed_versions as $installed_version) {
                    $this->setProjectInstalledVersion($installed_version);
                    if ($legacy_supported) {
                        $fixture = $legacy_major === 7 ? '8.1.0' : '9.1.0';
                    }
                    else {
                        if ($legacy_major === 8) {
                            continue;
                        }
                        $fixture = '8.1.0-legacy-unsupported';
                    }
                    $this->refreshUpdateStatus([
                        $this->updateProject => $fixture,
                    ]);
                    $this->assertUpdateTableTextNotContains('Security update required!');
                    $this->assertSession()
                        ->elementTextContains('css', $this->updateTableLocator . " .project-update__title", $installed_version);
                    if ($legacy_supported) {
                        // All installed versions should indicate that there is an update
                        // available for the next major version of the module.
                        // '$legacy_major.1.0' is shown for the next major version because
                        // it is the latest full release for that major.
                        // @todo Determine if both 8.0.0 and 8.0.1 should be expected as
                        // "Also available" releases in
                        // https://www.drupal.org/project/node/3100115.
                        $this->assertVersionUpdateLinks('Also available:', "{$semver_major}.1.0");
                        if ($installed_version === "8.x-{$legacy_major}.1") {
                            $this->assertUpdateTableTextContains('Up to date');
                            $this->assertUpdateTableTextNotContains('Update available');
                        }
                        else {
                            $this->assertUpdateTableTextNotContains('Up to date');
                            $this->assertUpdateTableTextContains('Update available');
                            // All installed versions besides 8.x-$legacy_major.1 should
                            // recommend 8.x-$legacy_major.1 because it is the latest full
                            // release for the major.
                            $this->assertVersionUpdateLinks('Recommended version:', "8.x-{$legacy_major}.1");
                        }
                    }
                    else {
                        // If '8.x-7.' is not in the XML 'supported_branches' value then the
                        // latest release for the next major should always be recommended.
                        $this->assertVersionUpdateLinks('Recommended version:', "{$semver_major}.1.0");
                    }
                }
            }
        }
    }

}

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. 40
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
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
CronRunTrait::cronRun protected function Runs cron on the test site.
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. 19
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. 28
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.
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. 2
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::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.
UpdateSemverContribTestBase::$modules protected static property Modules to enable. Overrides UpdateSemverTestBase::$modules
UpdateSemverContribTestBase::$projectTitle protected property The title of the project being tested. Overrides UpdateSemverTestBase::$projectTitle
UpdateSemverContribTestBase::$updateProject protected property The project that is being tested. Overrides UpdateTestBase::$updateProject
UpdateSemverContribTestBase::$updateTableLocator protected property The CSS locator for the update table run asserts on. Overrides UpdateTestBase::$updateTableLocator
UpdateSemverContribTestBase::setProjectInstalledVersion protected function Sets the project installed version. Overrides UpdateSemverTestBase::setProjectInstalledVersion
UpdateSemverContribTestBase::testUpdatesLegacyToSemver public function Tests updates from legacy versions to the semver versions.
UpdateSemverTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
UpdateSemverTestBase::refreshUpdateStatus protected function Refreshes the update status based on the desired available update scenario. Overrides UpdateTestBase::refreshUpdateStatus
UpdateSemverTestBase::setUp protected function Overrides BrowserTestBase::setUp
UpdateTestBase::assertSecurityUpdates protected function Asserts the expected security updates are displayed correctly on the page.
UpdateTestBase::assertUpdateTableElementContains protected function Asserts that the update table element HTML contains the specified text.
UpdateTestBase::assertUpdateTableElementNotContains protected function Asserts that the update table element HTML contains the specified text.
UpdateTestBase::assertUpdateTableTextContains protected function Asserts that the update table text contains the specified text.
UpdateTestBase::assertUpdateTableTextNotContains protected function Asserts that the update table text does not contain the specified text.
UpdateTestBase::assertVersionUpdateLinks protected function Asserts that an update version has the correct links.
UpdateTestBase::confirmRevokedStatus protected function Confirms messages are correct when a release has been unpublished/revoked.
UpdateTestBase::confirmUnsupportedStatus protected function Confirms messages are correct when a release has been marked unsupported.
UpdateTestBase::findUpdateElementByLabel protected function Finds an update page element by label.
UpdateTestBase::SECURITY_UPDATE_REQUIRED constant Denotes a security update will be required in the test case.
UpdateTestBase::standardTests protected function Runs a series of assertions that are applicable to all update statuses.
UpdateTestBase::UPDATE_AVAILABLE constant Denotes an update will be available in the test case.
UpdateTestBase::UPDATE_NONE constant Denotes no update will be available in the test case.
UpdateTestTrait::mockDefaultExtensionsInfo protected function Sets default information about installed extensions.
UpdateTestTrait::mockInstalledExtensionsInfo protected function Sets information about installed extensions.
UpdateTestTrait::mockReleaseHistory protected function Sets available release history.
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.