class WorkspaceCRUDTest in Drupal 9
Same name and namespace in other branches
- 8 core/modules/workspaces/tests/src/Kernel/WorkspaceCRUDTest.php \Drupal\Tests\workspaces\Kernel\WorkspaceCRUDTest
Tests CRUD operations for workspaces.
@group workspaces
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\workspaces\Kernel\WorkspaceCRUDTest uses ContentTypeCreationTrait, NodeCreationTrait, UserCreationTrait, WorkspaceTestTrait
Expanded class hierarchy of WorkspaceCRUDTest
File
- core/
modules/ workspaces/ tests/ src/ Kernel/ WorkspaceCRUDTest.php, line 17
Namespace
Drupal\Tests\workspaces\KernelView 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',
'path_alias',
];
/**
* {@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() {
$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,
]);
// The 'live' workspace should have 2 revisions now. The initial revision
// for each node.
$live_revisions = $this
->getUnassociatedRevisions('node');
$this
->assertCount(2, $live_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']);
// There should still be 2 revisions associated with 'live'.
$live_revisions = $this
->getUnassociatedRevisions('node');
$this
->assertCount(2, $live_revisions);
// The other 8 revisions should be associated with 'workspace_1'.
$associated_revisions = $workspace_association
->getAssociatedRevisions($workspace_1
->id(), 'node');
$this
->assertCount(8, $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);
// There should still be 2 revisions associated with 'live'.
$live_revisions = $this
->getUnassociatedRevisions('node');
$this
->assertCount(2, $live_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']);
// One revision of this entity is in 'live'.
$live_revisions = $this
->getUnassociatedRevisions('node', [
$workspace_2_node_1
->id(),
]);
$this
->assertCount(1, $live_revisions);
// The other 59 are associated with 'workspace_2'.
$associated_revisions = $workspace_association
->getAssociatedRevisions($workspace_2
->id(), 'node', [
$workspace_2_node_1
->id(),
]);
$this
->assertCount(59, $associated_revisions);
// Delete the workspace and check that we still have 9 revision left to
// delete.
$workspace_2
->delete();
$associated_revisions = $workspace_association
->getAssociatedRevisions($workspace_2
->id(), 'node', [
$workspace_2_node_1
->id(),
]);
$this
->assertCount(9, $associated_revisions);
// The live revision is also still there.
$live_revisions = $this
->getUnassociatedRevisions('node', [
$workspace_2_node_1
->id(),
]);
$this
->assertCount(1, $live_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();
$associated_revisions = $workspace_association
->getTrackedEntities($workspace_2
->id());
$this
->assertCount(0, $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
->assertEmpty($tracked_entities);
// The 3 revisions in 'live' remain.
$live_revisions = $this
->getUnassociatedRevisions('node');
$this
->assertCount(3, $live_revisions);
$workspace_deleted = \Drupal::state()
->get('workspace.deleted');
$this
->assertCount(0, $workspace_deleted);
}
/**
* Tests that deleting a workspace keeps its already published content.
*/
public function testDeletingPublishedWorkspace() {
$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() {
$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'));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. | 1 |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
WorkspaceCRUDTest:: |
protected | property | The entity type manager. | |
WorkspaceCRUDTest:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
WorkspaceCRUDTest:: |
protected | property | The state service. | |
WorkspaceCRUDTest:: |
protected | property |
The workspace replication manager. Overrides WorkspaceTestTrait:: |
|
WorkspaceCRUDTest:: |
protected | function |
Overrides KernelTestBase:: |
|
WorkspaceCRUDTest:: |
public | function | Tests that deleting a workspace keeps its already published content. | |
WorkspaceCRUDTest:: |
public | function | Tests the deletion of workspaces. | |
WorkspaceCRUDTest:: |
public | function | Tests that a workspace with children can not be deleted. | |
WorkspaceTestTrait:: |
protected | property | An array of test workspaces, keyed by workspace ID. | |
WorkspaceTestTrait:: |
protected | function | Checks the workspace_association records for a test scenario. | |
WorkspaceTestTrait:: |
protected | function | Creates a test workspace hierarchy. | |
WorkspaceTestTrait:: |
protected | function | Returns all the revisions which are not associated with any workspace. | |
WorkspaceTestTrait:: |
protected | function | Enables the Workspaces module and creates two workspaces. | |
WorkspaceTestTrait:: |
protected | function | Sets a given workspace as active. |