#14: --remove-image option (#15)

#14: --remove-image option

Author: iignatevich

pkg/action/env.container.go

@@ -29,6 +29,7 @@ const (
 
 	// Environment specific flags.
 	containerFlagUseVolumeWD = "use-volume-wd"
+	containerFlagRemoveImage = "remove-image"
 )
 
 type containerEnv struct {
@@ -38,7 +39,8 @@ type containerEnv struct {
 	nameprv ContainerNameProvider
 
 	// Runtime flags
-	useVolWD bool
+	useVolWD  bool
+	removeImg bool
 }
 
 // ContainerNameProvider provides an ability to generate a random container name
@@ -77,13 +79,25 @@ func (c *containerEnv) FlagsDefinition() OptionsList {
 			Type:        jsonschema.Boolean,
 			Default:     false,
 		},
+		&Option{
+			Name:        containerFlagRemoveImage,
+			Title:       "Remove Image",
+			Description: "Remove an image after execution of action",
+			Type:        jsonschema.Boolean,
+			Default:     false,
+		},
 	}
 }
 
 func (c *containerEnv) UseFlags(flags TypeOpts) error {
 	if v, ok := flags[containerFlagUseVolumeWD]; ok {
 		c.useVolWD = v.(bool)
 	}
+
+	if v, ok := flags[containerFlagRemoveImage]; ok {
+		c.removeImg = v.(bool)
+	}
+
 	return nil
 }
 
@@ -224,6 +238,16 @@ func (c *containerEnv) Execute(ctx context.Context, a *Action) (err error) {
 			return err
 		}
 	}
+
+	if c.removeImg {
+		err = c.imageRemove(ctx, a)
+		if err != nil {
+			log.Err("Image remove returned an error: %v", err)
+		} else {
+			cli.Println("Image %q was successfully removed", a.ActionDef().Image)
+		}
+	}
+
 	return nil
 }
 
@@ -245,6 +269,15 @@ func (c *containerEnv) Close() error {
 	return c.driver.Close()
 }
 
+func (c *containerEnv) imageRemove(ctx context.Context, a *Action) error {
+	_, err := c.driver.ImageRemove(ctx, a.ActionDef().Image, types.ImageRemoveOptions{
+		Force:         false,
+		PruneChildren: false,
+	})
+
+	return err
+}
+
 func (c *containerEnv) imageEnsure(ctx context.Context, a *Action) error {
 	streams := a.GetInput().IO
 	image := a.ActionDef().Image

pkg/action/env.container_test.go

@@ -199,6 +199,70 @@ func Test_ContainerExec_imageEnsure(t *testing.T) {
 	}
 }
 
