class ContentTranslationSyncUnitTest

Same name in other branches
  1. 8.9.x core/modules/content_translation/tests/src/Kernel/ContentTranslationSyncUnitTest.php \Drupal\Tests\content_translation\Kernel\ContentTranslationSyncUnitTest
  2. 10 core/modules/content_translation/tests/src/Kernel/ContentTranslationSyncUnitTest.php \Drupal\Tests\content_translation\Kernel\ContentTranslationSyncUnitTest
  3. 11.x core/modules/content_translation/tests/src/Kernel/ContentTranslationSyncUnitTest.php \Drupal\Tests\content_translation\Kernel\ContentTranslationSyncUnitTest

Tests the field synchronization logic.

@group content_translation

Hierarchy

Expanded class hierarchy of ContentTranslationSyncUnitTest

File

core/modules/content_translation/tests/src/Kernel/ContentTranslationSyncUnitTest.php, line 13

Namespace

Drupal\Tests\content_translation\Kernel
View source
class ContentTranslationSyncUnitTest extends KernelTestBase {
    
    /**
     * The synchronizer class to be tested.
     *
     * @var \Drupal\content_translation\FieldTranslationSynchronizer
     */
    protected $synchronizer;
    
    /**
     * The columns to be synchronized.
     *
     * @var array
     */
    protected $synchronized;
    
    /**
     * All the field columns.
     *
     * @var array
     */
    protected $columns;
    
    /**
     * The available language codes.
     *
     * @var array
     */
    protected $langcodes;
    
    /**
     * The field cardinality.
     *
     * @var int
     */
    protected $cardinality;
    
    /**
     * The unchanged field values.
     *
     * @var array
     */
    protected $unchangedFieldValues;
    protected static $modules = [
        'language',
        'content_translation',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->synchronizer = new FieldTranslationSynchronizer($this->container
            ->get('entity_type.manager'), $this->container
            ->get('plugin.manager.field.field_type'));
        $this->synchronized = [
            'sync1',
            'sync2',
        ];
        $this->columns = array_merge($this->synchronized, [
            'var1',
            'var2',
        ]);
        $this->langcodes = [
            'en',
            'it',
            'fr',
            'de',
            'es',
        ];
        $this->cardinality = 4;
        $this->unchangedFieldValues = [];
        // Set up an initial set of values in the correct state, that is with
        // "synchronized" values being equal.
        foreach ($this->langcodes as $langcode) {
            for ($delta = 0; $delta < $this->cardinality; $delta++) {
                foreach ($this->columns as $column) {
                    $sync = in_array($column, $this->synchronized) && $langcode != $this->langcodes[0];
                    $value = $sync ? $this->unchangedFieldValues[$this->langcodes[0]][$delta][$column] : $langcode . '-' . $delta . '-' . $column;
                    $this->unchangedFieldValues[$langcode][$delta][$column] = $value;
                }
            }
        }
    }
    
