class ConfigImportTest

Tests importing configuration from files into active configuration.

Hierarchy

Expanded class hierarchy of ConfigImportTest

File

drupal/core/modules/config/lib/Drupal/config/Tests/ConfigImportTest.php, line 15
Definition of Drupal\config\Tests\ConfigImportTest.

Namespace

Drupal\config\Tests
View source
class ConfigImportTest extends DrupalUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'config_test',
  );
  public static function getInfo() {
    return array(
      'name' => 'Import configuration',
      'description' => 'Tests importing configuration from files into active configuration.',
      'group' => 'Configuration',
    );
  }
  function setUp() {
    parent::setUp();
    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']);
  }

  /**
   * Tests omission of module APIs for bare configuration operations.
   */
  function testNoImport() {
    $dynamic_name = 'config_test.dynamic.default';

    // Verify the default configuration values exist.
    $config = config($dynamic_name);
    $this
      ->assertIdentical($config
      ->get('id'), 'default');

    // Verify that a bare config() does not involve module APIs.
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']));
  }

  /**
   * Tests deletion of configuration during import.
   */
  function testDeleted() {
    $dynamic_name = 'config_test.dynamic.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'), 'default');

    // Create an empty manifest to delete the configuration object.
    $staging
      ->write('manifest.config_test.dynamic', array());

    // Import.
    config_import();

    // Verify the values have disappeared.
    $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(config_sync_get_changes($staging, $storage));
  }

  /**
   * 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.');
    $this
      ->assertIdentical($staging
      ->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',
      'style' => '',
      'langcode' => 'und',
    );
    $staging
      ->write($dynamic_name, $original_dynamic_data);

    // Create manifest for new config entity.
    $manifest_data = config('manifest.config_test.dynamic')
      ->get();
    $manifest_data[$original_dynamic_data['id']]['name'] = 'config_test.dynamic.' . $original_dynamic_data['id'];
    $staging
      ->write('manifest.config_test.dynamic', $manifest_data);
    $this
      ->assertIdentical($staging
      ->exists($dynamic_name), TRUE, $dynamic_name . ' found.');

    // Import.
    config_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(config_sync_get_changes($staging, $storage));
  }

  /**
   * Tests updating of configuration during import.
   */
  function testUpdated() {
    $name = 'config_test.system';
    $dynamic_name = 'config_test.dynamic.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);

    // Create manifest for updated config entity.
    $manifest_data = config('manifest.config_test.dynamic')
      ->get();
    $staging
      ->write('manifest.config_test.dynamic', $manifest_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.
    config_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(config_sync_get_changes($staging, $storage));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigImportTest::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules
ConfigImportTest::getInfo public static function
ConfigImportTest::setUp function Sets up Drupal unit test environment. Overrides DrupalUnitTestBase::setUp
ConfigImportTest::testDeleted function Tests deletion of configuration during import.
ConfigImportTest::testNew function Tests creation of configuration during import.
ConfigImportTest::testNoImport function Tests omission of module APIs for bare configuration operations.
ConfigImportTest::testUpdated function Tests updating of configuration during import.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$moduleList private property Fixed module list being used by this test.
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 3
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container().
TestBase::run public function Run all tests in this class.
TestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. 10
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property
UnitTestBase::__construct function Constructor for UnitTestBase. Overrides TestBase::__construct 6