Add new way of handling secrets via new replacement pattern

Secrets can be declared in a secrets section in the root of a fabfile (similar to a question) and be used in any host-configuration as `%secret.MY_SECRET_NAME%. Phab will inject the actual value when the host configuration is requested. The actual value can be passed via environment variable of command line argument `--secret key=value` As a last ressort, the user is asked for the secret via shell.
factorial-io · Apr 6, 2021 · aa8be5d · aa8be5d
1 parent 35d3e98
commit aa8be5d
Show file tree

Hide file tree

Showing 53 changed files with 489 additions and 73 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -13,5 +13,8 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
+[*.yaml]
+indent_size = 2
+
 [composer.{json,lock}]
 indent_size = 4
diff --git a/src/Command/AboutCommand.php b/src/Command/AboutCommand.php
@@ -48,7 +48,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $this->write($output, $this->getDockerConfig()->raw(), 2);
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $this->getMethods()->runTask('about', $this->getHostConfig(), $context);
     }
 

diff --git a/src/Command/AppCreateCommand.php b/src/Command/AppCreateCommand.php
@@ -64,7 +64,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $copy_from = $this->getConfiguration()->getHostConfig($copy_from);
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $host_config = $this->getHostConfig();
 
         $this->configuration->getMethodFactory()->runTask('appCheckExisting', $host_config, $context);

diff --git a/src/Command/AppDestroyCommand.php b/src/Command/AppDestroyCommand.php
@@ -43,7 +43,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $host_config = $this->getHostConfig();
 
         $this->configuration->getMethodFactory()->runTask('appCheckExisting', $host_config, $context);

diff --git a/src/Command/AppScaffoldCommand.php b/src/Command/AppScaffoldCommand.php
@@ -62,9 +62,10 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        $context = $this->createContext($input, $output);
+
         $url = $input->getArgument('scaffold-url');
         $root_folder = empty($input->getOption('output')) ? getcwd() : $input->getOption('output');
-        $context = $this->createContext($input, $output);
 
         $this->scaffold($url, $root_folder, $context, [], new Options());
         return 0;

diff --git a/src/Command/AppUpdateCommand.php b/src/Command/AppUpdateCommand.php
@@ -41,7 +41,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
 
         try {
             $this->getMethods()->runTask('appUpdate', $this->getHostConfig(), $context);

diff --git a/src/Command/BackupCommand.php b/src/Command/BackupCommand.php
@@ -46,7 +46,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $context->set('what', array_map(function ($elem) {
             return trim(strtolower($elem));
         }, $input->getArgument('what')));

diff --git a/src/Command/BaseCommand.php b/src/Command/BaseCommand.php
@@ -12,6 +12,7 @@
 use Phabalicious\Exception\ShellProviderNotFoundException;
 use Phabalicious\Exception\ValidationFailedException;
 use Phabalicious\Exception\MissingHostConfigException;
+use Phabalicious\Method\TaskContext;
 use Phabalicious\ShellCompletion\FishShellCompletionContext;
 use Phabalicious\ShellProvider\ShellOptions;
 use Phabalicious\ShellProvider\ShellProviderInterface;
@@ -35,6 +36,7 @@ abstract class BaseCommand extends BaseOptionsCommand
     private $dockerConfig;
 
 
+
     protected function configure()
     {
         $default_conf = getenv('PHABALICIOUS_DEFAULT_CONFIG');
@@ -126,7 +128,8 @@ public function completeOptionValues($optionName, CompletionContext $context)
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $io = new SymfonyStyle($input, $output);
+        $this->createContext($input, $output);
+        $io = $this->getContext()->io();
 
         $this->checkAllRequiredOptionsAreNotEmpty($input);
 

diff --git a/src/Command/BaseOptionsCommand.php b/src/Command/BaseOptionsCommand.php
@@ -6,6 +6,7 @@
 use Phabalicious\Method\MethodFactory;
 use Phabalicious\Method\ScriptMethod;
 use Phabalicious\Method\TaskContext;
+use Phabalicious\Method\TaskContextInterface;
 use Phabalicious\Utilities\Utilities;
 use Stecman\Component\Symfony\Console\BashCompletion\Completion\CompletionAwareInterface;
 use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
@@ -26,6 +27,9 @@ abstract class BaseOptionsCommand extends Command implements CompletionAwareInte
      */
     protected $methods;
 
+    /** @var \Phabalicious\Method\TaskContextInterface */
+    private $context = null;
+
 
     public function __construct(ConfigurationService $configuration, MethodFactory $method_factory, $name = null)
     {
@@ -68,6 +72,13 @@ protected function configure()
                 InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
                 'Pass optional arguments',
                 []
+            )
+            ->addOption(
+                'secret',
+                null,
+                InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
+                'Pass optional secrets',
+                []
             );
     }
 
@@ -171,7 +182,7 @@ protected function parseScriptArguments(array $defaults, $arguments_string)
      */
     protected function createContext(InputInterface $input, OutputInterface $output, $default_arguments = [])
     {
-        $context = new TaskContext($this, $input, $output);
+        $context =  $this->context ? $this->context : new TaskContext($this, $input, $output);
         $arguments = $this->parseScriptArguments($default_arguments, $input->getOption('arguments'));
         $context->set('variables', $arguments);
         $context->set('deployArguments', $arguments);
@@ -180,6 +191,13 @@ protected function createContext(InputInterface $input, OutputInterface $output,
             $this->parseScriptArguments([], $input->getOption('arguments'))['arguments'] ?? []
         );
 
-        return $context;
+        $this->context = $context;
+        return $this->context;
+    }
+
+    protected function getContext(): TaskContextInterface
+    {
+        assert($this->context);
+        return $this->context;
     }
 }
diff --git a/src/Command/CopyFromCommand.php b/src/Command/CopyFromCommand.php
@@ -68,7 +68,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $from = $this->configuration->getHostConfig($input->getArgument('from'));
         if (empty($from['supportsCopyFrom'])) {
             throw new \InvalidArgumentException('Source config does not support copy-from!');

diff --git a/src/Command/DeployCommand.php b/src/Command/DeployCommand.php
@@ -62,7 +62,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
 
         // Override branch in config.
         $branch = $input->getArgument('branch');

diff --git a/src/Command/DockerCommand.php b/src/Command/DockerCommand.php
@@ -68,7 +68,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $docker_config = $this->getDockerConfig();
         $context->set('docker_config', $docker_config);
 

diff --git a/src/Command/GetBackupCommand.php b/src/Command/GetBackupCommand.php
@@ -57,7 +57,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return trim(strtolower($elem));
         }, $input->getArgument('what'));
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $context->set('what', $what);
 
         $hash = $input->getArgument('hash');

diff --git a/src/Command/GetFileCommand.php b/src/Command/GetFileCommand.php
@@ -49,7 +49,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $file = $input->getArgument('file');
 
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $context->set('sourceFile', $file);
         $context->set('destFile', getcwd() . '/' . basename($file));
 

diff --git a/src/Command/GetFilesDumpCommand.php b/src/Command/GetFilesDumpCommand.php
@@ -42,7 +42,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
 
         $this->getMethods()->runTask('getFilesDump', $this->getHostConfig(), $context);
         $to_copy = $context->getResult('files');

diff --git a/src/Command/GetSqlDumpCommand.php b/src/Command/GetSqlDumpCommand.php
@@ -43,7 +43,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
 
         $this->getMethods()->runTask('getSQLDump', $this->getHostConfig(), $context);
         $to_copy = $context->getResult('files');

diff --git a/src/Command/InstallCommand.php b/src/Command/InstallCommand.php
@@ -53,7 +53,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $host_config = $this->getHostConfig();
 
         if ($host_config['supportsInstalls'] == false) {

diff --git a/src/Command/JiraCommand.php b/src/Command/JiraCommand.php
@@ -42,7 +42,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $this->checkAllRequiredOptionsAreNotEmpty($input);
         $this->readConfiguration($input);
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
 
         $jira_config = $this->configuration->getSetting('jira', []);
         $errors = new ValidationErrorBag();

diff --git a/src/Command/K8sCommand.php b/src/Command/K8sCommand.php
@@ -62,7 +62,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $subcommands = $input->getArgument('k8s');
         if (!is_array($subcommands)) {
             $subcommands = [ $subcommands ];

diff --git a/src/Command/ListBackupsCommand.php b/src/Command/ListBackupsCommand.php
@@ -50,7 +50,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $what = array_map(function ($elem) {
             return trim(strtolower($elem));
         }, $input->getArgument('what'));

diff --git a/src/Command/NotifyCommand.php b/src/Command/NotifyCommand.php
@@ -60,7 +60,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         if ($result = parent::execute($input, $output)) {
             return $result;
         }
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $context->set('message', $input->getArgument('message'));
         $context->set('channel', $input->getOption('channel'));
 

diff --git a/src/Command/OutputCommand.php b/src/Command/OutputCommand.php
@@ -10,6 +10,7 @@
 use Phabalicious\Exception\MissingHostConfigException;
 use Phabalicious\Exception\ShellProviderNotFoundException;
 use Phabalicious\Exception\ValidationFailedException;
+use Phabalicious\Method\TaskContext;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -70,6 +71,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $this->readConfiguration($input);
         $data = [];
         $title = '';
+        $context = new TaskContext($this, $input, $output);
 
         if ($what == 'blueprint') {
             if (empty($blueprint)) {
@@ -82,9 +84,13 @@ protected function execute(InputInterface $input, OutputInterface $output)
             ];
             $title = 'Output of applied blueprint `' . $config . '`';
         } elseif ($what == 'host') {
-            $data = $this->getConfiguration()->getHostConfig($config)->raw();
+            if (!empty($blueprint)) {
+                $data = $this->getConfiguration()->getHostConfigFromBlueprint($config, $blueprint);
+            } else {
+                $data = $this->getConfiguration()->getHostConfig($config);
+            }
             $data = [
-                $data['configName'] => $data
+                $data['configName'] => $data->raw(),
             ];
             $title = 'Output of host-configuration `' . $config . '`';
         } elseif ($what == 'docker') {

diff --git a/src/Command/PlatformCommand.php b/src/Command/PlatformCommand.php
@@ -46,7 +46,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $context->set('command', implode(' ', $input->getArgument('platform')));
 
         try {

diff --git a/src/Command/PutFileCommand.php b/src/Command/PutFileCommand.php
@@ -52,7 +52,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             throw new \RuntimeException('Could not find file `' . $file . '`!');
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $context->set('sourceFile', $file);
 
         $context->io()->comment('Putting file `' . $file . '` to `' . $this->getHostConfig()['configName']. '`');

diff --git a/src/Command/ResetCommand.php b/src/Command/ResetCommand.php
@@ -41,7 +41,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
 
         try {
             $this->getMethods()->runTask('reset', $this->getHostConfig(), $context);

diff --git a/src/Command/RestoreCommand.php b/src/Command/RestoreCommand.php
@@ -51,7 +51,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $context->set('what', array_map(function ($elem) {
             return trim(strtolower($elem));
         }, $input->getArgument('what')));

diff --git a/src/Command/RestoreSqlFromFileCommand.php b/src/Command/RestoreSqlFromFileCommand.php
@@ -44,7 +44,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $file = $input->getArgument('file');
         if (!file_exists($file)) {
             throw new \InvalidArgumentException('Could not find file at `' . $file . '`');

diff --git a/src/Command/ScaffoldCommand.php b/src/Command/ScaffoldCommand.php
@@ -7,7 +7,6 @@
 use Phabalicious\Exception\MismatchedVersionException;
 use Phabalicious\Exception\MissingScriptCallbackImplementation;
 use Phabalicious\Exception\ValidationFailedException;
-use Phabalicious\Method\TaskContext;
 use Phabalicious\Scaffolder\Callbacks\TransformCallback;
 use Phabalicious\Scaffolder\Options;
 use Phabalicious\Utilities\PluginDiscovery;
@@ -61,6 +60,7 @@ protected function configure()
      * @throws FabfileNotReadableException
      * @throws FailedShellCommandException
      * @throws MissingScriptCallbackImplementation
+     * @throws \Phabalicious\Exception\UnknownReplacementPatternException
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {

diff --git a/src/Command/ShellCommand.php b/src/Command/ShellCommand.php
@@ -52,7 +52,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $host_config = $this->getHostConfig();
 
         // Allow methods to override the used shellProvider:

diff --git a/src/Command/ShellCommandCommand.php b/src/Command/ShellCommandCommand.php
@@ -45,7 +45,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $host_config = $this->getHostConfig();
 
         // Allow methods to override the used shellProvider:

diff --git a/src/Command/SimpleExecutableInvocationCommand.php b/src/Command/SimpleExecutableInvocationCommand.php
@@ -69,7 +69,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
 
         $arguments = $this->prepareArguments($input->getArgument('command-arguments'));
         $context->set('command', $arguments);

diff --git a/src/Command/StartRemoteAccessCommand.php b/src/Command/StartRemoteAccessCommand.php
@@ -76,7 +76,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
         $host_config = $this->getHostConfig();
         $this->getMethods()->runTask('startRemoteAccess', $host_config, $context);
 

diff --git a/src/Command/VariablePull.php b/src/Command/VariablePull.php
@@ -53,7 +53,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return $result;
         }
 
-        $context = $this->createContext($input, $output);
+        $context = $this->getContext();
 
         $context->set('action', 'pull');
         $filename = $input->getArgument('file');