-
Notifications
You must be signed in to change notification settings - Fork 5
Support for Tasks functionality #112
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vitolkachova
wants to merge
5
commits into
main
Choose a base branch
from
tasks-commands
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a3b7cc7
feat: implement task execute command
vitolkachova ee07e1e
feat: add tasks list command
vitolkachova f9d1f47
refactor: add task activity to the const list
vitolkachova 97bfa79
refactor: reword from execute to run
vitolkachova 3ba76b8
refactor: add exception wrapper
vitolkachova File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>', | ||
| $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; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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