Merge pull request #541 from carolynvs/exec-split-args-flags

Split the exec arguments into flags and args

build/testdata/bundles/mysql/porter.yaml

@@ -51,9 +51,8 @@ ping:
   - exec:
       description: "Ping"
       command: "bash"
-      arguments:
-        - -c
-        - echo ping
+      flags:
+        c: echo ping
 
 uninstall:
 - helm:

build/testdata/bundles/wordpress/porter.yaml

@@ -61,9 +61,8 @@ ping:
   - exec:
       description: "Ping"
       command: "bash"
-      arguments:
-        - -c
-        - echo ping
+      flags:
+        c: echo ping
 
 uninstall:
   - helm:

docs/content/build-image.md

@@ -27,17 +27,15 @@ install:
   - exec:
       description: "Install Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Hello World
+      flags:
+        c: echo Hello World
 
 uninstall:
   - exec:
       description: "Uninstall Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Goodbye World
+      flags:
+        c: echo Goodbye World
 
 #dependencies:
 #  - name: mysql
@@ -270,17 +268,15 @@ install:
 - exec:
     description: "Say Hello"
     command: bash
-    arguments:
-      - -c
-      - echo Hello World
+    flags:
+      c: echo Hello World
 
 uninstall:
 - exec:
     description: "Say Goodbye"
     command: bash
-    arguments:
-      - -c
-      - echo Goodbye World
+    flags:
+      c: echo Goodbye World
 ```
 
 This bundle, for example, declares a dependency on a bundle named `mysql`. The CNAB specification doesn't provide a mechanism for handling dependency resolution. Porter supplements the CNAB spec to support dependencies by resolving any dependencies at build time, including the contents of each dependency in the invocation image. At runtime the contents of that bundle will therefore be in the bundle and the Porter runtime component can execute them successfully.

docs/content/mixin-architecture.md

@@ -25,9 +25,8 @@ install:
 - exec:
     description: "Say Hello"
     command: bash
-    arguments:
-      - -c
-      - echo Hello World
+    flags:
+      c: echo Hello World
 ```
 
 ## Mixin API

docs/content/mixin-commands.md

@@ -224,9 +224,8 @@ status:
 - exec:
     description: "Run a rando command, don't care what action I'm in"
     command: bash
-    arguments:
-    - -c
-    - echo "Don't mind me, just getting the status of something..."
+    flags:
+      c: echo "Don't mind me, just getting the status of something..."
 ```
 
 # version

docs/content/mixins/exec.md

@@ -12,6 +12,29 @@ Source: https://github.com/deislabs/porter/tree/master/pkg/exec
 porter mixin install terraform --feed-url https://cdn.deislabs.io/porter/atom.xml
 ```
 
+## Mixin Syntax
+
+```yaml
+exec:
+  description: "Description of the command"
+  command: cmd
+  arguments:
+  - arg1
+  - arg2
+  flags:
+    a: flag-value
+    long-flag: true
+    repeated-flag:
+    - flag-value1
+    - flag-value2
+```
+
+This is executed as:
+
+```
+$ cmd arg1 arg2 -a flag-value --long-flag true --repeated-flag flag-value1 --repeated-flag flag-value2
+```
+
 ### Examples
 
 Run a command
@@ -20,9 +43,8 @@ install:
 - exec:
     description: "Install Hello World"
     command: bash
-    arguments:
-    - -c
-    - echo Hello World
+    flags:
+      c: echo Hello World
 ```
 
 Run a script

docs/content/quickstart.md

@@ -33,17 +33,15 @@ install:
   - description: "Install Hello World"
     exec:
       command: bash
-      arguments:
-        - -c
-        - echo Hello World
+      flags:
+        c: echo Hello World
 
 uninstall:
   - description: "Uninstall Hello World"
     exec:
       command: bash
-      arguments:
-        - -c
-        - echo Goodbye World
+      flags:
+        c: echo Goodbye World
 ```
 
 ## Build the bundle

docs/content/slides/pack-your-bags-msp/index.md

@@ -473,9 +473,8 @@ install:
   - exec:
       description: "Install Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Hello World
+      flags:
+        c: echo Hello World
 ```
 
 ---

docs/content/slides/pack-your-bags/index.md

@@ -519,9 +519,8 @@ install:
   - exec:
       description: "Install Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Hello World
+      flags:
+        c: echo Hello World
 ```
 
 ---

docs/content/wiring.md

@@ -70,9 +70,8 @@ install:
   - description: "Install Hello World"
     exec:
       command: bash
