create-build-tag: added --build-tag option

tags the built image of --build by forwarding the value to --tag of
podman build

added a test case with and without a repository
registry.fedoraproject.org was choosen as repository because podman doesn't
let one chose arbitrarily

Signed-off-by: Kilian Hanich <[email protected]>

Author: KilianHanich

src/cmd/create.go

@@ -55,6 +55,7 @@ var (
 		image     string
 		release   string
 		build     string
+		buildtag  string
 	}
 
 	createToolboxShMounts = []struct {
@@ -111,6 +112,12 @@ func init() {
 		"",
 		"Build a Toolbx container for use of this container")
 
+	flags.StringVarP(&createFlags.buildtag,
+		"build-tag",
+		"t",
+		"",
+		"Tag the image built")
+
 	createCmd.SetHelpFunc(createHelp)
 
 	if err := createCmd.RegisterFlagCompletionFunc("distro", completionDistroNames); err != nil {
@@ -166,6 +173,15 @@ func create(cmd *cobra.Command, args []string) error {
 		return errors.New(errMsg)
 	}
 
+	if cmd.Flag("build-tag").Changed && !cmd.Flag("build").Changed {
+		var builder strings.Builder
+		fmt.Fprintf(&builder, "--build-tag must be used together with --build\n")
+		fmt.Fprintf(&builder, "Run '%s --help' for usage.", executableBase)
+
+		errMsg := builder.String()
+		return errors.New(errMsg)
+	}
+
 	if cmd.Flag("authfile").Changed {
 		if !utils.PathExists(createFlags.authFile) {
 			var builder strings.Builder
@@ -194,7 +210,7 @@ func create(cmd *cobra.Command, args []string) error {
 		createFlags.distro,
 		createFlags.image,
 		createFlags.release,
-		createFlags.build)
+		podman.BuildOptions{Context: createFlags.build, Tag: createFlags.buildtag})
 
 	if err != nil {
 		return err

src/cmd/enter.go

@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/containers/toolbox/pkg/podman"
 	"github.com/containers/toolbox/pkg/utils"
 	"github.com/spf13/cobra"
 )
@@ -112,7 +113,7 @@ func enter(cmd *cobra.Command, args []string) error {
 		enterFlags.distro,
 		"",
 		enterFlags.release,
-		"")
+		podman.BuildOptions{Context: "", Tag: ""})
 
 	if err != nil {
 		return err

src/cmd/run.go

@@ -148,7 +148,7 @@ func run(cmd *cobra.Command, args []string) error {
 		runFlags.distro,
 		"",
 		runFlags.release,
-		"")
+		podman.BuildOptions{Context: "", Tag: ""})
 
 	if err != nil {
 		return err

src/cmd/utils.go

@@ -403,12 +403,12 @@ func poll(pollFn pollFunc, eventFD int32, fds ...int32) error {
 	}
 }
 
-func resolveContainerAndImageNames(container, containerArg, distroCLI, imageCLI, releaseCLI, buildCLI string) (
+func resolveContainerAndImageNames(container, containerArg, distroCLI, imageCLI, releaseCLI string, buildCLI podman.BuildOptions) (
 	string, string, string, error,
 ) {
 	var image, release string
 	var err error
-	if buildCLI == "" {
+	if buildCLI.Context == "" {
 		container, image, release, err = utils.ResolveContainerAndImageNames(container,
 			distroCLI,
 			imageCLI,

src/pkg/podman/podman.go

@@ -41,6 +41,11 @@ type Image struct {
 	Names   []string
 }
 
+type BuildOptions struct {
+	Context string
+	Tag     string
+}
+
 type ImageSlice []Image
 
 var (
@@ -137,22 +142,25 @@ func (images ImageSlice) Swap(i, j int) {
 	images[i], images[j] = images[j], images[i]
 }
 
-func BuildImage(buildContext string) (string, error) {
-	if !utils.PathExists(buildContext) {
-		return "", &utils.BuildError{BuildContext: buildContext, Err: ErrBuildContextDoesNotExist}
+func BuildImage(build BuildOptions) (string, error) {
+	if !utils.PathExists(build.Context) {
+		return "", &utils.BuildError{BuildContext: build.Context, Err: ErrBuildContextDoesNotExist}
 	}
-	if stat, err := os.Stat(buildContext); err != nil {
+	if stat, err := os.Stat(build.Context); err != nil {
 		return "", err
 	} else {
 		if !stat.Mode().IsDir() {
-			return "", &utils.BuildError{BuildContext: buildContext, Err: ErrBuildContextInvalid}
+			return "", &utils.BuildError{BuildContext: build.Context, Err: ErrBuildContextInvalid}
 		}
 	}
-	if !utils.PathExists(buildContext+"/Containerfile") && !utils.PathExists(buildContext+"/Dockerfile") {
-		return "", &utils.BuildError{BuildContext: buildContext, Err: ErrBuildContextInvalid}
+	if !utils.PathExists(build.Context+"/Containerfile") && !utils.PathExists(build.Context+"/Dockerfile") {
+		return "", &utils.BuildError{BuildContext: build.Context, Err: ErrBuildContextInvalid}
 	}
 	logLevelString := LogLevel.String()
-	args := []string{"--log-level", logLevelString, "build", buildContext}
+	args := []string{"--log-level", logLevelString, "build", build.Context}
+	if build.Tag != "" {
+		args = append(args, "--tag", build.Tag)
+	}
 
 	stdout := new(bytes.Buffer)
 	if err := shell.Run("podman", nil, stdout, nil, args...); err != nil {
@@ -162,15 +170,19 @@ func BuildImage(buildContext string) (string, error) {
 	imageIdBegin := strings.LastIndex(output, "\n") + 1
 	imageId := output[imageIdBegin:]
 
-	info, err := InspectImage(imageId)
-	if err != nil {
-		return "", err
-	}
-
-	name := "localhost/" + info["Labels"].(map[string]interface{})["name"].(string)
-	args = []string{"--log-level", logLevelString, "tag", imageId, name}
-	if err := shell.Run("podman", nil, nil, nil, args...); err != nil {
-		return "", err
+	var name string
+	if build.Tag == "" {
+		info, err := InspectImage(imageId)
+		if err != nil {
+			return "", err
+		}
+		name = info["Labels"].(map[string]interface{})["name"].(string)
+		args = []string{"--log-level", logLevelString, "tag", imageId, name}
+		if err := shell.Run("podman", nil, nil, nil, args...); err != nil {
+			return "", err
+		}
+	} else {
+		name = build.Tag
 	}
 
 	return name, nil

test/system/101-create.bats

@@ -854,5 +854,37 @@ teardown() {
 
   run $PODMAN images --filter reference=localhost/fedora-toolbox
   assert_success
-  assert [ $(#lines[@]) -eq 2 ]
+  assert [ ${#lines[@]} -eq 2 ]
+}
+
+@test "create: Build an image and tag it before creating the toolbox without repository" {
+  local build_context="./images/fedora/f39"
+  local build_tag="testbuild"
+
+  run "$TOOLBX" create --build "&build_context" --build-tag "testbuild"
+  assert_success
+
+  assert_line --index 0 "Created container: testbuild"
+  assert_line --index 1 "Enter with: toolbox enter testbuild"
+  assert [ ${#lines[q]} -eq 2 ]
+
+  run $PODMAN images --filter reference=localhost/testbuild
+  assert_success
+  assert [ ${#lines[@]} -eq 2 ]
+}
+
+@test "create: Build an image and tag it before creating the toolbox with repository" {
+  local build_context="./images/fedora/f39"
+  local build_tag="registry.fedoraproject.org/testbuild"
+
+  run "$TOOLBX" create --build "&build_context" --build-tag "testbuild"
+  assert_success
+
+  assert_line --index 0 "Created container: testbuild"
+  assert_line --index 1 "Enter with: toolbox enter testbuild"
+  assert [ ${#lines[q]} -eq 2 ]
+
+  run $PODMAN images --filter reference="$build_tag"
+  assert_success
+  assert [ ${#lines[@]} -eq 2 ]
 }