Refactor init:mac to setup:env to allow other envs

dave-redfern · dave-redfern · commit 6f5e13c1bd9a · 2020-10-20T12:59:43.000-04:00
Add config update to init command
diff --git a/readme.md b/readme.md
@@ -449,10 +449,10 @@ file yourself.
 
 ### Customising the development environment
 
-spm includes an `init:mac` command that will read a YAML file with various setup instructions
+spm includes a `setup:env` command that will read a YAML file with various setup instructions
 intended to get a new user up and running very quickly with the project. This file can include
 any number of shell commands to set various aspects on the machine. The file must be named:
-`init_mac.yaml`.
+`init_[mac|linux|windows].yaml`. This command is aliased to: `init:mac`, `init:linux` and `init:windows`.
 
 For example: you can create steps that install brew, and additional packages; or that creates
 overrides / default config files in various places.
diff --git a/src/Commands/InitCommand.php b/src/Commands/InitCommand.php
@@ -4,6 +4,7 @@
 
 use Somnambulist\ProjectManager\Commands\Behaviours\UseEnvironmentTemplate;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use function file_exists;
 use function file_get_contents;
@@ -28,6 +29,7 @@ protected function configure()
         $this
             ->setName('init')
             ->setDescription('Initialise the Project Manager config folder')
+            ->addOption('update', 'u', InputOption::VALUE_NONE, 'Update the main spm config file with the latest defaults')
         ;
     }
 
@@ -54,6 +56,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $this->tools()->success('Configuration re-created at <info>%s</info>', $dir);
         }
 
+        if ($input->getOption('update')) {
+            $this->tools()->warning('Updating configuration file latest <info>spm</info> default');
+            file_put_contents($dir . DIRECTORY_SEPARATOR . 'project_manager.yaml', $this->config());
+        }
+
         $this->tools()->newline();
 
         return 0;
diff --git a/src/Commands/PrepareDevEnvironmentCommand.php b/src/Commands/PrepareDevEnvironmentCommand.php
@@ -2,11 +2,13 @@
 
 namespace Somnambulist\ProjectManager\Commands;
 
+use IlluminateAgnostic\Str\Support\Str;
 use RuntimeException;
 use Somnambulist\ProjectManager\Commands\Behaviours\GetCurrentActiveProject;
 use Somnambulist\ProjectManager\Commands\Behaviours\ProjectConfigAwareCommand;
 use Somnambulist\ProjectManager\Contracts\ProjectConfigAwareInterface;
 use Somnambulist\ProjectManager\Models\Project;
+use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -16,12 +18,12 @@
 use function sprintf;
 
 /**
- * Class PrepareMacCommand
+ * Class PrepareDevEnvironmentCommand
  *
  * @package    Somnambulist\ProjectManager\Commands
- * @subpackage Somnambulist\ProjectManager\Commands\PrepareMacCommand
+ * @subpackage Somnambulist\ProjectManager\Commands\PrepareDevEnvironmentCommand
  */