    /**
     * Tests the field synchronization algorithm.
     */
    public function testFieldSync() {
        // Add a new item to the source items and check that its added to all the
        // translations.
        $sync_langcode = $this->langcodes[2];
        $unchanged_items = $this->unchangedFieldValues[$sync_langcode];
        $field_values = $this->unchangedFieldValues;
        $item = [];
        foreach ($this->columns as $column) {
            $item[$column] = $this->randomMachineName();
        }
        $field_values[$sync_langcode][] = $item;
        $this->synchronizer
            ->synchronizeItems($field_values, $unchanged_items, $sync_langcode, $this->langcodes, $this->synchronized);
        $result = TRUE;
        foreach ($this->unchangedFieldValues as $langcode => $items) {
            // Check that the old values are still in place.
            for ($delta = 0; $delta < $this->cardinality; $delta++) {
                foreach ($this->columns as $column) {
                    $result = $result && $this->unchangedFieldValues[$langcode][$delta][$column] == $field_values[$langcode][$delta][$column];
                }
            }
            // Check that the new item is available in all languages.
            foreach ($this->columns as $column) {
                $result = $result && $field_values[$langcode][$delta][$column] == $field_values[$sync_langcode][$delta][$column];
            }
        }
        $this->assertTrue($result, 'A new item has been correctly synchronized.');
        // Remove an item from the source items and check that its removed from all
        // the translations.
        $sync_langcode = $this->langcodes[1];
        $unchanged_items = $this->unchangedFieldValues[$sync_langcode];
        $field_values = $this->unchangedFieldValues;
        $sync_delta = mt_rand(0, count($field_values[$sync_langcode]) - 1);
        unset($field_values[$sync_langcode][$sync_delta]);
        // Renumber deltas to start from 0.
        $field_values[$sync_langcode] = array_values($field_values[$sync_langcode]);
        $this->synchronizer
            ->synchronizeItems($field_values, $unchanged_items, $sync_langcode, $this->langcodes, $this->synchronized);
        $result = TRUE;
        foreach ($this->unchangedFieldValues as $langcode => $items) {
            $new_delta = 0;
            // Check that the old values are still in place.
            for ($delta = 0; $delta < $this->cardinality; $delta++) {
                // Skip the removed item.
                if ($delta != $sync_delta) {
                    foreach ($this->columns as $column) {
                        $result = $result && $this->unchangedFieldValues[$langcode][$delta][$column] == $field_values[$langcode][$new_delta][$column];
                    }
                    $new_delta++;
                }
            }
        }
        $this->assertTrue($result, 'A removed item has been correctly synchronized.');
        // Move the items around in the source items and check that they are moved
        // in all the translations.
        $sync_langcode = $this->langcodes[3];
        $unchanged_items = $this->unchangedFieldValues[$sync_langcode];
        $field_values = $this->unchangedFieldValues;
        $field_values[$sync_langcode] = [];
        // Scramble the items.
        foreach ($unchanged_items as $delta => $item) {
            $new_delta = ($delta + 1) % $this->cardinality;
            $field_values[$sync_langcode][$new_delta] = $item;
        }
        // Renumber deltas to start from 0.
        ksort($field_values[$sync_langcode]);
        $this->synchronizer
            ->synchronizeItems($field_values, $unchanged_items, $sync_langcode, $this->langcodes, $this->synchronized);
        $result = TRUE;
        foreach ($field_values as $langcode => $items) {
            for ($delta = 0; $delta < $this->cardinality; $delta++) {
                foreach ($this->columns as $column) {
                    $value = $field_values[$langcode][$delta][$column];
                    if (in_array($column, $this->synchronized)) {
                        // If we are dealing with a synchronize column the current value is
                        // supposed to be the same of the source items.
                        $result = $result && $field_values[$sync_langcode][$delta][$column] == $value;
                    }
                    else {
                        // Otherwise the values should be unchanged.
                        $old_delta = ($delta > 0 ? $delta : $this->cardinality) - 1;
                        $result = $result && $this->unchangedFieldValues[$langcode][$old_delta][$column] == $value;
                    }
                }
            }
        }
        $this->assertTrue($result, 'Scrambled items have been correctly synchronized.');
    }
    
