Move testutils to pkg

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>

pkg/testutil/helpers.go

@@ -0,0 +1,82 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package testutil
+
+import (
+	"flag"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"strconv"
+	"testing"
+)
+
+var rootEnabled bool
+
+func init() {
+	flag.BoolVar(&rootEnabled, "test.root", false, "enable tests that require root")
+}
+
+// DumpDir prints the contents of the directory to the testing logger.
+//
+// Use this in a defer statement from a test that may allocate and exercise a
+// temporary directory. Immensely useful for sanity checking and debugging
+// failing tests.
+//
+// One should still test that contents are as expected. This is only a visual
+// tool to assist when things don't go your way.
+func DumpDir(t *testing.T, root string) {
+	if err := filepath.Walk(root, func(path string, fi os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+
+		if fi.Mode()&os.ModeSymlink != 0 {
+			target, err := os.Readlink(path)
+			if err != nil {
+				return err
+			}
+			t.Log(fi.Mode(), fmt.Sprintf("%10s", ""), path, "->", target)
+		} else if fi.Mode().IsRegular() {
+			p, err := ioutil.ReadFile(path)
+			if err != nil {
+				t.Logf("error reading file: %v", err)
+				return nil
+			}
+
+			if len(p) > 64 { // just display a little bit.
+				p = p[:64]
+			}
+			t.Log(fi.Mode(), fmt.Sprintf("%10d", fi.Size()), path, "[", strconv.Quote(string(p)), "...]")
+		} else {
+			t.Log(fi.Mode(), fmt.Sprintf("%10d", fi.Size()), path)
+		}
+
+		return nil
+	}); err != nil {
+		t.Fatalf("error dumping directory: %v", err)
+	}
+}
+
+// DumpDirOnFailure prints the contents of the directory to the testing logger if
+// the test has failed.
+func DumpDirOnFailure(t *testing.T, root string) {
+	if t.Failed() {
+		DumpDir(t, root)
+	}
+}

pkg/testutil/helpers_unix.go

@@ -0,0 +1,56 @@
+// +build !windows
+
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package testutil
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/containerd/containerd/mount"
+	"github.com/gotestyourself/gotestyourself/assert"
+)
+
+// Unmount unmounts a given mountPoint and sets t.Error if it fails
+func Unmount(t testing.TB, mountPoint string) {
+	t.Log("unmount", mountPoint)
+	err := mount.UnmountAll(mountPoint, umountflags)
+	assert.NilError(t, err)
+}
+
+// RequiresRoot skips tests that require root, unless the test.root flag has
+// been set
+func RequiresRoot(t testing.TB) {
+	if !rootEnabled {
+		t.Skip("skipping test that requires root")
+	}
+	assert.Equal(t, 0, os.Getuid(), "This test must be run as root.")
+}
+
+// RequiresRootM is similar to RequiresRoot but intended to be called from *testing.M.
+func RequiresRootM() {
+	if !rootEnabled {
+		fmt.Fprintln(os.Stderr, "skipping test that requires root")
+		os.Exit(0)
+	}
+	if 0 != os.Getuid() {
+		fmt.Fprintln(os.Stderr, "This test must be run as root.")
+		os.Exit(1)
+	}
+}

pkg/testutil/helpers_windows.go

@@ -0,0 +1,32 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package testutil
+
+import "testing"
+
+// RequiresRoot does nothing on Windows
+func RequiresRoot(t testing.TB) {
+}
+
+// RequiresRootM is similar to RequiresRoot but intended to be called from *testing.M.
+func RequiresRootM() {
+}
+
+// Unmount unmounts a given mountPoint and sets t.Error if it fails
+// Does nothing on Windows
+func Unmount(t *testing.T, mountPoint string) {
+}

pkg/testutil/loopback_linux.go

@@ -0,0 +1,72 @@
+// +build linux
+
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package testutil
+
+import (
+	"io/ioutil"
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
+)
+
+// NewLoopback creates a loopback device, and returns its device name (/dev/loopX), and its clean-up function.
+func NewLoopback(size int64) (string, func() error, error) {
+	// create temporary file for the disk image
+	file, err := ioutil.TempFile("", "containerd-test-loopback")
+	if err != nil {
+		return "", nil, errors.Wrap(err, "could not create temporary file for loopback")
+	}
+
+	if err := file.Truncate(size); err != nil {
+		file.Close()
+		os.Remove(file.Name())
+		return "", nil, errors.Wrap(err, "failed to resize temp file")
+	}
+	file.Close()
+
+	// create device
+	losetup := exec.Command("losetup", "--find", "--show", file.Name())
+	p, err := losetup.Output()
+	if err != nil {
+		os.Remove(file.Name())
+		return "", nil, errors.Wrap(err, "loopback setup failed")
+	}
+
+	deviceName := strings.TrimSpace(string(p))
+	logrus.Debugf("Created loop device %s (using %s)", deviceName, file.Name())
+
+	cleanup := func() error {
+		// detach device
+		logrus.Debugf("Removing loop device %s", deviceName)
+		losetup := exec.Command("losetup", "--detach", deviceName)
+		err := losetup.Run()
+		if err != nil {
+			return errors.Wrapf(err, "Could not remove loop device %s", deviceName)
+		}
+
+		// remove file
+		logrus.Debugf("Removing temporary file %s", file.Name())
+		return os.Remove(file.Name())
+	}
+
+	return deviceName, cleanup, nil
+}

pkg/testutil/mount_linux.go

@@ -0,0 +1,21 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package testutil
+
+import "golang.org/x/sys/unix"
+
+const umountflags int = unix.MNT_DETACH

pkg/testutil/mount_other.go

@@ -0,0 +1,21 @@
+// +build !linux,!windows
+
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package testutil
+
+const umountflags int = 0