Tests importing configuration from files into active configuration.
Expanded class hierarchy of ConfigImporterTest
class ConfigImporterTest extends DrupalUnitTestBase {
/**
* Config Importer object used for testing.
*
* @var \Drupal\Core\Config\ConfigImporter
*/
protected $configImporter;
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array(
'config_test',
'system',
);
public static function getInfo() {
return array(
'name' => 'Import configuration',
'description' => 'Tests importing configuration from files into active configuration.',
'group' => 'Configuration',
);
}
function setUp() {
parent::setUp();
$this
->installSchema('system', 'config_snapshot');
config_install_default_config('module', 'config_test');
// Installing config_test's default configuration pollutes the global
// variable being used for recording hook invocations by this test already,
// so it has to be cleared out manually.
unset($GLOBALS['hook_config_test']);
// Set up the ConfigImporter object for testing.
$config_comparer = new StorageComparer($this->container
->get('config.storage.staging'), $this->container
->get('config.storage'));
$this->configImporter = new ConfigImporter($config_comparer
->createChangelist(), $this->container
->get('event_dispatcher'), $this->container
->get('config.factory'), $this->container
->get('plugin.manager.entity'), $this->container
->get('lock'));
$this
->copyConfig($this->container
->get('config.storage'), $this->container
->get('config.storage.staging'));
}
/**
* Tests omission of module APIs for bare configuration operations.
*/
function testNoImport() {
$dynamic_name = 'config_test.dynamic.dotted.default';
// Verify the default configuration values exist.
$config = config($dynamic_name);
$this
->assertIdentical($config
->get('id'), 'dotted.default');
// Verify that a bare config() does not involve module APIs.
$this
->assertFalse(isset($GLOBALS['hook_config_test']));
}
/**
* Tests that trying to import from an empty staging configuration directory
* fails.
*/
function testEmptyImportFails() {
try {
$this->container
->get('config.storage.staging')
->deleteAll();
$this->configImporter
->reset()
->import();
$this
->assertFalse(FALSE, "ConfigImporterException not thrown, we didn't stop an empty import.");
} catch (ConfigImporterException $e) {
$this
->assertTrue(TRUE, 'ConfigImporterException thrown, successfully stopping an empty import.');
}
}
/**
* Tests deletion of configuration during import.
*/
function testDeleted() {
$dynamic_name = 'config_test.dynamic.dotted.default';
$storage = $this->container
->get('config.storage');
$staging = $this->container
->get('config.storage.staging');
// Verify the default configuration values exist.
$config = config($dynamic_name);
$this
->assertIdentical($config
->get('id'), 'dotted.default');
// Delete the file from the staging directory.
$staging
->delete($dynamic_name);
// Import.
$this->configImporter
->reset()
->import();
// Verify the file has been removed.
$this
->assertIdentical($storage
->read($dynamic_name), FALSE);
$config = config($dynamic_name);
$this
->assertIdentical($config
->get('id'), NULL);
// Verify that appropriate module API hooks have been invoked.
$this
->assertTrue(isset($GLOBALS['hook_config_test']['load']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['presave']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['insert']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['update']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['predelete']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['delete']));
// Verify that there is nothing more to import.
$this
->assertFalse($this->configImporter
->hasUnprocessedChanges());
}
/**
* Tests creation of configuration during import.
*/
function testNew() {
$dynamic_name = 'config_test.dynamic.new';
$storage = $this->container
->get('config.storage');
$staging = $this->container
->get('config.storage.staging');
// Verify the configuration to create does not exist yet.
$this
->assertIdentical($storage
->exists($dynamic_name), FALSE, $dynamic_name . ' not found.');
// Create new config entity.
$original_dynamic_data = array(
'id' => 'new',
'uuid' => '30df59bd-7b03-4cf7-bb35-d42fc49f0651',
'label' => 'New',
'weight' => '0',
'style' => '',
'status' => '1',
'langcode' => language_default()->langcode,
'protected_property' => '',
);
$staging
->write($dynamic_name, $original_dynamic_data);
$this
->assertIdentical($staging
->exists($dynamic_name), TRUE, $dynamic_name . ' found.');
// Import.
$this->configImporter
->reset()
->import();
// Verify the values appeared.
$config = config($dynamic_name);
$this
->assertIdentical($config
->get('label'), $original_dynamic_data['label']);
// Verify that appropriate module API hooks have been invoked.
$this
->assertFalse(isset($GLOBALS['hook_config_test']['load']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['presave']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['insert']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['update']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['predelete']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['delete']));
// Verify that there is nothing more to import.
$this
->assertFalse($this->configImporter
->hasUnprocessedChanges());
}
/**
* Tests updating of configuration during import.
*/
function testUpdated() {
$name = 'config_test.system';
$dynamic_name = 'config_test.dynamic.dotted.default';
$storage = $this->container
->get('config.storage');
$staging = $this->container
->get('config.storage.staging');
// Verify that the configuration objects to import exist.
$this
->assertIdentical($storage
->exists($name), TRUE, $name . ' found.');
$this
->assertIdentical($storage
->exists($dynamic_name), TRUE, $dynamic_name . ' found.');
// Replace the file content of the existing configuration objects in the
// staging directory.
$original_name_data = array(
'foo' => 'beer',
);
$staging
->write($name, $original_name_data);
$original_dynamic_data = $storage
->read($dynamic_name);
$original_dynamic_data['label'] = 'Updated';
$staging
->write($dynamic_name, $original_dynamic_data);
// Verify the active configuration still returns the default values.
$config = config($name);
$this
->assertIdentical($config
->get('foo'), 'bar');
$config = config($dynamic_name);
$this
->assertIdentical($config
->get('label'), 'Default');
// Import.
$this->configImporter
->reset()
->import();
// Verify the values were updated.
$config = config($name);
$this
->assertIdentical($config
->get('foo'), 'beer');
$config = config($dynamic_name);
$this
->assertIdentical($config
->get('label'), 'Updated');
// Verify that the original file content is still the same.
$this
->assertIdentical($staging
->read($name), $original_name_data);
$this
->assertIdentical($staging
->read($dynamic_name), $original_dynamic_data);
// Verify that appropriate module API hooks have been invoked.
$this
->assertTrue(isset($GLOBALS['hook_config_test']['load']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['presave']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['insert']));
$this
->assertTrue(isset($GLOBALS['hook_config_test']['update']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['predelete']));
$this
->assertFalse(isset($GLOBALS['hook_config_test']['delete']));
// Verify that there is nothing more to import.
$this
->assertFalse($this->configImporter
->hasUnprocessedChanges());
}
}
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigImporterTest:: |
protected | property |
Config Importer object used for testing. Overrides TestBase:: |
|
ConfigImporterTest:: |
public static | property |
Modules to enable. Overrides DrupalUnitTestBase:: |
|
ConfigImporterTest:: |
public static | function | ||
ConfigImporterTest:: |
function |
Sets up Drupal unit test environment. Overrides DrupalUnitTestBase:: |
||
ConfigImporterTest:: |
function | Tests deletion of configuration during import. | ||
ConfigImporterTest:: |
function | Tests that trying to import from an empty staging configuration directory fails. | ||
ConfigImporterTest:: |
function | Tests creation of configuration during import. | ||
ConfigImporterTest:: |
function | Tests omission of module APIs for bare configuration operations. | ||
ConfigImporterTest:: |
function | Tests updating of configuration during import. | ||
DrupalUnitTestBase:: |
protected | property | A KeyValueMemoryFactory instance to use when building the container. | |
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
public | function | Sets up the base service container for this test. | 1 |
DrupalUnitTestBase:: |
protected | function | Disables modules for this test. | |
DrupalUnitTestBase:: |
protected | function | Enables modules for this test. | |
DrupalUnitTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
DrupalUnitTestBase:: |
protected | function | Installs a specific table from a module schema definition. | |
DrupalUnitTestBase:: |
protected | function |
Deletes created files, database tables, and reverts all environment changes. Overrides TestBase:: |
2 |
DrupalUnitTestBase:: |
function |
Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase:: |
||
TestBase:: |
protected | property | Assertions thrown in that test case. | |
TestBase:: |
protected | property | The dependency injection container used in the test. | 1 |
TestBase:: |
protected | property | The database prefix of this test run. | |
TestBase:: |
public | property | Whether to die in case any test assertion fails. | |
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
TestBase:: |
protected | property | The original database prefix when running inside Simpletest. | |
TestBase:: |
protected | property | The settings array. | |
TestBase:: |
protected | property | The public file directory for the test environment. | |
TestBase:: |
public | property | Current results of this test case. | |
TestBase:: |
protected | property | Flag to indicate whether the test has been set up. | |
TestBase:: |
protected | property | ||
TestBase:: |
protected | property | ||
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
TestBase:: |
protected | property | The test run ID. | |
TestBase:: |
protected | property | Time limit for the test. | |
TestBase:: |
protected | property | TRUE if verbose debugging is enabled. | |
TestBase:: |
protected | property | Safe class name for use in verbose output filenames. | |
TestBase:: |
protected | property | Directory where verbose output files are put. | |
TestBase:: |
protected | property | URL to the verbose output file directory. | |
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
TestBase:: |
protected | function | Internal helper: stores the assert. | |
TestBase:: |
protected | function | Check to see if two values are equal. | |
TestBase:: |
protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | |
TestBase:: |
protected | function | Check to see if two values are identical. | |
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
TestBase:: |
protected | function | Check to see if two values are not equal. | |
TestBase:: |
protected | function | Check to see if two values are not identical. | |
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
TestBase:: |
protected | function | Check to see if a value is NULL. | |
TestBase:: |
protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | |
TestBase:: |
protected | function | Changes the database connection to the prefixed one. | |
TestBase:: |
protected | function | Checks the matching requirements for Test. | 4 |
TestBase:: |
public | function | Returns a ConfigImporter object to import test importing of configuration. | 1 |
TestBase:: |
public | function | Copies configuration objects from source storage to target storage. | |
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
TestBase:: |
protected | function | Fire an error assertion. | 1 |
TestBase:: |
public | function | Handle errors during test runs. | |
TestBase:: |
protected | function | Handle exceptions. | |
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
TestBase:: |
public static | function | Ensures test files are deletable within file_unmanaged_delete_recursive(). | |
TestBase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
TestBase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestBase:: |
public static | function | Store an assertion from outside the testing context. | |
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
TestBase:: |
protected | function | Create and set new configuration directories. | 1 |
TestBase:: |
protected | function | Generates a database prefix for running tests. | |
TestBase:: |
protected | function | Prepares the current environment for running the test. | |
TestBase:: |
public static | function | Generates a random string containing letters and numbers. | |
TestBase:: |
public static | function | Generates a random PHP object. | |
TestBase:: |
public static | function | Generates a random string of ASCII characters of codes 32 to 126. | |
TestBase:: |
protected | function | Rebuild drupal_container(). | 1 |
TestBase:: |
public | function | Run all tests in this class. | |
TestBase:: |
protected | function | Changes in memory settings. | |
TestBase:: |
protected | function | Logs verbose message in a text file. | |
UnitTestBase:: |
protected | property |