Support for Tasks functionality

legacy/src/Command/SourceOperation/RunCommand.php

@@ -45,7 +45,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $selection = $this->selector->getSelection($input);
 
-        $variables = $this->parseVariables($input->getOption('variable'));
+        $variables = (new Variable())->parseMultiple($input->getOption('variable'));
         $this->io->debug('Parsed variables: ' . json_encode($variables));
 
         $environment = $selection->getEnvironment();
@@ -104,21 +104,4 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         return $success ? 0 : 1;
     }
-
-    /**
-     * @param string[] $variables
-     *
-     * @return array<string, array<string, string>>
-     */
-    private function parseVariables(array $variables): array
-    {
-        $map = [];
-        $variable = new Variable();
-        foreach ($variables as $var) {
-            [$type, $name, $value] = $variable->parse($var);
-            $map[$type][$name] = $value;
-        }
-
-        return $map;
-    }
 }

legacy/src/Command/Task/TaskListCommand.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Platformsh\Cli\Command\Task;
+
+use GuzzleHttp\Exception\BadResponseException;
+use GuzzleHttp\Utils;
+use Platformsh\Cli\Command\CommandBase;
+use Platformsh\Cli\Selector\Selector;
+use Platformsh\Cli\Service\Api;
+use Platformsh\Cli\Service\Table;
+use Platformsh\Client\Exception\ApiResponseException;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(name: 'task:list', description: 'Get a list of tasks on an environment', aliases: ['tasks'])]
+class TaskListCommand extends CommandBase
+{
+    /** @var array<string, string> */
+    private array $tableHeader = [
+        'name' => 'Name',
+        'type' => 'Type',
+        'command' => 'Command',
+        'timeout' => 'Timeout (s)',
+    ];
+
+    public function __construct(private readonly Api $api, private readonly Selector $selector, private readonly Table $table)
+    {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        Table::configureInput($this->getDefinition(), $this->tableHeader);
+        $this->selector->addProjectOption($this->getDefinition());
+        $this->selector->addEnvironmentOption($this->getDefinition());
+        $this->addCompleter($this->selector);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $selection = $this->selector->getSelection($input);
+        $environment = $selection->getEnvironment();
+
+        try {
+            $response = $this->api->getHttpClient()->request('GET', $environment->getUri() . '/tasks');
+        } catch (BadResponseException $e) {
+            throw ApiResponseException::create($e->getRequest(), $e->getResponse(), $e);
+        }
+        $tasks = (array) Utils::jsonDecode((string) $response->getBody(), true);
+
+        if ($tasks === []) {
+            $this->stdErr->writeln(sprintf(
+                'No tasks were found on the environment %s.',
+                $this->api->getEnvironmentLabel($environment),
+            ));
+
+            return 0;
+        }
+
+        $rows = [];
+        foreach ($tasks as $task) {
+            $rows[] = [
+                'name' => $task['name'] ?? '',
+                'type' => $task['type'] ?? '',
+                'command' => isset($task['run']['command']) ? trim((string) $task['run']['command']) : '',
+                'timeout' => $task['run']['timeout'] ?? '',
+            ];
+        }
+
+        if (!$this->table->formatIsMachineReadable()) {
+            $this->stdErr->writeln(sprintf(
+                'Tasks on the environment %s:',
+                $this->api->getEnvironmentLabel($environment),
+            ));
+        }
+
+        $this->table->render($rows, $this->tableHeader);
+
+        return 0;
+    }
+}

legacy/src/Command/Task/TaskRunCommand.php

