123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338 |
- <?php
- namespace Drupal\FunctionalTests\Update;
- use Drupal\Component\Utility\Crypt;
- use Drupal\Core\Site\Settings;
- use Drupal\Core\Test\TestRunnerKernel;
- use Drupal\Tests\BrowserTestBase;
- use Drupal\Core\Database\Database;
- use Drupal\Core\DependencyInjection\ContainerBuilder;
- use Drupal\Core\File\FileSystemInterface;
- use Drupal\Core\Language\Language;
- use Drupal\Core\Url;
- use Drupal\Tests\UpdatePathTestTrait;
- use Drupal\user\Entity\User;
- use Symfony\Component\DependencyInjection\Reference;
- use Symfony\Component\HttpFoundation\Request;
- /**
- * Provides a base class for writing an update test.
- *
- * To write an update test:
- * - Write the hook_update_N() implementations that you are testing.
- * - Create one or more database dump files, which will set the database to the
- * "before updates" state. Normally, these will add some configuration data to
- * the database, set up some tables/fields, etc.
- * - Create a class that extends this class.
- * - Ensure that the test is in the legacy group. Tests can have multiple
- * groups.
- * - In your setUp() method, point the $this->databaseDumpFiles variable to the
- * database dump files, and then call parent::setUp() to run the base setUp()
- * method in this class.
- * - In your test method, call $this->runUpdates() to run the necessary updates,
- * and then use test assertions to verify that the result is what you expect.
- * - In order to test both with a "bare" database dump as well as with a
- * database dump filled with content, extend your update path test class with
- * a new test class that overrides the bare database dump. Refer to
- * UpdatePathTestBaseFilledTest for an example.
- *
- * @ingroup update_api
- *
- * @see hook_update_N()
- */
- abstract class UpdatePathTestBase extends BrowserTestBase {
- use UpdatePathTestTrait {
- runUpdates as doRunUpdates;
- }
- /**
- * Modules to enable after the database is loaded.
- */
- protected static $modules = [];
- /**
- * The file path(s) to the dumped database(s) to load into the child site.
- *
- * The file system/tests/fixtures/update/drupal-8.bare.standard.php.gz is
- * normally included first -- this sets up the base database from a bare
- * standard Drupal installation.
- *
- * The file system/tests/fixtures/update/drupal-8.filled.standard.php.gz
- * can also be used in case we want to test with a database filled with
- * content, and with all core modules enabled.
- *
- * @var array
- */
- protected $databaseDumpFiles = [];
- /**
- * The install profile used in the database dump file.
- *
- * @var string
- */
- protected $installProfile = 'standard';
- /**
- * Flag that indicates whether the child site has been updated.
- *
- * @var bool
- */
- protected $upgradedSite = FALSE;
- /**
- * Array of errors triggered during the update process.
- *
- * @var array
- */
- protected $upgradeErrors = [];
- /**
- * Array of modules loaded when the test starts.
- *
- * @var array
- */
- protected $loadedModules = [];
- /**
- * Flag to indicate whether zlib is installed or not.
- *
- * @var bool
- */
- protected $zlibInstalled = TRUE;
- /**
- * Flag to indicate whether there are pending updates or not.
- *
- * @var bool
- */
- protected $pendingUpdates = TRUE;
- /**
- * The update URL.
- *
- * @var string
- */
- protected $updateUrl;
- /**
- * Disable strict config schema checking.
- *
- * The schema is verified at the end of running the update.
- *
- * @var bool
- */
- protected $strictConfigSchema = FALSE;
- /**
- * Constructs an UpdatePathTestCase object.
- *
- * @param $test_id
- * (optional) The ID of the test. Tests with the same id are reported
- * together.
- * @param array $data
- * (optional) The test case data. Defaults to none.
- * @param string $data_name
- * The test data name. Defaults to none.
- */
- public function __construct($test_id = NULL, array $data = [], $data_name = '') {
- parent::__construct($test_id, $data, $data_name);
- $this->zlibInstalled = function_exists('gzopen');
- }
- /**
- * Overrides WebTestBase::setUp() for update testing.
- *
- * The main difference in this method is that rather than performing the
- * installation via the installer, a database is loaded. Additional work is
- * then needed to set various things such as the config directories and the
- * container that would normally be done via the installer.
- */
- protected function setUp() {
- $request = Request::createFromGlobals();
- // Boot up Drupal into a state where calling the database API is possible.
- // This is used to initialize the database system, so we can load the dump
- // files.
- $autoloader = require $this->root . '/autoload.php';
- $kernel = TestRunnerKernel::createFromRequest($request, $autoloader);
- $kernel->loadLegacyIncludes();
- // Set the update url. This must be set here rather than in
- // self::__construct() or the old URL generator will leak additional test
- // sites. Additionally, we need to prevent the path alias processor from
- // running because we might not have a working alias system before running
- // the updates.
- $this->updateUrl = Url::fromRoute('system.db_update', [], ['path_processing' => FALSE]);
- $this->setupBaseUrl();
- // Install Drupal test site.
- $this->prepareEnvironment();
- $this->runDbTasks();
- // We are going to set a missing zlib requirement property for usage
- // during the performUpgrade() and tearDown() methods. Also set that the
- // tests failed.
- if (!$this->zlibInstalled) {
- parent::setUp();
- return;
- }
- $this->installDrupal();
- // Add the config directories to settings.php.
- $sync_directory = Settings::get('config_sync_directory');
- \Drupal::service('file_system')->prepareDirectory($sync_directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
- // Ensure the default temp directory exist and is writable. The configured
- // temp directory may be removed during update.
- \Drupal::service('file_system')->prepareDirectory($this->tempFilesDirectory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
- // Set the container. parent::rebuildAll() would normally do this, but this
- // not safe to do here, because the database has not been updated yet.
- $this->container = \Drupal::getContainer();
- $this->replaceUser1();
- require_once $this->root . '/core/includes/update.inc';
- // Setup Mink.
- $this->initMink();
- // Set up the browser test output file.
- $this->initBrowserOutputFile();
- }
- /**
- * {@inheritdoc}
- */
- public function installDrupal() {
- $this->initUserSession();
- $this->prepareSettings();
- $this->doInstall();
- $this->initSettings();
- $request = Request::createFromGlobals();
- $container = $this->initKernel($request);
- $this->initConfig($container);
- }
- /**
- * {@inheritdoc}
- */
- protected function doInstall() {
- $this->runDbTasks();
- // Allow classes to set database dump files.
- $this->setDatabaseDumpFiles();
- // Load the database(s).
- foreach ($this->databaseDumpFiles as $file) {
- if (substr($file, -3) == '.gz') {
- $file = "compress.zlib://$file";
- }
- require $file;
- }
- }
- /**
- * {@inheritdoc}
- */
- protected function initFrontPage() {
- // Do nothing as Drupal is not installed yet.
- }
- /**
- * Set database dump files to be used.
- */
- abstract protected function setDatabaseDumpFiles();
- /**
- * Add settings that are missed since the installer isn't run.
- */
- protected function prepareSettings() {
- parent::prepareSettings();
- // Remember the profile which was used.
- $settings['settings']['install_profile'] = (object) [
- 'value' => $this->installProfile,
- 'required' => TRUE,
- ];
- // Generate a hash salt.
- $settings['settings']['hash_salt'] = (object) [
- 'value' => Crypt::randomBytesBase64(55),
- 'required' => TRUE,
- ];
- // Since the installer isn't run, add the database settings here too.
- $settings['databases']['default'] = (object) [
- 'value' => Database::getConnectionInfo(),
- 'required' => TRUE,
- ];
- // Force every update hook to only run one entity per batch.
- $settings['entity_update_batch_size'] = (object) [
- 'value' => 1,
- 'required' => TRUE,
- ];
- // Set up sync directory.
- $settings['settings']['config_sync_directory'] = (object) [
- 'value' => $this->publicFilesDirectory . '/config_sync',
- 'required' => TRUE,
- ];
- $this->writeSettings($settings);
- }
- /**
- * Helper function to run pending database updates.
- */
- protected function runUpdates() {
- if (!$this->zlibInstalled) {
- $this->fail('Missing zlib requirement for update tests.');
- return FALSE;
- }
- $this->doRunUpdates($this->updateUrl);
- }
- /**
- * Runs the install database tasks for the driver used by the test runner.
- */
- protected function runDbTasks() {
- // Create a minimal container so that t() works.
- // @see install_begin_request()
- $container = new ContainerBuilder();
- $container->setParameter('language.default_values', Language::$defaultValues);
- $container
- ->register('language.default', 'Drupal\Core\Language\LanguageDefault')
- ->addArgument('%language.default_values%');
- $container
- ->register('string_translation', 'Drupal\Core\StringTranslation\TranslationManager')
- ->addArgument(new Reference('language.default'));
- \Drupal::setContainer($container);
- require_once __DIR__ . '/../../../../includes/install.inc';
- $connection_info = Database::getConnectionInfo();
- $driver = $connection_info['default']['driver'];
- $namespace = $connection_info['default']['namespace'] ?? NULL;
- $errors = db_installer_object($driver, $namespace)->runTasks();
- if (!empty($errors)) {
- $this->fail('Failed to run installer database tasks: ' . implode(', ', $errors));
- }
- }
- /**
- * Replace User 1 with the user created here.
- */
- protected function replaceUser1() {
- /** @var \Drupal\user\UserInterface $account */
- // @todo: Saving the account before the update is problematic.
- // https://www.drupal.org/node/2560237
- $account = User::load(1);
- $account->setPassword($this->rootUser->pass_raw);
- $account->setEmail($this->rootUser->getEmail());
- $account->setUsername($this->rootUser->getAccountName());
- $account->save();
- }
- }
|