Stable 1.1.1 candidate

.ci/go-no-os-exit.sh

@@ -2,21 +2,28 @@
 # Copyright (c) 2018 Intel Corporation
 #
 # SPDX-License-Identifier: Apache-2.0
+#
+# Check there are no os.Exit() calls creeping into the code
+# We don't use that exit path in the Kata codebase.
+
+# Allow the path to check to be over-ridden.
+# Default to the current directory.
+go_packages=${1:-.}
 
-go_packages=.
+echo "Checking for no os.Exit() calls for package [${go_packages}]"
 
 candidates=`go list -f '{{.Dir}}/*.go' $go_packages`
 for f in $candidates; do
 	filename=`basename $f`
+	# skip all go test files
+	[[ $filename == *_test.go ]] && continue
 	# skip exit.go where, the only file we should call os.Exit() from.
 	[[ $filename == "exit.go" ]] && continue
-	# skip exit_test.go
-	[[ $filename == "exit_test.go" ]] && continue
-	# skip main_test.go
-	[[ $filename == "main_test.go" ]] && continue
 	files="$f $files"
 done
 
+[ -z "$files" ] && echo "No files to check, skipping" && exit 0
+
 if egrep -n '\<os\.Exit\>' $files; then
 	echo "Direct calls to os.Exit() are forbidden, please use exit() so atexit() works"
 	exit 1

Makefile

@@ -54,7 +54,7 @@ DESTDIR := /
 installing = $(findstring install,$(MAKECMDGOALS))
 
 ifeq ($(PREFIX),)
-PREFIX        := /usr/
+PREFIX        := /usr
 EXEC_PREFIX   := $(PREFIX)/local
 else
 EXEC_PREFIX   := $(PREFIX)
@@ -395,7 +395,8 @@ go-test: $(GENERATED_FILES)
 
 check-go-static:
 	$(QUIET_CHECK).ci/static-checks.sh
-	$(QUIET_CHECK).ci/go-no-os-exit.sh
+	$(QUIET_CHECK).ci/go-no-os-exit.sh ./cli
+	$(QUIET_CHECK).ci/go-no-os-exit.sh ./virtcontainers
 
 coverage:
 	$(QUIET_TEST).ci/go-test.sh html-coverage

cli/config.go

