Fix: imgutil/local: Add a warning message when saving a local image and containerd storage is enable #284

local/local_test.go

@@ -27,6 +27,16 @@ const someSHA = "sha256:aec070645fe53ee3b3763059376134f058cc337247c978add178b6cc
 
 var localTestRegistry *h.DockerRegistry
 
+type TestLogger struct {
+	WarnCalled bool
+	Message    string
+}
+
+func (logger *TestLogger) Warn(msg string) {
+	logger.WarnCalled = true
+	logger.Message = msg
+}
+
 func TestLocal(t *testing.T) {
 	localTestRegistry = h.NewDockerRegistry()
 	localTestRegistry.Start(t)
@@ -2028,6 +2038,52 @@ func testImage(t *testing.T, when spec.G, it spec.S) {
 				h.AssertError(t, err, "daemon response")
 			})
 		})
+		when("logger is set", func() {
+			when("containerd is used", func() {
+				testLogger := &TestLogger{}
+				dockerClient := h.DockerCli(t)
+				imgName := "test-image"
+
+				img, err := local.NewImage(imgName, dockerClient, local.WithLogger(testLogger))
+				if err != nil {
+					t.Fatalf("Failed to create image: %v", err)
+				}
+				err = img.Save()
+				if err != nil {
+					t.Fatalf("Failed to save image: %v", err)
+				}
+
+				defer func() {
+					if err := h.DockerRmi(dockerClient, imgName); err != nil {
+						t.Errorf("Failed to remove image %s: %v", imgName, err)
+					}
+				}()
+
+				isContainerd := func(cli local.DockerClient) bool {
+					info, err := cli.Info(context.Background())
+					if err != nil {
+						return false
+					}
+					for _, driverStatus := range info.DriverStatus {
+						if driverStatus[0] == "driver-type" && driverStatus[1] == "io.containerd.snapshotter.v1" {
+							return true
+						}
+					}
+					return false
+				}(dockerClient)
+				if isContainerd {
+					if !testLogger.WarnCalled {
+						t.Error("Expected warning to be logged,but it was not.")
+						t.Errorf(testLogger.Message)
+					}
+				} else {
+					if testLogger.WarnCalled {
+						t.Error("did not expected warning to be logged,but it was.")
+						t.Errorf(testLogger.Message)
+					}
+				}
+			})
+		})
 	})
 
 	when("#SaveFile", func() {

local/new.go

@@ -47,7 +47,11 @@ func NewImage(repoName string, dockerClient DockerClient, ops ...imgutil.ImageOp
 		baseIdentifier = baseImage.identifier
 		store = baseImage.layerStore
 	} else {
-		store = NewStore(dockerClient)
+		if options.Logger != nil {
+			store = NewStore(dockerClient, WithStoreLogger(options.Logger))
+		} else {
+			store = NewStore(dockerClient)
+		}
 	}
 
 	cnbImage, err := imgutil.NewCNBImage(*options)

local/options.go

@@ -38,3 +38,15 @@ func WithMediaTypes(m imgutil.MediaTypes) func(*imgutil.ImageOptions) {
 func WithPreviousImage(name string) func(*imgutil.ImageOptions) {
 	return imgutil.WithPreviousImage(name)
 }
+
+func WithLogger(logger imgutil.Logger) func(*imgutil.ImageOptions) {
+	return imgutil.WithLogger(logger)
+}
+
+type StoreOption func(*Store)
+
+func WithStoreLogger(logger imgutil.Logger) StoreOption {
+	return func(s *Store) {
+		s.Logger = logger
+	}
+}

local/store.go

@@ -34,6 +34,7 @@
 	// optional
 	downloadOnce         *sync.Once
 	onDiskLayersByDiffID map[v1.Hash]annotatedLayer
+	Logger               imgutil.Logger
 }
 
 // DockerClient is subset of client.CommonAPIClient required by this package.
@@ -53,12 +54,18 @@
 	uncompressedSize int64
 }
 
-func NewStore(dockerClient DockerClient) *Store {
-	return &Store{
+func NewStore(dockerClient DockerClient, ops ...StoreOption) *Store {
+	store := &Store{
 		dockerClient:         dockerClient,
 		downloadOnce:         &sync.Once{},
 		onDiskLayersByDiffID: make(map[v1.Hash]annotatedLayer),
+		Logger:               nil,
 	}
+	for _, op := range ops {
+		op(store)
+	}
+
+	return store
 }
 
 // images
@@ -95,10 +102,13 @@
 		inspect, err = s.doSave(image, withName)
 	}
 	if !canOmitBaseLayers || err != nil {
+		if s.Logger != nil && !canOmitBaseLayers {
+			s.Logger.Warn("Containerd is enabled, which will make saving your work more expensive.")
+		}
 		if err = image.ensureLayers(); err != nil {
 			return "", err
 		}
 		inspect, err = s.doSave(image, withName)
 		if err != nil {
 			saveErr := imgutil.SaveError{}
 			for _, n := range append([]string{withName}, withAdditionalNames...) {

options.go

@@ -17,6 +17,7 @@ type ImageOptions struct {
 	BaseImageRepoName     string
 	PreviousImageRepoName string
 	Config                *v1.Config
+	Logger                Logger
 	CreatedAt             time.Time
 	MediaTypes            MediaTypes
 	Platform              Platform
@@ -43,6 +44,10 @@ type RegistrySetting struct {
 	Insecure bool
 }
 
+type Logger interface {
+	Warn(msg string)
+}
+
 // FromBaseImage loads the provided image as the manifest, config, and layers for the working image.
 // If the image is not found, it does nothing.
 func FromBaseImage(name string) func(*ImageOptions) {
@@ -99,6 +104,13 @@ func WithPreviousImage(name string) func(*ImageOptions) {
 	}
 }
 
+// WithLogger if provided will check if contained is used.
+func WithLogger(logger Logger) func(*ImageOptions) {
+	return func(o *ImageOptions) {
+		o.Logger = logger
+	}
+}
+
 type IndexOption func(options *IndexOptions) error
 
 type IndexOptions struct {