class WorkspaceEntityRepositoryTest

Tests the entity repository integration for workspaces.

@group workspaces

Hierarchy

Expanded class hierarchy of WorkspaceEntityRepositoryTest

File

core/modules/workspaces/tests/src/Kernel/WorkspaceEntityRepositoryTest.php, line 19

Namespace

Drupal\Tests\workspaces\Kernel
View source
class WorkspaceEntityRepositoryTest extends KernelTestBase {
    use UserCreationTrait;
    use WorkspaceTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
        'language',
        'system',
        'user',
        'workspaces',
    ];
    
    /**
     * The entity type manager.
     */
    protected EntityTypeManagerInterface $entityTypeManager;
    
    /**
     * The entity repository.
     */
    protected EntityRepositoryInterface $entityRepository;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->entityTypeManager = $this->container
            ->get('entity_type.manager');
        $this->entityRepository = $this->container
            ->get('entity.repository');
        $this->installEntitySchema('entity_test_revpub');
        $this->installEntitySchema('entity_test_mulrevpub');
        $this->installEntitySchema('workspace');
        $this->installSchema('workspaces', [
            'workspace_association',
        ]);
        $this->installConfig([
            'system',
            'language',
        ]);
        ConfigurableLanguage::createFromLangcode('ro')->setWeight(1)
            ->save();
        Workspace::create([
            'id' => 'ham',
            'label' => 'Ham',
        ])->save();
        Workspace::create([
            'id' => 'cheese',
            'label' => 'Cheese',
        ])->save();
    }
    
    /**
     * Tests retrieving active variants in a workspace.
     *
     * @covers \Drupal\Core\Entity\EntityRepository::getActive
     * @covers \Drupal\Core\Entity\EntityRepository::getActiveMultiple
     */
    public function testGetActive() : void {
        $en_contexts = [
            'langcode' => 'en',
        ];
        $ro_contexts = [
            'langcode' => 'ro',
        ];
        // Check that the correct active variant is returned for a non-translatable
        // revisionable entity.
        $entity_type_id = 'entity_test_revpub';
        $storage = $this->entityTypeManager
            ->getStorage($entity_type_id);
        $values = [
            'name' => $this->randomString(),
        ];
        $entity = $storage->create($values);
        $storage->save($entity);
        // Create revisions in two workspaces, then another one in Live.
        $this->switchToWorkspace('ham');
        $ham_revision = $storage->createRevision($entity);
        $storage->save($ham_revision);
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $en_contexts);
        $this->assertSame($ham_revision->getLoadedRevisionId(), $active->getLoadedRevisionId());
        $this->switchToWorkspace('cheese');
        $cheese_revision = $storage->createRevision($entity);
        $storage->save($cheese_revision);
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $en_contexts);
        $this->assertSame($cheese_revision->getLoadedRevisionId(), $active->getLoadedRevisionId());
        $this->switchToLive();
        $live_revision = $storage->createRevision($entity);
        $storage->save($live_revision);
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $en_contexts);
        $this->assertSame($live_revision->getLoadedRevisionId(), $active->getLoadedRevisionId());
        // Switch back to the two workspaces and check that workspace-specific
        // revision are returned even when there's a newer revision in Live.
        $this->switchToWorkspace('ham');
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $en_contexts);
        $this->assertSame($ham_revision->getLoadedRevisionId(), $active->getLoadedRevisionId());
        $this->switchToWorkspace('cheese');
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $en_contexts);
        $this->assertSame($cheese_revision->getLoadedRevisionId(), $active->getLoadedRevisionId());
        // Check that a revision created in a workspace does not leak into other
        // workspaces.
        $entity_2 = $storage->create([
            'name' => $this->randomString(),
        ]);
        $storage->save($entity_2);
        // Create a new revision in a workspace.
        $this->switchToWorkspace('ham');
        $ham_revision = $storage->createRevision($entity_2);
        $storage->save($ham_revision);
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity_2->id(), $en_contexts);
        $this->assertSame($ham_revision->getLoadedRevisionId(), $active->getLoadedRevisionId());
        // Check that the default revision is returned in another workspace.
        $this->switchToWorkspace('cheese');
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity_2->id(), $en_contexts);
        $this->assertSame($entity_2->getLoadedRevisionId(), $active->getLoadedRevisionId());
        // Check that the correct active variant is returned for a translatable and
        // revisionable entity.
        $this->switchToLive();
        $entity_type_id = 'entity_test_mulrevpub';
        $storage = $this->entityTypeManager
            ->getStorage($entity_type_id);
        $values = [
            'name' => $this->randomString(),
        ];
        $initial_revision = $storage->create($values);
        $storage->save($initial_revision);
        $revision_translation = $initial_revision->addTranslation('ro', $values);
        $revision_translation = $storage->createRevision($revision_translation);
        $storage->save($revision_translation);
        // Add a translation in a workspace.
        $this->switchToWorkspace('ham');
        $ham_revision_ro = $storage->createRevision($revision_translation);
        $storage->save($ham_revision_ro);
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $ro_contexts);
        $this->assertSame($ham_revision_ro->getLoadedRevisionId(), $active->getLoadedRevisionId());
        $this->assertSame($ham_revision_ro->language()
            ->getId(), $active->language()
            ->getId());
        // Add a new translation in another workspace.
        $this->switchToWorkspace('cheese');
        $cheese_revision_ro = $storage->createRevision($revision_translation);
        $storage->save($cheese_revision_ro);
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $ro_contexts);
        $this->assertSame($cheese_revision_ro->getLoadedRevisionId(), $active->getLoadedRevisionId());
        $this->assertSame($cheese_revision_ro->language()
            ->getId(), $active->language()
            ->getId());
        // Add a new translations in Live.
        $this->switchToLive();
        $live_revision_ro = $storage->createRevision($revision_translation);
        $storage->save($live_revision_ro);
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $ro_contexts);
        $this->assertSame($live_revision_ro->getLoadedRevisionId(), $active->getLoadedRevisionId());
        $this->assertSame($live_revision_ro->language()
            ->getId(), $active->language()
            ->getId());
        $this->switchToWorkspace('ham');
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $ro_contexts);
        $this->assertSame($ham_revision_ro->getLoadedRevisionId(), $active->getLoadedRevisionId());
        $this->assertSame($ham_revision_ro->language()
            ->getId(), $active->language()
            ->getId());
        $this->switchToWorkspace('cheese');
        $active = $this->entityRepository
            ->getActive($entity_type_id, $entity->id(), $ro_contexts);
        $this->assertSame($cheese_revision_ro->getLoadedRevisionId(), $active->getLoadedRevisionId());
        $this->assertSame($cheese_revision_ro->language()
            ->getId(), $active->language()
            ->getId());
    }

}

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 Deprecated 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
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. 2
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. 2
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 33
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
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 9
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
WorkspaceEntityRepositoryTest::$entityRepository protected property The entity repository.
WorkspaceEntityRepositoryTest::$entityTypeManager protected property The entity type manager.
WorkspaceEntityRepositoryTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
WorkspaceEntityRepositoryTest::setUp protected function Overrides KernelTestBase::setUp
WorkspaceEntityRepositoryTest::testGetActive public function Tests retrieving active variants in a workspace.
WorkspaceTestTrait::$workspaceManager protected property The workspaces manager. 1
WorkspaceTestTrait::$workspaces protected property An array of test workspaces, keyed by workspace ID.
WorkspaceTestTrait::assertWorkspaceAssociation protected function Checks the workspace_association records for a test scenario.
WorkspaceTestTrait::createEntity protected function Creates an entity. 1
WorkspaceTestTrait::createWorkspaceHierarchy protected function Creates a test workspace hierarchy.
WorkspaceTestTrait::getUnassociatedRevisions protected function Returns all the revisions which are not associated with any workspace.
WorkspaceTestTrait::ignoreEntityType protected function Marks an entity type as ignored in a workspace.
WorkspaceTestTrait::initializeWorkspacesModule protected function Enables the Workspaces module and creates two workspaces.
WorkspaceTestTrait::switchToLive protected function Switches the test runner's context to Live.
WorkspaceTestTrait::switchToWorkspace protected function Sets a given workspace as active.

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