Merge pull request containerd#8355 from Jenkins-J/move-DefaultSnapshotter

mxpv · web-flow · commit 4dcfd5bf6eba · 2024-01-12T22:18:33.000Z
Move DefaultSnapshotter constants
diff --git a/client/client.go b/client/client.go
@@ -626,7 +626,7 @@ func (c *Client) ContentStore() content.Store {
 func (c *Client) SnapshotService(snapshotterName string) snapshots.Snapshotter {
 	snapshotterName, err := c.resolveSnapshotterName(context.Background(), snapshotterName)
 	if err != nil {
-		snapshotterName = DefaultSnapshotter
+		snapshotterName = defaults.DefaultSnapshotter
 	}
 	if c.snapshotters != nil {
 		return c.snapshotters[snapshotterName]
@@ -801,7 +801,7 @@ func (c *Client) resolveSnapshotterName(ctx context.Context, name string) (strin
 		if label != "" {
 			name = label
 		} else {
-			name = DefaultSnapshotter
+			name = defaults.DefaultSnapshotter
 		}
 	}
 
diff --git a/cmd/ctr/commands/images/mount.go b/cmd/ctr/commands/images/mount.go
@@ -22,6 +22,7 @@ import (
 
 	containerd "github.com/containerd/containerd/v2/client"
 	"github.com/containerd/containerd/v2/cmd/ctr/commands"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/errdefs"
 	"github.com/containerd/containerd/v2/leases"
 	"github.com/containerd/containerd/v2/mount"
@@ -69,7 +70,7 @@ When you are done, use the unmount command.
 
 		snapshotter := context.String("snapshotter")
 		if snapshotter == "" {
-			snapshotter = containerd.DefaultSnapshotter
+			snapshotter = defaults.DefaultSnapshotter
 		}
 
 		ctx, done, err := client.WithLease(ctx,
diff --git a/cmd/ctr/commands/images/usage.go b/cmd/ctr/commands/images/usage.go
@@ -23,6 +23,7 @@ import (
 
 	containerd "github.com/containerd/containerd/v2/client"
 	"github.com/containerd/containerd/v2/cmd/ctr/commands"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/pkg/progress"
 
 	"github.com/opencontainers/image-spec/identity"
@@ -48,7 +49,7 @@ var usageCommand = cli.Command{
 
 		snapshotter := context.String("snapshotter")
 		if snapshotter == "" {
-			snapshotter = containerd.DefaultSnapshotter
+			snapshotter = defaults.DefaultSnapshotter
 		}
 
 		img, err := client.ImageService().Get(ctx, ref)
diff --git a/defaults/defaults_snapshotter_linux.go b/defaults/defaults_snapshotter_linux.go
@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-package client
+package defaults
 
 const (
 	// DefaultSnapshotter will set the default snapshotter for the platform.
diff --git a/defaults/defaults_snapshotter_unix.go b/defaults/defaults_snapshotter_unix.go
@@ -16,7 +16,7 @@
    limitations under the License.
 */
 
-package client
+package defaults
 
 const (
 	// DefaultSnapshotter will set the default snapshotter for the platform.
diff --git a/defaults/defaults_snapshotter_windows.go b/defaults/defaults_snapshotter_windows.go
@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-package client
+package defaults
 
 const (
 	// DefaultSnapshotter will set the default snapshotter for the platform.
diff --git a/integration/client/client.go b/integration/client/client.go
@@ -23,7 +23,6 @@ import (
 	"os"
 	"testing"
 
-	containerd "github.com/containerd/containerd/v2/client"
 	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/namespaces"
 	"github.com/containerd/log/logtest"
@@ -37,7 +36,7 @@ const (
 var (
 	address           string
 	ctrdStdioFilePath string
-	testSnapshotter   = containerd.DefaultSnapshotter
+	testSnapshotter   = defaults.DefaultSnapshotter
 	ctrd              = &daemon{}
 )
 
diff --git a/integration/client/client_test.go b/integration/client/client_test.go
@@ -129,7 +129,7 @@ func TestMain(m *testing.M) {
 		"snapshotter": os.Getenv("TEST_SNAPSHOTTER"),
 	}).Info("running tests against containerd")
 
-	snapshotter := DefaultSnapshotter
+	snapshotter := defaults.DefaultSnapshotter
 	if ss := os.Getenv("TEST_SNAPSHOTTER"); ss != "" {
 		snapshotter = ss
 	}
diff --git a/integration/client/image_test.go b/integration/client/image_test.go
@@ -24,6 +24,7 @@ import (
 	"testing"
 
 	. "github.com/containerd/containerd/v2/client"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/errdefs"
 	"github.com/containerd/containerd/v2/images"
 	imagelist "github.com/containerd/containerd/v2/integration/images"
@@ -57,7 +58,7 @@ func TestImageIsUnpacked(t *testing.T) {
 	}
 
 	// Check that image is not unpacked
-	unpacked, err := image.IsUnpacked(ctx, DefaultSnapshotter)
+	unpacked, err := image.IsUnpacked(ctx, defaults.DefaultSnapshotter)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -66,11 +67,11 @@ func TestImageIsUnpacked(t *testing.T) {
 	}
 
 	// Check that image is unpacked
-	err = image.Unpack(ctx, DefaultSnapshotter)
+	err = image.Unpack(ctx, defaults.DefaultSnapshotter)
 	if err != nil {
 		t.Fatal(err)
 	}
-	unpacked, err = image.IsUnpacked(ctx, DefaultSnapshotter)
+	unpacked, err = image.IsUnpacked(ctx, defaults.DefaultSnapshotter)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -218,7 +219,7 @@ func TestImageUsage(t *testing.T) {
 		t.Fatalf("Expected actual usage to equal manifest reported usage of %d: got %d", s3, s)
 	}
 
-	err = image.Unpack(ctx, DefaultSnapshotter)
+	err = image.Unpack(ctx, defaults.DefaultSnapshotter)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -256,12 +257,12 @@ func TestImageSupportedBySnapshotter_Error(t *testing.T) {
 	_, err = client.Pull(ctx, unsupportedImage,
 		WithSchema1Conversion,
 		WithPlatform(platforms.DefaultString()),
-		WithPullSnapshotter(DefaultSnapshotter),
+		WithPullSnapshotter(defaults.DefaultSnapshotter),
 		WithPullUnpack,
 		WithUnpackOpts([]UnpackOpt{WithSnapshotterPlatformCheck()}),
 	)
 
 	if err == nil {
-		t.Fatalf("expected unpacking %s for snapshotter %s to fail", unsupportedImage, DefaultSnapshotter)
+		t.Fatalf("expected unpacking %s for snapshotter %s to fail", unsupportedImage, defaults.DefaultSnapshotter)
 	}
 }
diff --git a/integration/client/snapshot_test.go b/integration/client/snapshot_test.go
@@ -21,6 +21,7 @@ import (
 	"testing"
 
 	. "github.com/containerd/containerd/v2/client"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/snapshots"
 	"github.com/containerd/containerd/v2/snapshots/testsuite"
 )
@@ -31,7 +32,7 @@ func newSnapshotter(ctx context.Context, root string) (snapshots.Snapshotter, fu
 		return nil, nil, err
 	}
 
-	sn := client.SnapshotService(DefaultSnapshotter)
+	sn := client.SnapshotService(defaults.DefaultSnapshotter)
 
 	return sn, func() error {
 		// no need to close remote snapshotter
@@ -44,5 +45,5 @@ func TestSnapshotterClient(t *testing.T) {
 		t.Skip()
 	}
 
-	testsuite.SnapshotterSuite(t, DefaultSnapshotter, newSnapshotter)
+	testsuite.SnapshotterSuite(t, defaults.DefaultSnapshotter, newSnapshotter)
 }
diff --git a/integration/image_pull_timeout_test.go b/integration/image_pull_timeout_test.go
@@ -40,6 +40,7 @@ import (
 
 	containerd "github.com/containerd/containerd/v2/client"
 	"github.com/containerd/containerd/v2/content"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/leases"
 	"github.com/containerd/containerd/v2/namespaces"
 	criconfig "github.com/containerd/containerd/v2/pkg/cri/config"
@@ -476,15 +477,15 @@ func initLocalCRIImageService(client *containerd.Client, tmpDir string, registry
 	containerdRootDir := filepath.Join(tmpDir, "root")
 
 	cfg := criconfig.ImageConfig{
-		Snapshotter:              containerd.DefaultSnapshotter,
+		Snapshotter:              defaults.DefaultSnapshotter,
 		Registry:                 registryCfg,
 		ImagePullProgressTimeout: defaultImagePullProgressTimeout.String(),
 		StatsCollectPeriod:       10,
 	}
 
 	return images.NewService(cfg, &images.CRIImageServiceOptions{
 		ImageFSPaths: map[string]string{
-			containerd.DefaultSnapshotter: containerdRootDir,
+			defaults.DefaultSnapshotter: containerdRootDir,
 		},
 		RuntimePlatforms: map[string]images.ImagePlatform{},
 		Content:          client.ContentStore(),
diff --git a/pkg/cri/config/config_unix.go b/pkg/cri/config/config_unix.go
@@ -19,14 +19,14 @@
 package config
 
 import (
-	containerd "github.com/containerd/containerd/v2/client"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/pelletier/go-toml/v2"
 	"k8s.io/kubelet/pkg/cri/streaming"
 )
 
 func DefaultImageConfig() ImageConfig {
 	return ImageConfig{
-		Snapshotter:                containerd.DefaultSnapshotter,
+		Snapshotter:                defaults.DefaultSnapshotter,
 		DisableSnapshotAnnotations: true,
 		MaxConcurrentDownloads:     3,
 		ImageDecryption: ImageDecryption{
diff --git a/pkg/cri/config/config_windows.go b/pkg/cri/config/config_windows.go
@@ -20,13 +20,13 @@ import (
 	"os"
 	"path/filepath"
 
-	containerd "github.com/containerd/containerd/v2/client"
+	"github.com/containerd/containerd/v2/defaults"
 	"k8s.io/kubelet/pkg/cri/streaming"
 )
 
 func DefaultImageConfig() ImageConfig {
 	return ImageConfig{
-		Snapshotter:            containerd.DefaultSnapshotter,
+		Snapshotter:            defaults.DefaultSnapshotter,
 		StatsCollectPeriod:     10,
 		MaxConcurrentDownloads: 3,
 		ImageDecryption: ImageDecryption{
diff --git a/pkg/transfer/local/pull.go b/pkg/transfer/local/pull.go
@@ -20,8 +20,8 @@ import (
 	"context"
 	"fmt"
 
-	containerd "github.com/containerd/containerd/v2/client"
 	"github.com/containerd/containerd/v2/content"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/errdefs"
 	"github.com/containerd/containerd/v2/images"
 	"github.com/containerd/containerd/v2/pkg/transfer"
@@ -286,7 +286,7 @@ func getSupportedPlatform(uc transfer.UnpackConfiguration, supportedPlatforms []
 			// Assume sp.SnapshotterKey is not empty
 			if uc.Snapshotter == sp.SnapshotterKey {
 				return true, sp
-			} else if uc.Snapshotter == "" && sp.SnapshotterKey == containerd.DefaultSnapshotter {
+			} else if uc.Snapshotter == "" && sp.SnapshotterKey == defaults.DefaultSnapshotter {
 				return true, sp
 			}
 		}
diff --git a/pkg/transfer/local/pull_test.go b/pkg/transfer/local/pull_test.go
@@ -19,7 +19,7 @@ package local
 import (
 	"testing"
 
-	containerd "github.com/containerd/containerd/v2/client"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/pkg/transfer"
 	"github.com/containerd/containerd/v2/pkg/unpack"
 	"github.com/containerd/containerd/v2/platforms"
@@ -45,7 +45,7 @@ func TestGetSupportedPlatform(t *testing.T) {
 		},
 		{
 			Platform:       platforms.DefaultStrict(),
-			SnapshotterKey: containerd.DefaultSnapshotter,
+			SnapshotterKey: defaults.DefaultSnapshotter,
 		},
 	}
 
@@ -116,7 +116,7 @@ func TestGetSupportedPlatform(t *testing.T) {
 			Match:              true,
 			ExpectedPlatform: transfer.UnpackConfiguration{
 				Platform:    platforms.DefaultSpec(),
-				Snapshotter: containerd.DefaultSnapshotter,
+				Snapshotter: defaults.DefaultSnapshotter,
 			},
 		},
 	} {
diff --git a/plugins/transfer/plugin.go b/plugins/transfer/plugin.go
@@ -19,7 +19,7 @@ package transfer
 import (
 	"fmt"
 
-	containerd "github.com/containerd/containerd/v2/client"
+	"github.com/containerd/containerd/v2/defaults"
 	"github.com/containerd/containerd/v2/diff"
 	"github.com/containerd/containerd/v2/errdefs"
 	"github.com/containerd/containerd/v2/leases"
@@ -172,7 +172,7 @@ func defaultConfig() *transferConfig {
 		UnpackConfiguration: []unpackConfiguration{
 			{
 				Platform:    platforms.Format(platforms.DefaultSpec()),
-				Snapshotter: containerd.DefaultSnapshotter,
+				Snapshotter: defaults.DefaultSnapshotter,
 			},
 		},
 	}

Original file line number	Diff line number	Diff line change
`@@ -626,7 +626,7 @@ func (c *Client) ContentStore() content.Store {`
`626`	`626`	`func (c *Client) SnapshotService(snapshotterName string) snapshots.Snapshotter {`
`627`	`627`	`snapshotterName, err := c.resolveSnapshotterName(context.Background(), snapshotterName)`
`628`	`628`	`if err != nil {`
`629`		`- snapshotterName = DefaultSnapshotter`
	`629`	`+ snapshotterName = defaults.DefaultSnapshotter`
`630`	`630`	`}`
`631`	`631`	`if c.snapshotters != nil {`
`632`	`632`	`return c.snapshotters[snapshotterName]`
`@@ -801,7 +801,7 @@ func (c *Client) resolveSnapshotterName(ctx context.Context, name string) (strin`
`801`	`801`	`if label != "" {`
`802`	`802`	`name = label`
`803`	`803`	`} else {`
`804`		`- name = DefaultSnapshotter`
	`804`	`+ name = defaults.DefaultSnapshotter`
`805`	`805`	`}`
`806`	`806`	`}`
`807`	`807`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ func TestMain(m *testing.M) {`
`129`	`129`	`"snapshotter": os.Getenv("TEST_SNAPSHOTTER"),`
`130`	`130`	`}).Info("running tests against containerd")`
`131`	`131`
`132`		`- snapshotter := DefaultSnapshotter`
	`132`	`+ snapshotter := defaults.DefaultSnapshotter`
`133`	`133`	`if ss := os.Getenv("TEST_SNAPSHOTTER"); ss != "" {`
`134`	`134`	`snapshotter = ss`
`135`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ import (`
`24`	`24`	`"testing"`
`25`	`25`
`26`	`26`	`. "github.com/containerd/containerd/v2/client"`
	`27`	`+ "github.com/containerd/containerd/v2/defaults"`
`27`	`28`	`"github.com/containerd/containerd/v2/errdefs"`
`28`	`29`	`"github.com/containerd/containerd/v2/images"`
`29`	`30`	`imagelist "github.com/containerd/containerd/v2/integration/images"`
`@@ -57,7 +58,7 @@ func TestImageIsUnpacked(t *testing.T) {`
`57`	`58`	`}`
`58`	`59`
`59`	`60`	`// Check that image is not unpacked`
`60`		`- unpacked, err := image.IsUnpacked(ctx, DefaultSnapshotter)`
	`61`	`+ unpacked, err := image.IsUnpacked(ctx, defaults.DefaultSnapshotter)`
`61`	`62`	`if err != nil {`
`62`	`63`	`t.Fatal(err)`
`63`	`64`	`}`
`@@ -66,11 +67,11 @@ func TestImageIsUnpacked(t *testing.T) {`
`66`	`67`	`}`
`67`	`68`
`68`	`69`	`// Check that image is unpacked`
`69`		`- err = image.Unpack(ctx, DefaultSnapshotter)`
	`70`	`+ err = image.Unpack(ctx, defaults.DefaultSnapshotter)`
`70`	`71`	`if err != nil {`
`71`	`72`	`t.Fatal(err)`
`72`	`73`	`}`
`73`		`- unpacked, err = image.IsUnpacked(ctx, DefaultSnapshotter)`
	`74`	`+ unpacked, err = image.IsUnpacked(ctx, defaults.DefaultSnapshotter)`
`74`	`75`	`if err != nil {`
`75`	`76`	`t.Fatal(err)`
`76`	`77`	`}`
`@@ -218,7 +219,7 @@ func TestImageUsage(t *testing.T) {`
`218`	`219`	`t.Fatalf("Expected actual usage to equal manifest reported usage of %d: got %d", s3, s)`
`219`	`220`	`}`
`220`	`221`
`221`		`- err = image.Unpack(ctx, DefaultSnapshotter)`
	`222`	`+ err = image.Unpack(ctx, defaults.DefaultSnapshotter)`
`222`	`223`	`if err != nil {`
`223`	`224`	`t.Fatal(err)`
`224`	`225`	`}`
`@@ -256,12 +257,12 @@ func TestImageSupportedBySnapshotter_Error(t *testing.T) {`
`256`	`257`	`_, err = client.Pull(ctx, unsupportedImage,`
`257`	`258`	`WithSchema1Conversion,`
`258`	`259`	`WithPlatform(platforms.DefaultString()),`
`259`		`- WithPullSnapshotter(DefaultSnapshotter),`
	`260`	`+ WithPullSnapshotter(defaults.DefaultSnapshotter),`
`260`	`261`	`WithPullUnpack,`
`261`	`262`	`WithUnpackOpts([]UnpackOpt{WithSnapshotterPlatformCheck()}),`
`262`	`263`	`)`
`263`	`264`
`264`	`265`	`if err == nil {`
`265`		`- t.Fatalf("expected unpacking %s for snapshotter %s to fail", unsupportedImage, DefaultSnapshotter)`
	`266`	`+ t.Fatalf("expected unpacking %s for snapshotter %s to fail", unsupportedImage, defaults.DefaultSnapshotter)`
`266`	`267`	`}`
`267`	`268`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ import (`
`21`	`21`	`"testing"`
`22`	`22`
`23`	`23`	`. "github.com/containerd/containerd/v2/client"`
	`24`	`+ "github.com/containerd/containerd/v2/defaults"`
`24`	`25`	`"github.com/containerd/containerd/v2/snapshots"`
`25`	`26`	`"github.com/containerd/containerd/v2/snapshots/testsuite"`
`26`	`27`	`)`
`@@ -31,7 +32,7 @@ func newSnapshotter(ctx context.Context, root string) (snapshots.Snapshotter, fu`
`31`	`32`	`return nil, nil, err`
`32`	`33`	`}`
`33`	`34`
`34`		`- sn := client.SnapshotService(DefaultSnapshotter)`
	`35`	`+ sn := client.SnapshotService(defaults.DefaultSnapshotter)`
`35`	`36`
`36`	`37`	`return sn, func() error {`
`37`	`38`	`// no need to close remote snapshotter`
`@@ -44,5 +45,5 @@ func TestSnapshotterClient(t *testing.T) {`
`44`	`45`	`t.Skip()`
`45`	`46`	`}`
`46`	`47`
`47`		`- testsuite.SnapshotterSuite(t, DefaultSnapshotter, newSnapshotter)`
	`48`	`+ testsuite.SnapshotterSuite(t, defaults.DefaultSnapshotter, newSnapshotter)`
`48`	`49`	`}`