a28fc4798a
Fix image based drivers having host env vars set
411 lines
11 KiB
Go
411 lines
11 KiB
Go
package driver
|
|
|
|
import (
|
|
"io"
|
|
"log"
|
|
"math/rand"
|
|
"os"
|
|
"path/filepath"
|
|
"reflect"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/hashicorp/nomad/client/allocdir"
|
|
"github.com/hashicorp/nomad/client/config"
|
|
"github.com/hashicorp/nomad/client/driver/env"
|
|
"github.com/hashicorp/nomad/helper/testtask"
|
|
"github.com/hashicorp/nomad/nomad/mock"
|
|
"github.com/hashicorp/nomad/nomad/structs"
|
|
)
|
|
|
|
var basicResources = &structs.Resources{
|
|
CPU: 250,
|
|
MemoryMB: 256,
|
|
DiskMB: 20,
|
|
Networks: []*structs.NetworkResource{
|
|
&structs.NetworkResource{
|
|
IP: "0.0.0.0",
|
|
ReservedPorts: []structs.Port{{"main", 12345}},
|
|
DynamicPorts: []structs.Port{{"HTTP", 43330}},
|
|
},
|
|
},
|
|
}
|
|
|
|
func init() {
|
|
rand.Seed(49875)
|
|
}
|
|
|
|
func TestMain(m *testing.M) {
|
|
if !testtask.Run() {
|
|
os.Exit(m.Run())
|
|
}
|
|
}
|
|
|
|
// copyFile moves an existing file to the destination
|
|
func copyFile(src, dst string, t *testing.T) {
|
|
in, err := os.Open(src)
|
|
if err != nil {
|
|
t.Fatalf("copying %v -> %v failed: %v", src, dst, err)
|
|
}
|
|
defer in.Close()
|
|
out, err := os.Create(dst)
|
|
if err != nil {
|
|
t.Fatalf("copying %v -> %v failed: %v", src, dst, err)
|
|
}
|
|
defer func() {
|
|
if err := out.Close(); err != nil {
|
|
t.Fatalf("copying %v -> %v failed: %v", src, dst, err)
|
|
}
|
|
}()
|
|
if _, err = io.Copy(out, in); err != nil {
|
|
t.Fatalf("copying %v -> %v failed: %v", src, dst, err)
|
|
}
|
|
if err := out.Sync(); err != nil {
|
|
t.Fatalf("copying %v -> %v failed: %v", src, dst, err)
|
|
}
|
|
}
|
|
|
|
func testLogger() *log.Logger {
|
|
return log.New(os.Stderr, "", log.LstdFlags)
|
|
}
|
|
|
|
func testConfig() *config.Config {
|
|
conf := config.DefaultConfig()
|
|
conf.StateDir = os.TempDir()
|
|
conf.AllocDir = os.TempDir()
|
|
conf.MaxKillTimeout = 10 * time.Second
|
|
return conf
|
|
}
|
|
|
|
type testContext struct {
|
|
AllocDir *allocdir.AllocDir
|
|
DriverCtx *DriverContext
|
|
ExecCtx *ExecContext
|
|
}
|
|
|
|
// testDriverContext sets up an alloc dir, task dir, DriverContext, and ExecContext.
|
|
//
|
|
// It is up to the caller to call AllocDir.Destroy to cleanup.
|
|
func testDriverContexts(t *testing.T, task *structs.Task) *testContext {
|
|
cfg := testConfig()
|
|
allocDir := allocdir.NewAllocDir(testLogger(), filepath.Join(cfg.AllocDir, structs.GenerateUUID()))
|
|
if err := allocDir.Build(); err != nil {
|
|
t.Fatalf("AllocDir.Build() failed: %v", err)
|
|
}
|
|
alloc := mock.Alloc()
|
|
|
|
// Build a temp driver so we can call FSIsolation and build the task dir
|
|
tmpdrv, err := NewDriver(task.Driver, NewEmptyDriverContext())
|
|
if err != nil {
|
|
allocDir.Destroy()
|
|
t.Fatalf("NewDriver(%q, nil) failed: %v", task.Driver, err)
|
|
return nil
|
|
}
|
|
|
|
// Build the task dir
|
|
td := allocDir.NewTaskDir(task.Name)
|
|
if err := td.Build(config.DefaultChrootEnv, tmpdrv.FSIsolation()); err != nil {
|
|
allocDir.Destroy()
|
|
t.Fatalf("TaskDir.Build(%#v, %q) failed: %v", config.DefaultChrootEnv, tmpdrv.FSIsolation(), err)
|
|
return nil
|
|
}
|
|
|
|
execCtx := NewExecContext(td, alloc.ID)
|
|
|
|
taskEnv, err := GetTaskEnv(td, cfg.Node, task, alloc, cfg, "")
|
|
if err != nil {
|
|
allocDir.Destroy()
|
|
t.Fatalf("GetTaskEnv() failed: %v", err)
|
|
return nil
|
|
}
|
|
|
|
logger := testLogger()
|
|
emitter := func(m string, args ...interface{}) {
|
|
logger.Printf("[EVENT] "+m, args...)
|
|
}
|
|
driverCtx := NewDriverContext(task.Name, cfg, cfg.Node, logger, taskEnv, emitter)
|
|
|
|
return &testContext{allocDir, driverCtx, execCtx}
|
|
}
|
|
|
|
// setupTaskEnv creates a test env for GetTaskEnv testing. Returns task dir,
|
|
// expected env, and actual env.
|
|
func setupTaskEnv(t *testing.T, driver string) (*allocdir.TaskDir, map[string]string, map[string]string) {
|
|
task := &structs.Task{
|
|
Name: "Foo",
|
|
Driver: driver,
|
|
Env: map[string]string{
|
|
"HELLO": "world",
|
|
"lorem": "ipsum",
|
|
},
|
|
Resources: &structs.Resources{
|
|
CPU: 1000,
|
|
MemoryMB: 500,
|
|
Networks: []*structs.NetworkResource{
|
|
&structs.NetworkResource{
|
|
IP: "1.2.3.4",
|
|
ReservedPorts: []structs.Port{{"one", 80}, {"two", 443}},
|
|
DynamicPorts: []structs.Port{{"admin", 8081}, {"web", 8086}},
|
|
},
|
|
},
|
|
},
|
|
Meta: map[string]string{
|
|
"chocolate": "cake",
|
|
"strawberry": "icecream",
|
|
},
|
|
}
|
|
|
|
alloc := mock.Alloc()
|
|
alloc.Job.TaskGroups[0].Tasks[0] = task
|
|
alloc.Name = "Bar"
|
|
conf := testConfig()
|
|
allocDir := allocdir.NewAllocDir(testLogger(), filepath.Join(conf.AllocDir, alloc.ID))
|
|
taskDir := allocDir.NewTaskDir(task.Name)
|
|
env, err := GetTaskEnv(taskDir, nil, task, alloc, conf, "")
|
|
if err != nil {
|
|
t.Fatalf("GetTaskEnv() failed: %v", err)
|
|
}
|
|
exp := map[string]string{
|
|
"NOMAD_CPU_LIMIT": "1000",
|
|
"NOMAD_MEMORY_LIMIT": "500",
|
|
"NOMAD_ADDR_one": "1.2.3.4:80",
|
|
"NOMAD_IP_one": "1.2.3.4",
|
|
"NOMAD_PORT_one": "80",
|
|
"NOMAD_HOST_PORT_one": "80",
|
|
"NOMAD_ADDR_two": "1.2.3.4:443",
|
|
"NOMAD_IP_two": "1.2.3.4",
|
|
"NOMAD_PORT_two": "443",
|
|
"NOMAD_HOST_PORT_two": "443",
|
|
"NOMAD_ADDR_admin": "1.2.3.4:8081",
|
|
"NOMAD_IP_admin": "1.2.3.4",
|
|
"NOMAD_PORT_admin": "8081",
|
|
"NOMAD_HOST_PORT_admin": "8081",
|
|
"NOMAD_ADDR_web": "1.2.3.4:8086",
|
|
"NOMAD_IP_web": "1.2.3.4",
|
|
"NOMAD_PORT_web": "8086",
|
|
"NOMAD_HOST_PORT_web": "8086",
|
|
"NOMAD_META_CHOCOLATE": "cake",
|
|
"NOMAD_META_STRAWBERRY": "icecream",
|
|
"NOMAD_META_ELB_CHECK_INTERVAL": "30s",
|
|
"NOMAD_META_ELB_CHECK_TYPE": "http",
|
|
"NOMAD_META_ELB_CHECK_MIN": "3",
|
|
"NOMAD_META_OWNER": "armon",
|
|
"HELLO": "world",
|
|
"lorem": "ipsum",
|
|
"NOMAD_ALLOC_ID": alloc.ID,
|
|
"NOMAD_ALLOC_NAME": alloc.Name,
|
|
"NOMAD_TASK_NAME": task.Name,
|
|
"NOMAD_JOB_NAME": alloc.Job.Name,
|
|
}
|
|
|
|
act := env.EnvMap()
|
|
return taskDir, exp, act
|
|
}
|
|
|
|
func TestDriver_GetTaskEnv_None(t *testing.T) {
|
|
taskDir, exp, act := setupTaskEnv(t, "raw_exec")
|
|
|
|
// raw_exec should use host alloc dir path
|
|
exp[env.AllocDir] = taskDir.SharedAllocDir
|
|
exp[env.TaskLocalDir] = taskDir.LocalDir
|
|
exp[env.SecretsDir] = taskDir.SecretsDir
|
|
|
|
// Since host env vars are included only ensure expected env vars are present
|
|
for expk, expv := range exp {
|
|
v, ok := act[expk]
|
|
if !ok {
|
|
t.Errorf("%q not found in task env", expk)
|
|
continue
|
|
}
|
|
if v != expv {
|
|
t.Errorf("Expected %s=%q but found %q", expk, expv, v)
|
|
}
|
|
}
|
|
|
|
// Make sure common host env vars are included.
|
|
for _, envvar := range [...]string{"PATH", "HOME", "USER"} {
|
|
if exp := os.Getenv(envvar); act[envvar] != exp {
|
|
t.Errorf("Expected envvar %s=%q != %q", envvar, exp, act[envvar])
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestDriver_GetTaskEnv_Chroot(t *testing.T) {
|
|
_, exp, act := setupTaskEnv(t, "exec")
|
|
|
|
exp[env.AllocDir] = allocdir.SharedAllocContainerPath
|
|
exp[env.TaskLocalDir] = allocdir.TaskLocalContainerPath
|
|
exp[env.SecretsDir] = allocdir.TaskSecretsContainerPath
|
|
|
|
// Since host env vars are included only ensure expected env vars are present
|
|
for expk, expv := range exp {
|
|
v, ok := act[expk]
|
|
if !ok {
|
|
t.Errorf("%q not found in task env", expk)
|
|
continue
|
|
}
|
|
if v != expv {
|
|
t.Errorf("Expected %s=%q but found %q", expk, expv, v)
|
|
}
|
|
}
|
|
|
|
// Make sure common host env vars are included.
|
|
for _, envvar := range [...]string{"PATH", "HOME", "USER"} {
|
|
if exp := os.Getenv(envvar); act[envvar] != exp {
|
|
t.Errorf("Expected envvar %s=%q != %q", envvar, exp, act[envvar])
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestDriver_GetTaskEnv_Image ensures host environment variables are not set
|
|
// for image based drivers. See #2211
|
|
func TestDriver_GetTaskEnv_Image(t *testing.T) {
|
|
_, exp, act := setupTaskEnv(t, "docker")
|
|
|
|
exp[env.AllocDir] = allocdir.SharedAllocContainerPath
|
|
exp[env.TaskLocalDir] = allocdir.TaskLocalContainerPath
|
|
exp[env.SecretsDir] = allocdir.TaskSecretsContainerPath
|
|
|
|
// Since host env vars are excluded expected and actual maps should be equal
|
|
for expk, expv := range exp {
|
|
v, ok := act[expk]
|
|
delete(act, expk)
|
|
if !ok {
|
|
t.Errorf("Env var %s missing. Expected %s=%q", expk, expk, expv)
|
|
continue
|
|
}
|
|
if v != expv {
|
|
t.Errorf("Env var %s=%q -- Expected %q", expk, v, expk)
|
|
}
|
|
}
|
|
// Any remaining env vars are unexpected
|
|
for actk, actv := range act {
|
|
t.Errorf("Env var %s=%q is unexpected", actk, actv)
|
|
}
|
|
}
|
|
|
|
func TestMapMergeStrInt(t *testing.T) {
|
|
a := map[string]int{
|
|
"cakes": 5,
|
|
"cookies": 3,
|
|
}
|
|
|
|
b := map[string]int{
|
|
"cakes": 3,
|
|
"pies": 2,
|
|
}
|
|
|
|
c := mapMergeStrInt(a, b)
|
|
|
|
d := map[string]int{
|
|
"cakes": 3,
|
|
"cookies": 3,
|
|
"pies": 2,
|
|
}
|
|
|
|
if !reflect.DeepEqual(c, d) {
|
|
t.Errorf("\nExpected\n%+v\nGot\n%+v\n", d, c)
|
|
}
|
|
}
|
|
|
|
func TestMapMergeStrStr(t *testing.T) {
|
|
a := map[string]string{
|
|
"cake": "chocolate",
|
|
"cookie": "caramel",
|
|
}
|
|
|
|
b := map[string]string{
|
|
"cake": "strawberry",
|
|
"pie": "apple",
|
|
}
|
|
|
|
c := mapMergeStrStr(a, b)
|
|
|
|
d := map[string]string{
|
|
"cake": "strawberry",
|
|
"cookie": "caramel",
|
|
"pie": "apple",
|
|
}
|
|
|
|
if !reflect.DeepEqual(c, d) {
|
|
t.Errorf("\nExpected\n%+v\nGot\n%+v\n", d, c)
|
|
}
|
|
}
|
|
|
|
func TestCreatedResources_AddMerge(t *testing.T) {
|
|
res1 := NewCreatedResources()
|
|
res1.Add("k1", "v1")
|
|
res1.Add("k1", "v2")
|
|
res1.Add("k1", "v1")
|
|
res1.Add("k2", "v1")
|
|
|
|
expected := map[string][]string{
|
|
"k1": {"v1", "v2"},
|
|
"k2": {"v1"},
|
|
}
|
|
if !reflect.DeepEqual(expected, res1.Resources) {
|
|
t.Fatalf("1. %#v != expected %#v", res1.Resources, expected)
|
|
}
|
|
|
|
// Make sure merging nil works
|
|
var res2 *CreatedResources
|
|
res1.Merge(res2)
|
|
if !reflect.DeepEqual(expected, res1.Resources) {
|
|
t.Fatalf("2. %#v != expected %#v", res1.Resources, expected)
|
|
}
|
|
|
|
// Make sure a normal merge works
|
|
res2 = NewCreatedResources()
|
|
res2.Add("k1", "v3")
|
|
res2.Add("k2", "v1")
|
|
res2.Add("k3", "v3")
|
|
res1.Merge(res2)
|
|
|
|
expected = map[string][]string{
|
|
"k1": {"v1", "v2", "v3"},
|
|
"k2": {"v1"},
|
|
"k3": {"v3"},
|
|
}
|
|
if !reflect.DeepEqual(expected, res1.Resources) {
|
|
t.Fatalf("3. %#v != expected %#v", res1.Resources, expected)
|
|
}
|
|
}
|
|
|
|
func TestCreatedResources_CopyRemove(t *testing.T) {
|
|
res1 := NewCreatedResources()
|
|
res1.Add("k1", "v1")
|
|
res1.Add("k1", "v2")
|
|
res1.Add("k1", "v3")
|
|
res1.Add("k2", "v1")
|
|
|
|
// Assert Copy creates a deep copy
|
|
res2 := res1.Copy()
|
|
|
|
if !reflect.DeepEqual(res1, res2) {
|
|
t.Fatalf("%#v != %#v", res1, res2)
|
|
}
|
|
|
|
// Assert removing v1 from k1 returns true and updates Resources slice
|
|
if removed := res2.Remove("k1", "v1"); !removed {
|
|
t.Fatalf("expected v1 to be removed: %#v", res2)
|
|
}
|
|
|
|
if expected := []string{"v2", "v3"}; !reflect.DeepEqual(expected, res2.Resources["k1"]) {
|
|
t.Fatalf("unpexpected list for k1: %#v", res2.Resources["k1"])
|
|
}
|
|
|
|
// Assert removing the only value from a key removes the key
|
|
if removed := res2.Remove("k2", "v1"); !removed {
|
|
t.Fatalf("expected v1 to be removed from k2: %#v", res2.Resources)
|
|
}
|
|
|
|
if _, found := res2.Resources["k2"]; found {
|
|
t.Fatalf("k2 should have been removed from Resources: %#v", res2.Resources)
|
|
}
|
|
|
|
// Make sure res1 wasn't updated
|
|
if reflect.DeepEqual(res1, res2) {
|
|
t.Fatalf("res1 should not equal res2: #%v", res1)
|
|
}
|
|
}
|