Merge pull request #245 from secrethub/feature/mock-os-env

Allow mocking of OS environment

Author: SimonBarendse

internals/cli/env.go

@@ -103,12 +103,12 @@ func (a *App) isExtraEnvVar(key string) bool {
 // of environment variables are not printed out for security reasons. The list
 // is limited to variables that are actually set in the environment. Setting
 // verbose to true will also include all known variables that are not set.
-func (a *App) PrintEnv(w io.Writer, verbose bool) error {
+func (a *App) PrintEnv(w io.Writer, verbose bool, osEnv func() []string) error {
 	tabWriter := tabwriter.NewWriter(w, 0, 4, 4, ' ', 0)
 	fmt.Fprintf(tabWriter, "%s\t%s\n", "NAME", "STATUS")
 
 	envVarStatus := make(map[string]string)
-	for _, envVar := range os.Environ() {
+	for _, envVar := range osEnv() {
 		key, _, match := splitVar(a.name, a.separator, envVar)
 		key = strings.ToUpper(key)
 		if match {

internals/secrethub/inject.go

@@ -34,6 +34,7 @@ type InjectCommand struct {
 	useClipboard                  bool
 	clearClipboardAfter           time.Duration
 	clipper                       clip.Clipper
+	osEnv                         func() []string
 	newClient                     newClientFunc
 	templateVars                  map[string]string
 	templateVersion               string
@@ -44,6 +45,7 @@ type InjectCommand struct {
 func NewInjectCommand(io ui.IO, newClient newClientFunc) *InjectCommand {
 	return &InjectCommand{
 		clipper:             clip.NewClipboard(),
+		osEnv:               os.Environ,
 		clearClipboardAfter: defaultClearClipboardAfter,
 		io:                  io,
 		newClient:           newClient,
@@ -99,7 +101,7 @@ func (cmd *InjectCommand) Run() error {
 		}
 	}
 
-	osEnv, _ := parseKeyValueStringsToMap(os.Environ())
+	osEnv, _ := parseKeyValueStringsToMap(cmd.osEnv())
 
 	var templateVariableReader tpl.VariableReader
 	templateVariableReader, err = newVariableReader(osEnv, cmd.templateVars)

internals/secrethub/printenv.go

@@ -1,6 +1,8 @@
 package secrethub
 
 import (
+	"os"
+
 	"github.com/secrethub/secrethub-cli/internals/cli"
 	"github.com/secrethub/secrethub-cli/internals/cli/ui"
 	"github.com/secrethub/secrethub-cli/internals/secrethub/command"
@@ -10,20 +12,22 @@ import (
 type PrintEnvCommand struct {
 	app     *cli.App
 	io      ui.IO
+	osEnv   func() []string
 	verbose bool
 }
 
 // NewPrintEnvCommand creates a new PrintEnvCommand.
 func NewPrintEnvCommand(app *cli.App, io ui.IO) *PrintEnvCommand {
 	return &PrintEnvCommand{
-		app: app,
-		io:  io,
+		app:   app,
+		io:    io,
+		osEnv: os.Environ,
 	}
 }
 
 // Run prints out debug statements about all environment variables.
 func (cmd *PrintEnvCommand) Run() error {
-	err := cmd.app.PrintEnv(cmd.io.Stdout(), cmd.verbose)
+	err := cmd.app.PrintEnv(cmd.io.Stdout(), cmd.verbose, cmd.osEnv)
 	if err != nil {
 		return err
 	}

internals/secrethub/run.go

@@ -57,6 +57,7 @@ const (
 type RunCommand struct {
 	command                      []string
 	io                           ui.IO
+	osEnv                        func() []string
 	envar                        map[string]string
 	envFile                      string
 	templateVars                 map[string]string
@@ -73,6 +74,7 @@ type RunCommand struct {
 func NewRunCommand(io ui.IO, newClient newClientFunc) *RunCommand {
 	return &RunCommand{
 		io:           io,
+		osEnv:        os.Environ,
 		envar:        make(map[string]string),
 		templateVars: make(map[string]string),
 		newClient:    newClient,
@@ -129,7 +131,7 @@ func (cmd *RunCommand) Run() error {
 		}
 	}
 
-	osEnv, passthroughEnv := parseKeyValueStringsToMap(os.Environ())
+	osEnv, passthroughEnv := parseKeyValueStringsToMap(cmd.osEnv())
 	if err != nil {
 		return err
 	}

internals/secrethub/run_test.go

@@ -458,11 +458,13 @@ func TestRunCommand_Run(t *testing.T) {
 	}{
 		"success, no secrets": {
 			command: RunCommand{
+				osEnv:   func() []string { return []string{} },
 				command: []string{"echo", "test"},
 			},
 		},
 		"missing secret": {
 			command: RunCommand{
+				osEnv:   func() []string { return []string{} },
 				command: []string{"echo", "test"},
 				envar: map[string]string{
 					"missing": "path/to/unexisting/secret",
@@ -484,6 +486,7 @@ func TestRunCommand_Run(t *testing.T) {
 		},
 		"missing secret ignored": {
 			command: RunCommand{
+				osEnv:   func() []string { return []string{} },
 				command: []string{"echo", "test"},
 				envar: map[string]string{
 					"missing": "path/to/unexisting/secret",
@@ -505,6 +508,7 @@ func TestRunCommand_Run(t *testing.T) {
 		},
 		"repo does not exist ignored": {
 			command: RunCommand{
+				osEnv:   func() []string { return []string{} },
 				command: []string{"echo", "test"},
 				envar: map[string]string{
 					"missing": "unexisting/repo/secret",
@@ -526,6 +530,7 @@ func TestRunCommand_Run(t *testing.T) {
 		},
 		"invalid template var: start with a number": {
 			command: RunCommand{
+				osEnv:   func() []string { return []string{} },
 				envFile: "secrethub.env",
 				templateVars: map[string]string{
 					"0foo": "value",
@@ -536,6 +541,7 @@ func TestRunCommand_Run(t *testing.T) {
 		},
 		"invalid template var: illegal character": {
 			command: RunCommand{
+				osEnv:   func() []string { return []string{} },
 				envFile: "secrethub.env",
 				templateVars: map[string]string{
 					"foo@bar": "value",