class EntityRevisionTranslationTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionTranslationTest.php \Drupal\KernelTests\Core\Entity\EntityRevisionTranslationTest
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionTranslationTest.php \Drupal\KernelTests\Core\Entity\EntityRevisionTranslationTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionTranslationTest.php \Drupal\KernelTests\Core\Entity\EntityRevisionTranslationTest

Tests proper revision propagation of entities.

@group Entity

Hierarchy

Expanded class hierarchy of EntityRevisionTranslationTest

File

core/tests/Drupal/KernelTests/Core/Entity/EntityRevisionTranslationTest.php, line 16

Namespace

Drupal\KernelTests\Core\Entity
View source
class EntityRevisionTranslationTest extends EntityKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Enable some additional languages.
        ConfigurableLanguage::createFromLangcode('de')->save();
        ConfigurableLanguage::createFromLangcode('it')->save();
        $this->installEntitySchema('entity_test_mul');
        $this->installEntitySchema('entity_test_mulrev');
    }
    
    /**
     * Tests if the translation object has the right revision id after new revision.
     */
    public function testNewRevisionAfterTranslation() : void {
        $user = $this->createUser();
        // Create a test entity.
        $entity = EntityTestMulRev::create([
            'name' => $this->randomString(),
            'user_id' => $user->id(),
            'language' => 'en',
        ]);
        $entity->save();
        $old_rev_id = $entity->getRevisionId();
        $translation = $entity->addTranslation('de');
        $translation->setNewRevision();
        $translation->save();
        // Verify that the saved translation for the new translation has a newer
        // revision ID.
        $this->assertGreaterThan($old_rev_id, $translation->getRevisionId());
        // Verify that the entity from the storage has a newer revision ID.
        $this->assertGreaterThan($old_rev_id, $this->reloadEntity($entity)
            ->getRevisionId());
    }
    
    /**
     * Tests if the translation object has the right revision id after new revision.
     */
    public function testRevertRevisionAfterTranslation() : void {
        $user = $this->createUser();
        
        /** @var \Drupal\Core\Entity\RevisionableStorageInterface $storage */
        $storage = $this->entityTypeManager
            ->getStorage('entity_test_mulrev');
        // Create a test entity.
        $entity = EntityTestMulRev::create([
            'name' => $this->randomString(),
            'user_id' => $user->id(),
            'language' => 'en',
        ]);
        $entity->save();
        $old_rev_id = $entity->getRevisionId();
        $translation = $entity->addTranslation('de');
        $translation->setNewRevision();
        $translation->save();
        $entity = $this->reloadEntity($entity);
        $this->assertTrue($entity->hasTranslation('de'));
        $entity = $storage->loadRevision($old_rev_id);
        $entity->setNewRevision();
        $entity->isDefaultRevision(TRUE);
        $entity->save();
        $entity = $this->reloadEntity($entity);
        $this->assertFalse($entity->hasTranslation('de'));
    }
    
    /**
     * Tests the translation values when saving a pending revision.
     */
    public function testTranslationValuesWhenSavingPendingRevisions() : void {
        $user = $this->createUser();
        
        /** @var \Drupal\Core\Entity\RevisionableStorageInterface $storage */
        $storage = $this->entityTypeManager
            ->getStorage('entity_test_mulrev');
        // Create a test entity and a translation for it.
        $entity = EntityTestMulRev::create([
            'name' => 'default revision - en',
            'user_id' => $user->id(),
            'language' => 'en',
        ]);
        $entity->addTranslation('de', [
            'name' => 'default revision - de',
        ]);
        $entity->save();
        // Create a pending revision for the entity and change a field value for
        // both languages.
        $pending_revision = $this->reloadEntity($entity);
        $pending_revision->setNewRevision();
        $pending_revision->isDefaultRevision(FALSE);
        $pending_revision->name = 'pending revision - en';
        $pending_revision->save();
        $pending_revision_translation = $pending_revision->getTranslation('de');
        $pending_revision_translation->name = 'pending revision - de';
        $pending_revision_translation->save();
        $pending_revision_id = $pending_revision->getRevisionId();
        $pending_revision = $storage->loadRevision($pending_revision_id);
        // Change the value of the field in the default language, save the pending
        // revision and check that the value of the field in the second language is
        // also taken from the pending revision, *not* from the default revision.
        $pending_revision->name = 'updated pending revision - en';
        $pending_revision->save();
        $pending_revision = $storage->loadRevision($pending_revision_id);
        $this->assertEquals('updated pending revision - en', $pending_revision->name->value);
        $this->assertEquals('pending revision - de', $pending_revision->getTranslation('de')->name->value);
    }
    
    /**
     * Tests changing the default revision flag is propagated to all translations.
     */
    public function testDefaultRevision() : void {
        // Create a test entity with a translation, which will internally trigger
        // entity cloning for the new translation and create references for some of
        // the entity properties.
        $entity = EntityTestMulRev::create([
            'name' => 'original',
            'language' => 'en',
        ]);
        $translation = $entity->addTranslation('de');
        $entity->save();
        // Assert that the entity is in the default revision.
        $this->assertTrue($entity->isDefaultRevision());
        $this->assertTrue($translation->isDefaultRevision());
        // Change the default revision flag on one of the entity translations and
        // assert that the change is propagated to all entity translation objects.
        $translation->isDefaultRevision(FALSE);
        $this->assertFalse($entity->isDefaultRevision());
        $this->assertFalse($translation->isDefaultRevision());
    }
    
    /**
     * @covers \Drupal\Core\Entity\ContentEntityBase::setNewRevision
     */
    public function testSetNewRevision() : void {
        $user = $this->createUser();
        // All revisionable entity variations have to have the same results.
        foreach (entity_test_entity_types(ENTITY_TEST_TYPES_REVISABLE) as $entity_type) {
            $this->installEntitySchema($entity_type);
            $storage = \Drupal::entityTypeManager()->getStorage($entity_type);
            $entity = $storage->create([
                'name' => 'foo',
                'user_id' => $user->id(),
            ]);
            $entity->save();
            $entity_id = $entity->id();
            $entity_rev_id = $entity->getRevisionId();
            $entity = $storage->loadUnchanged($entity_id);
            $entity->setNewRevision(TRUE);
            $entity->setNewRevision(FALSE);
            $entity->save();
            $entity = $storage->loadUnchanged($entity_id);
            $this->assertEquals($entity_rev_id, $entity->getRevisionId(), 'A new entity revision was not created.');
        }
    }
    
    /**
     * Tests that revision translations are correctly detected.
     *
     * @covers \Drupal\Core\Entity\ContentEntityStorageBase::isAnyStoredRevisionTranslated
     */
    public function testIsAnyStoredRevisionTranslated() : void {
        
        /** @var \Drupal\Core\Entity\ContentEntityStorageInterface $storage */
        $storage = $this->entityTypeManager
            ->getStorage('entity_test_mul');
        $method = new \ReflectionMethod(get_class($storage), 'isAnyStoredRevisionTranslated');
        // Check that a non-revisionable new entity is handled correctly.
        $entity = EntityTestMul::create();
        $this->assertEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        $entity->addTranslation('it');
        $this->assertNotEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        // Check that not yet stored translations are handled correctly.
        $entity = EntityTestMul::create();
        $entity->save();
        $entity->addTranslation('it');
        $this->assertNotEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        // Check that removed translations are handled correctly.
        $entity->save();
        $entity->removeTranslation('it');
        $this->assertEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertTrue($method->invoke($storage, $entity));
        $entity->save();
        $this->assertEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        $entity->addTranslation('de');
        $entity->removeTranslation('de');
        $this->assertEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        // Check that a non-revisionable not translated entity is handled correctly.
        $entity = EntityTestMul::create();
        $entity->save();
        $this->assertEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        // Check that a non-revisionable translated entity is handled correctly.
        $entity->addTranslation('it');
        $entity->save();
        $this->assertNotEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertTrue($method->invoke($storage, $entity));
        
        /** @var \Drupal\Core\Entity\ContentEntityStorageInterface $storage */
        $storage = $this->entityTypeManager
            ->getStorage('entity_test_mulrev');
        // Check that a revisionable new entity is handled correctly.
        $entity = EntityTestMulRev::create();
        $this->assertEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        $entity->addTranslation('it');
        $this->assertNotEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        // Check that a revisionable not translated entity is handled correctly.
        $entity = EntityTestMulRev::create();
        $entity->save();
        $this->assertEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertFalse($method->invoke($storage, $entity));
        // Check that a revisionable translated pending revision is handled
        // correctly.
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $new_revision */
        $new_revision = $storage->createRevision($entity, FALSE);
        $new_revision->addTranslation('it');
        $new_revision->save();
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
        $entity = $storage->loadUnchanged($entity->id());
        $this->assertEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertNotEmpty($new_revision->getTranslationLanguages(FALSE));
        $this->assertTrue($method->invoke($storage, $entity));
        // Check that a revisionable translated default revision is handled
        // correctly.
        $new_revision->isDefaultRevision(TRUE);
        $new_revision->save();
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
        $entity = $storage->loadUnchanged($entity->id());
        $this->assertNotEmpty($entity->getTranslationLanguages(FALSE));
        $this->assertNotEmpty($new_revision->getTranslationLanguages(FALSE));
        $this->assertTrue($method->invoke($storage, $entity));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias 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::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.
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.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityRevisionTranslationTest::$modules protected static property Modules to install. Overrides EntityKernelTestBase::$modules
EntityRevisionTranslationTest::setUp protected function Overrides EntityKernelTestBase::setUp
EntityRevisionTranslationTest::testDefaultRevision public function Tests changing the default revision flag is propagated to all translations.
EntityRevisionTranslationTest::testIsAnyStoredRevisionTranslated public function Tests that revision translations are correctly detected.
EntityRevisionTranslationTest::testNewRevisionAfterTranslation public function Tests if the translation object has the right revision id after new revision.
EntityRevisionTranslationTest::testRevertRevisionAfterTranslation public function Tests if the translation object has the right revision id after new revision.
EntityRevisionTranslationTest::testSetNewRevision public function @covers \Drupal\Core\Entity\ContentEntityBase::setNewRevision
EntityRevisionTranslationTest::testTranslationValuesWhenSavingPendingRevisions public function Tests the translation values when saving a pending revision.
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. 3
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. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 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 protected function Bootstraps a kernel for a test. 1
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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 27
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. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
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::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
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 Deprecated 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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

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