You are here

Home » API reference » Drupal 9 » ConfigEntityImportTest.php

class ConfigEntityImportTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/system/tests/src/Kernel/Entity/ConfigEntityImportTest.php \Drupal\Tests\system\Kernel\Entity\ConfigEntityImportTest

Tests ConfigEntity importing.

@group Entity

Hierarchy

Expanded class hierarchy of ConfigEntityImportTest

File

core/modules/system/tests/src/Kernel/Entity/ConfigEntityImportTest.php, line 19

Namespace

Drupal\Tests\system\Kernel\Entity
View source 
class ConfigEntityImportTest extends KernelTestBase {
  use BlockCreationTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'action',
    'block',
    'config_test',
    'filter',
    'image',
    'search',
    'search_extra_type',
    'system',
  ];

  /**
   * Runs test methods for each module within a single test run.
   */
  public function testConfigUpdateImport() {
    $this
      ->installConfig([
      'action',
      'block',
      'filter',
      'image',
    ]);
    $this->container
      ->get('theme_installer')
      ->install([
      'bartik',
    ]);
    $config_storage = $this->container
      ->get('config.storage');

    // Ensure the 'system.site' config.
    $config_storage
      ->write('system.site', [
      'uuid' => (new Php())
        ->generate(),
    ]);
    $this
      ->copyConfig($config_storage, $this->container
      ->get('config.storage.sync'));
    $this
      ->doActionUpdate();
    $this
      ->doBlockUpdate();
    $this
      ->doFilterFormatUpdate();
    $this
      ->doImageStyleUpdate();
    $this
      ->doSearchPageUpdate();
    $this
      ->doThirdPartySettingsUpdate();
  }

  /**
   * Tests updating an action during import.
   */
  protected function doActionUpdate() {

    // Create a test action with a known label.
    $name = 'system.action.apple';
    $entity = Action::create([
      'id' => 'apple',
      'plugin' => 'action_message_action',
    ]);
    $entity
      ->save();
    $this
      ->checkSinglePluginConfigSync($entity, 'configuration', 'message', '');

    // Read the existing data, and prepare an altered version in sync.
    $custom_data = $original_data = $this->container
      ->get('config.storage')
      ->read($name);
    $custom_data['configuration']['message'] = 'Granny Smith';
    $this
      ->assertConfigUpdateImport($name, $original_data, $custom_data);
  }

  /**
   * Tests updating a block during import.
   */
  protected function doBlockUpdate() {

    // Create a test block with a known label.
    $name = 'block.block.apple';
    $block = $this
      ->placeBlock('system_powered_by_block', [
      'id' => 'apple',
      'label' => 'Red Delicious',
      'theme' => 'bartik',
    ]);
    $this
      ->checkSinglePluginConfigSync($block, 'settings', 'label', 'Red Delicious');

    // Read the existing data, and prepare an altered version in sync.
    $custom_data = $original_data = $this->container
      ->get('config.storage')
      ->read($name);
    $custom_data['settings']['label'] = 'Granny Smith';
    $this
      ->assertConfigUpdateImport($name, $original_data, $custom_data);
  }

  /**
   * Tests updating a filter format during import.
   */
  protected function doFilterFormatUpdate() {

    // Create a test filter format with a known label.
    $name = 'filter.format.plain_text';

    /** @var \Drupal\filter\Entity\FilterFormat $entity */
    $entity = FilterFormat::load('plain_text');
    $plugin_collection = $entity
      ->getPluginCollections()['filters'];
    $filters = $entity
      ->get('filters');
    $this
      ->assertSame(72, $filters['filter_url']['settings']['filter_url_length']);
    $filters['filter_url']['settings']['filter_url_length'] = 100;
    $entity
      ->set('filters', $filters);
    $entity
      ->save();
    $this
      ->assertSame($filters, $entity
      ->get('filters'));
    $this
      ->assertSame($filters, $plugin_collection
      ->getConfiguration());
    $filters['filter_url']['settings']['filter_url_length'] = -100;
    $entity
      ->getPluginCollections()['filters']
      ->setConfiguration($filters);
    $entity
      ->save();
    $this
      ->assertSame($filters, $entity
      ->get('filters'));
    $this
      ->assertSame($filters, $plugin_collection
      ->getConfiguration());

    // Read the existing data, and prepare an altered version in sync.
    $custom_data = $original_data = $this->container
      ->get('config.storage')
      ->read($name);
    $custom_data['filters']['filter_url']['settings']['filter_url_length'] = 100;
    $this
      ->assertConfigUpdateImport($name, $original_data, $custom_data);
  }

  /**
   * Tests updating an image style during import.
   */
  protected function doImageStyleUpdate() {

    // Create a test image style with a known label.
    $name = 'image.style.thumbnail';

    /** @var \Drupal\image\Entity\ImageStyle $entity */
    $entity = ImageStyle::load('thumbnail');
    $plugin_collection = $entity
      ->getPluginCollections()['effects'];
    $effects = $entity
      ->get('effects');
    $effect_id = key($effects);
    $this
      ->assertSame(100, $effects[$effect_id]['data']['height']);
    $effects[$effect_id]['data']['height'] = 50;
    $entity
      ->set('effects', $effects);
    $entity
      ->save();

    // Ensure the entity and plugin have the correct configuration.
    $this
      ->assertSame($effects, $entity
      ->get('effects'));
    $this
      ->assertSame($effects, $plugin_collection
      ->getConfiguration());
    $effects[$effect_id]['data']['height'] = -50;
    $entity
      ->getPluginCollections()['effects']
      ->setConfiguration($effects);
    $entity
      ->save();

    // Ensure the entity and plugin have the correct configuration.
    $this
      ->assertSame($effects, $entity
      ->get('effects'));
    $this
      ->assertSame($effects, $plugin_collection
      ->getConfiguration());

    // Read the existing data, and prepare an altered version in sync.
    $custom_data = $original_data = $this->container
      ->get('config.storage')
      ->read($name);
    $effect_name = key($original_data['effects']);
    $custom_data['effects'][$effect_name]['data']['upscale'] = FALSE;
    $this
      ->assertConfigUpdateImport($name, $original_data, $custom_data);
  }

  /**
   * Tests updating a search page during import.
   */
  protected function doSearchPageUpdate() {

    // Create a test search page with a known label.
    $name = 'search.page.apple';
    $entity = SearchPage::create([
      'id' => 'apple',
      'plugin' => 'search_extra_type_search',
    ]);
    $entity
      ->save();
    $this
      ->checkSinglePluginConfigSync($entity, 'configuration', 'boost', 'bi');

    // Read the existing data, and prepare an altered version in sync.
    $custom_data = $original_data = $this->container
      ->get('config.storage')
      ->read($name);
    $custom_data['configuration']['boost'] = 'asdf';
    $this
      ->assertConfigUpdateImport($name, $original_data, $custom_data);
  }

  /**
   * Tests updating of third party settings.
   */
  protected function doThirdPartySettingsUpdate() {

    // Create a test action with a known label.
    $name = 'system.action.third_party_settings_test';

    /** @var \Drupal\config_test\Entity\ConfigTest $entity */
    $entity = Action::create([
      'id' => 'third_party_settings_test',
      'plugin' => 'action_message_action',
    ]);
    $entity
      ->save();
    $this
      ->assertSame([], $entity
      ->getThirdPartyProviders());

    // Get a copy of the configuration before the third party setting is added.
    $no_third_part_setting_config = $this->container
      ->get('config.storage')
      ->read($name);

    // Add a third party setting.
    $entity
      ->setThirdPartySetting('config_test', 'integer', 1);
    $entity
      ->save();
    $this
      ->assertSame(1, $entity
      ->getThirdPartySetting('config_test', 'integer'));
    $has_third_part_setting_config = $this->container
      ->get('config.storage')
      ->read($name);

    // Ensure configuration imports can completely remove third party settings.
    $this
      ->assertConfigUpdateImport($name, $has_third_part_setting_config, $no_third_part_setting_config);
  }

  /**
   * Tests that a single set of plugin config stays in sync.
   *
   * @param \Drupal\Core\Entity\EntityWithPluginCollectionInterface $entity
   *   The entity.
   * @param string $config_key
   *   Where the plugin config is stored.
   * @param string $setting_key
   *   The setting within the plugin config to change.
   * @param mixed $expected
   *   The expected default value of the plugin config setting.
   */
  protected function checkSinglePluginConfigSync(EntityWithPluginCollectionInterface $entity, $config_key, $setting_key, $expected) {
    $plugin_collection = $entity
      ->getPluginCollections()[$config_key];
    $settings = $entity
      ->get($config_key);

    // Ensure the default config exists.
    $this
      ->assertSame($expected, $settings[$setting_key]);

    // Change the plugin config by setting it on the entity.
    $settings[$setting_key] = $this
      ->randomString();
    $entity
      ->set($config_key, $settings);
    $entity
      ->save();
    $this
      ->assertSame($settings, $entity
      ->get($config_key));
    $this
      ->assertSame($settings, $plugin_collection
      ->getConfiguration());

    // Change the plugin config by setting it on the plugin.
    $settings[$setting_key] = $this
      ->randomString();
    $plugin_collection
      ->setConfiguration($settings);
    $entity
      ->save();
    $this
      ->assertSame($settings, $entity
      ->get($config_key));
    $this
      ->assertSame($settings, $plugin_collection
      ->getConfiguration());
  }

  /**
   * Asserts that config entities are updated during import.
   *
   * @param string $name
   *   The name of the config object.
   * @param array $original_data
   *   The original data stored in the config object.
   * @param array $custom_data
   *   The new data to store in the config object.
   */
  public function assertConfigUpdateImport($name, $original_data, $custom_data) {
    $this->container
      ->get('config.storage.sync')
      ->write($name, $custom_data);

    // Verify the active configuration still returns the default values.
    $config = $this
      ->config($name);
    $this
      ->assertSame($config
      ->get(), $original_data);

    // Import.
    $this
      ->configImporter()
      ->import();

    // Verify the values were updated.
    $this->container
      ->get('config.factory')
      ->reset($name);
    $config = $this
      ->config($name);
    $this
      ->assertSame($config
      ->get(), $custom_data);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings.
ConfigEntityImportTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
ConfigEntityImportTest::assertConfigUpdateImport public function Asserts that config entities are updated during import.
ConfigEntityImportTest::checkSinglePluginConfigSync protected function Tests that a single set of plugin config stays in sync.
ConfigEntityImportTest::doActionUpdate protected function Tests updating an action during import.
ConfigEntityImportTest::doBlockUpdate protected function Tests updating a block during import.
ConfigEntityImportTest::doFilterFormatUpdate protected function Tests updating a filter format during import.
ConfigEntityImportTest::doImageStyleUpdate protected function Tests updating an image style during import.
ConfigEntityImportTest::doSearchPageUpdate protected function Tests updating a search page during import.
ConfigEntityImportTest::doThirdPartySettingsUpdate protected function Tests updating of third party settings.
ConfigEntityImportTest::testConfigUpdateImport public function Runs test methods for each module within a single test run.
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUp protected function 334
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
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::$randomGenerator protected property The random generator.
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. 1
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 public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.