back round 0 view raw

spindle/engine: helpers to convert step.Environment to []string{} and set them #247

merged

opened by

anirudh.fi 6 months ago targeting master from push-pmtpswykplzr

Signed-off-by: Anirudh Oppiliappan anirudh@tangled.sh

options

unified split

Changed files

+107 -1

spindle

engine

engine.go

envs.go

envs_test.go

+5 -1

spindle/engine/engine.go

···

       203
       203
        
       	}()

     

       204
       204
        
       

     

       205
       205
        
       	for _, step := range steps {

     

       206
       206
       +
       		envs := ConstructEnvs(step.Environment)

     

       207
       207
       +
       		envs.AddEnv("HOME", workspaceDir)

     

       208
       208
       +
       		e.l.Debug("envs for step", "step", step.Name, "envs", envs.Slice())

     

       209
       209
       +
       

     

       206
       210
        
       		hostConfig := hostConfig(wid)

     

       207
       211
        
       		resp, err := e.docker.ContainerCreate(ctx, &container.Config{

     

       208
       212
        
       			Image:      image,

     
···

       210
       214
        
       			WorkingDir: workspaceDir,

     

       211
       215
        
       			Tty:        false,

     

       212
       216
        
       			Hostname:   "spindle",

     

       213
       213
       -
       			Env:        []string{"HOME=" + workspaceDir},

     

       217
       217
       +
       			Env:        envs.Slice(),

     

       214
       218
        
       		}, hostConfig, nil, nil, "")

     

       215
       219
        
       		if err != nil {

     

       216
       220
        
       			return fmt.Errorf("creating container: %w", err)

+32

spindle/engine/envs.go

···

       1
       1
       +
       package engine

     

       2
       2
       +
       

     

       3
       3
       +
       import (

     

       4
       4
       +
       	"fmt"

     

       5
       5
       +
       

     

       6
       6
       +
       	"tangled.sh/tangled.sh/core/api/tangled"

     

       7
       7
       +
       )

     

       8
       8
       +
       

     

       9
       9
       +
       type EnvVars []string

     

       10
       10
       +
       

     

       11
       11
       +
       // ConstructEnvs converts a tangled.Pipeline_Step_Environment_Elem.{Key,Value}

     

       12
       12
       +
       // representation into a docker-friendly []string{"KEY=value", ...} slice.

     

       13
       13
       +
       func ConstructEnvs(envs []*tangled.Pipeline_Step_Environment_Elem) EnvVars {

     

       14
       14
       +
       	var dockerEnvs EnvVars

     

       15
       15
       +
       	for _, env := range envs {

     

       16
       16
       +
       		if env != nil {

     

       17
       17
       +
       			ev := fmt.Sprintf("%s=%s", env.Key, env.Value)

     

       18
       18
       +
       			dockerEnvs = append(dockerEnvs, ev)

     

       19
       19
       +
       		}

     

       20
       20
       +
       	}

     

       21
       21
       +
       	return dockerEnvs

     

       22
       22
       +
       }

     

       23
       23
       +
       

     

       24
       24
       +
       // Slice returns the EnvVar as a []string slice.

     

       25
       25
       +
       func (ev EnvVars) Slice() []string {

     

       26
       26
       +
       	return ev

     

       27
       27
       +
       }

     

       28
       28
       +
       

     

       29
       29
       +
       // AddEnv adds a key=value string to the EnvVar.

     

       30
       30
       +
       func (ev *EnvVars) AddEnv(key, value string) {

     

       31
       31
       +
       	*ev = append(*ev, fmt.Sprintf("%s=%s", key, value))

     

       32
       32
       +
       }

+70

spindle/engine/envs_test.go

···

       1
       1
       +
       package engine

     

       2
       2
       +
       

     

       3
       3
       +
       import (

     

       4
       4
       +
       	"reflect"

     

       5
       5
       +
       	"testing"

     

       6
       6
       +
       

     

       7
       7
       +
       	"tangled.sh/tangled.sh/core/api/tangled"

     

       8
       8
       +
       )

     

       9
       9
       +
       

     

       10
       10
       +
       func TestConstructEnvs(t *testing.T) {

     

       11
       11
       +
       	tests := []struct {

     

       12
       12
       +
       		name string

     

       13
       13
       +
       		in   []*tangled.Pipeline_Step_Environment_Elem

     

       14
       14
       +
       		want EnvVars

     

       15
       15
       +
       	}{

     

       16
       16
       +
       		{

     

       17
       17
       +
       			name: "empty input",

     

       18
       18
       +
       			in:   []*tangled.Pipeline_Step_Environment_Elem{},

     

       19
       19
       +
       			want: EnvVars{},

     

       20
       20
       +
       		},

     

       21
       21
       +
       		{

     

       22
       22
       +
       			name: "single env var",

     

       23
       23
       +
       			in: []*tangled.Pipeline_Step_Environment_Elem{

     

       24
       24
       +
       				{Key: "FOO", Value: "bar"},

     

       25
       25
       +
       			},

     

       26
       26
       +
       			want: EnvVars{"FOO=bar"},

     

       27
       27
       +
       		},

     

       28
       28
       +
       		{

     

       29
       29
       +
       			name: "multiple env vars",

     

       30
       30
       +
       			in: []*tangled.Pipeline_Step_Environment_Elem{

     

       31
       31
       +
       				{Key: "FOO", Value: "bar"},

     

       32
       32
       +
       				{Key: "BAZ", Value: "qux"},

     

       33
       33
       +
       			},

     

       34
       34
       +
       			want: EnvVars{"FOO=bar", "BAZ=qux"},

     

       35
       35
       +
       		},

     

       36
       36
       +
       		{

     

       37
       37
       +
       			name: "nil entries are skipped",

     

       38
       38
       +
       			in: []*tangled.Pipeline_Step_Environment_Elem{

     

       39
       39
       +
       				nil,

     

       40
       40
       +
       				{Key: "FOO", Value: "bar"},

     

       41
       41
       +
       			},

     

       42
       42
       +
       			want: EnvVars{"FOO=bar"},

     

       43
       43
       +
       		},

     

       44
       44
       +
       	}

     

       45
       45
       +
       

     

       46
       46
       +
       	for _, tt := range tests {

     

       47
       47
       +
       		t.Run(tt.name, func(t *testing.T) {

     

       48
       48
       +
       			got := ConstructEnvs(tt.in)

     

       49
       49
       +
       

     

       50
       50
       +
       			if got == nil {

     

       51
       51
       +
       				got = EnvVars{}

     

       52
       52
       +
       			}

     

       53
       53
       +
       

     

       54
       54
       +
       			if !reflect.DeepEqual(got, tt.want) {

     

       55
       55
       +
       				t.Errorf("ConstructEnvs() = %v, want %v", got, tt.want)

     

       56
       56
       +
       			}

     

       57
       57
       +
       		})

     

       58
       58
       +
       	}

     

       59
       59
       +
       }

     

       60
       60
       +
       

     

       61
       61
       +
       func TestAddEnv(t *testing.T) {

     

       62
       62
       +
       	ev := EnvVars{}

     

       63
       63
       +
       	ev.AddEnv("FOO", "bar")

     

       64
       64
       +
       	ev.AddEnv("BAZ", "qux")

     

       65
       65
       +
       

     

       66
       66
       +
       	want := EnvVars{"FOO=bar", "BAZ=qux"}

     

       67
       67
       +
       	if !reflect.DeepEqual(ev, want) {

     

       68
       68
       +
       		t.Errorf("AddEnv result = %v, want %v", ev, want)

     

       69
       69
       +
       	}

     

       70
       70
       +
       }