@@ -0,0 +1,115 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Platformsh\Cli\Command\Task;
+
+use GuzzleHttp\Exception\BadResponseException;
+use GuzzleHttp\Utils;
+use Platformsh\Cli\Command\CommandBase;
+use Platformsh\Cli\Model\Variable;
+use Platformsh\Cli\Selector\Selector;
+use Platformsh\Cli\Service\ActivityMonitor;
+use Platformsh\Cli\Service\Api;
+use Platformsh\Cli\Service\Config;
+use Platformsh\Cli\Service\QuestionHelper;
+use Platformsh\Client\Exception\ApiResponseException;
+use Platformsh\Client\Model\Activity;
+use Platformsh\Client\Model\Result;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[AsCommand(name: 'task:run', description: 'Execute a task on an environment')]
+class TaskRunCommand extends CommandBase
+{
+    public function __construct(private readonly ActivityMonitor $activityMonitor, private readonly Api $api, private readonly Config $config, private readonly QuestionHelper $questionHelper, private readonly Selector $selector)
+    {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->addArgument('task', InputArgument::REQUIRED, 'The name of the task to execute')
+            ->addOption('variable', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'A variable to set when running the task, in the format <info>type:name=value</info>')
+            // Tasks can run for a long time, so waiting is opt-in rather than the default.
+            ->addOption('wait', null, InputOption::VALUE_NONE, 'Wait for the task to complete');
+
+        $this->selector->addProjectOption($this->getDefinition());
+        $this->selector->addEnvironmentOption($this->getDefinition());
+        $this->addCompleter($this->selector);
+
+        $this->addExample('Run the "migrate" task on the environment "main"', 'migrate --environment main');
+        $this->addExample('Run the "migrate" task, setting environment variable FOO=bar', 'migrate -e main --variable env:FOO=bar');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $selection = $this->selector->getSelection($input);
+        $environment = $selection->getEnvironment();
+
+        $taskName = $input->getArgument('task');
+        $variables = (new Variable())->parseMultiple($input->getOption('variable'));
+
+        if ($environment->type === 'production' && !$this->questionHelper->confirm(sprintf(
+            'Are you sure you want to run the task <comment>%s</comment> on the production environment %s?',
+            $taskName,
+            $this->api->getEnvironmentLabel($environment, 'comment'),
+        ))) {
+            return 1;
+        }
+
+        $this->stdErr->writeln(sprintf(
+            'Executing task <info>%s</info> on the environment %s',
+            $taskName,
+            $this->api->getEnvironmentLabel($environment),
+        ));
+
+        $url = $environment->getUri() . '/tasks/' . rawurlencode($taskName) . '/run';
+        try {
+            $response = $this->api->getHttpClient()->request('POST', $url, ['json' => ['variables' => (object) $variables]]);
+        } catch (BadResponseException $e) {
+            throw ApiResponseException::create($e->getRequest(), $e->getResponse(), $e);
+        }
+
+        $result = new Result(
+            (array) Utils::jsonDecode((string) $response->getBody(), true),
+            $environment->getUri(),
+            $this->api->getHttpClient(),
+            Activity::class,
+        );
+        $activities = $result->getActivities();
+
+        $this->stdErr->writeln('');
+        $this->stdErr->writeln('The task has been triggered.');
+
+        // Waiting is opt-in so the exit code can reflect a failed activity, e.g. in CI.
+        if ($input->getOption('wait') && $activities !== []) {
+            $success = $this->activityMonitor->waitMultiple($activities, $selection->getProject());
+            return $success ? 0 : 1;
+        }
+
+        $executable = $this->config->getStr('application.executable');
+        if ($activities !== []) {
+            // Reference the exact activity ID so the log can be followed even
+            // when several activities are running in parallel.
+            $activity = reset($activities);
+            $this->stdErr->writeln(sprintf(
+                'To follow its log, run: <info>%s activity:log %s</info>',
+                $executable,
+                $activity->id,
+            ));
+        } else {
+            $this->stdErr->writeln(sprintf(
+                'To follow its log, run: <info>%s activity:log --type environment.task -e %s</info>',
+                $executable,
+                $environment->id,
+            ));
+        }
+
+        return 0;
+    }
+}

legacy/src/Model/Variable.php

@@ -28,6 +28,25 @@ public function parse(string $variable): array
         return [$this->validateType($type), $this->validateName($name), $value];
     }
 
+    /**
+     * Parses multiple type:name=value definitions into a nested array.
+     *
+     * @param string[] $variables
+     *
+     * @return array<string, array<string, string>>
+     *   Values keyed by type and then by name.
+     */
+    public function parseMultiple(array $variables): array
+    {
+        $map = [];
+        foreach ($variables as $var) {
+            [$type, $name, $value] = $this->parse($var);
+            $map[$type][$name] = $value;
+        }
+
+        return $map;
+    }
+
     /**
      * Validates the variable type (AKA namespace).
      *

legacy/src/Service/ActivityLoader.php

@@ -201,6 +201,7 @@ public static function getAvailableTypes(): array
             'environment.source-operation',
             'environment.subscription.update',
             'environment.synchronize',
+            'environment.task',
             'environment.update.http_access',
             'environment.update.restrict_robots',
             'environment.update.smtp',

legacy/tests/Model/VariableTest.php

@@ -39,6 +39,36 @@ public function testParseValidVariables(): void
         );
     }
 
+    public function testParseMultiple(): void
+    {
+        $this->assertEquals([], (new Variable())->parseMultiple([]));
+
+        $this->assertEquals(
+            [
+                'env' => ['foo' => 'bar', 'baz' => 'qux'],
+                'complex' => ['json' => '{"a":"b"}'],
+            ],
+            (new Variable())->parseMultiple([
+                'env:foo=bar',
+                'env:baz=qux',
+                'complex:json={"a":"b"}',
+            ]),
+        );
+
+        // A later definition overwrites an earlier one with the same type and name.
+        $this->assertEquals(
+            ['env' => ['foo' => 'second']],
+            (new Variable())->parseMultiple(['env:foo=first', 'env:foo=second']),
+        );
+    }
+
+    public function testParseMultipleWithInvalidVariable(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage($this->invalidMessage);
+        (new Variable())->parseMultiple(['env:foo=bar', 'invalid']);
+    }
+
     public function testParseInvalidVariableType(): void
     {
         $this->expectException(\InvalidArgumentException::class);