Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\simpletest\Tests;
Chris@0: 
Chris@0: use Drupal\Core\Database\Database;
Chris@0: use Drupal\field\Entity\FieldConfig;
Chris@0: use Drupal\simpletest\KernelTestBase;
Chris@0: use Drupal\field\Entity\FieldStorageConfig;
Chris@0: use Drupal\Core\Entity\Entity\EntityViewDisplay;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests KernelTestBase functionality.
Chris@0:  *
Chris@0:  * @group simpletest
Chris@0:  */
Chris@0: class KernelTestBaseTest extends KernelTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['entity_test'];
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected function setUp() {
Chris@0:     $php = <<<'EOS'
Chris@0: <?php
Chris@0: # Make sure that the $test_class variable is defined when this file is included.
Chris@0: if ($test_class) {
Chris@0: }
Chris@0: 
Chris@0: # Define a function to be able to check that this file was loaded with
Chris@0: # function_exists().
Chris@0: if (!function_exists('simpletest_test_stub_settings_function')) {
Chris@0:   function simpletest_test_stub_settings_function() {}
Chris@0: }
Chris@0: EOS;
Chris@0: 
Chris@0:     $settings_testing_file = $this->siteDirectory . '/settings.testing.php';
Chris@0:     file_put_contents($settings_testing_file, $php);
Chris@0: 
Chris@0:     $original_container = $this->originalContainer;
Chris@0:     parent::setUp();
Chris@0:     $this->assertNotIdentical(\Drupal::getContainer(), $original_container, 'KernelTestBase test creates a new container.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests expected behavior of setUp().
Chris@0:    */
Chris@0:   public function testSetUp() {
Chris@0:     $modules = ['entity_test'];
Chris@0:     $table = 'entity_test';
Chris@0: 
Chris@0:     // Verify that specified $modules have been loaded.
Chris@0:     $this->assertTrue(function_exists('entity_test_entity_bundle_info'), 'entity_test.module was loaded.');
Chris@0:     // Verify that there is a fixed module list.
Chris@0:     $this->assertIdentical(array_keys(\Drupal::moduleHandler()->getModuleList()), $modules);
Chris@0:     $this->assertIdentical(\Drupal::moduleHandler()->getImplementations('entity_bundle_info'), ['entity_test']);
Chris@0:     $this->assertIdentical(\Drupal::moduleHandler()->getImplementations('entity_type_alter'), ['entity_test']);
Chris@0: 
Chris@0:     // Verify that no modules have been installed.
Chris@17:     $this->assertFalse(Database::getConnection()->schema()->tableExists($table), "'$table' database table not found.");
Chris@0: 
Chris@0:     // Verify that the settings.testing.php got taken into account.
Chris@0:     $this->assertTrue(function_exists('simpletest_test_stub_settings_function'));
Chris@0: 
Chris@0:     // Ensure that the database tasks have been run during set up. Neither MySQL
Chris@0:     // nor SQLite make changes that are testable.
Chris@0:     $database = $this->container->get('database');
Chris@0:     if ($database->driver() == 'pgsql') {
Chris@0:       $this->assertEqual('on', $database->query("SHOW standard_conforming_strings")->fetchField());
Chris@0:       $this->assertEqual('escape', $database->query("SHOW bytea_output")->fetchField());
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests expected load behavior of enableModules().
Chris@0:    */
Chris@0:   public function testEnableModulesLoad() {
Chris@0:     $module = 'field_test';
Chris@0: 
Chris@0:     // Verify that the module does not exist yet.
Chris@0:     $this->assertFalse(\Drupal::moduleHandler()->moduleExists($module), "$module module not found.");
Chris@0:     $list = array_keys(\Drupal::moduleHandler()->getModuleList());
Chris@0:     $this->assertFalse(in_array($module, $list), "$module module not found in the extension handler's module list.");
Chris@0:     $list = \Drupal::moduleHandler()->getImplementations('entity_display_build_alter');
Chris@0:     $this->assertFalse(in_array($module, $list), "{$module}_entity_display_build_alter() in \Drupal::moduleHandler()->getImplementations() not found.");
Chris@0: 
Chris@0:     // Enable the module.
Chris@0:     $this->enableModules([$module]);
Chris@0: 
Chris@0:     // Verify that the module exists.
Chris@0:     $this->assertTrue(\Drupal::moduleHandler()->moduleExists($module), "$module module found.");
Chris@0:     $list = array_keys(\Drupal::moduleHandler()->getModuleList());
Chris@0:     $this->assertTrue(in_array($module, $list), "$module module found in the extension handler's module list.");
Chris@0:     $list = \Drupal::moduleHandler()->getImplementations('query_efq_table_prefixing_test_alter');
Chris@0:     $this->assertTrue(in_array($module, $list), "{$module}_query_efq_table_prefixing_test_alter() in \Drupal::moduleHandler()->getImplementations() found.");
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests expected installation behavior of enableModules().
Chris@0:    */
Chris@0:   public function testEnableModulesInstall() {
Chris@0:     $module = 'module_test';
Chris@0:     $table = 'module_test';
Chris@0: 
Chris@0:     // Verify that the module does not exist yet.
Chris@0:     $this->assertFalse(\Drupal::moduleHandler()->moduleExists($module), "$module module not found.");
Chris@0:     $list = array_keys(\Drupal::moduleHandler()->getModuleList());
Chris@0:     $this->assertFalse(in_array($module, $list), "$module module not found in the extension handler's module list.");
Chris@0:     $list = \Drupal::moduleHandler()->getImplementations('hook_info');
Chris@0:     $this->assertFalse(in_array($module, $list), "{$module}_hook_info() in \Drupal::moduleHandler()->getImplementations() not found.");
Chris@0: 
Chris@17:     $this->assertFalse(Database::getConnection()->schema()->tableExists($table), "'$table' database table not found.");
Chris@0: 
Chris@0:     // Install the module.
Chris@0:     \Drupal::service('module_installer')->install([$module]);
Chris@0: 
Chris@0:     // Verify that the enabled module exists.
Chris@0:     $this->assertTrue(\Drupal::moduleHandler()->moduleExists($module), "$module module found.");
Chris@0:     $list = array_keys(\Drupal::moduleHandler()->getModuleList());
Chris@0:     $this->assertTrue(in_array($module, $list), "$module module found in the extension handler's module list.");
Chris@0:     $list = \Drupal::moduleHandler()->getImplementations('hook_info');
Chris@0:     $this->assertTrue(in_array($module, $list), "{$module}_hook_info() in \Drupal::moduleHandler()->getImplementations() found.");
Chris@0: 
Chris@17:     $this->assertTrue(Database::getConnection()->schema()->tableExists($table), "'$table' database table found.");
Chris@0:     $schema = drupal_get_module_schema($module, $table);
Chris@0:     $this->assertTrue($schema, "'$table' table schema found.");
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests installing modules with DependencyInjection services.
Chris@0:    */
Chris@0:   public function testEnableModulesInstallContainer() {
Chris@0:     // Install Node module.
Chris@0:     $this->enableModules(['user', 'field', 'node']);
Chris@0: 
Chris@0:     $this->installEntitySchema('node', ['node', 'node_field_data']);
Chris@0:     // Perform an entity query against node.
Chris@0:     $query = \Drupal::entityQuery('node');
Chris@0:     // Disable node access checks, since User module is not enabled.
Chris@0:     $query->accessCheck(FALSE);
Chris@0:     $query->condition('nid', 1);
Chris@0:     $query->execute();
Chris@0:     $this->pass('Entity field query was executed.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests expected behavior of installSchema().
Chris@0:    */
Chris@0:   public function testInstallSchema() {
Chris@0:     $module = 'entity_test';
Chris@0:     $table = 'entity_test_example';
Chris@0:     // Verify that we can install a table from the module schema.
Chris@0:     $this->installSchema($module, $table);
Chris@17:     $this->assertTrue(Database::getConnection()->schema()->tableExists($table), "'$table' database table found.");
Chris@0: 
Chris@0:     // Verify that the schema is known to Schema API.
Chris@0:     $schema = drupal_get_module_schema($module, $table);
Chris@0:     $this->assertTrue($schema, "'$table' table schema found.");
Chris@0: 
Chris@0:     // Verify that a unknown table from an enabled module throws an error.
Chris@0:     $table = 'unknown_entity_test_table';
Chris@0:     try {
Chris@0:       $this->installSchema($module, $table);
Chris@0:       $this->fail('Exception for non-retrievable schema found.');
Chris@0:     }
Chris@0:     catch (\Exception $e) {
Chris@0:       $this->pass('Exception for non-retrievable schema found.');
Chris@0:     }
Chris@17:     $this->assertFalse(Database::getConnection()->schema()->tableExists($table), "'$table' database table not found.");
Chris@0:     $schema = drupal_get_module_schema($module, $table);
Chris@0:     $this->assertFalse($schema, "'$table' table schema not found.");
Chris@0: 
Chris@0:     // Verify that a table from a unknown module cannot be installed.
Chris@0:     $module = 'database_test';
Chris@0:     $table = 'test';
Chris@0:     try {
Chris@0:       $this->installSchema($module, $table);
Chris@0:       $this->fail('Exception for non-retrievable schema found.');
Chris@0:     }
Chris@0:     catch (\Exception $e) {
Chris@0:       $this->pass('Exception for non-retrievable schema found.');
Chris@0:     }
Chris@17:     $this->assertFalse(Database::getConnection()->schema()->tableExists($table), "'$table' database table not found.");
Chris@0:     $schema = drupal_get_module_schema($module, $table);
Chris@0:     $this->assertTrue($schema, "'$table' table schema found.");
Chris@0: 
Chris@0:     // Verify that the same table can be installed after enabling the module.
Chris@0:     $this->enableModules([$module]);
Chris@0:     $this->installSchema($module, $table);
Chris@17:     $this->assertTrue(Database::getConnection()->schema()->tableExists($table), "'$table' database table found.");
Chris@0:     $schema = drupal_get_module_schema($module, $table);
Chris@0:     $this->assertTrue($schema, "'$table' table schema found.");
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests expected behavior of installEntitySchema().
Chris@0:    */
Chris@0:   public function testInstallEntitySchema() {
Chris@0:     $entity = 'entity_test';
Chris@0:     // The entity_test Entity has a field that depends on the User module.
Chris@0:     $this->enableModules(['user']);
Chris@0:     // Verity that the entity schema is created properly.
Chris@0:     $this->installEntitySchema($entity);
Chris@17:     $this->assertTrue(Database::getConnection()->schema()->tableExists($entity), "'$entity' database table found.");
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests expected behavior of installConfig().
Chris@0:    */
Chris@0:   public function testInstallConfig() {
Chris@0:     // The user module has configuration that depends on system.
Chris@0:     $this->enableModules(['system']);
Chris@0:     $module = 'user';
Chris@0: 
Chris@0:     // Verify that default config can only be installed for enabled modules.
Chris@0:     try {
Chris@0:       $this->installConfig([$module]);
Chris@0:       $this->fail('Exception for non-enabled module found.');
Chris@0:     }
Chris@0:     catch (\Exception $e) {
Chris@0:       $this->pass('Exception for non-enabled module found.');
Chris@0:     }
Chris@0:     $this->assertFalse($this->container->get('config.storage')->exists('user.settings'));
Chris@0: 
Chris@0:     // Verify that default config can be installed.
Chris@0:     $this->enableModules(['user']);
Chris@0:     $this->installConfig(['user']);
Chris@0:     $this->assertTrue($this->container->get('config.storage')->exists('user.settings'));
Chris@0:     $this->assertTrue($this->config('user.settings')->get('register'));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests that the module list is retained after enabling/installing/disabling.
Chris@0:    */
Chris@0:   public function testEnableModulesFixedList() {
Chris@0:     // Install system module.
Chris@18:     $this->container->get('module_installer')->install(['system', 'user', 'menu_link_content']);
Chris@0:     $entity_manager = \Drupal::entityManager();
Chris@0: 
Chris@0:     // entity_test is loaded via $modules; its entity type should exist.
Chris@0:     $this->assertEqual($this->container->get('module_handler')->moduleExists('entity_test'), TRUE);
Chris@0:     $this->assertTrue(TRUE == $entity_manager->getDefinition('entity_test'));
Chris@0: 
Chris@0:     // Load some additional modules; entity_test should still exist.
Chris@0:     $this->enableModules(['field', 'text', 'entity_test']);
Chris@0:     $this->assertEqual($this->container->get('module_handler')->moduleExists('entity_test'), TRUE);
Chris@0:     $this->assertTrue(TRUE == $entity_manager->getDefinition('entity_test'));
Chris@0: 
Chris@0:     // Install some other modules; entity_test should still exist.
Chris@0:     $this->container->get('module_installer')->install(['user', 'field', 'field_test'], FALSE);
Chris@0:     $this->assertEqual($this->container->get('module_handler')->moduleExists('entity_test'), TRUE);
Chris@0:     $this->assertTrue(TRUE == $entity_manager->getDefinition('entity_test'));
Chris@0: 
Chris@0:     // Uninstall one of those modules; entity_test should still exist.
Chris@0:     $this->container->get('module_installer')->uninstall(['field_test']);
Chris@0:     $this->assertEqual($this->container->get('module_handler')->moduleExists('entity_test'), TRUE);
Chris@0:     $this->assertTrue(TRUE == $entity_manager->getDefinition('entity_test'));
Chris@0: 
Chris@0:     // Set the weight of a module; entity_test should still exist.
Chris@0:     module_set_weight('field', -1);
Chris@0:     $this->assertEqual($this->container->get('module_handler')->moduleExists('entity_test'), TRUE);
Chris@0:     $this->assertTrue(TRUE == $entity_manager->getDefinition('entity_test'));
Chris@0: 
Chris@0:     // Reactivate the previously uninstalled module.
Chris@0:     $this->enableModules(['field_test']);
Chris@0: 
Chris@0:     // Create a field.
Chris@18:     $this->installEntitySchema('entity_test');
Chris@0:     $display = EntityViewDisplay::create([
Chris@0:       'targetEntityType' => 'entity_test',
Chris@0:       'bundle' => 'entity_test',
Chris@0:       'mode' => 'default',
Chris@0:     ]);
Chris@0:     $field_storage = FieldStorageConfig::create([
Chris@0:       'field_name' => 'test_field',
Chris@0:       'entity_type' => 'entity_test',
Chris@17:       'type' => 'test_field',
Chris@0:     ]);
Chris@0:     $field_storage->save();
Chris@0:     FieldConfig::create([
Chris@0:       'field_storage' => $field_storage,
Chris@0:       'bundle' => 'entity_test',
Chris@0:     ])->save();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests that ThemeManager works right after loading a module.
Chris@0:    */
Chris@0:   public function testEnableModulesTheme() {
Chris@0:     /** @var \Drupal\Core\Render\RendererInterface $renderer */
Chris@0:     $renderer = $this->container->get('renderer');
Chris@0:     $original_element = $element = [
Chris@0:       '#type' => 'container',
Chris@0:       '#markup' => 'Foo',
Chris@0:       '#attributes' => [],
Chris@0:     ];
Chris@0:     $this->enableModules(['system']);
Chris@0:     // \Drupal\Core\Theme\ThemeManager::render() throws an exception if modules
Chris@0:     // are not loaded yet.
Chris@0:     $this->assertTrue($renderer->renderRoot($element));
Chris@0: 
Chris@0:     $element = $original_element;
Chris@0:     $this->disableModules(['entity_test']);
Chris@0:     $this->assertTrue($renderer->renderRoot($element));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests that there is no theme by default.
Chris@0:    */
Chris@0:   public function testNoThemeByDefault() {
Chris@0:     $themes = $this->config('core.extension')->get('theme');
Chris@0:     $this->assertEqual($themes, []);
Chris@0: 
Chris@0:     $extensions = $this->container->get('config.storage')->read('core.extension');
Chris@0:     $this->assertEqual($extensions['theme'], []);
Chris@0: 
Chris@0:     $active_theme = $this->container->get('theme.manager')->getActiveTheme();
Chris@0:     $this->assertEqual($active_theme->getName(), 'core');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests that \Drupal::installProfile() returns NULL.
Chris@0:    *
Chris@0:    * As the currently active installation profile is used when installing
Chris@0:    * configuration, for example, this is essential to ensure test isolation.
Chris@0:    */
Chris@0:   public function testDrupalGetProfile() {
Chris@0:     $this->assertNull(\Drupal::installProfile());
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function run(array $methods = []) {
Chris@0:     parent::run($methods);
Chris@0: 
Chris@0:     // Check that all tables of the test instance have been deleted. At this
Chris@0:     // point the original database connection is restored so we need to prefix
Chris@0:     // the tables.
Chris@0:     $connection = Database::getConnection();
Chris@0:     if ($connection->databaseType() != 'sqlite') {
Chris@0:       $tables = $connection->schema()->findTables($this->databasePrefix . '%');
Chris@0:       $this->assertTrue(empty($tables), 'All test tables have been removed.');
Chris@0:     }
Chris@0:     else {
Chris@0:       // We don't have the test instance connection anymore so we have to
Chris@0:       // re-attach its database and then use the same query as
Chris@0:       // \Drupal\Core\Database\Driver\sqlite\Schema::findTables().
Chris@0:       // @see \Drupal\Core\Database\Driver\sqlite\Connection::__construct()
Chris@0:       $info = Database::getConnectionInfo();
Chris@0:       $connection->query('ATTACH DATABASE :database AS :prefix', [
Chris@0:         ':database' => $info['default']['database'] . '-' . $this->databasePrefix,
Chris@17:         ':prefix' => $this->databasePrefix,
Chris@0:       ]);
Chris@0: 
Chris@0:       $result = $connection->query("SELECT name FROM " . $this->databasePrefix . ".sqlite_master WHERE type = :type AND name LIKE :table_name AND name NOT LIKE :pattern", [
Chris@0:         ':type' => 'table',
Chris@0:         ':table_name' => '%',
Chris@0:         ':pattern' => 'sqlite_%',
Chris@0:       ])->fetchAllKeyed(0, 0);
Chris@0: 
Chris@0:       $this->assertTrue(empty($result), 'All test tables have been removed.');
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }