expose env vars through exec mixin and add docs

Signed-off-by: David Justice <[email protected]>

docs/content/mixins/exec.md

@@ -31,6 +31,8 @@ exec:
     - flag-value2
   suffix-arguments: # These arguments are specified after any flags are passed
   - suffix-arg1
+  envs: # Environment variables to be added to the command execution environment
+    FOO_KEY: foo-value
   suppress-output: false # Do not print the command output to the console
   ignoreError: # Conditions when execution should continue even if the command fails
     all: true # Ignore all errors 

pkg/exec/action.go

@@ -88,23 +88,27 @@ func (a *Actions) UnmarshalYAML(unmarshal func(interface{}) error) error {
 	return nil
 }
 
-var _ builder.HasOrderedArguments = Step{}
-var _ builder.ExecutableStep = Step{}
-var _ builder.StepWithOutputs = Step{}
+var (
+	_ builder.HasOrderedArguments = Step{}
+	_ builder.ExecutableStep      = Step{}
+	_ builder.StepWithOutputs     = Step{}
+	_ builder.HasEnvironmentVars  = Step{}
+)
 
 type Step struct {
 	Instruction `yaml:"exec"`
 }
 
 type Instruction struct {
-	Description     string        `yaml:"description"`
-	Command         string        `yaml:"command"`
-	WorkingDir      string        `yaml:"dir,omitempty"`
-	Arguments       []string      `yaml:"arguments,omitempty"`
-	SuffixArguments []string      `yaml:"suffix-arguments,omitempty"`
-	Flags           builder.Flags `yaml:"flags,omitempty"`
-	Outputs         []Output      `yaml:"outputs,omitempty"`
-	SuppressOutput  bool          `yaml:"suppress-output,omitempty"`
+	Description     string            `yaml:"description"`
+	Command         string            `yaml:"command"`
+	WorkingDir      string            `yaml:"dir,omitempty"`
+	Arguments       []string          `yaml:"arguments,omitempty"`
+	SuffixArguments []string          `yaml:"suffix-arguments,omitempty"`
+	Flags           builder.Flags     `yaml:"flags,omitempty"`
+	EnvironmentVars map[string]string `yaml:"envs,omitempty"`
+	Outputs         []Output          `yaml:"outputs,omitempty"`
+	SuppressOutput  bool              `yaml:"suppress-output,omitempty"`
 
 	// Allow the user to ignore some errors
 	builder.IgnoreErrorHandler `yaml:"ignoreError,omitempty"`
@@ -126,6 +130,10 @@ func (s Step) GetFlags() builder.Flags {
 	return s.Flags
 }
 
+func (s Step) GetEnvironmentVars() map[string]string {
+	return s.EnvironmentVars
+}
+
 func (s Step) SuppressesOutput() bool {
 	return s.SuppressOutput
 }

pkg/exec/exec_test.go

@@ -11,9 +11,10 @@ import (
 
 	"get.porter.sh/porter/pkg/test"
 
-	yaml "get.porter.sh/porter/pkg/yaml"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	yaml "get.porter.sh/porter/pkg/yaml"
 )
 
 func TestAction_UnmarshalYAML(t *testing.T) {
@@ -34,6 +35,7 @@ func TestAction_UnmarshalYAML(t *testing.T) {
 	assert.Equal(t, builder.NewFlag("machine-type", "f1-micro"), step.Flags[0])
 	assert.Equal(t, builder.NewFlag("project", "porterci"), step.Flags[1])
 	assert.Equal(t, builder.NewFlag("zone", "us-central1-a"), step.Flags[2])
+	assert.Equal(t, step.EnvironmentVars, map[string]string{"SECRET": "super-secret"})
 	require.Len(t, step.Outputs, 1)
 	assert.Equal(t, Output{Name: "vms", JsonPath: "$[*].id"}, step.Outputs[0])
 }

pkg/exec/schema/exec.json

@@ -72,6 +72,13 @@
             "type": "string"
           }
         },
+        "envs": {
+          "description": "Environment variables to add to the env of the command",
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
         "suffix-arguments": {
           "description": "Positional arguments to pass to the command after any flags",
           "type": "array",

pkg/exec/testdata/install-input.yaml

@@ -10,6 +10,8 @@ install:
       project: porterci
       zone: us-central1-a
       machine-type: f1-micro
+    envs:
+      SECRET: super-secret
     ignoreError:
       output:
         contains: ["already exists"]

pkg/pkgmgmt/client/install_test.go

@@ -7,15 +7,17 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"path"
+	"runtime"
 	"strings"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
 	"get.porter.sh/porter/pkg"
 	"get.porter.sh/porter/pkg/config"
 	"get.porter.sh/porter/pkg/pkgmgmt"
 	"get.porter.sh/porter/tests"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
 )
 
 func TestFileSystem_InstallFromUrl(t *testing.T) {
@@ -52,6 +54,10 @@ func TestFileSystem_InstallFromUrl(t *testing.T) {
 }
 
 func TestFileSystem_InstallFromFeedUrl(t *testing.T) {
+	if runtime.GOOS == "darwin" && runtime.GOARCH == "arm64" {
+		t.Skip("skipping because there is no release for helm for darwin/arm64")
+	}
+
 	var testURL = ""
 	feed, err := ioutil.ReadFile("../feed/testdata/atom.xml")
 	require.NoError(t, err)

pkg/porter/testdata/schema.json

@@ -309,6 +309,13 @@
             "description": "The directory in which to execute the command",
             "type": "string"
           },
+          "envs": {
+            "additionalProperties": {
+              "type": "string"
+            },
+            "description": "Environment variables to add to the env of the command",
+            "type": "object"
+          },
           "flags": {
             "additionalProperties": {
               "type": "string"