Skip to content
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.

Sign up for GitHub

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

Distinguish (again) between "deactivate" and "delete" in the env:delete command #1160

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Distinguish (again) between "deactivate" and "delete" in the env:delete command #1160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
49 changes: 24 additions & 25 deletions src/Command/Environment/EnvironmentDeleteCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,29 @@ protected function configure()
{
$this
->setName('environment:delete')
->setHiddenAliases(['environment:deactivate'])
->setDescription('Delete one or more environments')
->addArgument('environment', InputArgument::IS_ARRAY, "The environment(s) to delete.\nThe % character may be used as a wildcard." . "\n" . ArrayArgument::SPLIT_HELP)
->setAliases(['environment:deactivate'])
->setDescription('Deactivate or delete one or more environments')
->addArgument('environment', InputArgument::IS_ARRAY, "Select environment(s) by ID.\nThe % character may be used as a wildcard." . "\n" . ArrayArgument::SPLIT_HELP)
->addOption('delete-branch', null, InputOption::VALUE_NONE, 'Delete Git branch(es) (inactive environments)')
->addOption('no-delete-branch', null, InputOption::VALUE_NONE, 'Do not delete Git branch(es) (inactive environments)')
->addOption('type', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Delete all environments of a type (adding to any others selected)' . "\n" . ArrayArgument::SPLIT_HELP)
->addOption('only-type', 't', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Only delete environment(s) of a specific type' . "\n" . ArrayArgument::SPLIT_HELP)
->addOption('exclude', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, "Environment(s) not to delete.\nThe % character may be used as a wildcard.\n" . ArrayArgument::SPLIT_HELP)
->addOption('exclude-type', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Environment type(s) of which not to delete' . "\n" . ArrayArgument::SPLIT_HELP)
->addOption('inactive', null, InputOption::VALUE_NONE, 'Delete all inactive environments (adding to any others selected')
->addOption('merged', null, InputOption::VALUE_NONE, 'Delete all merged environments (adding to any others selected)');
->addOption('type', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Select all environments of a type (adding to any others selected)' . "\n" . ArrayArgument::SPLIT_HELP)
->addOption('only-type', 't', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Include only environment(s) of a specific type' . "\n" . ArrayArgument::SPLIT_HELP)
->addOption('exclude', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, "Environment(s) to exclude.\nThe % character may be used as a wildcard.\n" . ArrayArgument::SPLIT_HELP)
->addOption('exclude-type', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Environment type(s) to exclude' . "\n" . ArrayArgument::SPLIT_HELP)
->addOption('inactive', null, InputOption::VALUE_NONE, 'Select all inactive environments (adding to any others selected')
->addOption('merged', null, InputOption::VALUE_NONE, 'Select all merged environments (adding to any others selected)');
$this->addProjectOption()
->addEnvironmentOption()
->addWaitOptions();
$this->addExample('Delete the currently checked out environment');
$this->addExample('Delete the environments "test" and "example-1"', 'test example-1');
$this->addExample('Deactivate and delete the currently checked out environment');
$this->addExample('Deactivate and delete the environments "test" and "example-1"', 'test example-1');
$this->addExample('Delete all inactive environments', '--inactive');
$this->addExample('Delete all environments merged with their parent', '--merged');
$service = $this->config()->get('service.name');
$this->addExample('Deactivate and delete all environments merged with their parent', '--merged');
$this->setHelp(<<<EOF
When a {$service} environment is deleted, it will become "inactive": it will
exist only as a Git branch, containing code but no services, databases nor
files.
Deactivating an environment will destroy all its data and services. Only the
code in the Git branch remains.

This command allows you to delete environment(s) as well as their Git branches.
This command allows you to deactivate environment(s) and delete their Git branches.
EOF
);
}
Expand Down Expand Up @@ -180,7 +178,8 @@ function ($environment) {
$this->stdErr->writeln('');
}

// Confirm which of the environments the user wishes to be deleted.
// Confirm which of the environments the user wishes to be deactivated
// or deleted.
$this->api()->sortResources($selectedEnvironments, 'id');
$toDeleteBranch = [];
$toDeactivate = [];
Expand All @@ -194,7 +193,7 @@ function ($environment) {
foreach ($environments as $potentialChild) {
if ($potentialChild->parent === $environment->id) {
$this->stdErr->writeln(\sprintf(
"The environment %s has children and therefore can't be deleted.",
"The environment %s has children and therefore can't be deactivated or deleted.",
$this->api()->getEnvironmentLabel($environment, 'error')
));
$this->stdErr->writeln("Please delete the environment's children first.");
Expand All @@ -214,12 +213,12 @@ function ($environment) {
continue;
}
if ($environment->status === 'deleting') {
$this->stdErr->writeln("The environment <comment>$environmentId</comment> is already being deleted.");
$this->stdErr->writeln("The environment <comment>$environmentId</comment> is already being deactivated or deleted.");
$needNewline = true;
continue;
}
if ($environment->status === 'dirty') {
$this->stdErr->writeln("The environment <error>$environmentId</error> is currently building, and therefore can't be deleted. Please wait.");
$this->stdErr->writeln("The environment <error>$environmentId</error> is currently building, and therefore can't be deactivated or deleted. Please wait.");
$error = $needNewline = true;
continue;
}
Expand All @@ -228,10 +227,10 @@ function ($environment) {
if ($environment->isActive()) {
$needNewline = true;
$this->stdErr->writeln(\sprintf(
'The environment %s is currently active: deleting it will delete all associated data.',
'The environment %s is currently active. Deactivating it will destroy all associated data and services.',
$this->api()->getEnvironmentLabel($environment, 'comment')
));
if ($questionHelper->confirm('Are you sure you want to delete this environment?')) {
if ($questionHelper->confirm('Are you sure you want to deactivate this environment?')) {
$toDeactivate[$environmentId] = $environment;
} else {
$error = true;
Expand Down Expand Up @@ -259,7 +258,7 @@ function ($environment) {
}

if (empty($toDeleteBranch) && empty($toDeactivate)) {
$this->stdErr->writeln('No environment(s) to delete.');
$this->stdErr->writeln('No environments to deactivate or delete.');
if (!$anythingSpecified) {
$this->stdErr->writeln(\sprintf('For help, run: <info>%s help environment:delete</info>', $this->config()->get('application.executable')));
}
Expand Down Expand Up @@ -299,7 +298,7 @@ protected function deleteMultiple(array $toDeactivate, array $toDeleteBranch, In
/** @var Environment $environment */
foreach ($toDeactivate as $environmentId => $environment) {
try {
$this->stdErr->writeln("Deleting environment <info>$environmentId</info>");
$this->stdErr->writeln("Deactivating environment <info>$environmentId</info>");
$deactivateActivities[] = $environment->deactivate();
$deactivated++;
} catch (\Exception $e) {
Expand Down