open-nomad/client/driver/lxc_test.go

//+build linux,lxc

package driver

import (
	"bytes"
	"fmt"
	"io/ioutil"
	"os"
	"os/exec"
	"path/filepath"
	"testing"
	"time"

	"github.com/hashicorp/nomad/client/config"
	cstructs "github.com/hashicorp/nomad/client/structs"
	ctestutil "github.com/hashicorp/nomad/client/testutil"
	"github.com/hashicorp/nomad/nomad/structs"
	"github.com/hashicorp/nomad/testutil"
	lxc "gopkg.in/lxc/go-lxc.v2"
)

func TestLxcDriver_Fingerprint(t *testing.T) {
	t.Parallel()
	if !lxcPresent(t) {
		t.Skip("lxc not present")
	}

	task := &structs.Task{
		Name:      "foo",
		Driver:    "lxc",
		Resources: structs.DefaultResources(),
	}

	ctx := testDriverContexts(t, task)
	defer ctx.AllocDir.Destroy()
	d := NewLxcDriver(ctx.DriverCtx)

	node := &structs.Node{
		Attributes: map[string]string{},
	}

	// test with an empty config
	{
		request := &cstructs.FingerprintRequest{Config: &config.Config{}, Node: node}
		var response cstructs.FingerprintResponse
		err := d.Fingerprint(request, &response)
		if err != nil {
			t.Fatalf("err: %v", err)
		}
	}

	// test when lxc is enable din the config
	{
		conf := &config.Config{Options: map[string]string{lxcConfigOption: "1"}}
		request := &cstructs.FingerprintRequest{Config: conf, Node: node}
		var response cstructs.FingerprintResponse
		err := d.Fingerprint(request, &response)
		if err != nil {
			t.Fatalf("err: %v", err)
		}

		if !response.Detected {
			t.Fatalf("expected response to be applicable")
		}

		if response.Attributes["driver.lxc"] == "" {
			t.Fatalf("missing driver")
		}
	}
}

func TestLxcDriver_Start_Wait(t *testing.T) {
	if !testutil.IsTravis() {
		t.Parallel()
	}
	if !lxcPresent(t) {
		t.Skip("lxc not present")
	}
	ctestutil.RequireRoot(t)

	task := &structs.Task{
		Name:   "foo",
		Driver: "lxc",
		Config: map[string]interface{}{
			"template": "/usr/share/lxc/templates/lxc-busybox",
			"volumes":  []string{"/tmp/:mnt/tmp"},
		},
		KillTimeout: 10 * time.Second,
		Resources:   structs.DefaultResources(),
	}

	testFileContents := []byte("this should be visible under /mnt/tmp")
	tmpFile, err := ioutil.TempFile("/tmp", "testlxcdriver_start_wait")
	if err != nil {
		t.Fatalf("error writing temp file: %v", err)
	}
	defer os.Remove(tmpFile.Name())
	if _, err := tmpFile.Write(testFileContents); err != nil {
		t.Fatalf("error writing temp file: %v", err)
	}
	if err := tmpFile.Close(); err != nil {
		t.Fatalf("error closing temp file: %v", err)
	}

	ctx := testDriverContexts(t, task)
	defer ctx.AllocDir.Destroy()
	d := NewLxcDriver(ctx.DriverCtx)

	if _, err := d.Prestart(ctx.ExecCtx, task); err != nil {
		t.Fatalf("prestart err: %v", err)
	}
	sresp, err := d.Start(ctx.ExecCtx, task)
	if err != nil {
		t.Fatalf("err: %v", err)
	}

	lxcHandle, _ := sresp.Handle.(*lxcDriverHandle)

	// Destroy the container after the test
	defer func() {
		lxcHandle.container.Stop()
		lxcHandle.container.Destroy()
	}()

	testutil.WaitForResult(func() (bool, error) {
		state := lxcHandle.container.State()
		if state == lxc.RUNNING {
			return true, nil
		}
		return false, fmt.Errorf("container in state: %v", state)
	}, func(err error) {
		t.Fatalf("err: %v", err)
	})

	// Look for mounted directories in their proper location
	containerName := fmt.Sprintf("%s-%s", task.Name, ctx.DriverCtx.allocID)
	for _, mnt := range []string{"alloc", "local", "secrets", "mnt/tmp"} {
		fullpath := filepath.Join(lxcHandle.lxcPath, containerName, "rootfs", mnt)
		stat, err := os.Stat(fullpath)
		if err != nil {
			t.Fatalf("err %v", err)
		}
		if !stat.IsDir() {
			t.Fatalf("expected %q to be a dir", fullpath)
		}
	}

	// Test that /mnt/tmp/$tempFile exists in the container:
	mountedContents, err := exec.Command("lxc-attach", "-n", containerName, "--", "cat", filepath.Join("/mnt/", tmpFile.Name())).Output()
	if err != nil {
		t.Fatalf("err reading temp file in bind mount: %v", err)
	}

	if !bytes.Equal(mountedContents, testFileContents) {
		t.Fatalf("contents of temp bind mounted file did not match, was '%s'", mountedContents)
	}

	// Desroy the container
	if err := sresp.Handle.Kill(); err != nil {
		t.Fatalf("err: %v", err)
	}

	select {
	case res := <-sresp.Handle.WaitCh():
		if !res.Successful() {
			t.Fatalf("err: %v", res)
		}
	case <-time.After(time.Duration(testutil.TestMultiplier()*5) * time.Second):
		t.Fatalf("timeout")
	}
}

