Merge branch 'hotfix/3.5.4'

Changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.5.4 / 2020-08-17
+
+### New:
+
+  * Allow optional script context definition of a script, this will allow to execute the script in a different context, eg in the context of the kubectl shell
+
 ## 3.5.3 / 2020-08-11
 
 ## Fixed:

docs/scripts.md

@@ -61,6 +61,46 @@ host:
 
 These scripts in the above examples gets executed only for the host `test` and task `deploy`.
 
+
+## Defaults
+
+You an provide defaults for a script, which can be verridden via the `--arguments` commandline option
+
+```yaml
+scripts:
+  test:
+    defaults:
+      foo: World
+    script:
+      - echo "Hello %arguments.foo%"
+```
+
+Running 
+```
+phab -c<config> script test
+```
+ will output `Hello World`
+ 
+```
+phab -c<config> script test --arguments foo=bar
+```
+
+will output `Hello bar`
+
+## Script contexts
+
+Sometimes it makes sense to run a script in a different context, e.g. not on the host-config, but for example in the context of the kubectl application or the docker host. You can override the context via
+
+```yaml
+scripts:
+  test:
+    context: kubectl
+    script:
+      - kubectl apply -f whatever
+```
+
+The example above will run the script not in the context of the host, but in the context of the shell which also runs the kubectl command.
+
 ## Examples
 
 A rather complex example scripting phabalicious.

src/Command/ScriptCommand.php

@@ -2,6 +2,7 @@
 
 namespace Phabalicious\Command;
 
+use Phabalicious\Method\ScriptMethod;
 use Phabalicious\Method\TaskContext;
 use Phabalicious\ShellCompletion\FishShellCompletionContext;
 use Phabalicious\Utilities\Utilities;
@@ -81,12 +82,14 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 return 1;
             }
             $defaults = $script_data['defaults'] ?? [];
+            $script_context = $script_data['context'] ?? ScriptMethod::HOST_SCRIPT_CONTEXT;
             if (!empty($script_data['script'])) {
                 $script_data = $script_data['script'];
             }
 
             $context = $this->createContext($input, $output, $defaults);
             $context->set('scriptData', $script_data);
+            $context->set('scriptContext', $script_context);
 
             $this->getMethods()->call('script', 'runScript', $this->getHostConfig(), $context);
         }

src/Method/K8sMethod.php

@@ -20,6 +20,8 @@
 
 class K8sMethod extends BaseMethod implements MethodInterface
 {
+    const KUBECTL_SCRIPT_CONTEXT = 'kubectl';
+
     const AVAILABLE_SUB_COMMANDS = [
         'delete',
         'apply',
@@ -119,6 +121,10 @@ public function preflightTask(string $task, HostConfig $config, TaskContextInter
         if (empty($config['kube']['podForCli'])) {
             $config->setChild('kube', 'podForCli', $this->getPodNameFromSelector($config, $context));
         }
+        if ($task == 'runScript' && $context->get('scriptContext', 'host') == self::KUBECTL_SCRIPT_CONTEXT) {
+            $this->ensureShell($config, $context);
+            $context->setShell($this->kubectlShell);
+        }
     }
 
     public function postflightTask(string $task, HostConfig $config, TaskContextInterface $context)

src/Method/ScriptMethod.php

@@ -14,6 +14,8 @@
 class ScriptMethod extends BaseMethod implements MethodInterface
 {
 
+    const HOST_SCRIPT_CONTEXT = 'host';
+
     private $breakOnFirstError = true;
     private $callbacks = [];
     private $handledTaskSpecificScripts = [];

src/Utilities/Utilities.php

@@ -8,7 +8,7 @@
 class Utilities
 {
 
-    const FALLBACK_VERSION = '3.5.3';
+    const FALLBACK_VERSION = '3.5.4';
     const COMBINED_ARGUMENTS = 'combined';
     const UNNAMED_ARGUMENTS = 'unnamedArguments';