+func Test_ContainerExec_imageRemove(t *testing.T) {
+	t.Parallel()
+
+	actLoc := testContainerAction(&DefAction{
+		Image: "build:local",
+		Build: &types.BuildDefinition{
+			Context: ".",
+		},
+	})
+	err := actLoc.EnsureLoaded()
+	assert.NoError(t, err)
+	type testCase struct {
+		name     string
+		action   *DefAction
+		expBuild *types.BuildDefinition
+		ret      []interface{}
+	}
+
+	tts := []testCase{
+		{
+			"image removed",
+			actLoc.ActionDef(),
+			nil,
+			[]interface{}{&types.ImageRemoveResponse{Status: types.ImageRemoved}, nil},
+		},
+		{
+			"failed to remove",
+			&DefAction{Image: "failed"},
+			nil,
+			[]interface{}{nil, fmt.Errorf("failed to remove")},
+		},
+	}
+
+	for _, tt := range tts {
+		tt := tt
+
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			assert, ctrl, d, r := prepareContainerTestSuite(t)
+			ctx := context.Background()
+
+			defer ctrl.Finish()
+			defer r.driver.Close()
+
+			act := testContainerAction(tt.action)
+			act.input = Input{
+				IO: cli.NoopStreams(),
+			}
+
+			err := act.EnsureLoaded()
+			assert.NoError(err)
+
+			a := act.ActionDef()
+			imgOpts := types.ImageRemoveOptions{Force: false, PruneChildren: false}
+			d.EXPECT().
+				ImageRemove(ctx, a.Image, gomock.Eq(imgOpts)).
+				Return(tt.ret...)
+			err = r.imageRemove(ctx, act)
+
+			assert.Equal(err, tt.ret[1])
+		})
+	}
+}
+
 func Test_ContainerExec_containerCreate(t *testing.T) {
 	t.Parallel()
 	assert, ctrl, d, r := prepareContainerTestSuite(t)
@@ -678,6 +742,10 @@ func callContainerDriverMockFn(d *mockdriver.MockContainerRunner, step mockCallI
 		call = d.EXPECT().
 			ContainerStart(gomock.Any(), step.args[0], step.args[1]).
 			Return(step.ret...)
+	case "ImageRemove":
+		call = d.EXPECT().
+			ImageRemove(gomock.Any(), step.args[0], step.args[1]).
+			Return(step.ret...)
 	}
 	if step.minTimes > 1 {
 		call.MinTimes(step.minTimes)

pkg/action/loader.go

@@ -193,7 +193,7 @@ func (p inputProcessor) Process(ctx LoadContext, b []byte) ([]byte, error) {
 			}
 		}
 		if hasDash && strings.Contains(err.Error(), "bad character U+002D '-'") {
-			return nil, fmt.Errorf(`Unexpected '-' symbol in a template variable. 
+			return nil, fmt.Errorf(`unexpected '-' symbol in a template variable. 
 Action definition is correct, but dashes are not allowed in templates, replace "-" with "_" in {{ }} blocks`)
 		}
 		return nil, err

pkg/action/loader_test.go

@@ -56,7 +56,7 @@ func Test_InputProcessor(t *testing.T) {
 
 	s = "{{ .opt-str }}"
 	res, err = proc.Process(ctx, []byte(s))
-	assert.ErrorContains(t, err, "Unexpected '-' symbol in a template variable.")
+	assert.ErrorContains(t, err, "unexpected '-' symbol in a template variable.")
 	assert.Equal(t, "", string(res))
 
 	s = "{{ .arg2 }},{{ .optUnd }}"

pkg/driver/docker.go

@@ -86,6 +86,16 @@ func (d *dockerDriver) ImageEnsure(ctx context.Context, image types.ImageOptions
 	return &types.ImageStatusResponse{Status: types.ImagePull, Progress: reader}, nil
 }
 
+func (d *dockerDriver) ImageRemove(ctx context.Context, image string, options types.ImageRemoveOptions) (*types.ImageRemoveResponse, error) {
+	_, err := d.cli.ImageRemove(ctx, image, dockertypes.ImageRemoveOptions(options))
+
+	if err != nil {
+		return nil, err
+	}
+
+	return &types.ImageRemoveResponse{Status: types.ImageRemoved}, nil
+}
+
 func (d *dockerDriver) CopyToContainer(ctx context.Context, cid string, path string, content io.Reader, opts types.CopyToContainerOptions) error {
 	return d.cli.CopyToContainer(ctx, cid, path, content, dockertypes.CopyToContainerOptions(opts))
 }

pkg/driver/driver.go

@@ -13,6 +13,7 @@ import (
 // ContainerRunner defines common interface for container environments.
 type ContainerRunner interface {
 	ImageEnsure(ctx context.Context, opts types.ImageOptions) (*types.ImageStatusResponse, error)
+	ImageRemove(ctx context.Context, image string, opts types.ImageRemoveOptions) (*types.ImageRemoveResponse, error)
 	CopyToContainer(ctx context.Context, cid string, path string, content io.Reader, opts types.CopyToContainerOptions) error
 	CopyFromContainer(ctx context.Context, cid, srcPath string) (io.ReadCloser, types.ContainerPathStat, error)
 	ContainerStatPath(ctx context.Context, cid string, path string) (types.ContainerPathStat, error)

pkg/driver/mocks/driver.go

@@ -62,6 +62,9 @@ type ImageOptions struct {
 	Build *BuildDefinition
 }
 
+// ImageRemoveOptions stores options for removing an image.
+type ImageRemoveOptions = types.ImageRemoveOptions
+
 // ImageStatus defines image status on local machine.
 type ImageStatus int64
 
@@ -70,6 +73,7 @@ const (
 	ImageUnexpectedError                    // ImageUnexpectedError - image can't be pulled or retrieved.
 	ImagePull                               // ImagePull - image is being pulled from the registry.
 	ImageBuild                              // ImageBuild - image is being built.
+	ImageRemoved                            // ImageRemoved - image was removed
 )
 
 // ContainerListOptions stores options to request container list.
@@ -90,6 +94,11 @@ type ImageStatusResponse struct {
 	Progress io.ReadCloser
 }
 
+// ImageRemoveResponse stores response when removing the image.
+type ImageRemoveResponse struct {
+	Status ImageStatus
+}
+
 // ContainerPathStat is a type alias for container path stat result.
 type ContainerPathStat = types.ContainerPathStat