Add extra environment variables support.

The child process may expects a set of typical environment variables be
present in the target system. In this patch, we add a configuratio entry
to the env plugin for configuration of extra variables that should be
passed to the sandbox.

We also set the HOME environment variable in the native engine, as many
shell commands expects for it.

engines/native/sandbox.go

@@ -54,11 +54,20 @@ func newSandbox(b *sandboxBuilder) (*sandbox, error) {
 		return nil, fmt.Errorf("Failed to create temporary system user, error: %s", err)
 	}
 
+	env := map[string]string{}
+	for k, v := range b.env {
+		env[k] = v
+	}
+
+	env["HOME"] = homeFolder.Path()
+	env["USER"] = user.Name()
+	env["LOGNAME"] = user.Name()
+
 	// Start process
 	debug("StartProcess: %v", b.payload.Command)
 	process, err := system.StartProcess(system.ProcessOptions{
 		Arguments:     b.payload.Command,
-		Environment:   b.env,
+		Environment:   env,
 		WorkingFolder: homeFolder.Path(),
 		Owner:         user,
 		Stdout:        ioext.WriteNopCloser(b.context.LogDrain()),

engines/native/system/user_darwin.go

@@ -103,7 +103,7 @@ func CreateUser(homeFolder string, groups []*Group) (*User, error) {
 		}
 	}
 
-	err = d.create(userPath, "NFSHomeDirectory", userPath)
+	err = d.create(userPath, "NFSHomeDirectory", homeFolder)
 	if err != nil {
 		panic(fmt.Errorf("Error setting home directory: %v", err))
 	}
@@ -146,6 +146,11 @@ func (u *User) Remove() {
 	}
 }
 
+// Name returns the user name
+func (u *User) Name() string {
+	return u.name
+}
+
 // return the next uid available
 func getMaxUID(d dscl) (int, error) {
 	uids, err := d.list("/Users", "uid")

engines/native/system/user_linux.go

@@ -103,3 +103,8 @@ func (u *User) Remove() {
 		))
 	}
 }
+
+// Name returns the user name
+func (u *User) Name() string {
+	return u.name
+}

engines/native/system/user_windows.go

@@ -19,3 +19,8 @@ func (u *User) Remove() {
 
 	panic("Not implemented")
 }
+
+// Name returns the user name
+func (u *User) Name() string {
+	return u.name
+}

examples/macosx-config.yml

@@ -20,7 +20,16 @@ config:
       userGroups: ['staff']
   logLevel:         info
   plugins:
-    disabled:       ['success', 'interactive']
+    disabled:       ['interactive', 'maxruntime']
+    env:
+      extra:
+        PATH: {$env: PATH}
+        TMPDIR: {$env: TMPDIR}
+        LANG: {$env: LANG}
+        LC_ALL: {$env: LC_ALL}
+        TERM: {$env: TERM}
+        TERM_PROGRAM: {$env: TERM_PROGRAM}
+        SHELL: /bin/bash
   pollingInterval:  10
   queueBaseUrl:     https://queue.taskcluster.net/v1
   reclaimOffset:    120

plugins/env/env.go

@@ -13,12 +13,29 @@ import (
 
 type plugin struct {
 	plugins.PluginBase
+	extraVars map[string]string
 }
 
 type payloadType struct {
 	Env map[string]string `json:"env"`
 }
 
+type config struct {
+	Extra map[string]string `json:"extra"`
+}
+
+var configSchema = schematypes.Object{
+	Properties: schematypes.Properties{
+		"extra": schematypes.Map{
+			MetaData: schematypes.MetaData{
+				Title:       "Extra environment variables",
+				Description: "This defines extra environment variables to add to the engine.",
+			},
+			Values: schematypes.String{},
+		},
+	},
+}
+
 var payloadSchema = schematypes.Object{
 	Properties: schematypes.Properties{
 		"env": schematypes.Map{
@@ -35,7 +52,7 @@ func (plugin) PayloadSchema() schematypes.Object {
 	return payloadSchema
 }
 
-func (plugin) NewTaskPlugin(options plugins.TaskPluginOptions) (plugins.TaskPlugin, error) {
+func (pl plugin) NewTaskPlugin(options plugins.TaskPluginOptions) (plugins.TaskPlugin, error) {
 	var p payloadType
 	err := payloadSchema.Map(options.Payload, &p)
 	if err == schematypes.ErrTypeMismatch {
@@ -44,6 +61,10 @@ func (plugin) NewTaskPlugin(options plugins.TaskPluginOptions) (plugins.TaskPlug
 		return nil, engines.ErrContractViolation
 	}
 
+	for k, v := range pl.extraVars {
+		p.Env[k] = v
+	}
+
 	return taskPlugin{
 		TaskPluginBase: plugins.TaskPluginBase{},
 		variables:      p.Env,
@@ -82,8 +103,20 @@ type pluginProvider struct {
 	plugins.PluginProviderBase
 }
 
-func (pluginProvider) NewPlugin(plugins.PluginOptions) (plugins.Plugin, error) {
-	return plugin{}, nil
+func (pluginProvider) NewPlugin(options plugins.PluginOptions) (plugins.Plugin, error) {
+	var c config
+	if err := schematypes.MustMap(configSchema, options.Config, &c); err != nil {
+		return nil, engines.ErrContractViolation
+	}
+
+	return plugin{
+		PluginBase: plugins.PluginBase{},
+		extraVars:  c.Extra,
+	}, nil
+}
+
+func (pluginProvider) ConfigSchema() schematypes.Schema {
+	return configSchema
 }
 
 func init() {

plugins/env/env_test.go

@@ -13,6 +13,7 @@ func TestEnvNone(*testing.T) {
 			"function": "true",
 			"argument": "whatever"
 		}`,
+		PluginConfig:  `{}`,
 		Plugin:        "env",
 		PluginSuccess: true,
 		EngineSuccess: true,
@@ -29,6 +30,7 @@ func TestEnvDefinition(*testing.T) {
 				"ENV1": "env1"
 			}
 		}`,
+		PluginConfig:  `{}`,
 		Plugin:        "env",
 		PluginSuccess: true,
 		EngineSuccess: true,
@@ -46,9 +48,32 @@ func TestEnvUnDefinition(*testing.T) {
 				"ENV2": "env2"
 			}
 		}`,
+		PluginConfig:  `{}`,
 		Plugin:        "env",
 		PluginSuccess: true,
 		EngineSuccess: false,
 		NotMatchLog:   "env1",
 	}.Test()
 }
+
+func TestEnvConfig(*testing.T) {
+	plugintest.Case{
+		Payload: `{
+			"delay": 0,
+			"function": "print-env-var",
+			"argument": "ENV1",
+			"env": {
+				"ENV2" : "env2"
+			}
+		}`,
+		PluginConfig: `{
+			"extra": {
+				"ENV1": "env1"
+			}
+		}`,
+		Plugin:        "env",
+		PluginSuccess: true,
+		EngineSuccess: true,
+		MatchLog:      "env1",
+	}.Test()
+}

worker/worker_test.go

@@ -37,6 +37,9 @@ func TestStart(t *testing.T) {
 		},
 		"plugins": map[string]interface{}{
 			"disabled": []string{},
+			"env": map[string]interface{}{
+				"extra": map[string]interface{}{},
+			},
 		},
 		"capacity": 1,
 		"credentials": map[string]interface{}{