class UpdatePathTestBaseTest

Same name in other branches
  1. 9 core/tests/Drupal/FunctionalTests/Update/UpdatePathTestBaseTest.php \Drupal\FunctionalTests\Update\UpdatePathTestBaseTest
  2. 8.9.x core/tests/Drupal/FunctionalTests/Update/UpdatePathTestBaseTest.php \Drupal\FunctionalTests\Update\UpdatePathTestBaseTest
  3. 11.x core/tests/Drupal/FunctionalTests/Update/UpdatePathTestBaseTest.php \Drupal\FunctionalTests\Update\UpdatePathTestBaseTest

Tests the update path base class.

@group Update @group #slow

Hierarchy

Expanded class hierarchy of UpdatePathTestBaseTest

File

core/tests/Drupal/FunctionalTests/Update/UpdatePathTestBaseTest.php, line 16

Namespace

Drupal\FunctionalTests\Update
View source
class UpdatePathTestBaseTest extends UpdatePathTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'update_test_schema',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setDatabaseDumpFiles() {
        $this->databaseDumpFiles[] = __DIR__ . '/../../../../modules/system/tests/fixtures/update/drupal-9.4.0.bare.standard.php.gz';
        $this->databaseDumpFiles[] = __DIR__ . '/../../../../modules/system/tests/fixtures/update/drupal-8.update-test-schema-enabled.php';
        $this->databaseDumpFiles[] = __DIR__ . '/../../../../modules/system/tests/fixtures/update/drupal-8.update-test-semver-update-n-enabled.php';
    }
    
    /**
     * Tests that the database was properly loaded.
     */
    public function testDatabaseProperlyLoaded() : void {
        $this->testDatabaseLoaded();
    }
    
    /**
     * Tests that updates are properly run.
     */
    public function testUpdateHookN() : void {
        $connection = Database::getConnection();
        // Increment the schema version.
        \Drupal::state()->set('update_test_schema_version', 8001);
        $this->runUpdates();
        // Ensure that after running the updates the update functions have been
        // loaded. If they have not then the tests carried out in
        // \Drupal\Tests\UpdatePathTestTrait::runUpdates() can result in false
        // positives.
        $this->assertTrue(function_exists('update_test_semver_update_n_update_8001'), 'The update_test_semver_update_n_update_8001() has been loaded');
        $select = $connection->select('watchdog');
        $select->orderBy('wid', 'DESC');
        $select->range(0, 5);
        $select->fields('watchdog', [
            'message',
        ]);
        $container_cannot_be_saved_messages = array_filter(iterator_to_array($select->execute()), function ($row) {
            return str_contains($row->message, 'Container cannot be saved to cache.');
        });
        $this->assertEquals([], $container_cannot_be_saved_messages);
        // Ensure schema has changed.
        
        /** @var \Drupal\Core\Update\UpdateHookRegistry $update_registry */
        $update_registry = \Drupal::service('update.update_hook_registry');
        $this->assertEquals(8001, $update_registry->getInstalledVersion('update_test_schema'));
        $this->assertEquals(8001, $update_registry->getInstalledVersion('update_test_semver_update_n'));
        // Ensure the index was added for column a.
        $this->assertTrue($connection->schema()
            ->indexExists('update_test_schema_table', 'test'), 'Version 8001 of the update_test_schema module is installed.');
        // Ensure update_test_semver_update_n_update_8001 was run.
        $this->assertEquals('Yes, I was run. Thanks for testing!', \Drupal::state()->get('update_test_semver_update_n_update_8001'));
    }
    
    /**
     * Tests that path aliases are not processed during database updates.
     */
    public function testPathAliasProcessing() : void {
        // Add a path alias for the '/admin' system path.
        $values = [
            'path' => '/admin/structure',
            'alias' => '/admin-structure-alias',
            'langcode' => 'und',
            'status' => 1,
        ];
        $database = \Drupal::database();
        $id = $database->insert('path_alias')
            ->fields($values + [
            'uuid' => \Drupal::service('uuid')->generate(),
        ])
            ->execute();
        $revision_id = $database->insert('path_alias_revision')
            ->fields($values + [
            'id' => $id,
            'revision_default' => 1,
        ])
            ->execute();
        $database->update('path_alias')
            ->fields([
            'revision_id' => $revision_id,
        ])
            ->condition('id', $id)
            ->execute();
        // Increment the schema version.
        \Drupal::state()->set('update_test_schema_version', 8002);
        $this->runUpdates();
        // Check that the alias defined earlier is not used during the update
        // process.
        $this->assertSession()
            ->linkByHrefExists('/admin/structure');
        $this->assertSession()
            ->linkByHrefNotExists('/admin-structure-alias');
        $account = $this->createUser([
            'administer site configuration',
            'access administration pages',
            'access site reports',
        ]);
        $this->drupalLogin($account);
        // Go to the status report page and check that the alias is used.
        $this->drupalGet('admin/reports/status');
        $this->assertSession()
            ->linkByHrefNotExists('/admin/structure');
        $this->assertSession()
            ->linkByHrefExists('/admin-structure-alias');
    }
    
    /**
     * Tests that test running environment is updated when module list changes.
     *
     * @see update_test_schema_update_8003()
     */
    public function testModuleListChange() : void {
        // Set a value in the cache to prove caches are cleared.
        \Drupal::service('cache.default')->set(__CLASS__, 'Test');
        // Ensure that modules are installed and uninstalled as expected prior to
        // running updates.
        $extension_config = $this->config('core.extension')
            ->get();
        $this->assertArrayHasKey('page_cache', $extension_config['module']);
        $this->assertArrayNotHasKey('module_test', $extension_config['module']);
        $module_list = \Drupal::moduleHandler()->getModuleList();
        $this->assertArrayHasKey('page_cache', $module_list);
        $this->assertArrayNotHasKey('module_test', $module_list);
        $namespaces = \Drupal::getContainer()->getParameter('container.namespaces');
        $this->assertArrayHasKey('Drupal\\page_cache', $namespaces);
        $this->assertArrayNotHasKey('Drupal\\module_test', $namespaces);
        // Increment the schema version so that update_test_schema_update_8003()
        // runs.
        \Drupal::state()->set('update_test_schema_version', 8003);
        $this->runUpdates();
        // Ensure that test running environment has been updated with the changes to
        // the module list.
        $extension_config = $this->config('core.extension')
            ->get();
        $this->assertArrayNotHasKey('page_cache', $extension_config['module']);
        $this->assertArrayHasKey('module_test', $extension_config['module']);
        $module_list = \Drupal::moduleHandler()->getModuleList();
        $this->assertArrayNotHasKey('page_cache', $module_list);
        $this->assertArrayHasKey('module_test', $module_list);
        $namespaces = \Drupal::getContainer()->getParameter('container.namespaces');
        $this->assertArrayNotHasKey('Drupal\\page_cache', $namespaces);
        $this->assertArrayHasKey('Drupal\\module_test', $namespaces);
        // Ensure the test runners cache has been cleared.
        $this->assertFalse(\Drupal::service('cache.default')->get(__CLASS__));
    }
    
    /**
     * Tests that schema can be excluded from testing.
     *
     * @see \Drupal\FunctionalTests\Update\UpdatePathTestBase::runUpdates()
     * @see \Drupal\Core\Test\TestSetupTrait::$configSchemaCheckerExclusions
     */
    public function testSchemaChecking() : void {
        // Create some configuration that should be skipped.
        $this->config('config_schema_test.no_schema')
            ->set('foo', 'bar')
            ->save();
        $this->runUpdates();
        $this->assertSame('bar', $this->config('config_schema_test.no_schema')
            ->get('foo'));
    }
    
    /**
     * Tests that setup is done correctly.
     */
    public function testSetup() : void {
        $this->assertCount(3, $this->databaseDumpFiles);
        $this->assertSame(1, Settings::get('entity_update_batch_size'));
    }

}

Members

Title Sort descending Deprecated 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::$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 SettingsEditor::rewrite().
BrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. 1575
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. 40
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 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::initMink protected function Initializes Mink sessions. 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::__get 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
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. 10
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::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::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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
RequirementsPageTrait::assertErrorSummaries protected function Asserts the given error summaries are present on the page.
RequirementsPageTrait::assertRequirementSummaries protected function Asserts the given requirements section summaries are present on the page.
RequirementsPageTrait::assertWarningSummaries protected function Asserts the given warning summaries are present on the page.
RequirementsPageTrait::continueOnExpectedWarnings protected function Continues installation when the expected warnings are found.
RequirementsPageTrait::updateRequirementsProblem protected function Handles the update requirements page.
SchemaCheckTestTrait::assertConfigSchema public function Asserts the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTestTrait::assertConfigSchemaByName public function Asserts configuration, specified by name, has a valid schema.
SchemaCheckTrait::$configName protected property The configuration object name under test.
SchemaCheckTrait::$ignoredPropertyPaths protected static property The ignored property paths.
SchemaCheckTrait::$schema protected property The config schema wrapper object for the configuration object under test.
SchemaCheckTrait::checkConfigSchema public function Checks the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTrait::checkValue protected function Helper method to check data type.
SchemaCheckTrait::isViolationForIgnoredPropertyPath protected static function Determines whether this violation is for an ignored Config property path.
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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated 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. 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::$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 Deprecated public static function Returns the database connection to the site under 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.
UpdatePathTestBase::$databaseDumpFiles protected property The file path(s) to the dumped database(s) to load into the child site.
UpdatePathTestBase::$strictConfigSchema protected property Disable strict config schema checking. Overrides TestSetupTrait::$strictConfigSchema
UpdatePathTestBase::$updateUrl protected property The update URL.
UpdatePathTestBase::doInstall protected function Execute the non-interactive installer. Overrides FunctionalTestSetupTrait::doInstall
UpdatePathTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
UpdatePathTestBase::installDrupal public function Overrides BrowserTestBase::installDrupal() for update testing. Overrides BrowserTestBase::installDrupal
UpdatePathTestBase::prepareSettings protected function Add settings that are missed since the installer isn't run. Overrides FunctionalTestSetupTrait::prepareSettings 1
UpdatePathTestBase::replaceUser1 protected function Replace User 1 with the user created here. 1
UpdatePathTestBase::runDbTasks protected function Runs the install database tasks for the driver used by the test runner. 2
UpdatePathTestBase::runUpdates protected function Helper function to run pending database updates.
UpdatePathTestBase::setUp protected function Overrides BrowserTestBase::setUp 10
UpdatePathTestBase::testDatabaseLoaded protected function Tests that the database was properly loaded. 1
UpdatePathTestBaseTest::$modules protected static property Modules to install after the database is loaded. Overrides UpdatePathTestBase::$modules
UpdatePathTestBaseTest::setDatabaseDumpFiles protected function Set database dump files to be used. Overrides UpdatePathTestBase::setDatabaseDumpFiles
UpdatePathTestBaseTest::testDatabaseProperlyLoaded public function Tests that the database was properly loaded.
UpdatePathTestBaseTest::testModuleListChange public function Tests that test running environment is updated when module list changes.
UpdatePathTestBaseTest::testPathAliasProcessing public function Tests that path aliases are not processed during database updates.
UpdatePathTestBaseTest::testSchemaChecking public function Tests that schema can be excluded from testing.
UpdatePathTestBaseTest::testSetup public function Tests that setup is done correctly.
UpdatePathTestBaseTest::testUpdateHookN public function Tests that updates are properly run.
UpdatePathTestTrait::$checkFailedUpdates protected property Fail the test if there are failed updates.
UpdatePathTestTrait::doSelectionTest protected function Tests the selection page. 5
UpdatePathTestTrait::ensureUpdatesToRun protected function Installs the update_script_test module and makes an update available.
UpdatePathTestTrait::runUpdates protected function Helper function to run pending database updates. Aliased as: doRunUpdates
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.