-class PrepareMacCommand extends AbstractCommand implements ProjectConfigAwareInterface
+class PrepareDevEnvironmentCommand extends AbstractCommand implements ProjectConfigAwareInterface
 {
 
     use GetCurrentActiveProject;
@@ -30,27 +32,55 @@ class PrepareMacCommand extends AbstractCommand implements ProjectConfigAwareInt
     protected function configure()
     {
         $this
-            ->setName('init:mac')
-            ->setDescription('Sets up preferred libraries and programs for development on macOS')
+            ->setName('setup:env')
+            ->setAliases(['init:mac', 'init:linux', 'init:windows'])
+            ->setDescription('Sets up preferred libraries and programs for development as configured in the current project')
+            ->addArgument('arch', InputArgument::OPTIONAL, 'The specific config type to run: [mac|linux|windows]', 'mac')
             ->addOption('step', 's', InputOption::VALUE_OPTIONAL, 'Skip to this step in the chain', 0)
             ->addOption('test', 't', InputOption::VALUE_NONE, 'Run a test outputting the commands that will be run')
             ->addOption('bash', 'b', InputOption::VALUE_NONE, 'Output commands on each line without comments; runs as test')
+            ->setHelp(<<<HLP
+Various commands can be provided in an YAML file for setting up a dev machine
+with various applications, configuration defaults for faster dev setup. Typically
+these will be for installing company preferred apps, default configuration or
+hosts entries, VPN configuration etc etc.
+
+By default, this command will attempt to run the <info>mac</info> config options.
+You should specify the alternative setup file using the second argument, or use
+one of the aliases to pre-configure the command with that architecture.
+
+<comment>Note:</comment> when developing the setup scripts, you should test in a virtual machine
+before running the scripts on a live machine.
+
+<info>No attempt is made to auto-detect the running architecture.</info>
+
+HLP)
         ;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $this->setupConsoleHelper($input, $output);
 
+        if (Str::startsWith($comm = $input->getArgument('command'), 'init')) {
+            $input->setArgument('arch', Str::after($comm, 'init:'));
+        }
+
+        if (!in_array($arch = $input->getArgument('arch'), ['mac', 'linux', 'windows'])) {
+            $this->tools()->error('<error>%s</error> is not a valid architecture option. Must be one of: [mac, windows, linux]', $arch);
+
+            return 1;
+        }
+
         $project  = $this->getActiveProject();
-        $steps    = $this->loadInitialisationSteps($project);
+        $steps    = $this->loadInitialisationSteps($project, $arch);
         $bashMode = $input->getOption('bash');
 
         if ($bashMode) {
             $this->tools()->disableOutput();
         }
 
-        $this->tools()->warning('Starting macOS preparation');
+        $this->tools()->warning('Starting <info>%s</info> preparation', $arch);
         $this->tools()->warning('Please note: setup may require sudo for some steps');
 
         if (!$bashMode) {
@@ -81,8 +111,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
                     if ('exit' === $toRun) {
                         if (!$bashMode) {
-                            $this->tools()->info('init:mac must wait for the previous command');
-                            $this->tools()->info('resume using: <info>init:mac -s %s</info>', $i + 1);
+                            $this->tools()->info('<info>%s</info> must wait for the previous command', $comm);
+                            $this->tools()->info('resume using: <info>%s -s %s</info>', $comm, $i + 1);
                             $this->tools()->newline();
 
                             return 0;
@@ -98,14 +128,16 @@ protected function execute(InputInterface $input, OutputInterface $output)
                     if ($input->getOption('test') || $bashMode) {
                         $this->tools()->step('RUN', $toRun);
                         !$bashMode ?: $output->writeln($toRun);
+
+                        continue;
+                    }
+
+                    if ($this->tools()->execute($command)) {
+                        $this->tools()->success('   ...command completed successfully');
                     } else {
-                        if ($this->tools()->execute($command)) {
-                            $this->tools()->success('   ...command completed successfully');
-                        } else {
-                            $this->tools()->error('   ...command failed to execute!');
+                        $this->tools()->error('   ...command failed to execute!');
 
-                            return 1;
-                        }
+                        return 1;
                     }
                 }
             } else {
@@ -114,18 +146,20 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         $this->tools()->success('All steps completed');
-        $this->tools()->info('If you install Xcode you may wish to run: <info>sudo xcodebuild -license accept</info>');
+        if ('mac' === $arch) {
+            $this->tools()->info('If you install Xcode you may wish to run: <info>sudo xcodebuild -license accept</info>');
+        }
         $this->tools()->newline();
 
         return 0;
     }
 
-    private function loadInitialisationSteps(Project $project): array
+    private function loadInitialisationSteps(Project $project, string $arch): array
     {
         $this->tools()->info('Reading config data from <info>%s</info> project', $project->name());
 
-        if (!file_exists($file = $project->getFileInProject('init_mac.yaml'))) {
-            throw new RuntimeException(sprintf('The current project "%s" does not have an "init_mac.yaml" file', $project->name()));
+        if (!file_exists($file = $project->getFileInProject($f = sprintf('init_%s.yaml', $arch)))) {
+            throw new RuntimeException(sprintf('The current project "%s" does not have an "%s" file', $project->name(), $f));
         }
 
         $config = strtr(file_get_contents($file), [
