class MigrateUpgradeExecuteTestBase

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

Provides a base class for testing a complete upgrade via the UI.

Hierarchy

Expanded class hierarchy of MigrateUpgradeExecuteTestBase

10 files declare their use of MigrateUpgradeExecuteTestBase
DoubleSlashTest.php in core/modules/migrate_drupal_ui/tests/src/Functional/d7/DoubleSlashTest.php
IdConflictTest.php in core/modules/migrate_drupal_ui/tests/src/Functional/d6/IdConflictTest.php
IdConflictTest.php in core/modules/migrate_drupal_ui/tests/src/Functional/d7/IdConflictTest.php
NodeClassicTest.php in core/modules/migrate_drupal_ui/tests/src/Functional/d6/NodeClassicTest.php
Upgrade6Test.php in core/modules/forum/tests/src/Functional/migrate_drupal/d6/Upgrade6Test.php

... See full list

File

core/modules/migrate_drupal_ui/tests/src/Functional/MigrateUpgradeExecuteTestBase.php, line 14

Namespace

Drupal\Tests\migrate_drupal_ui\Functional
View source
abstract class MigrateUpgradeExecuteTestBase extends MigrateUpgradeTestBase {
    use CreateTestContentEntitiesTrait;
    
    /**
     * Indicates if the watchdog logs should be output.
     *
     * @var bool
     */
    protected bool $outputLogs = FALSE;
    
    /**
     * The admin username after the migration.
     *
     * @var string
     */
    protected string $migratedAdminUserName = 'admin';
    
    /**
     * The number of expected logged errors of type migrate_drupal_ui.
     *
     * @var int
     */
    protected int $expectedLoggedErrors = 0;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create content.
        $this->createContent();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function tearDown() : void {
        if ($this->outputLogs) {
            $this->outputLogs($this->migratedAdminUserName);
        }
        parent::tearDown();
    }
    
    /**
     * Executes an upgrade and then an incremental upgrade.
     */
    public function doUpgradeAndIncremental() {
        // Start the upgrade process.
        $this->submitCredentialForm();
        $session = $this->assertSession();
        $this->submitForm([], 'I acknowledge I may lose data. Continue anyway.');
        $session->statusCodeEquals(200);
        // Test the review form.
        $this->assertReviewForm();
        $this->useTestMailCollector();
        $this->submitForm([], 'Perform upgrade');
        $this->assertUpgrade($this->getEntityCounts());
        // Test incremental migration.
        $this->createContentPostUpgrade();
        $this->drupalGet('/upgrade');
        $session->pageTextContains("An upgrade has already been performed on this site. To perform a new migration, create a clean and empty new install of Drupal {$this->destinationSiteVersion}. Rollbacks are not yet supported through the user interface.");
        $this->submitForm([], 'Import new configuration and content from old site');
        $this->submitForm($this->edits, 'Review upgrade');
        $this->submitForm([], 'I acknowledge I may lose data. Continue anyway.');
        $session->statusCodeEquals(200);
        // Run the incremental migration and check the results.
        $this->submitForm([], 'Perform upgrade');
        $this->assertUpgrade($this->getEntityCountsIncremental());
    }
    
    /**
     * Helper to set the test mail collector in settings.php.
     */
    public function useTestMailCollector() {
        // Set up an override.
        $settings['config']['system.mail']['interface']['default'] = (object) [
            'value' => 'test_mail_collector',
            'required' => TRUE,
        ];
        $settings['config']['system.mail']['mailer_dsn']['scheme'] = (object) [
            'value' => 'null',
            'required' => TRUE,
        ];
        $settings['config']['system.mail']['mailer_dsn']['host'] = (object) [
            'value' => 'null',
            'required' => TRUE,
        ];
        $this->writeSettings($settings);
    }
    
    /**
     * Checks the number of the specified entity's revisions.
     *
     * Revision translations are excluded.
     *
     * @param string $content_entity_type_id
     *   The entity type ID of the content entity, e.g. 'node', 'media',
     *   'block_content'.
     * @param int $expected_revision_count
     *   The expected number of the revisions.
     *
     * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
     * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
     */
    protected function assertEntityRevisionsCount(string $content_entity_type_id, int $expected_revision_count) {
        $entity_storage = \Drupal::entityTypeManager()->getStorage($content_entity_type_id);
        assert($entity_storage instanceof ContentEntityStorageInterface);
        $revision_ids = $entity_storage->getQuery()
            ->allRevisions()
            ->accessCheck(FALSE)
            ->execute();
        $this->assertCount($expected_revision_count, $revision_ids, sprintf("The number of %s revisions is different than expected", $content_entity_type_id));
    }
    
    /**
     * Asserts log errors.
     */
    public function assertLogError() : void {
        $db = \Drupal::service('database');
        $num_errors = $db->select('watchdog', 'w')
            ->fields('w')
            ->condition('type', 'migrate_drupal_ui')
            ->condition('severity', RfcLogLevel::ERROR)
            ->countQuery()
            ->execute()
            ->fetchField();
        $this->assertSame($this->expectedLoggedErrors, (int) $num_errors);
    }
    
