class WorkspaceCRUDTest

Same name in other branches
  1. 9 core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php \Drupal\Tests\workspaces\Kernel\WorkspaceCRUDTest
  2. 8.9.x core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php \Drupal\Tests\workspaces\Kernel\WorkspaceCRUDTest
  3. 11.x core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php \Drupal\Tests\workspaces\Kernel\WorkspaceCRUDTest

Tests CRUD operations for workspaces.

@group workspaces

Hierarchy

Expanded class hierarchy of WorkspaceCRUDTest

File

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

Namespace

Drupal\Tests\workspaces\Kernel
View source
class WorkspaceCRUDTest extends KernelTestBase {
    use UserCreationTrait;
    use NodeCreationTrait;
    use ContentTypeCreationTrait;
    use WorkspaceTestTrait;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The state service.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected $state;
    
    /**
     * The workspace replication manager.
     *
     * @var \Drupal\workspaces\WorkspaceManagerInterface
     */
    protected $workspaceManager;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'user',
        'system',
        'workspaces',
        'field',
        'filter',
        'node',
        'text',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->setUpCurrentUser();
        $this->installSchema('node', [
            'node_access',
        ]);
        $this->installEntitySchema('workspace');
        $this->installSchema('workspaces', [
            'workspace_association',
        ]);
        $this->installEntitySchema('node');
        $this->installConfig([
            'filter',
            'node',
            'system',
        ]);
        $this->createContentType([
            'type' => 'page',
        ]);
        $this->entityTypeManager = \Drupal::entityTypeManager();
        $this->state = \Drupal::state();
        $this->workspaceManager = \Drupal::service('workspaces.manager');
    }
    
    /**
     * Tests the deletion of workspaces.
     */
    public function testDeletingWorkspaces() : void {
        $admin = $this->createUser([
            'administer nodes',
            'create workspace',
            'view any workspace',
            'edit any workspace',
            'delete any workspace',
        ]);
        $this->setCurrentUser($admin);
        
        /** @var \Drupal\workspaces\WorkspaceAssociationInterface $workspace_association */
        $workspace_association = \Drupal::service('workspaces.association');
        // Create a workspace with a very small number of associated node revisions.
        $workspace_1 = Workspace::create([
            'id' => 'gibbon',
            'label' => 'Gibbon',
        ]);
        $workspace_1->save();
        $this->workspaceManager
            ->setActiveWorkspace($workspace_1);
        $workspace_1_node_1 = $this->createNode([
            'status' => FALSE,
        ]);
        $workspace_1_node_2 = $this->createNode([
            'status' => FALSE,
        ]);
        // Check that the workspace tracks the initial revisions for both nodes.
        $initial_revisions = $workspace_association->getAssociatedInitialRevisions($workspace_1->id(), 'node');
        $this->assertCount(2, $initial_revisions);
        for ($i = 0; $i < 4; $i++) {
            $workspace_1_node_1->setNewRevision(TRUE);
            $workspace_1_node_1->save();
            $workspace_1_node_2->setNewRevision(TRUE);
            $workspace_1_node_2->save();
        }
        // The workspace should now track 2 nodes.
        $tracked_entities = $workspace_association->getTrackedEntities($workspace_1->id());
        $this->assertCount(2, $tracked_entities['node']);
        // Since all the revisions were created inside a workspace, including the
        // default one, 'workspace_1' should be tracking all 10 revisions.
        $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_1->id(), 'node');
        $this->assertCount(10, $associated_revisions);
        // Check that we are allowed to delete the workspace.
        $this->assertTrue($workspace_1->access('delete', $admin));
        // Delete the workspace and check that all the workspace_association
        // entities and all the node revisions have been deleted as well.
        $workspace_1->delete();
        // There are no more tracked entities in 'workspace_1'.
        $tracked_entities = $workspace_association->getTrackedEntities($workspace_1->id());
        $this->assertEmpty($tracked_entities);
        // There are no more revisions associated with 'workspace_1'.
        $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_1->id(), 'node');
        $this->assertCount(0, $associated_revisions);
        // Create another workspace, this time with a larger number of associated
        // node revisions so we can test the batch purge process.
        $workspace_2 = Workspace::create([
            'id' => 'baboon',
            'label' => 'Baboon',
        ]);
        $workspace_2->save();
        $this->workspaceManager
            ->setActiveWorkspace($workspace_2);
        $workspace_2_node_1 = $this->createNode([
            'status' => FALSE,
        ]);
        for ($i = 0; $i < 59; $i++) {
            $workspace_2_node_1->setNewRevision(TRUE);
            $workspace_2_node_1->save();
        }
        // Now there is one entity tracked in 'workspace_2'.
        $tracked_entities = $workspace_association->getTrackedEntities($workspace_2->id());
        $this->assertCount(1, $tracked_entities['node']);
        // All 60 are associated with 'workspace_2'.
        $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_2->id(), 'node', [
            $workspace_2_node_1->id(),
        ]);
        $this->assertCount(60, $associated_revisions);
        // Delete the workspace and check that we still have 10 revision left to
        // delete.
        $workspace_2->delete();
        $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_2->id(), 'node', [
            $workspace_2_node_1->id(),
        ]);
        $this->assertCount(10, $associated_revisions);
        $workspace_deleted = \Drupal::state()->get('workspace.deleted');
        $this->assertCount(1, $workspace_deleted);
        // Check that we can not create another workspace with the same ID while its
        // data purging is not finished.
        $workspace_3 = Workspace::create([
            'id' => 'baboon',
            'label' => 'Baboon',
        ]);
        $violations = $workspace_3->validate();
        $this->assertCount(1, $violations);
        $this->assertEquals('A workspace with this ID has been deleted but data still exists for it.', $violations[0]->getMessage());
        // Running cron should delete the remaining data as well as the workspace ID
        // from the "workspace.delete" state entry.
        \Drupal::service('cron')->run();
        // Check that the actual node revisions were deleted as well.
        $node_storage = $this->entityTypeManager
            ->getStorage('node');
        $this->assertEmpty($node_storage->loadMultipleRevisions(array_keys($associated_revisions)));
        // 'workspace_2 'is empty now.
        $associated_revisions = $workspace_association->getAssociatedRevisions($workspace_2->id(), 'node', [
            $workspace_2_node_1->id(),
        ]);
        $this->assertCount(0, $associated_revisions);
        $tracked_entities = $workspace_association->getTrackedEntities($workspace_2->id());
        $this->assertCount(0, $tracked_entities);
        $workspace_deleted = \Drupal::state()->get('workspace.deleted');
        $this->assertCount(0, $workspace_deleted);
        // Check that the deleted workspace is no longer active.
        $this->assertFalse($this->workspaceManager
            ->hasActiveWorkspace());
    }
    
    /**
     * Tests that deleting a workspace keeps its already published content.
     */
    public function testDeletingPublishedWorkspace() : void {
        $admin = $this->createUser([
            'administer nodes',
            'create workspace',
            'view own workspace',
            'edit own workspace',
            'delete own workspace',
        ]);
        $this->setCurrentUser($admin);
        $live_workspace = Workspace::create([
            'id' => 'live',
            'label' => 'Live',
        ]);
        $live_workspace->save();
        $workspace = Workspace::create([
            'id' => 'stage',
            'label' => 'Stage',
        ]);
        $workspace->save();
        $this->workspaceManager
            ->setActiveWorkspace($workspace);
        // Create a new node in the 'stage' workspace
        $node = $this->createNode([
            'status' => TRUE,
        ]);
        // Create an additional workspace-specific revision for the node.
        $node->setNewRevision(TRUE);
        $node->save();
        // The node should have 3 revisions now: a default and 2 pending ones.
        $revisions = $this->entityTypeManager
            ->getStorage('node')
            ->loadMultipleRevisions([
            1,
            2,
            3,
        ]);
        $this->assertCount(3, $revisions);
        $this->assertTrue($revisions[1]->isDefaultRevision());
        $this->assertFalse($revisions[2]->isDefaultRevision());
        $this->assertFalse($revisions[3]->isDefaultRevision());
        // Publish the workspace, which should mark revision 3 as the default one
        // and keep revision 2 as a 'source' draft revision.
        $workspace->publish();
        $revisions = $this->entityTypeManager
            ->getStorage('node')
            ->loadMultipleRevisions([
            1,
            2,
            3,
        ]);
        $this->assertFalse($revisions[1]->isDefaultRevision());
        $this->assertFalse($revisions[2]->isDefaultRevision());
        $this->assertTrue($revisions[3]->isDefaultRevision());
        // Create two new workspace-revisions for the node.
        $node->setNewRevision(TRUE);
        $node->save();
        $node->setNewRevision(TRUE);
        $node->save();
        // The node should now have 5 revisions.
        $revisions = $this->entityTypeManager
            ->getStorage('node')
            ->loadMultipleRevisions([
            1,
            2,
            3,
            4,
            5,
        ]);
        $this->assertFalse($revisions[1]->isDefaultRevision());
        $this->assertFalse($revisions[2]->isDefaultRevision());
        $this->assertTrue($revisions[3]->isDefaultRevision());
        $this->assertFalse($revisions[4]->isDefaultRevision());
        $this->assertFalse($revisions[5]->isDefaultRevision());
        // Delete the workspace and check that only the two new pending revisions
        // were deleted by the workspace purging process.
        $workspace->delete();
        $revisions = $this->entityTypeManager
            ->getStorage('node')
            ->loadMultipleRevisions([
            1,
            2,
            3,
            4,
            5,
        ]);
        $this->assertCount(3, $revisions);
        $this->assertFalse($revisions[1]->isDefaultRevision());
        $this->assertFalse($revisions[2]->isDefaultRevision());
        $this->assertTrue($revisions[3]->isDefaultRevision());
        $this->assertFalse(isset($revisions[4]));
        $this->assertFalse(isset($revisions[5]));
    }
    
    /**
     * Tests that a workspace with children can not be deleted.
     */
    public function testDeletingWorkspaceWithChildren() : void {
        $stage = Workspace::create([
            'id' => 'stage',
            'label' => 'Stage',
        ]);
        $stage->save();
        $dev = Workspace::create([
            'id' => 'dev',
            'label' => 'Dev',
            'parent' => 'stage',
        ]);
        $dev->save();
        // Check that a workspace which has children can not be deleted.
        try {
            $stage->delete();
            $this->fail('The Stage workspace has children and should not be deletable.');
        } catch (EntityStorageException $e) {
            $this->assertEquals('The Stage workspace can not be deleted because it has child workspaces.', $e->getMessage());
            $this->assertNotNull(Workspace::load('stage'));
        }
        // Check that if we delete its child first, the parent workspace can also be
        // deleted.
        $dev->delete();
        $stage->delete();
        $this->assertNull(Workspace::load('dev'));
        $this->assertNull(Workspace::load('stage'));
    }
    
    /**
     * Tests loading the workspace tree when there are no workspaces available.
     */
    public function testEmptyWorkspaceTree() : void {
        $tree = \Drupal::service('workspaces.repository')->loadTree();
        $this->assertSame([], $tree);
    }

}

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::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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
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.
NodeCreationTrait::createNode protected function Creates a node based on default settings.
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
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.
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.
WorkspaceCRUDTest::$entityTypeManager protected property The entity type manager.
WorkspaceCRUDTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
WorkspaceCRUDTest::$state protected property The state service.
WorkspaceCRUDTest::$workspaceManager protected property The workspace replication manager. Overrides WorkspaceTestTrait::$workspaceManager
WorkspaceCRUDTest::setUp protected function Overrides KernelTestBase::setUp
WorkspaceCRUDTest::testDeletingPublishedWorkspace public function Tests that deleting a workspace keeps its already published content.
WorkspaceCRUDTest::testDeletingWorkspaces public function Tests the deletion of workspaces.
WorkspaceCRUDTest::testDeletingWorkspaceWithChildren public function Tests that a workspace with children can not be deleted.
WorkspaceCRUDTest::testEmptyWorkspaceTree public function Tests loading the workspace tree when there are no workspaces available.
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::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&#039;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.