-      arguments:
-        - -c
-        - "{{ bundle.parameters.command }}"
+      flags:
+        c: "{{ bundle.parameters.command }}"
 ```
 
 NOTE: These references must be quoted, as in the examples above.

examples/aks-spring-music/porter.yaml

@@ -91,9 +91,8 @@ uninstall:
   - exec:
       description: "Uninstall Spring Music Demo"
       command: bash
-      arguments:
-        - -c
-        - echo App should be uninstalled here, but it is not
+      flags:
+        c: echo App should be uninstalled here, but it is not
 
 credentials:
 - name: SUBSCRIPTION_ID

examples/azure-tf-example/porter.yaml

@@ -78,9 +78,8 @@ install:
   - exec:
       description: "Emit the key in base64 encoded form"
       command: bash
-      arguments:
-        - -c
-        - echo "Here is a the storage account key (base64 encoded) ==> $(echo {{bundle.outputs.STORAGE_ACCOUNT_KEY}} | base64)"
+      flags:
+        c: echo "Here is a the storage account key (base64 encoded) ==> $(echo {{bundle.outputs.STORAGE_ACCOUNT_KEY}} | base64)"
 
   - terraform:
       description: "Create Azure CosmosDB and Event Hubs"

examples/kubernetes-mixin-example/porter.yaml

@@ -27,9 +27,8 @@ install:
   - exec:
       description: "Echo the IP Address"
       command: bash
-      arguments:
-        - -c
-        - "echo 'You will find the service at: {{bundle.outputs.IP_ADDRESS}}'"
+      flags:
+        c: "echo 'You will find the service at: {{bundle.outputs.IP_ADDRESS}}'"
 
 uninstall:
   - kubernetes:

pkg/cnab/config_adapter/stamp_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-var simpleManifestDigest = "3f4c199b5b279b5457b00f20b7680e5b1fe644e89005dc8c4f7adf64565252fa"
+var simpleManifestDigest = "74ef9c4abc7dfc41566ba28d9fcfab9c70baa0ca5ca434c71298689487f554e8"
 
 func TestConfig_ComputeManifestDigest(t *testing.T) {
 	c := config.NewTestConfig(t)

pkg/cnab/config_adapter/testdata/porter-with-custom-action.yaml

@@ -17,38 +17,33 @@ install:
   - exec:
       description: "Install Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Hello World
+      flags:
+        c: echo Hello World
 
 upgrade:
   - exec:
       description: "World 2.0"
       command: bash
-      arguments:
-        - -c
-        - echo World 2.0
+      flags:
+        c: echo World 2.0
 
 status:
   - exec:
       description: "Get World Status"
       command: bash
-      arguments:
-        - -c
-        - echo The world is on fire
+      flags:
+        c: echo The world is on fire
 
 zombies:
   - exec:
       description: "Trigger zombie apocalypse"
       command: bash
-      arguments:
-        - -c
-        - echo oh noes my brains
+      flags:
+        c: echo oh noes my brains
 
 uninstall:
   - exec:
       description: "Uninstall Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Goodbye World
+      flags:
+        c: echo Goodbye World

pkg/cnab/config_adapter/testdata/porter-with-deps.yaml

@@ -22,22 +22,19 @@ install:
   - exec:
       description: "Install Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Hello World
+      flags:
+        c: echo Hello World
 
 upgrade:
   - exec:
       description: "World 2.0"
       command: bash
-      arguments:
-        - -c
-        - echo World 2.0
+      flags:
+        c: echo World 2.0
 
 uninstall:
   - exec:
       description: "Uninstall Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Goodbye World
+      flags:
+        c: echo Goodbye World

pkg/cnab/config_adapter/testdata/porter-with-parameters.yaml

@@ -45,22 +45,19 @@ install:
   - exec:
       description: "Install Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Hello World
+      flags:
+        c: echo Hello World
 
 upgrade:
   - exec:
       description: "World 2.0"
       command: bash
-      arguments:
-        - -c
-        - echo World 2.0
+      flags:
+        c: echo World 2.0
 
 uninstall:
   - exec:
       description: "Uninstall Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Goodbye World
+      flags:
+        c: echo Goodbye World

pkg/cnab/config_adapter/testdata/porter.yaml

@@ -14,22 +14,19 @@ install:
 - exec:
     description: "Say Hello"
     command: bash
-    arguments:
-    - -c
-    - echo Hello World
+    flags:
+      c: echo Hello World
 
 status:
 - exec:
     description: "Get World Status"
     command: bash
-    arguments:
-    - -c
-    - echo The world is on fire
+    flags:
+      c: echo The world is on fire
 
 uninstall:
 - exec:
     description: "Say Goodbye"
     command: bash
-    arguments:
-    - -c
-    - echo Goodbye World
+    flags:
+      c: echo Goodbye World

pkg/config/runtime-manifest_test.go

@@ -425,10 +425,10 @@ func TestResolveSliceWithAMap(t *testing.T) {
 	t.Logf("install data %v", installStep.Data)
 	exec := installStep.Data["exec"].(map[interface{}]interface{})
 	assert.NotNil(t, exec)
-	args := exec["arguments"].([]interface{})
-	assert.Len(t, args, 2)
-	assert.Equal(t, "echo hello world", args[1].(string))
-	assert.NotNil(t, args)
+	flags := exec["flags"].(map[interface{}]interface{})
+	assert.Len(t, flags, 1)
+	assert.Equal(t, "echo hello world", flags["c"].(string))
+	assert.NotNil(t, flags)
 }
 
 func TestResolveMultipleStepOutputs(t *testing.T) {

pkg/config/testdata/param-test-in-block.yaml

@@ -20,6 +20,5 @@ uninstall:
   - exec:
       description: "Uninstall Hello World"
       command: bash
-      arguments:
-        - -c
-        - echo Goodbye World
+      flags:
+        c: echo Goodbye World