    /**
     * Tests that items holding the same values are correctly synchronized.
     */
    public function testMultipleSyncedValues() {
        $sync_langcode = $this->langcodes[1];
        $unchanged_items = $this->unchangedFieldValues[$sync_langcode];
        // Determine whether the unchanged values should be altered depending on
        // their delta.
        $delta_callbacks = [
            // Continuous field values: all values are equal.
function ($delta) {
                return TRUE;
            },
            // Alternated field values: only the even ones are equal.
function ($delta) {
                return $delta % 2 !== 0;
            },
            // Sparse field values: only the "middle" ones are equal.
function ($delta) {
                return $delta === 1 || $delta === 2;
            },
            // Sparse field values: only the "extreme" ones are equal.
function ($delta) {
                return $delta === 0 || $delta === 3;
            },
        ];
        foreach ($delta_callbacks as $delta_callback) {
            $field_values = $this->unchangedFieldValues;
            for ($delta = 0; $delta < $this->cardinality; $delta++) {
                if ($delta_callback($delta)) {
                    foreach ($this->columns as $column) {
                        if (in_array($column, $this->synchronized)) {
                            $field_values[$sync_langcode][$delta][$column] = $field_values[$sync_langcode][0][$column];
                        }
                    }
                }
            }
            $changed_items = $field_values[$sync_langcode];
            $this->synchronizer
                ->synchronizeItems($field_values, $unchanged_items, $sync_langcode, $this->langcodes, $this->synchronized);
            foreach ($this->unchangedFieldValues as $langcode => $unchanged_items) {
                for ($delta = 0; $delta < $this->cardinality; $delta++) {
                    foreach ($this->columns as $column) {
                        // The first item is always unchanged hence it is retained by the
                        // synchronization process. The other ones are retained or synced
                        // depending on the logic implemented by the delta callback and
                        // whether it is a sync column or not.
                        $value = $delta > 0 && $delta_callback($delta) && in_array($column, $this->synchronized) ? $changed_items[0][$column] : $unchanged_items[$delta][$column];
                        $this->assertEquals($field_values[$langcode][$delta][$column], $value, "Item {$delta} column {$column} for langcode {$langcode} synced correctly");
                    }
                }
            }
        }
    }
    
    /**
     * Tests that one change in a synchronized column triggers a change in all columns.
     */
    public function testDifferingSyncedColumns() {
        $sync_langcode = $this->langcodes[2];
        $unchanged_items = $this->unchangedFieldValues[$sync_langcode];
        $field_values = $this->unchangedFieldValues;
        for ($delta = 0; $delta < $this->cardinality; $delta++) {
            $index = $delta % 2 + 1;
            $field_values[$sync_langcode][$delta]['sync' . $index] .= '-updated';
        }
        $changed_items = $field_values[$sync_langcode];
        $this->synchronizer
            ->synchronizeItems($field_values, $unchanged_items, $sync_langcode, $this->langcodes, $this->synchronized);
        foreach ($this->unchangedFieldValues as $langcode => $unchanged_items) {
            for ($delta = 0; $delta < $this->cardinality; $delta++) {
                foreach ($this->columns as $column) {
                    // If the column is synchronized, the value should have been synced,
                    // for unsynchronized columns, the value must not change.
                    $expected_value = in_array($column, $this->synchronized) ? $changed_items[$delta][$column] : $this->unchangedFieldValues[$langcode][$delta][$column];
                    $this->assertEquals($expected_value, $field_values[$langcode][$delta][$column], "Differing Item {$delta} column {$column} for langcode {$langcode} synced correctly");
                }
            }
        }
    }

}

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
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.
ContentTranslationSyncUnitTest::$cardinality protected property The field cardinality.
ContentTranslationSyncUnitTest::$columns protected property All the field columns.
ContentTranslationSyncUnitTest::$langcodes protected property The available language codes.
ContentTranslationSyncUnitTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
ContentTranslationSyncUnitTest::$synchronized protected property The columns to be synchronized.
ContentTranslationSyncUnitTest::$synchronizer protected property The synchronizer class to be tested.
ContentTranslationSyncUnitTest::$unchangedFieldValues protected property The unchanged field values.
ContentTranslationSyncUnitTest::setUp protected function Overrides KernelTestBase::setUp
ContentTranslationSyncUnitTest::testDifferingSyncedColumns public function Tests that one change in a synchronized column triggers a change in all columns.
ContentTranslationSyncUnitTest::testFieldSync public function Tests the field synchronization algorithm.
ContentTranslationSyncUnitTest::testMultipleSyncedValues public function Tests that items holding the same values are correctly synchronized.
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::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.