@@ -311,7 +311,7 @@ func newQemuHypervisorConfig(h hypervisor) (vc.HypervisorConfig, error) {
 
 	if image != "" && initrd != "" {
 		return vc.HypervisorConfig{},
-			errors.New("cannot specify an image and an initrd in configuration file")
+			errors.New("having both an image and an initrd defined in the configuration file is not supported")
 	}
 
 	firmware, err := h.firmware()

cli/create.go

@@ -16,7 +16,6 @@ import (
 
 	vc "github.com/kata-containers/runtime/virtcontainers"
 	"github.com/kata-containers/runtime/virtcontainers/pkg/oci"
-	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli"
 )
 
@@ -90,6 +89,7 @@ func create(containerID, bundlePath, console, pidFilePath string, detach bool,
 	var err error
 
 	kataLog = kataLog.WithField("container", containerID)
+	setExternalLoggers(kataLog)
 
 	// Checks the MUST and MUST NOT from OCI runtime specification
 	if bundlePath, err = validCreateParams(containerID, bundlePath); err != nil {
@@ -241,6 +241,7 @@ func createSandbox(ociSpec oci.CompatOCISpec, runtimeConfig oci.RuntimeConfig,
 	}
 
 	kataLog = kataLog.WithField("sandbox", sandbox.ID())
+	setExternalLoggers(kataLog)
 
 	containers := sandbox.GetAllContainers()
 	if len(containers) != 1 {
@@ -268,6 +269,7 @@ func createContainer(ociSpec oci.CompatOCISpec, containerID, bundlePath,
 	}
 
 	kataLog = kataLog.WithField("sandbox", sandboxID)
+	setExternalLoggers(kataLog)
 
 	_, c, err := vci.CreateContainer(sandboxID, contConfig)
 	if err != nil {
@@ -283,11 +285,7 @@ func createContainer(ociSpec oci.CompatOCISpec, containerID, bundlePath,
 
 func createCgroupsFiles(containerID string, cgroupsDirPath string, cgroupsPathList []string, pid int) error {
 	if len(cgroupsPathList) == 0 {
-		fields := logrus.Fields{
-			"container": containerID,
-			"pid":       pid,
-		}
-		kataLog.WithFields(fields).Info("Cgroups files not created because cgroupsPath was empty")
+		kataLog.WithField("pid", pid).Info("Cgroups files not created because cgroupsPath was empty")
 		return nil
 	}
 

cli/delete.go

@@ -64,6 +64,8 @@ func delete(containerID string, force bool) error {
 		"sandbox":   sandboxID,
 	})
 
+	setExternalLoggers(kataLog)
+
 	containerID = status.ID
 
 	containerType, err := oci.GetContainerType(status.Annotations)

cli/delete_test.go

@@ -121,7 +121,7 @@ func TestDeleteInvalidConfig(t *testing.T) {
 	assert.False(vcmock.IsMockError(err))
 }
 
-func testConfigSetup(t *testing.T) string {
+func testConfigSetup(t *testing.T) (rootPath string, configPath string) {
 	assert := assert.New(t)
 
 	tmpdir, err := ioutil.TempDir("", "")
@@ -135,8 +135,8 @@ func testConfigSetup(t *testing.T) string {
 	assert.NoError(err)
 
 	// config json path
-	configPath := filepath.Join(bundlePath, "config.json")
-	return configPath
+	configPath = filepath.Join(bundlePath, "config.json")
+	return tmpdir, configPath
 }
 
 func TestDeleteSandbox(t *testing.T) {
@@ -146,7 +146,8 @@ func TestDeleteSandbox(t *testing.T) {
 		MockID: testSandboxID,
 	}
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -223,7 +224,8 @@ func TestDeleteInvalidContainerType(t *testing.T) {
 		MockID: testSandboxID,
 	}
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -261,7 +263,8 @@ func TestDeleteSandboxRunning(t *testing.T) {
 		MockID: testSandboxID,
 	}
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -340,7 +343,8 @@ func TestDeleteRunningContainer(t *testing.T) {
 		},
 	}
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -422,7 +426,8 @@ func TestDeleteContainer(t *testing.T) {
 		},
 	}
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -523,7 +528,8 @@ func TestDeleteCLIFunctionSuccess(t *testing.T) {
 		},
 	}
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 

cli/events.go

@@ -156,6 +156,8 @@ information is displayed once every 5 seconds.`,
 			"sandbox":   sandboxID,
 		})
 
+		setExternalLoggers(kataLog)
+
 		if status.State.State == vc.StateStopped {
 			return fmt.Errorf("container with id %s is not running", status.ID)
 		}

cli/exec.go

@@ -194,6 +194,8 @@ func execute(context *cli.Context) error {
 		"sandbox":   sandboxID,
 	})
 
+	setExternalLoggers(kataLog)
+
 	// Retrieve OCI spec configuration.
 	ociSpec, err := oci.GetOCIConfig(status)
 	if err != nil {

cli/exec_test.go

@@ -89,7 +89,8 @@ func TestExecuteErrors(t *testing.T) {
 	assert.False(vcmock.IsMockError(err))
 
 	// Container state undefined
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -147,7 +148,8 @@ func TestExecuteErrorReadingProcessJson(t *testing.T) {
 	flagSet.Parse([]string{testContainerID})
 	ctx := cli.NewContext(cli.NewApp(), flagSet, nil)
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -195,7 +197,8 @@ func TestExecuteErrorOpeningConsole(t *testing.T) {
 	flagSet.Parse([]string{testContainerID})
 	ctx := cli.NewContext(cli.NewApp(), flagSet, nil)
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -261,7 +264,8 @@ func TestExecuteWithFlags(t *testing.T) {
 	flagSet.Parse([]string{testContainerID, "/tmp/foo"})
 	ctx := cli.NewContext(cli.NewApp(), flagSet, nil)
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -349,7 +353,8 @@ func TestExecuteWithFlagsDetached(t *testing.T) {
 	flagSet.Parse([]string{testContainerID, "/tmp/foo"})
 	ctx := cli.NewContext(cli.NewApp(), flagSet, nil)
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -427,7 +432,8 @@ func TestExecuteWithInvalidProcessJson(t *testing.T) {
 	flagSet.Parse([]string{testContainerID})
 	ctx := cli.NewContext(cli.NewApp(), flagSet, nil)
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -478,7 +484,8 @@ func TestExecuteWithValidProcessJson(t *testing.T) {
 	flagSet.Parse([]string{testContainerID, "/tmp/foo"})
 	ctx := cli.NewContext(cli.NewApp(), flagSet, nil)
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 
@@ -578,7 +585,8 @@ func TestExecuteWithEmptyEnvironmentValue(t *testing.T) {
 	flagSet.Parse([]string{testContainerID})
 	ctx := cli.NewContext(cli.NewApp(), flagSet, nil)
 
-	configPath := testConfigSetup(t)
+	rootPath, configPath := testConfigSetup(t)
+	defer os.RemoveAll(rootPath)
 	configJSON, err := readOCIConfigJSON(configPath)
 	assert.NoError(err)
 

cli/kata-check.go

@@ -283,6 +283,8 @@ var kataCheckCLICommand = cli.Command{
 	Usage: "tests if system can run " + project,
 	Action: func(context *cli.Context) error {
 
+		setCPUtype()
+
 		details := vmContainerCapableDetails{
 			cpuInfoFile:           procCPUInfo,
 			requiredCPUFlags:      archRequiredCPUFlags,