Merge pull request #643 from bbakalov/fix/cli-command-return-type

vvuksan · web-flow · commit 5ba5819fdaf1 · 2023-06-26T10:53:25.000-04:00
cli command return success/failure added
diff --git a/Console/Command/ConfigGetCommand.php b/Console/Command/ConfigGetCommand.php
@@ -27,6 +27,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputOption;
+use Magento\Framework\Console\Cli;
 
 /**
  * Class ConfigGetCommand
@@ -189,7 +190,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
 
         if (count(array_unique($options)) === 1) {
             $this->output->writeln('<comment>' . $this->getSynopsis() . '</comment>', OutputInterface::OUTPUT_NORMAL);
-            return;
+            return Cli::RETURN_FAILURE;
         }
 
         // Get Service ID
@@ -261,6 +262,8 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
         if ($input->getOption('fastly-status')) {
             $this->getFastlyStatus($this->config->isFastlyEnabled());
         }
+
+        return Cli::RETURN_SUCCESS;
     }
 
     /**
diff --git a/Console/Command/ConfigImportCommand.php b/Console/Command/ConfigImportCommand.php
@@ -25,6 +25,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputOption;
+use Magento\Framework\Console\Cli;
 
 /**
  * Class ConfigImportCommand
@@ -93,7 +94,8 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
             $data = json_decode(file_get_contents($file));
             if (!$data) {
                 $output->writeln("<error>Invalid file structure</error>");
-                return;
+
+                return Cli::RETURN_FAILURE;
             }
 
             $clone = $this->getClonedVersion();
@@ -117,7 +119,10 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
 
         } catch (\Exception $e) {
             $output->writeln("<error>{$e->getMessage()}</error>");
+            return Cli::RETURN_FAILURE;
         }
+
+        return Cli::RETURN_SUCCESS;
     }
 
     /**
diff --git a/Console/Command/EnableCommand.php b/Console/Command/EnableCommand.php
@@ -30,6 +30,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Magento\Framework\App\Config\Storage\WriterInterface;
 use Magento\Framework\App\Cache\Manager;
+use Magento\Framework\Console\Cli;
 use Magento\Framework\Filesystem;
 use Magento\Framework\App\Filesystem\DirectoryList;
 
@@ -284,7 +285,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
 
         if (count(array_unique($options)) === 1) {
             $this->output->writeln('<comment>' . $this->getSynopsis() . '</comment>', OutputInterface::OUTPUT_NORMAL);
-            return;
+            return Cli::RETURN_FAILURE;
         }
 
         // Set Service ID
@@ -389,6 +390,8 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
 
         $arguments = new ArrayInput(['command' => 'cache:flush', 'types' => ['config']]);
         $this->getApplication()->find('cache:flush')->run($arguments, $output);
+
+        return Cli::RETURN_SUCCESS;
     }
 
     /**
diff --git a/Console/Command/GenerateVclCommand.php b/Console/Command/GenerateVclCommand.php
@@ -23,6 +23,7 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Magento\Framework\Console\Cli;
 
 /**
  * Class GenerateVclCommand
@@ -51,5 +52,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
             "Fastly custom VCL use been deprecated."
                 . "Please upload VCL snippets from the Magento admin UI or using the CLI commands."
         );
+
+        return Cli::RETURN_SUCCESS;
     }
 }
diff --git a/Console/Command/JsonToSerialize.php b/Console/Command/JsonToSerialize.php
@@ -24,6 +24,7 @@
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Config\Storage\WriterInterface;
 use Magento\Framework\App\ProductMetadataInterface;
+use Magento\Framework\Console\Cli;
 use Magento\Framework\Serialize\SerializerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -120,7 +121,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
 
             if ($oldData === false || $oldData === null) {
                 $output->writeln('Invalid JSON format, unable to decode config data : ' . $path);
-                return;
+                return Cli::RETURN_FAILURE;
             }
 
             $oldData = (is_array($oldData)) ? $oldData : [];
@@ -134,6 +135,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
             $this->cacheManager->clean([\Magento\Framework\App\Cache\Type\Config::TYPE_IDENTIFIER]);
 
             $output->writeln('Config Cache Flushed');
+            return Cli::RETURN_SUCCESS;
         }
     }
 }
diff --git a/Console/Command/SerializeToJson.php b/Console/Command/SerializeToJson.php
@@ -24,6 +24,7 @@
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Config\Storage\WriterInterface;
 use Magento\Framework\App\ProductMetadataInterface;
+use Magento\Framework\Console\Cli;
 use Magento\Framework\Serialize\Serializer\Serialize;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -130,7 +131,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
                     'Invalid serialization format, unable to unserialize config data : ' . $path
                 );
 
-                return;
+                return Cli::RETURN_FAILURE;
             }
             $oldData = (is_array($oldData)) ? $oldData : [];
 
@@ -143,6 +144,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
             $this->cacheManager->clean([\Magento\Framework\App\Cache\Type\Config::TYPE_IDENTIFIER]);
 
             $output->writeln('Config Cache Flushed');
+            return Cli::RETURN_SUCCESS;
         }
     }
 }
diff --git a/Console/Command/SuperUserCommand.php b/Console/Command/SuperUserCommand.php
@@ -23,6 +23,7 @@
 use Fastly\Cdn\Model\Config;
 use Fastly\Cdn\Model\Api;
 use Fastly\Cdn\Helper\Vcl;
+use Magento\Framework\Console\Cli;
 use Magento\Framework\Filesystem;
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Symfony\Component\Console\Command\Command;
@@ -119,7 +120,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
 
         if (count(array_unique($options)) === 1) {
             $this->output->writeln('<comment>' . $this->getSynopsis() . '</comment>', OutputInterface::OUTPUT_NORMAL);
-            return;
+            return Cli::RETURN_FAILURE;
         }
 
         if ($input->getOption('enable')) {
@@ -133,6 +134,8 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c
         if ($input->getOption('update')) {
             $this->updateSuIps();
         }
+
+        return Cli::RETURN_SUCCESS;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`	`use Symfony\Component\Console\Command\Command;`
`24`	`24`	`use Symfony\Component\Console\Input\InputInterface;`
`25`	`25`	`use Symfony\Component\Console\Output\OutputInterface;`
	`26`	`+use Magento\Framework\Console\Cli;`
`26`	`27`
`27`	`28`	`/**`
`28`	`29`	`* Class GenerateVclCommand`
`@@ -51,5 +52,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c`
`51`	`52`	`"Fastly custom VCL use been deprecated."`
`52`	`53`	`. "Please upload VCL snippets from the Magento admin UI or using the CLI commands."`
`53`	`54`	`);`
	`55`	`+`
	`56`	`+ return Cli::RETURN_SUCCESS;`
`54`	`57`	`}`
`55`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`use Magento\Framework\App\Config\ScopeConfigInterface;`
`25`	`25`	`use Magento\Framework\App\Config\Storage\WriterInterface;`
`26`	`26`	`use Magento\Framework\App\ProductMetadataInterface;`
	`27`	`+use Magento\Framework\Console\Cli;`
`27`	`28`	`use Magento\Framework\Serialize\SerializerInterface;`
`28`	`29`	`use Symfony\Component\Console\Command\Command;`
`29`	`30`	`use Symfony\Component\Console\Input\InputInterface;`
`@@ -120,7 +121,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c`
`120`	`121`
`121`	`122`	`if ($oldData === false \|\| $oldData === null) {`
`122`	`123`	`$output->writeln('Invalid JSON format, unable to decode config data : ' . $path);`
`123`		`- return;`
	`124`	`+ return Cli::RETURN_FAILURE;`
`124`	`125`	`}`
`125`	`126`
`126`	`127`	`$oldData = (is_array($oldData)) ? $oldData : [];`
`@@ -134,6 +135,7 @@ protected function execute(InputInterface $input, OutputInterface $output) // @c`
`134`	`135`	`$this->cacheManager->clean([\Magento\Framework\App\Cache\Type\Config::TYPE_IDENTIFIER]);`
`135`	`136`
`136`	`137`	`$output->writeln('Config Cache Flushed');`
	`138`	`+ return Cli::RETURN_SUCCESS;`
`137`	`139`	`}`
`138`	`140`	`}`
`139`	`141`	`}`