Add workspaces:publish command (#6432)

Author: weitzman

.docker/zz-php.ini

@@ -3,7 +3,7 @@ variables_order = GPCS
 error_reporting = E_ALL & ~E_DEPRECATED
 date.timezone = "UTC"
 sendmail_path = "true"
-memory_limit = 512M
+memory_limit = 1024M
 
 [xdebug]
 xdebug.mode = off

.gitignore

@@ -27,3 +27,6 @@ sut/modules/contrib
 # Test fixtures
 sut/drush/sites/synctest.site.yml
 /tests/.phpunit.result.cache
+
+# Code tools
+.claude

src/Commands/core/WorkspacesCommand.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Drush\Commands\core;
+
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\workspaces\WorkspaceOperationFactory;
+use Drush\Attributes as CLI;
+use Drush\Commands\AutowireTrait;
+use Drush\Style\DrushStyle;
+use Psr\Container\ContainerInterface;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(
+    name: self::NAME,
+    description: 'Publish a workspace.'
+)]
+#[CLI\ValidateModulesEnabled(modules: ['workspaces'])]
+final class WorkspacesCommand extends Command
+{
+    use AutowireTrait;
+
+    const NAME = 'workspaces:publish';
+
+    protected ?WorkspaceOperationFactory $workspacesOperationFactory = null;
+
+    /**
+     * Constructs a WorkspacesCommands object.
+     */
+    public function __construct(
+        private readonly EntityTypeManagerInterface $entityTypeManager,
+        protected readonly ContainerInterface $container,
+    ) {
+        parent::__construct();
+
+        if ($container->has('workspaces.operation_factory')) {
+            $this->workspacesOperationFactory = $container->get('workspaces.operation_factory');
+        }
+    }
+
+    protected function configure()
+    {
+        $this
+            ->addArgument('id', InputArgument::REQUIRED, 'The workspace to publish.')
+            ->addUsage('workspaces:publish stage');
+    }
+
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new DrushStyle($input, $output);
+        $id = $input->getArgument('id');
+        /** @var \Drupal\workspaces\Entity\Workspace $workspace */
+        $workspace = $this->entityTypeManager->getStorage('workspace')->load($id);
+        if (!$workspace) {
+            throw new \Exception(dt('Workspace @id not found.', ['@id' => $id]));
+        }
+
+        $workspace_publisher = $this->workspacesOperationFactory->getPublisher($workspace);
+
+        // Does this workspace have any content to publish?
+        $diff = $workspace_publisher->getDifferringRevisionIdsOnSource();
+        if (empty($diff)) {
+            $io->success(sprintf('There are no changes that can be published from %s to %s', $workspace->label(), $workspace_publisher->getTargetLabel()));
+            return self::SUCCESS;
+        }
+
+        $workspace->publish();
+        $io->success(sprintf('Workspace %s published.', $workspace->label()));
+        return self::SUCCESS;
+    }
+}

tests/integration/WorkspacesTest.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Unish;
+
+use Drupal\node\Entity\Node;
+use Drupal\workspaces\WorkspaceManagerInterface;
+use Drush\Commands\core\WorkspacesCommand;
+use Drush\Commands\pm\PmInstallCommand;
+
+/**
+ * Tests Workspaces commands
+ *
+ * @group commands
+ */
+class WorkspacesTest extends UnishIntegrationTestCase
+{
+    private WorkspaceManagerInterface $workspaceManager;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->drush(PmInstallCommand::NAME, ['workspaces', 'node']);
+        $this->workspaceManager = \Drupal::service('workspaces.manager');
+
+        // Create article content type if it doesn't exist
+        $node_types = \Drupal::entityTypeManager()->getStorage('node_type')->loadMultiple();
+        if (!isset($node_types['article'])) {
+            $article_type = \Drupal\node\Entity\NodeType::create([
+                'type' => 'article',
+                'name' => 'Article',
+            ]);
+            $article_type->save();
+        }
+
+        // Create a test workspace if it doesn't exist
+        $workspace_storage = \Drupal::entityTypeManager()->getStorage('workspace');
+        $existing_workspace = $workspace_storage->load('stage');
+        if (!$existing_workspace) {
+            $workspace = \Drupal\workspaces\Entity\Workspace::create([
+                'id' => 'stage',
+                'label' => 'Stage',
+            ]);
+            $workspace->save();
+        }
+
+        // Set the stage workspace as active and create content in it
+        $stage_workspace = $workspace_storage->load('stage');
+        $this->workspaceManager->setActiveWorkspace($stage_workspace);
+
+        // Create a sample node in the workspace context
+        $node = Node::create([
+            'type' => 'article',
+            'title' => 'Test Node in Workspace',
+            'body' => 'This is a test node created in the stage workspace.',
+            'status' => 1,
+        ]);
+        $node->save();
+    }
+
+    public function testWorkspaces(): void
+    {
+        // Test that workspace has content to publish
+        $workspace_id = 'stage';
+
+        // Publish the workspace
+        $this->drush(WorkspacesCommand::NAME, [$workspace_id]);
+        $this->assertStringContainsString('Workspace Stage published', $this->getErrorOutput());
+
+        // Verify no more changes exist after publishing
+        $this->drush(WorkspacesCommand::NAME, [$workspace_id]);
+        $this->assertStringContainsString('There are no changes that can be published', $this->getErrorOutput());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function tearDown(): void
+    {
+        // Cleanup the test workspace (this should also handle content deletion)
+        $this->drush('entity:delete', ['workspace', 'stage'], ['yes' => true]);
+        $this->drush('entity:delete', ['node'], ['yes' => true, 'bundle' => 'article']);
+        $this->drush('pm:uninstall', ['workspaces', 'node'], ['yes' => true]);
+        parent::tearDown();
+    }
+}