Remove pkg/testutil/assert in favor of testify

I noticed that we're using a homegrown package for assertions. The
functions are extremely similar to testify, but with enough slight
differences to be confusing (for example, Equal takes its arguments in a
different order). We already vendor testify, and it's used in a few
places by tests.

I also found some problems with pkg/testutil/assert. For example, the
NotNil function seems to be broken. It checks the argument against
"nil", which only works for an interface. If you pass in a nil map or
slice, the equality check will fail.

In the interest of avoiding NIH, I'm proposing replacing
pkg/testutil/assert with testify. The test code looks almost the same,
but we avoid the confusion of having two similar but slightly different
assertion packages, and having to maintain our own package instead of
using a commonly-used one.

In the process, I found a few places where the tests should halt if an
assertion fails, so I've made those cases (that I noticed) use "require"
instead of "assert", and I've vendored the "require" package from
testify alongside the already-present "assert" package.

Signed-off-by: Aaron Lehmann <[email protected]>

Author: aaronlehmann

builder/dockerfile/buildargs_test.go

@@ -1,8 +1,9 @@
 package dockerfile
 
 import (
-	"github.com/docker/docker/pkg/testutil/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func strPtr(source string) *string {
@@ -37,7 +38,7 @@ func TestGetAllAllowed(t *testing.T) {
 		"ArgFromMeta":                         "frommeta1",
 		"ArgFromMetaOverriden":                "fromdockerfile3",
 	}
-	assert.DeepEqual(t, all, expected)
+	assert.Equal(t, expected, all)
 }
 
 func TestGetAllMeta(t *testing.T) {
@@ -59,5 +60,5 @@ func TestGetAllMeta(t *testing.T) {
 		"ArgOverriddenByOptions":        "fromopt2",
 		"ArgNoDefaultInMetaFromOptions": "fromopt3",
 	}
-	assert.DeepEqual(t, all, expected)
+	assert.Equal(t, expected, all)
 }

builder/dockerfile/builder_test.go

