Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions legacy/src/Command/Task/TaskListCommand.php
Original file line number Diff line number Diff line change
@@ -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;
}
}
116 changes: 116 additions & 0 deletions legacy/src/Command/Task/TaskRunCommand.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<?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\Api;
use Platformsh\Cli\Service\Config;
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 Api $api, private readonly Config $config, 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>');

$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 = $this->parseVariables($input->getOption('variable'));

$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.');

$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>',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could directly follow the log here, using the ActivityMonitor service. I think it would be more consistent with other commands.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I deliberately decided not to as task execution can last for many hours, and IMO if a user wants to follow the log it should be an action from their side

$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;
}

/**
* Parses variables in the format type:name=value into a nested array.
*
* @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;
}
}
1 change: 1 addition & 0 deletions legacy/src/Service/ActivityLoader.php
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down