create-build: added --build option

uses the given path as the build context forwarded to podman build

afterwards it extracts the name of the image and sets it to satisfy other
assumption in existing code

the test builds a Fedora 39 toolbx and checks if the image is successfully
tagged as localhost/fedora-toolbox

Author: KilianHanich

src/cmd/create.go

@@ -54,6 +54,7 @@ var (
 		distro    string
 		image     string
 		release   string
+		build     string
 	}
 
 	createToolboxShMounts = []struct {
@@ -104,6 +105,12 @@ func init() {
 		"",
 		"Create a Toolbx container for a different operating system release than the host")
 
+	flags.StringVarP(&createFlags.build,
+		"build",
+		"b",
+		"",
+		"Build a Toolbx container for use of this container")
+
 	createCmd.SetHelpFunc(createHelp)
 
 	if err := createCmd.RegisterFlagCompletionFunc("distro", completionDistroNames); err != nil {
@@ -150,6 +157,15 @@ func create(cmd *cobra.Command, args []string) error {
 		return errors.New(errMsg)
 	}
 
+	if cmd.Flag("build").Changed && (cmd.Flag("image").Changed || cmd.Flag("release").Changed || cmd.Flag("distro").Changed) {
+		var builder strings.Builder
+		fmt.Fprintf(&builder, "options --build and --release, --image or -- distro cannot be used together\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
@@ -177,7 +193,8 @@ func create(cmd *cobra.Command, args []string) error {
 		containerArg,
 		createFlags.distro,
 		createFlags.image,
-		createFlags.release)
+		createFlags.release,
+		createFlags.build)
 
 	if err != nil {
 		return err

src/cmd/enter.go

@@ -111,7 +111,8 @@ func enter(cmd *cobra.Command, args []string) error {
 		containerArg,
 		enterFlags.distro,
 		"",
-		enterFlags.release)
+		enterFlags.release,
+		"")
 
 	if err != nil {
 		return err

src/cmd/run.go

@@ -130,7 +130,8 @@ func run(cmd *cobra.Command, args []string) error {
 		"--container",
 		runFlags.distro,
 		"",
-		runFlags.release)
+		runFlags.release,
+		"")
 
 	if err != nil {
 		return err

src/cmd/utils.go

@@ -29,6 +29,7 @@ import (
 	"strings"
 	"syscall"
 
+	"github.com/containers/toolbox/pkg/podman"
 	"github.com/containers/toolbox/pkg/utils"
 	"github.com/sirupsen/logrus"
 	"golang.org/x/sys/unix"
@@ -392,13 +393,26 @@ func poll(pollFn pollFunc, eventFD int32, fds ...int32) error {
 	}
 }
 
-func resolveContainerAndImageNames(container, containerArg, distroCLI, imageCLI, releaseCLI string) (
+func resolveContainerAndImageNames(container, containerArg, distroCLI, imageCLI, releaseCLI, buildCLI string) (
 	string, string, string, error,
 ) {
-	container, image, release, err := utils.ResolveContainerAndImageNames(container,
-		distroCLI,
-		imageCLI,
-		releaseCLI)
+	var image, release string
+	var err error
+	if buildCLI == "" {
+		container, image, release, err = utils.ResolveContainerAndImageNames(container,
+			distroCLI,
+			imageCLI,
+			releaseCLI)
+	} else {
+		image, err = podman.BuildImage(buildCLI)
+		if err != nil {
+			return "", "", "", err
+		}
+		container, image, release, err = utils.ResolveContainerAndImageNames(container,
+			distroCLI,
+			image,
+			releaseCLI)
+	}
 
 	if err != nil {
 		var errContainer *utils.ContainerError

src/pkg/podman/podman.go

@@ -19,8 +19,11 @@ package podman
 import (
 	"bytes"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
+	"os"
+	"strings"
 
 	"github.com/HarryMichal/go-version"
 	"github.com/containers/toolbox/pkg/shell"
@@ -45,6 +48,12 @@ var (
 	LogLevel = logrus.ErrorLevel
 )
 
+var (
+	ErrBuildContextDoesNotExist = errors.New("build context does not exist")
+
+	ErrBuildContextInvalid = errors.New("build context is not a directory with a Containerfile")
+)
+
 func (image *Image) FlattenNames(fillNameWithID bool) []Image {
 	var ret []Image
 
@@ -427,3 +436,41 @@ func SystemMigrate(ociRuntimeRequired string) error {
 
 	return nil
 }
+
+func BuildImage(buildContext string) (string, error) {
+	if !utils.PathExists(buildContext) {
+		return "", &utils.BuildError{BuildContext: buildContext, Err: ErrBuildContextDoesNotExist}
+	}
+	if stat, err := os.Stat(buildContext); err != nil {
+		return "", err
+	} else {
+		if !stat.Mode().IsDir() {
+			return "", &utils.BuildError{BuildContext: buildContext, Err: ErrBuildContextInvalid}
+		}
+	}
+	if !utils.PathExists(buildContext+"/Containerfile") && !utils.PathExists(buildContext+"/Dockerfile") {
+		return "", &utils.BuildError{BuildContext: buildContext, Err: ErrBuildContextInvalid}
+	}
+	logLevelString := LogLevel.String()
+	args := []string{"--log-level", logLevelString, "build", buildContext}
+
+	stdout := new(bytes.Buffer)
+	if err := shell.Run("podman", nil, stdout, nil, args...); err != nil {
+		return "", err
+	}
+	output := strings.TrimRight(stdout.String(), "\n")
+	imageIdBegin := strings.LastIndex(output, "\n") + 1
+	imageId := output[imageIdBegin:]
+
+	info, err := Inspect("image", 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
+	}
+
+	return name, nil
+}

src/pkg/utils/errors.go

@@ -40,6 +40,11 @@ type ParseReleaseError struct {
 	Hint string
 }
 
+type BuildError struct {
+	BuildContext string
+	Err          error
+}
+
 func (err *ContainerError) Error() string {
 	errMsg := fmt.Sprintf("%s: %s", err.Container, err.Err)
 	return errMsg
@@ -70,3 +75,8 @@ func (err *ImageError) Unwrap() error {
 func (err *ParseReleaseError) Error() string {
 	return err.Hint
 }
+
+func (err *BuildError) Error() string {
+	errMsg := fmt.Sprintf("%s: %s", err.BuildContext, err.Err)
+	return errMsg
+}

test/system/101-create.bats

@@ -771,3 +771,18 @@ teardown() {
   assert_line --index 1 "Enter with: toolbox enter fedora-toolbox-34"
   assert [ ${#lines[@]} -eq 2 ]
 }
+
+@test "create: Build an image before creating the toolbox" {
+  local build_context="./images/fedora/f39"
+
+  run "$TOOLBX" create --build "$build_context"
+  assert_success
+
+  assert_line --index 0 "Created container: fedora-toolbox"
+  assert_line --index 1 "Enter with: toolbox enter fedora-toolbox"
+  assert [ ${#lines[@]} -eq 2 ]
+
+  run $PODMAN images --filter reference=localhost/fedora-toolbox
+  assert_success
+  assert [ $(#lines[@]) -eq 2 ]
+}