func TestLxcDriver_Open_Wait(t *testing.T) {
	if !testutil.IsTravis() {
		t.Parallel()
	}
	if !lxcPresent(t) {
		t.Skip("lxc not present")
	}
	ctestutil.RequireRoot(t)

	task := &structs.Task{
		Name:   "foo",
		Driver: "lxc",
		Config: map[string]interface{}{
			"template": "/usr/share/lxc/templates/lxc-busybox",
		},
		KillTimeout: 10 * time.Second,
		Resources:   structs.DefaultResources(),
	}

	ctx := testDriverContexts(t, task)
	defer ctx.AllocDir.Destroy()
	d := NewLxcDriver(ctx.DriverCtx)

	if _, err := d.Prestart(ctx.ExecCtx, task); err != nil {
		t.Fatalf("prestart err: %v", err)
	}
	sresp, err := d.Start(ctx.ExecCtx, task)
	if err != nil {
		t.Fatalf("err: %v", err)
	}

	// Destroy the container after the test
	lh := sresp.Handle.(*lxcDriverHandle)
	defer func() {
		lh.container.Stop()
		lh.container.Destroy()
	}()

	handle2, err := d.Open(ctx.ExecCtx, lh.ID())
	if err != nil {
		t.Fatalf("err: %v", err)
	}

	if handle2 == nil {
		t.Fatalf("missing handle on open")
	}

	lxcHandle, _ := handle2.(*lxcDriverHandle)

	testutil.WaitForResult(func() (bool, error) {
		state := lxcHandle.container.State()
		if state == lxc.RUNNING {
			return true, nil
		}
		return false, fmt.Errorf("container in state: %v", state)
	}, func(err error) {
		t.Fatalf("err: %v", err)
	})

	// Desroy the container
	if err := handle2.Kill(); err != nil {
		t.Fatalf("err: %v", err)
	}
}

func lxcPresent(t *testing.T) bool {
	return lxc.Version() != ""
}

func TestLxcDriver_Volumes_ConfigValidation(t *testing.T) {
	if !testutil.IsTravis() {
		t.Parallel()
	}
	if !lxcPresent(t) {
		t.Skip("lxc not present")
	}
	ctestutil.RequireRoot(t)

	brokenVolumeConfigs := [][]string{
		{
			"foo:/var",
		},
		{
			":",
		},
		{
			"abc:",
		},
		{
			":def",
		},
		{
			"abc:def:ghi",
		},
	}

	for _, bc := range brokenVolumeConfigs {
		if err := testVolumeConfig(t, bc); err == nil {
			t.Fatalf("error expected in validate for config %+v", bc)
		}
	}
	if err := testVolumeConfig(t, []string{"abc:def"}); err != nil {
		t.Fatalf("error in validate for syntactically valid config abc:def")
	}
}

func testVolumeConfig(t *testing.T, volConfig []string) error {
	task := &structs.Task{
		Name:        "voltest",
		Driver:      "lxc",
		KillTimeout: 10 * time.Second,
		Resources:   structs.DefaultResources(),
		Config: map[string]interface{}{
			"template": "busybox",
		},
	}
	task.Config["volumes"] = volConfig

	ctx := testDriverContexts(t, task)
	defer ctx.AllocDir.Destroy()

	driver := NewLxcDriver(ctx.DriverCtx)

	err := driver.Validate(task.Config)
	return err

}

func TestLxcDriver_Start_NoVolumes(t *testing.T) {
	if !testutil.IsTravis() {
		t.Parallel()
	}
	if !lxcPresent(t) {
		t.Skip("lxc not present")
	}
	ctestutil.RequireRoot(t)

	task := &structs.Task{
		Name:   "foo",
		Driver: "lxc",
		Config: map[string]interface{}{
			"template": "/usr/share/lxc/templates/lxc-busybox",
			"volumes":  []string{"/tmp/:mnt/tmp"},
		},
		KillTimeout: 10 * time.Second,
		Resources:   structs.DefaultResources(),
	}

	ctx := testDriverContexts(t, task)
	defer ctx.AllocDir.Destroy()

	// set lxcVolumesConfigOption to false to disallow absolute paths as the source for the bind mount
	ctx.DriverCtx.config.Options = map[string]string{lxcVolumesConfigOption: "false"}

	d := NewLxcDriver(ctx.DriverCtx)

	if _, err := d.Prestart(ctx.ExecCtx, task); err != nil {
		t.Fatalf("prestart err: %v", err)
	}

	// expect the "absolute bind-mount volume in config.. " error
	_, err := d.Start(ctx.ExecCtx, task)
	if err == nil {
		t.Fatalf("expected error in start, got nil.")
	}

	// Because the container was created but not started before
	// the expected error, we can test that the destroy-only
	// cleanup is done here.
	containerName := fmt.Sprintf("%s-%s", task.Name, ctx.DriverCtx.allocID)
	if err := exec.Command("bash", "-c", fmt.Sprintf("lxc-ls -1 | grep -q %s", containerName)).Run(); err == nil {
		t.Fatalf("error, container '%s' is still around", containerName)
	}

}