class ConfigSingleImportExportTest

Same name in other branches
  1. 9 core/modules/config/tests/src/Functional/ConfigSingleImportExportTest.php \Drupal\Tests\config\Functional\ConfigSingleImportExportTest
  2. 8.9.x core/modules/config/tests/src/Functional/ConfigSingleImportExportTest.php \Drupal\Tests\config\Functional\ConfigSingleImportExportTest
  3. 11.x core/modules/config/tests/src/Functional/ConfigSingleImportExportTest.php \Drupal\Tests\config\Functional\ConfigSingleImportExportTest

Tests the user interface for importing/exporting a single configuration.

@group config

Hierarchy

Expanded class hierarchy of ConfigSingleImportExportTest

File

core/modules/config/tests/src/Functional/ConfigSingleImportExportTest.php, line 15

Namespace

Drupal\Tests\config\Functional
View source
class ConfigSingleImportExportTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'config',
        'config_test',
        // Adding language module makes it possible to involve non-default
        // (language.xx) collections in import/export operations.
'language',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('page_title_block');
    }
    
    /**
     * Tests importing a single configuration file.
     */
    public function testImport() : void {
        $storage = \Drupal::entityTypeManager()->getStorage('config_test');
        $uuid = \Drupal::service('uuid');
        $this->drupalLogin($this->drupalCreateUser([
            'import configuration',
        ]));
        // Attempt an import with invalid YAML.
        $edit = [
            'config_type' => 'action',
            'import' => '{{{',
        ];
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        // Assert the static portion of the error since different parsers could give different text in their error.
        $this->assertSession()
            ->pageTextContains('The import failed with the following message: ');
        $import = <<<EOD
label: First
weight: 0
style: ''
status: '1'
EOD;
        $edit = [
            'config_type' => 'config_test',
            'import' => $import,
        ];
        // Attempt an import with a missing ID.
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('Missing ID key "id" for this Test configuration import.');
        // Perform an import with no specified UUID and a unique ID.
        $this->assertNull($storage->load('first'));
        $edit['import'] = "id: first\n" . $edit['import'];
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('Are you sure you want to create a new first test configuration?');
        $this->submitForm([], 'Confirm');
        $entity = $storage->load('first');
        $this->assertSame('First', $entity->label());
        $this->assertSame('first', $entity->id());
        $this->assertTrue($entity->status());
        $this->assertSession()
            ->pageTextContains('The configuration was imported successfully.');
        // Attempt an import with an existing ID but missing UUID.
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('An entity with this machine name already exists but the import did not specify a UUID.');
        // Attempt an import with a mismatched UUID and existing ID.
        $edit['import'] .= "\nuuid: " . $uuid->generate();
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('An entity with this machine name already exists but the UUID does not match.');
        // Attempt an import with a custom ID.
        $edit['custom_entity_id'] = 'custom_id';
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('Are you sure you want to create a new custom_id test configuration?');
        $this->submitForm([], 'Confirm');
        $this->assertSession()
            ->pageTextContains('The configuration was imported successfully.');
        // Perform an import with a unique ID and UUID.
        $import = <<<EOD
id: second
label: Second
weight: 0
style: ''
status: '0'
EOD;
        $edit = [
            'config_type' => 'config_test',
            'import' => $import,
        ];
        $second_uuid = $uuid->generate();
        $edit['import'] .= "\nuuid: " . $second_uuid;
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('Are you sure you want to create a new second test configuration?');
        $this->submitForm([], 'Confirm');
        $entity = $storage->load('second');
        $this->assertSession()
            ->pageTextContains('The configuration was imported successfully.');
        $this->assertSame('Second', $entity->label());
        $this->assertSame('second', $entity->id());
        $this->assertFalse($entity->status());
        $this->assertSame($second_uuid, $entity->uuid());
        // Perform an update.
        $import = <<<EOD
id: second
uuid: {<span class="php-variable">$second_uuid</span>}
label: 'Second updated'
weight: 0
style: ''
status: '0'
EOD;
        $edit = [
            'config_type' => 'config_test',
            'import' => $import,
        ];
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('Are you sure you want to update the second test configuration?');
        $this->submitForm([], 'Confirm');
        $entity = $storage->load('second');
        $this->assertSession()
            ->pageTextContains('The configuration was imported successfully.');
        $this->assertSame('Second updated', $entity->label());
        // Try to perform an update which adds missing dependencies.
        $import = <<<EOD
id: second
uuid: {<span class="php-variable">$second_uuid</span>}
label: 'Second updated'
weight: 0
style: ''
status: '0'
dependencies:
  module:
    - does_not_exist
EOD;
        $edit = [
            'config_type' => 'config_test',
            'import' => $import,
        ];
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('Configuration config_test.dynamic.second depends on the does_not_exist module that will not be installed after import.');
        // Try to preform an update which would create a PHP object if Yaml parsing
        // not securely set up.
        // Perform an update.
        $import = <<<EOD
id: second
uuid: {<span class="php-variable">$second_uuid</span>}
label: !php/object "O:36:\\"Drupal\\\\Core\\\\Test\\\\ObjectSerialization\\":0:{}"
weight: 0
style: ''
status: '0'
EOD;
        $edit = [
            'config_type' => 'config_test',
            'import' => $import,
        ];
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        // @see \Drupal\Tests\Component\Serialization\YamlSymfonyTest:: testDecodeObjectSupportDisabled()
        $this->assertSession()
            ->responseContains('The import failed with the following message:');
        $this->assertSession()
            ->responseContains('Object support when parsing a YAML file has been disabled');
    }
    
    /**
     * Tests importing a simple configuration file.
     */
    public function testImportSimpleConfiguration() : void {
        $this->drupalLogin($this->drupalCreateUser([
            'import configuration',
        ]));
        $config = $this->config('system.site')
            ->set('name', 'Test simple import');
        // Place branding block with site name into header region.
        $this->drupalPlaceBlock('system_branding_block', [
            'region' => 'header',
        ]);
        $edit = [
            'config_type' => 'system.simple',
            'config_name' => $config->getName(),
            'import' => Yaml::encode($config->get()),
        ];
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('Are you sure you want to update the ' . $config->getName() . ' simple configuration?');
        $this->submitForm([], 'Confirm');
        $this->drupalGet('');
        $this->assertSession()
            ->pageTextContains('Test simple import');
        // Ensure that ConfigImporter validation is running when importing simple
        // configuration.
        $config_data = $this->config('core.extension')
            ->get();
        // Simulate uninstalling the Config module.
        unset($config_data['module']['config']);
        $edit = [
            'config_type' => 'system.simple',
            'config_name' => 'core.extension',
            'import' => Yaml::encode($config_data),
        ];
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm($edit, 'Import');
        $this->assertSession()
            ->pageTextContains('Can not uninstall the Configuration module as part of a configuration synchronization through the user interface.');
        // Try to import without any values.
        $this->drupalGet('admin/config/development/configuration/single/import');
        $this->submitForm([], 'Import');
        $this->assertSession()
            ->pageTextContains('Configuration type field is required.');
        $this->assertSession()
            ->pageTextContains('Paste your configuration here field is required.');
    }
    
    /**
     * Tests exporting a single configuration file.
     */
    public function testExport() : void {
        $this->drupalLogin($this->drupalCreateUser([
            'export configuration',
        ]));
        // Verify that the simple configuration option is selected when specified
        // in the URL.
        $this->drupalGet('admin/config/development/configuration/single/export/system.simple');
        $option_node = $this->assertSession()
            ->optionExists("config_type", 'Simple configuration');
        $this->assertTrue($option_node->isSelected());
        // Spot check several known simple configuration files.
        $this->assertSession()
            ->optionExists('config_name', 'system.site');
        $this->assertSession()
            ->optionExists('config_name', 'user.settings');
        $this->drupalGet('admin/config/development/configuration/single/export/system.simple/system.image');
        // cspell:disable-next-line
        $this->assertSession()
            ->fieldValueEquals('export', "_core:\n  default_config_hash: durWHaKeBaq4d9Wpi4RqwADj1OufDepcnJuhVLmKN24\ntoolkit: gd\n");
        // Verify that the date format entity type is selected when specified in
        // the URL.
        $this->drupalGet('admin/config/development/configuration/single/export/date_format');
        $option_node = $this->assertSession()
            ->optionExists("config_type", 'Date format');
        $this->assertTrue($option_node->isSelected());
        // Verify that the fallback date format config entity is selected when
        // specified in the URL.
        $this->drupalGet('admin/config/development/configuration/single/export/date_format/fallback');
        $option_node = $this->assertSession()
            ->optionExists("config_name", 'fallback (Fallback date format)');
        $this->assertTrue($option_node->isSelected());
        $fallback_date = \Drupal::entityTypeManager()->getStorage('date_format')
            ->load('fallback');
        $yaml_text = $this->assertSession()
            ->fieldExists('export')
            ->getValue();
        $this->assertEquals(Yaml::decode($yaml_text), $fallback_date->toArray(), 'The fallback date format config entity export code is displayed.');
    }

}

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::$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::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::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.
ConfigSingleImportExportTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ConfigSingleImportExportTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
ConfigSingleImportExportTest::setUp protected function Overrides BrowserTestBase::setUp
ConfigSingleImportExportTest::testExport public function Tests exporting a single configuration file.
ConfigSingleImportExportTest::testImport public function Tests importing a single configuration file.
ConfigSingleImportExportTest::testImportSimpleConfiguration public function Tests importing a simple configuration file.
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
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::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
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
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::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 5
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.
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.