Merge branch 'block-storage-methods' into 'master'

Block storage methods

See merge request transip/restapi-cli-client!177

Author: Jordi Donadeu

CHANGELOG.md

@@ -1,6 +1,10 @@
 CHANGELOG
 =========
 
+6.32.0
+-----
+* Added block storage commands. Deprecated big storage methods.
+
 6.31.0
 -----
 * Added ssh key support to rescue images

composer.json

@@ -23,7 +23,7 @@
     "symfony/console": "^5.4",
     "symfony/finder": "^5.4",
     "symfony/filesystem": "^5.4",
-    "transip/transip-api-php": "^6.45",
+    "transip/transip-api-php": "^6.48",
     "symfony/yaml": "^5.4"
   },
   "require-dev": {

composer.lock

@@ -8,6 +8,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
 use Transip\Api\CLI\Command\Setup\Setup;
 use Transip\Api\CLI\ConsoleOutput\Interfaces\OutputInterface as ConsoleOutputInterface;
 use Transip\Api\CLI\ConsoleOutput\OutputFactory;
@@ -31,6 +32,9 @@ abstract class AbstractCommand extends Command
      */
     private $output;
 
+    /** @var SymfonyStyle */
+    private $io;
+
     public function __construct(string $name = null)
     {
         parent::__construct($name);
@@ -90,6 +94,8 @@ protected function initialize(InputInterface $input, OutputInterface $output): v
             $formatter = $helperSet->get('formatter');
 
             $settings->ensureConfigFileIsReadOnly($formatter, $output);
+
+            $this->io = new SymfonyStyle($input, $output);
         }
 
         $this->input  = $input;
@@ -114,6 +120,11 @@ protected function output($data): void
         $this->output->writeln($formattedOutput);
     }
 
+    protected function warning(string $message): void
+    {
+        $this->io->getErrorStyle()->warning($message);
+    }
+
     private function getFormatterFromInput(): ConsoleOutputInterface
     {
         $formatType = $this->input->getOption(Field::FORMAT);

src/Command/AbstractCommand.php

@@ -20,11 +20,12 @@ protected function configure(): void
             ->addArgument(Field::BIGSTORAGE_NAME, InputArgument::REQUIRED, Field::BIGSTORAGE_NAME__DESC)
             ->addArgument(Field::VPS_NAME, InputArgument::REQUIRED, 'Name of the vps that the big storage should attach to.')
             ->addOption(Field::ACTION_WAIT, 'w', InputOption::VALUE_NONE, Field::ACTION_WAIT_DESC)
-            ->setHelp('This command will attach your big storage to your vps.');
+            ->setHelp('This command will attach your big storage to your vps. [deprecated] Use blockstorage:attachvps instead.');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $this->warning('Deprecated: use blockstorage:attachvps instead');
         $bigStorageName    = $input->getArgument(Field::BIGSTORAGE_NAME);
         $bigStorageVpsName = $input->getArgument(Field::VPS_NAME);
         $waitForAction     = $input->getOption(Field::ACTION_WAIT);

src/Command/BigStorage/AttachVps.php

@@ -16,11 +16,12 @@ protected function configure(): void
         $this->setName('bigstorage:backup:getbybigstoragename')
             ->setDescription('Get a list of backups for a big storage')
             ->addArgument(Field::BIGSTORAGE_NAME, InputArgument::REQUIRED, Field::BIGSTORAGE_NAME__DESC)
-            ->setHelp('This command lists backups for any given big storage.');
+            ->setHelp('This command lists backups for any given big storage. [deprecated] Use blockstorage:backup:getbyblockstoragename instead.');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $this->warning('Deprecated: use blockstorage:backup:getbyblockstoragename instead');
         $bigStorageName = $input->getArgument(Field::BIGSTORAGE_NAME);
         $vps = $this->getTransipApi()->bigStorageBackups()->getByBigStorageName($bigStorageName);
         $this->output($vps);

src/Command/BigStorage/Backup/GetByBigStorageName.php

@@ -21,11 +21,12 @@ protected function configure(): void
             ->addArgument(Field::BIGSTORAGE_BACKUP_DESTINATION_NAME, InputArgument::OPTIONAL, Field::BIGSTORAGE_BACKUP_DESTINATION_NAME__DESC . Field::OPTIONAL)
             ->addOption(Field::ACTION_WAIT, 'w', InputOption::VALUE_NONE, Field::ACTION_WAIT_DESC)
             ->addOption(Field::ACTION_PROGRESS, 'p', InputOption::VALUE_NONE, Field::ACTION_PROGRESS_DESC)
-            ->setHelp('This command restores a big storage backup.');
+            ->setHelp('This command restores a big storage backup. [deprecated] Use blockstorage:backup:revert instead.');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $this->warning('Deprecated: use blockstorage:backup:revert instead');
         $bigStorageName     = $input->getArgument(Field::BIGSTORAGE_NAME);
         $bigStorageBackupId = $input->getArgument(Field::BIGSTORAGE_BACKUPID);
         $destinationBigStorageName = $input->getArgument(Field::BIGSTORAGE_BACKUP_DESTINATION_NAME) ?? '';

src/Command/BigStorage/Backup/Revert.php

@@ -18,11 +18,12 @@ protected function configure(): void
             ->setDescription('Terminate or cancel your big storage')
             ->addArgument(Field::BIGSTORAGE_NAME, InputArgument::REQUIRED, Field::BIGSTORAGE_NAME__DESC)
             ->addArgument(Field::CANCELTIME, InputArgument::REQUIRED, Field::CANCELTIME__DESC)
-            ->setHelp('This command will terminate or cancel your big storage.');
+            ->setHelp('This command will terminate or cancel your big storage. [deprecated] Use blockstorage:cancel instead.');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $this->warning('Deprecated: use blockstorage:cancel instead');
         $bigStorageName = $input->getArgument(Field::BIGSTORAGE_NAME);
         if (strlen($bigStorageName) < 3) {
             throw new Exception('Invalid big storage name provided');

src/Command/BigStorage/Cancel.php

@@ -19,11 +19,12 @@ protected function configure(): void
             ->setDescription('Detach your big storage to your vps')
             ->addArgument(Field::BIGSTORAGE_NAME, InputArgument::REQUIRED, Field::BIGSTORAGE_NAME__DESC)
             ->addOption(Field::ACTION_WAIT, 'w', InputOption::VALUE_NONE, Field::ACTION_WAIT_DESC)
-            ->setHelp('This command will detach your big storage from your vps.');
+            ->setHelp('This command will detach your big storage from your vps. [deprecated] Use blockstorage:detachvps instead.');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $this->warning('Deprecated: use blockstorage:detachvps instead');
         $bigStorageName = $input->getArgument(Field::BIGSTORAGE_NAME);
         $waitForAction     = $input->getOption(Field::ACTION_WAIT);
 

src/Command/BigStorage/DetachVps.php

@@ -12,10 +12,12 @@ class GetAll extends AbstractCommand
     protected function configure(): void
     {
         $this->setName('bigstorage:getall')
-             ->setDescription('Get all of your big storages');
+             ->setDescription('Get all of your big storages')
+             ->setHelp('This command will return all your big storages. [deprecated] Use blockstorage:getall instead.');
     }
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $this->warning('Deprecated: use blockstorage:getall instead');
         $bigStorages = $this->getTransipApi()->bigStorages()->getAll();
 
         $this->output($bigStorages);