@@ -5,13 +5,13 @@ import (
 	"testing"
 
 	"github.com/docker/docker/builder/dockerfile/parser"
-	"github.com/docker/docker/pkg/testutil/assert"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestAddNodesForLabelOption(t *testing.T) {
 	dockerfile := "FROM scratch"
 	result, err := parser.Parse(strings.NewReader(dockerfile))
-	assert.NilError(t, err)
+	assert.NoError(t, err)
 
 	labels := map[string]string{
 		"org.e": "cli-e",
@@ -27,8 +27,8 @@ func TestAddNodesForLabelOption(t *testing.T) {
 		"FROM scratch",
 		`LABEL "org.a"='cli-a' "org.b"='cli-b' "org.c"='cli-c' "org.d"='cli-d' "org.e"='cli-e'`,
 	}
-	assert.Equal(t, len(nodes.Children), 2)
+	assert.Len(t, nodes.Children, 2)
 	for i, v := range nodes.Children {
-		assert.Equal(t, v.Original, expected[i])
+		assert.Equal(t, expected[i], v.Original)
 	}
 }

builder/dockerfile/dispatchers_test.go

@@ -10,8 +10,8 @@ import (
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/strslice"
 	"github.com/docker/docker/builder"
-	"github.com/docker/docker/pkg/testutil/assert"
 	"github.com/docker/go-connections/nat"
+	"github.com/stretchr/testify/assert"
 )
 
 type commandWithFunction struct {
@@ -137,13 +137,13 @@ func TestEnv2Variables(t *testing.T) {
 
 	args := []string{"var1", "val1", "var2", "val2"}
 	err := env(b, args, nil, "")
-	assert.NilError(t, err)
+	assert.NoError(t, err)
 
 	expected := []string{
 		fmt.Sprintf("%s=%s", args[0], args[1]),
 		fmt.Sprintf("%s=%s", args[2], args[3]),
 	}
-	assert.DeepEqual(t, b.runConfig.Env, expected)
+	assert.Equal(t, expected, b.runConfig.Env)
 }
 
 func TestEnvValueWithExistingRunConfigEnv(t *testing.T) {
@@ -153,13 +153,13 @@ func TestEnvValueWithExistingRunConfigEnv(t *testing.T) {
 
 	args := []string{"var1", "val1"}
 	err := env(b, args, nil, "")
-	assert.NilError(t, err)
+	assert.NoError(t, err)
 
 	expected := []string{
 		fmt.Sprintf("%s=%s", args[0], args[1]),
 		"var2=fromenv",
 	}
-	assert.DeepEqual(t, b.runConfig.Env, expected)
+	assert.Equal(t, expected, b.runConfig.Env)
 }
 
 func TestMaintainer(t *testing.T) {
@@ -215,49 +215,49 @@ func TestFromScratch(t *testing.T) {
 	err := from(b, []string{"scratch"}, nil, "")
 
 	if runtime.GOOS == "windows" {
-		assert.Error(t, err, "Windows does not support FROM scratch")
+		assert.EqualError(t, err, "Windows does not support FROM scratch")
 		return
 	}
 
-	assert.NilError(t, err)
-	assert.Equal(t, b.image, "")
-	assert.Equal(t, b.noBaseImage, true)
+	assert.NoError(t, err)
+	assert.Equal(t, "", b.image)
+	assert.Equal(t, true, b.noBaseImage)
 }
 
 func TestFromWithArg(t *testing.T) {
 	tag, expected := ":sometag", "expectedthisid"
 
 	getImage := func(name string) (builder.Image, error) {
-		assert.Equal(t, name, "alpine"+tag)
+		assert.Equal(t, "alpine"+tag, name)
 		return &mockImage{id: "expectedthisid"}, nil
 	}
 	b := newBuilderWithMockBackend()
 	b.docker.(*MockBackend).getImageOnBuildFunc = getImage
 
-	assert.NilError(t, arg(b, []string{"THETAG=" + tag}, nil, ""))
+	assert.NoError(t, arg(b, []string{"THETAG=" + tag}, nil, ""))
 	err := from(b, []string{"alpine${THETAG}"}, nil, "")
 
-	assert.NilError(t, err)
-	assert.Equal(t, b.image, expected)
-	assert.Equal(t, b.from.ImageID(), expected)
-	assert.Equal(t, len(b.buildArgs.GetAllAllowed()), 0)
-	assert.Equal(t, len(b.buildArgs.GetAllMeta()), 1)
+	assert.NoError(t, err)
+	assert.Equal(t, expected, b.image)
+	assert.Equal(t, expected, b.from.ImageID())
+	assert.Len(t, b.buildArgs.GetAllAllowed(), 0)
+	assert.Len(t, b.buildArgs.GetAllMeta(), 1)
 }
 
 func TestFromWithUndefinedArg(t *testing.T) {
 	tag, expected := "sometag", "expectedthisid"
 
 	getImage := func(name string) (builder.Image, error) {
-		assert.Equal(t, name, "alpine")
+		assert.Equal(t, "alpine", name)
 		return &mockImage{id: "expectedthisid"}, nil
 	}
 	b := newBuilderWithMockBackend()
 	b.docker.(*MockBackend).getImageOnBuildFunc = getImage
 	b.options.BuildArgs = map[string]*string{"THETAG": &tag}
 
 	err := from(b, []string{"alpine${THETAG}"}, nil, "")
-	assert.NilError(t, err)
-	assert.Equal(t, b.image, expected)
+	assert.NoError(t, err)
+	assert.Equal(t, expected, b.image)
 }
 
 func TestOnbuildIllegalTriggers(t *testing.T) {
@@ -508,11 +508,11 @@ func TestArg(t *testing.T) {
 	argDef := fmt.Sprintf("%s=%s", argName, argVal)
 
 	err := arg(b, []string{argDef}, nil, "")
-	assert.NilError(t, err)
+	assert.NoError(t, err)
 
 	expected := map[string]string{argName: argVal}
 	allowed := b.buildArgs.GetAllAllowed()
-	assert.DeepEqual(t, allowed, expected)
+	assert.Equal(t, expected, allowed)
 }
 
 func TestShell(t *testing.T) {

builder/dockerfile/internals_test.go

@@ -7,7 +7,8 @@ import (
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/builder"
 	"github.com/docker/docker/pkg/archive"
-	"github.com/docker/docker/pkg/testutil/assert"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestEmptyDockerfile(t *testing.T) {
@@ -38,7 +39,7 @@ func TestDockerfileOutsideTheBuildContext(t *testing.T) {
 	contextDir, cleanup := createTestTempDir(t, "", "builder-dockerfile-test")
 	defer cleanup()
 
-	expectedError := "Forbidden path outside the build context"
+	expectedError := "Forbidden path outside the build context: ../../Dockerfile ()"
 
 	readAndCheckDockerfile(t, "DockerfileOutsideTheBuildContext", contextDir, "../../Dockerfile", expectedError)
 }
@@ -54,7 +55,7 @@ func TestNonExistingDockerfile(t *testing.T) {
 
 func readAndCheckDockerfile(t *testing.T, testName, contextDir, dockerfilePath, expectedError string) {
 	tarStream, err := archive.Tar(contextDir, archive.Uncompressed)
-	assert.NilError(t, err)
+	require.NoError(t, err)
 
 	defer func() {
 		if err = tarStream.Close(); err != nil {
@@ -63,7 +64,7 @@ func readAndCheckDockerfile(t *testing.T, testName, contextDir, dockerfilePath,
 	}()
 
 	context, err := builder.MakeTarSumContext(tarStream)
-	assert.NilError(t, err)
+	require.NoError(t, err)
 
 	defer func() {
 		if err = context.Close(); err != nil {
@@ -78,5 +79,5 @@ func readAndCheckDockerfile(t *testing.T, testName, contextDir, dockerfilePath,
 	b := &Builder{options: options, context: context}
 
 	_, err = b.readAndParseDockerfile()
-	assert.Error(t, err, expectedError)
+	assert.EqualError(t, err, expectedError)
 }

builder/dockerfile/parser/line_parsers_test.go

@@ -1,26 +1,27 @@
 package parser
 
 import (
-	"github.com/docker/docker/pkg/testutil/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestParseNameValOldFormat(t *testing.T) {
 	directive := Directive{}
 	node, err := parseNameVal("foo bar", "LABEL", &directive)
-	assert.NilError(t, err)
+	assert.NoError(t, err)
 
 	expected := &Node{
 		Value: "foo",
 		Next:  &Node{Value: "bar"},
 	}
-	assert.DeepEqual(t, node, expected)
+	assert.Equal(t, expected, node)
 }
 
 func TestParseNameValNewFormat(t *testing.T) {
 	directive := Directive{}
 	node, err := parseNameVal("foo=bar thing=star", "LABEL", &directive)
-	assert.NilError(t, err)
+	assert.NoError(t, err)
 
 	expected := &Node{
 		Value: "foo",
@@ -34,7 +35,7 @@ func TestParseNameValNewFormat(t *testing.T) {
 			},
 		},
 	}
-	assert.DeepEqual(t, node, expected)
+	assert.Equal(t, expected, node)
 }
 
 func TestNodeFromLabels(t *testing.T) {
@@ -60,6 +61,6 @@ func TestNodeFromLabels(t *testing.T) {
 	}
 
 	node := NodeFromLabels(labels)
-	assert.DeepEqual(t, node, expected)
+	assert.Equal(t, expected, node)
 
 }

builder/dockerfile/parser/parser_test.go

@@ -9,7 +9,8 @@ import (
 	"runtime"
 	"testing"
 
-	"github.com/docker/docker/pkg/testutil/assert"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 const testDir = "testfiles"
@@ -18,11 +19,11 @@ const testFileLineInfo = "testfile-line/Dockerfile"
 
 func getDirs(t *testing.T, dir string) []string {
 	f, err := os.Open(dir)
-	assert.NilError(t, err)
+	require.NoError(t, err)
 	defer f.Close()
 
 	dirs, err := f.Readdirnames(0)
-	assert.NilError(t, err)
+	require.NoError(t, err)
 	return dirs
 }
 
@@ -31,11 +32,11 @@ func TestTestNegative(t *testing.T) {
 		dockerfile := filepath.Join(negativeTestDir, dir, "Dockerfile")
 
 		df, err := os.Open(dockerfile)
-		assert.NilError(t, err)
+		require.NoError(t, err)
 		defer df.Close()
 
 		_, err = Parse(df)
-		assert.Error(t, err, "")
+		assert.Error(t, err)
 	}
 }
 
@@ -45,21 +46,21 @@ func TestTestData(t *testing.T) {
 		resultfile := filepath.Join(testDir, dir, "result")
 
 		df, err := os.Open(dockerfile)
-		assert.NilError(t, err)
+		require.NoError(t, err)
 		defer df.Close()
 
 		result, err := Parse(df)
-		assert.NilError(t, err)
+		require.NoError(t, err)
 
 		content, err := ioutil.ReadFile(resultfile)
-		assert.NilError(t, err)
+		require.NoError(t, err)
 
 		if runtime.GOOS == "windows" {
 			// CRLF --> CR to match Unix behavior
 			content = bytes.Replace(content, []byte{'\x0d', '\x0a'}, []byte{'\x0a'}, -1)
 		}
 
-		assert.Equal(t, result.AST.Dump()+"\n", string(content), "In "+dockerfile)
+		assert.Contains(t, result.AST.Dump()+"\n", string(content), "In "+dockerfile)
 	}
 }
 
@@ -101,24 +102,24 @@ func TestParseWords(t *testing.T) {
 
 	for _, test := range tests {
 		words := parseWords(test["input"][0], NewDefaultDirective())
-		assert.DeepEqual(t, words, test["expect"])
+		assert.Equal(t, test["expect"], words)
 	}
 }
 
 func TestLineInformation(t *testing.T) {
 	df, err := os.Open(testFileLineInfo)
-	assert.NilError(t, err)
+	require.NoError(t, err)
 	defer df.Close()
 
 	result, err := Parse(df)
-	assert.NilError(t, err)
+	require.NoError(t, err)
 
 	ast := result.AST
 	if ast.StartLine != 5 || ast.endLine != 31 {
 		fmt.Fprintf(os.Stderr, "Wrong root line information: expected(%d-%d), actual(%d-%d)\n", 5, 31, ast.StartLine, ast.endLine)
 		t.Fatal("Root line information doesn't match result.")
 	}
-	assert.Equal(t, len(ast.Children), 3)
+	assert.Len(t, ast.Children, 3)
 	expected := [][]int{
 		{5, 5},
 		{11, 12},

builder/dockerfile/shell_parser_test.go

@@ -7,15 +7,15 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/docker/docker/pkg/testutil/assert"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestShellParser4EnvVars(t *testing.T) {
 	fn := "envVarTest"
 	lineCount := 0
 
 	file, err := os.Open(fn)
-	assert.NilError(t, err)
+	assert.NoError(t, err)
 	defer file.Close()
 
 	scanner := bufio.NewScanner(file)
@@ -36,7 +36,7 @@ func TestShellParser4EnvVars(t *testing.T) {
 		}
 
 		words := strings.Split(line, "|")
-		assert.Equal(t, len(words), 3)
+		assert.Len(t, words, 3)
 
 		platform := strings.TrimSpace(words[0])
 		source := strings.TrimSpace(words[1])
@@ -51,9 +51,9 @@ func TestShellParser4EnvVars(t *testing.T) {
 			((platform == "U" || platform == "A") && runtime.GOOS != "windows") {
 			newWord, err := ProcessWord(source, envs, '\\')
 			if expected == "error" {
-				assert.Error(t, err, "")
+				assert.Error(t, err)
 			} else {
-				assert.NilError(t, err)
+				assert.NoError(t, err)
 				assert.Equal(t, newWord, expected)
 			}
 		}