Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\config\Functional;
Chris@0: 
Chris@0: use Drupal\Core\Config\PreExistingConfigException;
Chris@0: use Drupal\Core\Config\StorageInterface;
Chris@18: use Drupal\Core\File\Exception\FileException;
Chris@0: use Drupal\language\Entity\ConfigurableLanguage;
Chris@0: use Drupal\Tests\BrowserTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests installation and removal of configuration objects in install, disable
Chris@0:  * and uninstall functionality.
Chris@0:  *
Chris@0:  * @group config
Chris@0:  */
Chris@0: class ConfigInstallWebTest extends BrowserTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * The admin user used in this test.
Chris@0:    */
Chris@0:   protected $adminUser;
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     $this->adminUser = $this->drupalCreateUser(['administer modules', 'administer themes', 'administer site configuration']);
Chris@0: 
Chris@0:     // Ensure the global variable being asserted by this test does not exist;
Chris@0:     // a previous test executed in this request/process might have set it.
Chris@0:     unset($GLOBALS['hook_config_test']);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests module re-installation.
Chris@0:    */
Chris@0:   public function testIntegrationModuleReinstallation() {
Chris@0:     $default_config = 'config_integration_test.settings';
Chris@0:     $default_configuration_entity = 'config_test.dynamic.config_integration_test';
Chris@0: 
Chris@0:     // Install the config_test module we're integrating with.
Chris@0:     \Drupal::service('module_installer')->install(['config_test']);
Chris@0: 
Chris@0:     // Verify the configuration does not exist prior to installation.
Chris@0:     $config_static = $this->config($default_config);
Chris@0:     $this->assertIdentical($config_static->isNew(), TRUE);
Chris@0:     $config_entity = $this->config($default_configuration_entity);
Chris@0:     $this->assertIdentical($config_entity->isNew(), TRUE);
Chris@0: 
Chris@0:     // Install the integration module.
Chris@0:     \Drupal::service('module_installer')->install(['config_integration_test']);
Chris@0:     $this->resetAll();
Chris@0: 
Chris@0:     // Verify that default module config exists.
Chris@0:     \Drupal::configFactory()->reset($default_config);
Chris@0:     \Drupal::configFactory()->reset($default_configuration_entity);
Chris@0:     $config_static = $this->config($default_config);
Chris@0:     $this->assertIdentical($config_static->isNew(), FALSE);
Chris@0:     $this->assertIdentical($config_static->get('foo'), 'default setting');
Chris@0:     $config_entity = $this->config($default_configuration_entity);
Chris@0:     $this->assertIdentical($config_entity->isNew(), FALSE);
Chris@0:     $this->assertIdentical($config_entity->get('label'), 'Default integration config label');
Chris@0: 
Chris@0:     // Customize both configuration objects.
Chris@0:     $config_static->set('foo', 'customized setting')->save();
Chris@0:     $config_entity->set('label', 'Customized integration config label')->save();
Chris@0: 
Chris@0:     // @todo FIXME: Setting config keys WITHOUT SAVING retains the changed config
Chris@0:     //   object in memory. Every new call to $this->config() MUST revert in-memory changes
Chris@0:     //   that haven't been saved!
Chris@0:     //   In other words: This test passes even without this reset, but it shouldn't.
Chris@0:     $this->container->get('config.factory')->reset();
Chris@0: 
Chris@0:     // Disable and uninstall the integration module.
Chris@0:     $this->container->get('module_installer')->uninstall(['config_integration_test']);
Chris@0: 
Chris@0:     // Verify the integration module's config was uninstalled.
Chris@0:     $config_static = $this->config($default_config);
Chris@0:     $this->assertIdentical($config_static->isNew(), TRUE);
Chris@0: 
Chris@0:     // Verify the integration config still exists.
Chris@0:     $config_entity = $this->config($default_configuration_entity);
Chris@0:     $this->assertIdentical($config_entity->isNew(), FALSE);
Chris@0:     $this->assertIdentical($config_entity->get('label'), 'Customized integration config label');
Chris@0: 
Chris@0:     // Reinstall the integration module.
Chris@0:     try {
Chris@0:       \Drupal::service('module_installer')->install(['config_integration_test']);
Chris@0:       $this->fail('Expected PreExistingConfigException not thrown.');
Chris@0:     }
Chris@0:     catch (PreExistingConfigException $e) {
Chris@0:       $this->assertEqual($e->getExtension(), 'config_integration_test');
Chris@0:       $this->assertEqual($e->getConfigObjects(), [StorageInterface::DEFAULT_COLLECTION => ['config_test.dynamic.config_integration_test']]);
Chris@0:       $this->assertEqual($e->getMessage(), 'Configuration objects (config_test.dynamic.config_integration_test) provided by config_integration_test already exist in active configuration');
Chris@0:     }
Chris@0: 
Chris@0:     // Delete the configuration entity so that the install will work.
Chris@0:     $config_entity->delete();
Chris@0:     \Drupal::service('module_installer')->install(['config_integration_test']);
Chris@0: 
Chris@0:     // Verify the integration module's config was re-installed.
Chris@0:     \Drupal::configFactory()->reset($default_config);
Chris@0:     \Drupal::configFactory()->reset($default_configuration_entity);
Chris@0:     $config_static = $this->config($default_config);
Chris@0:     $this->assertIdentical($config_static->isNew(), FALSE);
Chris@0:     $this->assertIdentical($config_static->get('foo'), 'default setting');
Chris@0: 
Chris@0:     // Verify the integration config is using the default.
Chris@0:     $config_entity = \Drupal::config($default_configuration_entity);
Chris@0:     $this->assertIdentical($config_entity->isNew(), FALSE);
Chris@0:     $this->assertIdentical($config_entity->get('label'), 'Default integration config label');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests pre-existing configuration detection.
Chris@0:    */
Chris@0:   public function testPreExistingConfigInstall() {
Chris@0:     $this->drupalLogin($this->adminUser);
Chris@0: 
Chris@0:     // Try to install config_install_fail_test and config_test. Doing this
Chris@0:     // will install the config_test module first because it is a dependency of
Chris@0:     // config_install_fail_test.
Chris@0:     // @see \Drupal\system\Form\ModulesListForm::submitForm()
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_test][enable]' => TRUE, 'modules[config_install_fail_test][enable]' => TRUE], t('Install'));
Chris@0:     $this->assertRaw('Unable to install Configuration install fail test, <em class="placeholder">config_test.dynamic.dotted.default</em> already exists in active configuration.');
Chris@0: 
Chris@0:     // Uninstall the config_test module to test the confirm form.
Chris@0:     $this->drupalPostForm('admin/modules/uninstall', ['uninstall[config_test]' => TRUE], t('Uninstall'));
Chris@0:     $this->drupalPostForm(NULL, [], t('Uninstall'));
Chris@0: 
Chris@0:     // Try to install config_install_fail_test without selecting config_test.
Chris@0:     // The user is shown a confirm form because the config_test module is a
Chris@0:     // dependency.
Chris@0:     // @see \Drupal\system\Form\ModulesListConfirmForm::submitForm()
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_install_fail_test][enable]' => TRUE], t('Install'));
Chris@0:     $this->drupalPostForm(NULL, [], t('Continue'));
Chris@0:     $this->assertRaw('Unable to install Configuration install fail test, <em class="placeholder">config_test.dynamic.dotted.default</em> already exists in active configuration.');
Chris@0: 
Chris@0:     // Test that collection configuration clashes during a module install are
Chris@0:     // reported correctly.
Chris@0:     \Drupal::service('module_installer')->install(['language']);
Chris@0:     $this->rebuildContainer();
Chris@0:     ConfigurableLanguage::createFromLangcode('fr')->save();
Chris@0:     \Drupal::languageManager()
Chris@0:       ->getLanguageConfigOverride('fr', 'config_test.dynamic.dotted.default')
Chris@0:       ->set('label', 'Je suis Charlie')
Chris@0:       ->save();
Chris@0: 
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_install_fail_test][enable]' => TRUE], t('Install'));
Chris@0:     $this->assertRaw('Unable to install Configuration install fail test, <em class="placeholder">config_test.dynamic.dotted.default, language/fr/config_test.dynamic.dotted.default</em> already exist in active configuration.');
Chris@0: 
Chris@0:     // Test installing a theme through the UI that has existing configuration.
Chris@0:     // This relies on the fact the config_test has been installed and created
Chris@0:     // the config_test.dynamic.dotted.default configuration and the translation
Chris@0:     // override created still exists.
Chris@0:     $this->drupalGet('admin/appearance');
Chris@0:     $url = $this->xpath("//a[contains(@href,'config_clash_test_theme') and contains(@href,'/install?')]/@href")[0];
Chris@0:     $this->drupalGet($this->getAbsoluteUrl($url->getText()));
Chris@0:     $this->assertRaw('Unable to install config_clash_test_theme, <em class="placeholder">config_test.dynamic.dotted.default, language/fr/config_test.dynamic.dotted.default</em> already exist in active configuration.');
Chris@0: 
Chris@0:     // Test installing a theme through the API that has existing configuration.
Chris@0:     try {
Chris@0:       \Drupal::service('theme_handler')->install(['config_clash_test_theme']);
Chris@0:       $this->fail('Expected PreExistingConfigException not thrown.');
Chris@0:     }
Chris@0:     catch (PreExistingConfigException $e) {
Chris@0:       $this->assertEqual($e->getExtension(), 'config_clash_test_theme');
Chris@0:       $this->assertEqual($e->getConfigObjects(), [StorageInterface::DEFAULT_COLLECTION => ['config_test.dynamic.dotted.default'], 'language.fr' => ['config_test.dynamic.dotted.default']]);
Chris@0:       $this->assertEqual($e->getMessage(), 'Configuration objects (config_test.dynamic.dotted.default, language/fr/config_test.dynamic.dotted.default) provided by config_clash_test_theme already exist in active configuration');
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests unmet dependencies detection.
Chris@0:    */
Chris@0:   public function testUnmetDependenciesInstall() {
Chris@0:     $this->drupalLogin($this->adminUser);
Chris@0:     // We need to install separately since config_install_dependency_test does
Chris@0:     // not depend on config_test and order is important.
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_test][enable]' => TRUE], t('Install'));
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_install_dependency_test][enable]' => TRUE], t('Install'));
Chris@0:     $this->assertRaw('Unable to install <em class="placeholder">Config install dependency test</em> due to unmet dependencies: <em class="placeholder">config_test.dynamic.other_module_test_with_dependency (config_other_module_config_test, config_test.dynamic.dotted.english)</em>');
Chris@0: 
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_test_language][enable]' => TRUE], t('Install'));
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_install_dependency_test][enable]' => TRUE], t('Install'));
Chris@0:     $this->assertRaw('Unable to install <em class="placeholder">Config install dependency test</em> due to unmet dependencies: <em class="placeholder">config_test.dynamic.other_module_test_with_dependency (config_other_module_config_test)</em>');
Chris@0: 
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_other_module_config_test][enable]' => TRUE], t('Install'));
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config_install_dependency_test][enable]' => TRUE], t('Install'));
Chris@0:     $this->rebuildContainer();
Chris@18:     $this->assertTrue(\Drupal::entityTypeManager()->getStorage('config_test')->load('other_module_test_with_dependency'), 'The config_test.dynamic.other_module_test_with_dependency configuration has been created during install.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests config_requirements().
Chris@0:    */
Chris@0:   public function testConfigModuleRequirements() {
Chris@0:     $this->drupalLogin($this->adminUser);
Chris@0:     $this->drupalPostForm('admin/modules', ['modules[config][enable]' => TRUE], t('Install'));
Chris@0: 
Chris@0:     $directory = config_get_config_directory(CONFIG_SYNC_DIRECTORY);
Chris@18:     try {
Chris@18:       \Drupal::service('file_system')->deleteRecursive($directory);
Chris@18:     }
Chris@18:     catch (FileException $e) {
Chris@18:       // Ignore failed deletes.
Chris@18:     }
Chris@0:     $this->drupalGet('/admin/reports/status');
Chris@0:     $this->assertRaw(t('The directory %directory does not exist.', ['%directory' => $directory]));
Chris@0:   }
Chris@0: 
Chris@0: }