    /**
     * Preserve the logs pages.
     */
    public function outputLogs(string $username) : void {
        // Ensure user 1 is accessing the admin log. Change the username because
        // the migration changes the username of user 1 but not the password.
        if (\Drupal::currentUser()->id() != 1) {
            $this->rootUser->name = $username;
            $this->drupalLogin($this->rootUser);
        }
        $this->drupalGet('/admin/reports/dblog');
        while ($next_link = $this->getSession()
            ->getPage()
            ->findLink('Next page')) {
            $next_link->click();
        }
    }

}

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::$defaultTheme protected property The theme to install as the default for testing. 1581
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::$modules protected static property Modules to install. 726
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
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::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
CreateTestContentEntitiesTrait::createContent protected function Create several pieces of generic content.
CreateTestContentEntitiesTrait::createContentPostUpgrade protected function Create several pieces of generic content.
CreateTestContentEntitiesTrait::getRequiredModules protected function Gets required modules.
CreateTestContentEntitiesTrait::installEntitySchemas protected function Install required entity schemas.
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. 3
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
MigrateUpgradeExecuteTestBase::$expectedLoggedErrors protected property The number of expected logged errors of type migrate_drupal_ui.
MigrateUpgradeExecuteTestBase::$migratedAdminUserName protected property The admin username after the migration.
MigrateUpgradeExecuteTestBase::$outputLogs protected property Indicates if the watchdog logs should be output.
MigrateUpgradeExecuteTestBase::assertEntityRevisionsCount protected function Checks the number of the specified entity's revisions.
MigrateUpgradeExecuteTestBase::assertLogError public function Asserts log errors.
MigrateUpgradeExecuteTestBase::doUpgradeAndIncremental public function Executes an upgrade and then an incremental upgrade.
MigrateUpgradeExecuteTestBase::outputLogs public function Preserve the logs pages.
MigrateUpgradeExecuteTestBase::setUp protected function Overrides MigrateUpgradeTestBase::setUp 10
MigrateUpgradeExecuteTestBase::tearDown protected function Overrides MigrateUpgradeTestBase::tearDown
MigrateUpgradeExecuteTestBase::useTestMailCollector public function Helper to set the test mail collector in settings.php.
MigrateUpgradeTestBase::$destinationSiteVersion protected property The destination site major version.
MigrateUpgradeTestBase::$edits protected property Input data for the credential form.
MigrateUpgradeTestBase::$profile protected property Use the Standard profile to test help implementations of many core modules. Overrides BrowserTestBase::$profile 2
MigrateUpgradeTestBase::$sourceDatabase protected property The source database connection.
MigrateUpgradeTestBase::assertEmailsSent protected function Confirm emails were sent.
MigrateUpgradeTestBase::assertFileMigrations protected function Checks public and private files are copied but not temporary files.
MigrateUpgradeTestBase::assertIdConflictForm protected function Helper method that asserts text on the ID conflict form.
MigrateUpgradeTestBase::assertReviewForm protected function Helper to assert content on the Review form.
MigrateUpgradeTestBase::assertUpgrade protected function Asserts the upgrade completed successfully.
MigrateUpgradeTestBase::assertUserLogIn public function Asserts that a migrated user can login.
MigrateUpgradeTestBase::createMigrationConnection protected function Changes the database connection to the prefixed one.
MigrateUpgradeTestBase::getAvailablePaths abstract protected function Gets the available upgrade paths. 25
MigrateUpgradeTestBase::getCredentials protected function Creates an array of credentials for the Credential form.
MigrateUpgradeTestBase::getEntityCounts abstract protected function Gets the expected number of entities per entity type after migration. 15
MigrateUpgradeTestBase::getEntityCountsIncremental abstract protected function Gets expected number of entities per entity after incremental migration. 15
MigrateUpgradeTestBase::getMissingPaths abstract protected function Gets the missing upgrade paths. 25
MigrateUpgradeTestBase::getSourceBasePath abstract protected function Gets the source base path for the concrete test. 25
MigrateUpgradeTestBase::getSourcePrivateBasePath protected function Provides the source base path for private files for the credential form.
MigrateUpgradeTestBase::loadFixture protected function Loads a database fixture into the source database connection.
MigrateUpgradeTestBase::submitCredentialForm public function Navigates to the credential form and submits valid credentials.
MigrationConfigurationTrait::$configFactory protected property The config factory service.
MigrationConfigurationTrait::$followUpMigrationTags protected property The follow-up migration tags.
MigrationConfigurationTrait::$migrationPluginManager protected property The migration plugin manager service.
MigrationConfigurationTrait::$state protected property The state service.
MigrationConfigurationTrait::createDatabaseStateSettings protected function Creates the necessary state entries for SqlBase::getDatabase() to work.
MigrationConfigurationTrait::getConfigFactory protected function Gets the config factory service.
MigrationConfigurationTrait::getConnection protected function Gets the database connection for the source Drupal database.
MigrationConfigurationTrait::getFollowUpMigrationTags protected function Returns the follow-up migration tags.
MigrationConfigurationTrait::getLegacyDrupalVersion public static function Determines what version of Drupal the source database contains.
MigrationConfigurationTrait::getMigrationPluginManager protected function Gets the migration plugin manager service.
MigrationConfigurationTrait::getMigrations protected function Gets the migrations for import.
MigrationConfigurationTrait::getState protected function Gets the state service.
MigrationConfigurationTrait::getSystemData protected function Gets the system data from the system table of the source Drupal database.
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. 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.