class ConfigDiffTest

Same name in other branches
  1. 8.9.x core/tests/Drupal/KernelTests/Core/Config/ConfigDiffTest.php \Drupal\KernelTests\Core\Config\ConfigDiffTest
  2. 10 core/tests/Drupal/KernelTests/Core/Config/ConfigDiffTest.php \Drupal\KernelTests\Core\Config\ConfigDiffTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Config/ConfigDiffTest.php \Drupal\KernelTests\Core\Config\ConfigDiffTest

Calculating the difference between two sets of configuration.

@group config

Hierarchy

Expanded class hierarchy of ConfigDiffTest

File

core/tests/Drupal/KernelTests/Core/Config/ConfigDiffTest.php, line 12

Namespace

Drupal\KernelTests\Core\Config
View source
class ConfigDiffTest extends KernelTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'config_test',
        'system',
    ];
    
    /**
     * Tests calculating the difference between two sets of configuration.
     */
    public function testDiff() {
        $active = $this->container
            ->get('config.storage');
        $sync = $this->container
            ->get('config.storage.sync');
        $config_name = 'config_test.system';
        $change_key = 'foo';
        $remove_key = '404';
        $add_key = 'biff';
        $add_data = 'bangpow';
        $change_data = 'foobar';
        // Install the default config.
        $this->installConfig([
            'config_test',
        ]);
        $original_data = \Drupal::config($config_name)->get();
        // Change a configuration value in sync.
        $sync_data = $original_data;
        $sync_data[$change_key] = $change_data;
        $sync_data[$add_key] = $add_data;
        $sync->write($config_name, $sync_data);
        // Verify that the diff reflects a change.
        $diff = \Drupal::service('config.manager')->diff($active, $sync, $config_name);
        $edits = $diff->getEdits();
        $this->assertYamlEdit($edits, $change_key, 'change', [
            $change_key . ': ' . $original_data[$change_key],
        ], [
            $change_key . ': ' . $change_data,
        ]);
        // Reset data back to original, and remove a key
        $sync_data = $original_data;
        unset($sync_data[$remove_key]);
        $sync->write($config_name, $sync_data);
        // Verify that the diff reflects a removed key.
        $diff = \Drupal::service('config.manager')->diff($active, $sync, $config_name);
        $edits = $diff->getEdits();
        $this->assertYamlEdit($edits, $change_key, 'copy');
        $this->assertYamlEdit($edits, $remove_key, 'delete', [
            $remove_key . ': ' . $original_data[$remove_key],
        ], FALSE);
        // Reset data back to original and add a key
        $sync_data = $original_data;
        $sync_data[$add_key] = $add_data;
        $sync->write($config_name, $sync_data);
        // Verify that the diff reflects an added key.
        $diff = \Drupal::service('config.manager')->diff($active, $sync, $config_name);
        $edits = $diff->getEdits();
        $this->assertYamlEdit($edits, $change_key, 'copy');
        $this->assertYamlEdit($edits, $add_key, 'add', FALSE, [
            $add_key . ': ' . $add_data,
        ]);
        // Test diffing a renamed config entity.
        $test_entity_id = $this->randomMachineName();
        $test_entity = \Drupal::entityTypeManager()->getStorage('config_test')
            ->create([
            'id' => $test_entity_id,
            'label' => $this->randomMachineName(),
        ]);
        $test_entity->save();
        $data = $active->read('config_test.dynamic.' . $test_entity_id);
        $sync->write('config_test.dynamic.' . $test_entity_id, $data);
        $config_name = 'config_test.dynamic.' . $test_entity_id;
        $diff = \Drupal::service('config.manager')->diff($active, $sync, $config_name, $config_name);
        // Prove the fields match.
        $edits = $diff->getEdits();
        $this->assertEquals('copy', $edits[0]->type, 'The first item in the diff is a copy.');
        $this->assertCount(1, $edits, 'There is one item in the diff');
        // Rename the entity.
        $new_test_entity_id = $this->randomMachineName();
        $test_entity->set('id', $new_test_entity_id);
        $test_entity->save();
        $diff = \Drupal::service('config.manager')->diff($active, $sync, 'config_test.dynamic.' . $new_test_entity_id, $config_name);
        $edits = $diff->getEdits();
        $this->assertYamlEdit($edits, 'uuid', 'copy');
        $this->assertYamlEdit($edits, 'id', 'change', [
            'id: ' . $new_test_entity_id,
        ], [
            'id: ' . $test_entity_id,
        ]);
        $this->assertYamlEdit($edits, 'label', 'copy');
        $this->assertEquals('copy', $edits[2]->type, 'The third item in the diff is a copy.');
        $this->assertCount(3, $edits, 'There are three items in the diff.');
    }
    
    /**
     * Tests calculating the difference between two sets of config collections.
     */
    public function testCollectionDiff() {
        
        /** @var \Drupal\Core\Config\StorageInterface $active */
        $active = $this->container
            ->get('config.storage');
        
        /** @var \Drupal\Core\Config\StorageInterface $sync */
        $sync = $this->container
            ->get('config.storage.sync');
        $active_test_collection = $active->createCollection('test');
        $sync_test_collection = $sync->createCollection('test');
        $config_name = 'config_test.test';
        $data = [
            'foo' => 'bar',
        ];
        $active->write($config_name, $data);
        $sync->write($config_name, $data);
        $active_test_collection->write($config_name, $data);
        $sync_test_collection->write($config_name, [
            'foo' => 'baz',
        ]);
        // Test the fields match in the default collection diff.
        $diff = \Drupal::service('config.manager')->diff($active, $sync, $config_name);
        $edits = $diff->getEdits();
        $this->assertEquals('copy', $edits[0]->type, 'The first item in the diff is a copy.');
        $this->assertCount(1, $edits, 'There is one item in the diff');
        // Test that the differences are detected when diffing the collection.
        $diff = \Drupal::service('config.manager')->diff($active, $sync, $config_name, NULL, 'test');
        $edits = $diff->getEdits();
        $this->assertYamlEdit($edits, 'foo', 'change', [
            'foo: bar',
        ], [
            'foo: baz',
        ]);
    }
    
    /**
     * Helper method to test that an edit is found in the diff of two storages.
     *
     * @param array $edits
     *   A list of edits.
     * @param string $field
     *   The field key that is being asserted.
     * @param string $type
     *   The type of edit that is being asserted.
     * @param mixed $orig
     *   (optional) The original value of the edit. If not supplied, assertion
     *   is skipped.
     * @param mixed $closing
     *   (optional) The closing value of the edit. If not supplied, assertion
     *   is skipped.
     *
     * @internal
     */
    protected function assertYamlEdit(array $edits, string $field, string $type, $orig = NULL, $closing = NULL) : void {
        $match = FALSE;
        foreach ($edits as $edit) {
            // Choose which section to search for the field.
            $haystack = $type == 'add' ? $edit->closing : $edit->orig;
            // Look through each line and try and find the key.
            if (is_array($haystack)) {
                foreach ($haystack as $item) {
                    if (strpos($item, $field . ':') === 0) {
                        $match = TRUE;
                        // Assert that the edit is of the type specified.
                        $this->assertEquals($type, $edit->type, "The {$field} item in the diff is a {$type}");
                        // If an original value was given, assert that it matches.
                        if (isset($orig)) {
                            $this->assertSame($orig, $edit->orig, "The original value for key '{$field}' is correct.");
                        }
                        // If a closing value was given, assert that it matches.
                        if (isset($closing)) {
                            $this->assertSame($closing, $edit->closing, "The closing value for key '{$field}' is correct.");
                        }
                        // Break out of the search entirely.
                        break 2;
                    }
                }
            }
        }
        // If we didn't match anything, fail.
        if (!$match) {
            $this->fail("{$field} edit was not matched");
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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 raw text IS NOT found escaped on 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
ConfigDiffTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
ConfigDiffTest::assertYamlEdit protected function Helper method to test that an edit is found in the diff of two storages.
ConfigDiffTest::testCollectionDiff public function Tests calculating the difference between two sets of config collections.
ConfigDiffTest::testDiff public function Tests calculating the difference between two sets of configuration.
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. 6
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::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 7
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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
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 353
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
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.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.