Merge pull request containerd#3549 from apostasie/debug-clarity

AkihiroSuda · web-flow · commit 427f1cb6697a · 2024-10-16T04:58:34.000+09:00
Enhance debug output and readability
diff --git a/cmd/nerdctl/completion/completion_linux_test.go b/cmd/nerdctl/completion/completion_linux_test.go
@@ -30,7 +30,7 @@ func TestCompletion(t *testing.T) {
 	testCase := &test.Case{
 		Require: test.Not(nerdtest.Docker),
 		Setup: func(data test.Data, helpers test.Helpers) {
-			helpers.Ensure("pull", testutil.AlpineImage)
+			helpers.Ensure("pull", "--quiet", testutil.AlpineImage)
 			helpers.Ensure("network", "create", data.Identifier())
 			helpers.Ensure("volume", "create", data.Identifier())
 			data.Set("identifier", data.Identifier())
diff --git a/cmd/nerdctl/image/image_convert_linux_test.go b/cmd/nerdctl/image/image_convert_linux_test.go
@@ -36,7 +36,7 @@ func TestImageConvert(t *testing.T) {
 			test.Not(nerdtest.Docker),
 		),
 		Setup: func(data test.Data, helpers test.Helpers) {
-			helpers.Ensure("pull", testutil.CommonImage)
+			helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 		},
 		SubTests: []*test.Case{
 			{
@@ -108,10 +108,10 @@ func TestImageConvertNydusVerify(t *testing.T) {
 			test.Binary("nydusify"),
 			test.Binary("nydusd"),
 			test.Not(nerdtest.Docker),
-			nerdtest.RootFul,
+			nerdtest.Rootful,
 		),
 		Setup: func(data test.Data, helpers test.Helpers) {
-			helpers.Ensure("pull", testutil.CommonImage)
+			helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 			base := testutil.NewBase(t)
 			registry = testregistry.NewWithNoAuth(base, 0, false)
 			data.Set(remoteImageKey, fmt.Sprintf("%s:%d/nydusd-image:test", "localhost", registry.Port))
diff --git a/cmd/nerdctl/image/image_encrypt_linux_test.go b/cmd/nerdctl/image/image_encrypt_linux_test.go
@@ -57,7 +57,7 @@ func TestImageEncryptJWE(t *testing.T) {
 			base := testutil.NewBase(t)
 			registry = testregistry.NewWithNoAuth(base, 0, false)
 			keyPair = testhelpers.NewJWEKeyPair(t)
-			helpers.Ensure("pull", testutil.CommonImage)
+			helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 			encryptImageRef := fmt.Sprintf("127.0.0.1:%d/%s:encrypted", registry.Port, data.Identifier())
 			helpers.Ensure("image", "encrypt", "--recipient=jwe:"+keyPair.Pub, testutil.CommonImage, encryptImageRef)
 			inspector := helpers.Capture("image", "inspect", "--mode=native", "--format={{len .Index.Manifests}}", encryptImageRef)
@@ -71,7 +71,7 @@ func TestImageEncryptJWE(t *testing.T) {
 		},
 		Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
 			helpers.Fail("pull", data.Get(remoteImageKey))
-			helpers.Ensure("pull", "--unpack=false", data.Get(remoteImageKey))
+			helpers.Ensure("pull", "--quiet", "--unpack=false", data.Get(remoteImageKey))
 			helpers.Fail("image", "decrypt", "--key="+keyPair.Pub, data.Get(remoteImageKey), data.Identifier("decrypted")) // decryption needs prv key, not pub key
 			return helpers.Command("image", "decrypt", "--key="+keyPair.Prv, data.Get(remoteImageKey), data.Identifier("decrypted"))
 		},
diff --git a/cmd/nerdctl/image/image_history_test.go b/cmd/nerdctl/image/image_history_test.go
@@ -81,7 +81,7 @@ func TestImageHistory(t *testing.T) {
 			// https://github.com/containerd/nerdctl/issues/3512
 			// Isolating it into a completely different root is the last ditched attempt at avoiding the issue
 			helpers.Write(nerdtest.DataRoot, test.ConfigValue(data.TempDir()))
-			helpers.Ensure("pull", "--platform", "linux/arm64", testutil.CommonImage)
+			helpers.Ensure("pull", "--quiet", "--platform", "linux/arm64", testutil.CommonImage)
 		},
 		SubTests: []*test.Case{
 			{
diff --git a/cmd/nerdctl/image/image_inspect_test.go b/cmd/nerdctl/image/image_inspect_test.go
@@ -33,7 +33,6 @@ func TestImageInspectSimpleCases(t *testing.T) {
 	nerdtest.Setup()
 
 	testCase := &test.Case{
-		Description: "TestImageInspect",
 		Setup: func(data test.Data, helpers test.Helpers) {
 			helpers.Ensure("pull", testutil.CommonImage)
 		},
@@ -88,9 +87,9 @@ func TestImageInspectDifferentValidReferencesForTheSameImage(t *testing.T) {
 			nerdtest.Private,
 		),
 		Setup: func(data test.Data, helpers test.Helpers) {
-			helpers.Ensure("pull", "alpine")
-			helpers.Ensure("pull", "busybox")
-			helpers.Ensure("pull", "registry-1.docker.io/library/busybox")
+			helpers.Ensure("pull", "--quiet", "alpine")
+			helpers.Ensure("pull", "--quiet", "busybox")
+			helpers.Ensure("pull", "--quiet", "registry-1.docker.io/library/busybox")
 		},
 		SubTests: []*test.Case{
 			{
diff --git a/cmd/nerdctl/image/image_list_test.go b/cmd/nerdctl/image/image_list_test.go
@@ -38,8 +38,8 @@ func TestImages(t *testing.T) {
 		Description: "TestImages",
 		Require:     test.Not(nerdtest.Docker),
 		Setup: func(data test.Data, helpers test.Helpers) {
-			helpers.Ensure("pull", testutil.CommonImage)
-			helpers.Ensure("pull", testutil.NginxAlpineImage)
+			helpers.Ensure("pull", "--quiet", testutil.CommonImage)
+			helpers.Ensure("pull", "--quiet", testutil.NginxAlpineImage)
 		},
 		SubTests: []*test.Case{
 			{
@@ -127,7 +127,7 @@ func TestImagesFilter(t *testing.T) {
 		Description: "TestImagesFilter",
 		Require:     nerdtest.Build,
 		Setup: func(data test.Data, helpers test.Helpers) {
-			helpers.Ensure("pull", testutil.CommonImage)
+			helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 			helpers.Ensure("tag", testutil.CommonImage, "taggedimage:one-fragment-one")
 			helpers.Ensure("tag", testutil.CommonImage, "taggedimage:two-fragment-two")
 
diff --git a/cmd/nerdctl/image/image_load_test.go b/cmd/nerdctl/image/image_load_test.go
@@ -37,7 +37,7 @@ func TestLoadStdinFromPipe(t *testing.T) {
 		Description: "TestLoadStdinFromPipe",
 		Require:     test.Linux,
 		Setup: func(data test.Data, helpers test.Helpers) {
-			helpers.Ensure("pull", testutil.CommonImage)
+			helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 			helpers.Ensure("tag", testutil.CommonImage, data.Identifier())
 			helpers.Ensure("save", data.Identifier(), "-o", filepath.Join(data.TempDir(), "common.tar"))
 			helpers.Ensure("rmi", "-f", data.Identifier())
diff --git a/cmd/nerdctl/image/image_push_linux_test.go b/cmd/nerdctl/image/image_push_linux_test.go
@@ -64,7 +64,7 @@ func TestPush(t *testing.T) {
 			{
 				Description: "plain http",
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.CommonImage)
+					helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 					testImageRef := fmt.Sprintf("%s:%d/%s:%s",
 						registryNoAuthHTTPRandom.IP.String(), registryNoAuthHTTPRandom.Port, data.Identifier(), strings.Split(testutil.CommonImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
@@ -84,7 +84,7 @@ func TestPush(t *testing.T) {
 				Description: "plain http with insecure",
 				Require:     test.Not(nerdtest.Docker),
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.CommonImage)
+					helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 					testImageRef := fmt.Sprintf("%s:%d/%s:%s",
 						registryNoAuthHTTPRandom.IP.String(), registryNoAuthHTTPRandom.Port, data.Identifier(), strings.Split(testutil.CommonImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
@@ -103,7 +103,7 @@ func TestPush(t *testing.T) {
 			{
 				Description: "plain http with localhost",
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.CommonImage)
+					helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 					testImageRef := fmt.Sprintf("%s:%d/%s:%s",
 						"127.0.0.1", registryNoAuthHTTPRandom.Port, data.Identifier(), strings.Split(testutil.CommonImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
@@ -118,7 +118,7 @@ func TestPush(t *testing.T) {
 				Description: "plain http with insecure, default port",
 				Require:     test.Not(nerdtest.Docker),
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.CommonImage)
+					helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 					testImageRef := fmt.Sprintf("%s/%s:%s",
 						registryNoAuthHTTPDefault.IP.String(), data.Identifier(), strings.Split(testutil.CommonImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
@@ -138,7 +138,7 @@ func TestPush(t *testing.T) {
 				Description: "with insecure, with login",
 				Require:     test.Not(nerdtest.Docker),
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.CommonImage)
+					helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 					testImageRef := fmt.Sprintf("%s:%d/%s:%s",
 						registryTokenAuthHTTPSRandom.IP.String(), registryTokenAuthHTTPSRandom.Port, data.Identifier(), strings.Split(testutil.CommonImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
@@ -161,7 +161,7 @@ func TestPush(t *testing.T) {
 				Description: "with hosts dir, with login",
 				Require:     test.Not(nerdtest.Docker),
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.CommonImage)
+					helpers.Ensure("pull", "--quiet", testutil.CommonImage)
 					testImageRef := fmt.Sprintf("%s:%d/%s:%s",
 						registryTokenAuthHTTPSRandom.IP.String(), registryTokenAuthHTTPSRandom.Port, data.Identifier(), strings.Split(testutil.CommonImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
@@ -184,7 +184,7 @@ func TestPush(t *testing.T) {
 				Description: "non distributable artifacts",
 				Require:     test.Not(nerdtest.Docker),
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.NonDistBlobImage)
+					helpers.Ensure("pull", "--quiet", testutil.NonDistBlobImage)
 					testImageRef := fmt.Sprintf("%s:%d/%s:%s",
 						registryNoAuthHTTPRandom.IP.String(), registryNoAuthHTTPRandom.Port, data.Identifier(), strings.Split(testutil.NonDistBlobImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
@@ -216,7 +216,7 @@ func TestPush(t *testing.T) {
 				Description: "non distributable artifacts (with)",
 				Require:     test.Not(nerdtest.Docker),
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.NonDistBlobImage)
+					helpers.Ensure("pull", "--quiet", testutil.NonDistBlobImage)
 					testImageRef := fmt.Sprintf("%s:%d/%s:%s",
 						registryNoAuthHTTPRandom.IP.String(), registryNoAuthHTTPRandom.Port, data.Identifier(), strings.Split(testutil.NonDistBlobImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
@@ -251,7 +251,7 @@ func TestPush(t *testing.T) {
 					test.Not(nerdtest.Docker),
 				),
 				Setup: func(data test.Data, helpers test.Helpers) {
-					helpers.Ensure("pull", testutil.UbuntuImage)
+					helpers.Ensure("pull", "--quiet", testutil.UbuntuImage)
 					testImageRef := fmt.Sprintf("%s:%d/%s:%s",
 						registryNoAuthHTTPRandom.IP.String(), registryNoAuthHTTPRandom.Port, data.Identifier(), strings.Split(testutil.UbuntuImage, ":")[1])
 					data.Set("testImageRef", testImageRef)
diff --git a/cmd/nerdctl/image/image_remove_test.go b/cmd/nerdctl/image/image_remove_test.go
@@ -166,7 +166,7 @@ func TestRemove(t *testing.T) {
 			NoParallel:  true,
 			Require:     test.Not(test.Windows),
 			Setup: func(data test.Data, helpers test.Helpers) {
-				helpers.Ensure("pull", testutil.NginxAlpineImage)
+				helpers.Ensure("pull", "--quiet", testutil.NginxAlpineImage)
 				helpers.Ensure("create", "--pull", "always", "--name", data.Identifier(), testutil.CommonImage, "sleep", "infinity")
 				helpers.Ensure("rmi", testutil.NginxAlpineImage)
 			},
diff --git a/cmd/nerdctl/ipfs/ipfs_compose_linux_test.go b/cmd/nerdctl/ipfs/ipfs_compose_linux_test.go
@@ -71,7 +71,6 @@ func TestIPFSCompNoBuild(t *testing.T) {
 		if ipfsRegistry != nil {
 			ipfsRegistry.Cleanup(data, helpers)
 		}
-		// Speeding up repeat tests...
 		helpers.Anyhow("rmi", "-f", testutil.WordpressImage)
 		helpers.Anyhow("rmi", "-f", testutil.MariaDBImage)
 	}
@@ -91,13 +90,15 @@ func subtestTestIPFSCompNoB(t *testing.T, stargz bool, byAddr bool) *test.Case {
 
 	testCase.Description += "with"
 
-	if stargz {
-		testCase.Description += "-stargz"
+	if !stargz {
+		testCase.Description += "-no"
 	}
+	testCase.Description += "-stargz"
 
-	if byAddr {
-		testCase.Description += "-byAddr"
+	if !byAddr {
+		testCase.Description += "-no"
 	}
+	testCase.Description += "-byAddr"
 
 	if stargz {
 		testCase.Require = nerdtest.Stargz
diff --git a/cmd/nerdctl/ipfs/ipfs_registry_linux_test.go b/cmd/nerdctl/ipfs/ipfs_registry_linux_test.go
@@ -85,7 +85,7 @@ func TestIPFSNerdctlRegistry(t *testing.T) {
 			NoParallel:  true,
 			Setup: func(data test.Data, helpers test.Helpers) {
 				data.Set(ipfsImageURLKey, listenAddr+"/ipfs/"+pushToIPFS(helpers, testutil.AlpineImage))
-				helpers.Ensure("pull", data.Get(ipfsImageURLKey))
+				helpers.Ensure("pull", "--quiet", data.Get(ipfsImageURLKey))
 			},
 			Cleanup: func(data test.Data, helpers test.Helpers) {
 				if data.Get(ipfsImageURLKey) != "" {
@@ -103,7 +103,7 @@ func TestIPFSNerdctlRegistry(t *testing.T) {
 			Require:     nerdtest.Stargz,
 			Setup: func(data test.Data, helpers test.Helpers) {
 				data.Set(ipfsImageURLKey, listenAddr+"/ipfs/"+pushToIPFS(helpers, testutil.AlpineImage, "--estargz"))
-				helpers.Ensure("pull", data.Get(ipfsImageURLKey))
+				helpers.Ensure("pull", "--quiet", data.Get(ipfsImageURLKey))
 			},
 			Cleanup: func(data test.Data, helpers test.Helpers) {
 				if data.Get(ipfsImageURLKey) != "" {
diff --git a/cmd/nerdctl/network/network_remove_linux_test.go b/cmd/nerdctl/network/network_remove_linux_test.go
@@ -31,7 +31,7 @@ import (
 func TestNetworkRemove(t *testing.T) {
 	testCase := nerdtest.Setup()
 
-	testCase.Require = nerdtest.RootFul
+	testCase.Require = nerdtest.Rootful
 
 	testCase.SubTests = []*test.Case{
 		{
diff --git a/docs/testing/tools.md b/docs/testing/tools.md
@@ -385,7 +385,7 @@ nerdtest.Docker // a test only run on Docker - normally used with test.Not(nerdt
 nerdtest.Soci // a test requires the soci snapshotter
 nerdtest.Stargz // a test requires the stargz snapshotter
 nerdtest.Rootless // a test requires Rootless
-nerdtest.RootFul // a test requires Rootful
+nerdtest.Rootful // a test requires Rootful
 nerdtest.Build // a test requires buildkit
 nerdtest.CGroup // a test requires cgroup
 nerdtest.NerdctlNeedsFixing // indicates that a test cannot be run on nerdctl yet as a fix is required
diff --git a/pkg/testutil/nerdtest/requirements.go b/pkg/testutil/nerdtest/requirements.go
@@ -131,8 +131,8 @@ var BrokenTest = func(message string, req *test.Requirement) *test.Requirement {
 	}
 }
 
-// RootLess marks a test as suitable only for the rootless environment
-var RootLess = &test.Requirement{
+// Rootless marks a test as suitable only for the rootless environment
+var Rootless = &test.Requirement{
 	Check: func(data test.Data, helpers test.Helpers) (ret bool, mess string) {
 		// Make sure we DO not return "IsRootless true" for docker
 		ret = getTarget() == targetNerdctl && rootlessutil.IsRootless()
@@ -145,8 +145,8 @@ var RootLess = &test.Requirement{
 	},
 }
 
-// RootFul marks a test as suitable only for rootful env
-var RootFul = test.Not(RootLess)
+// Rootful marks a test as suitable only for rootful env
+var Rootful = test.Not(Rootless)
 
 // CGroup requires that cgroup is enabled
 var CGroup = &test.Requirement{

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ func TestImageHistory(t *testing.T) {`
`81`	`81`	`// https://github.com/containerd/nerdctl/issues/3512`
`82`	`82`	`// Isolating it into a completely different root is the last ditched attempt at avoiding the issue`
`83`	`83`	`helpers.Write(nerdtest.DataRoot, test.ConfigValue(data.TempDir()))`
`84`		`- helpers.Ensure("pull", "--platform", "linux/arm64", testutil.CommonImage)`
	`84`	`+ helpers.Ensure("pull", "--quiet", "--platform", "linux/arm64", testutil.CommonImage)`
`85`	`85`	`},`
`86`	`86`	`SubTests: []*test.Case{`
`87`	`87`	`{`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,6 @@ func TestIPFSCompNoBuild(t *testing.T) {`
`71`	`71`	`if ipfsRegistry != nil {`
`72`	`72`	`ipfsRegistry.Cleanup(data, helpers)`
`73`	`73`	`}`
`74`		`- // Speeding up repeat tests...`
`75`	`74`	`helpers.Anyhow("rmi", "-f", testutil.WordpressImage)`
`76`	`75`	`helpers.Anyhow("rmi", "-f", testutil.MariaDBImage)`
`77`	`76`	`}`
`@@ -91,13 +90,15 @@ func subtestTestIPFSCompNoB(t testing.T, stargz bool, byAddr bool) test.Case {`
`91`	`90`
`92`	`91`	`testCase.Description += "with"`
`93`	`92`
`94`		`- if stargz {`
`95`		`- testCase.Description += "-stargz"`
	`93`	`+ if !stargz {`
	`94`	`+ testCase.Description += "-no"`
`96`	`95`	`}`
	`96`	`+ testCase.Description += "-stargz"`
`97`	`97`
`98`		`- if byAddr {`
`99`		`- testCase.Description += "-byAddr"`
	`98`	`+ if !byAddr {`
	`99`	`+ testCase.Description += "-no"`
`100`	`100`	`}`
	`101`	`+ testCase.Description += "-byAddr"`
`101`	`102`
`102`	`103`	`if stargz {`
`103`	`104`	`testCase.Require = nerdtest.Stargz`