feat: support kiwi image profiles (#433)

Author: reubeno

internal/app/azldev/cmds/image/build.go

@@ -143,7 +143,7 @@ func BuildImage(env *azldev.Env, options *ImageBuildOptions) (*ImageBuildResult,
 	}
 
 	// Run kiwi to build the image into the work directory.
-	kiwiRunner, err := createKiwiRunner(env, kiwiDefPath, kiwiWorkDir, options)
+	kiwiRunner, err := createKiwiRunner(env, imageConfig, kiwiWorkDir, options)
 	if err != nil {
 		return nil, err
 	}
@@ -181,13 +181,18 @@ func checkBuildPrerequisites(env *azldev.Env) error {
 // createKiwiRunner sets up a kiwi runner with the configured repositories.
 func createKiwiRunner(
 	env *azldev.Env,
-	kiwiDefPath, targetDir string,
+	imageConfig *projectconfig.ImageConfig,
+	targetDir string,
 	options *ImageBuildOptions,
 ) (*kiwi.Runner, error) {
-	runner := kiwi.NewRunner(env, filepath.Dir(kiwiDefPath)).
+	runner := kiwi.NewRunner(env, filepath.Dir(imageConfig.Definition.Path)).
 		WithTargetDir(targetDir).
 		WithRemoteRepoGPGCheck(!options.NoRemoteRepoGpgCheck)
 
+	if imageConfig.Definition.Profile != "" {
+		runner.WithProfile(imageConfig.Definition.Profile)
+	}
+
 	for _, repoURI := range options.RemoteRepoPaths {
 		if err := runner.AddRemoteRepo(repoURI); err != nil {
 			return nil, fmt.Errorf("invalid remote repository:\n%w", err)

internal/projectconfig/image.go

@@ -33,6 +33,9 @@ type ImageDefinition struct {
 
 	// Path points to the image definition file.
 	Path string `toml:"path,omitempty" json:"path,omitempty" jsonschema:"title=Path,description=Path to the image definition file"`
+
+	// Profile is an optional field that specifies the profile to use when building the image.
+	Profile string `toml:"profile,omitempty" json:"profile,omitempty" jsonschema:"title=Profile,description=Optional field that specifies the profile to use when building the image"`
 }
 
 // Type of image definition.

internal/utils/kiwi/kiwi.go

@@ -66,6 +66,9 @@ type Runner struct {
 	// remoteRepoGPGCheck controls whether GPG checking is enabled for remote repositories.
 	// Defaults to true.
 	remoteRepoGPGCheck bool
+
+	// profile is the optional kiwi profile to use when building the image.
+	profile string
 }
 
 // NewRunner constructs a new [Runner] that can be used to invoke kiwi-ng.
@@ -77,6 +80,7 @@ func NewRunner(ctx opctx.Ctx, descriptionDir string) *Runner {
 		verbose:            ctx.Verbose(),
 		descriptionDir:     descriptionDir,
 		remoteRepoGPGCheck: true, // GPG checking enabled by default
+		profile:            "",
 	}
 }
 
@@ -91,6 +95,7 @@ func (r *Runner) Clone() *Runner {
 		localRepoPaths:     deep.MustCopy(r.localRepoPaths),
 		remoteRepoPaths:    deep.MustCopy(r.remoteRepoPaths),
 		remoteRepoGPGCheck: r.remoteRepoGPGCheck,
+		profile:            r.profile,
 	}
 }
 
@@ -109,6 +114,13 @@ func (r *Runner) WithRemoteRepoGPGCheck(enabled bool) *Runner {
 	return r
 }
 
+// WithProfile sets the profile that kiwi will use to build the image.
+func (r *Runner) WithProfile(profile string) *Runner {
+	r.profile = profile
+
+	return r
+}
+
 // RemoteRepoGPGCheck returns whether GPG checking is enabled for remote repositories.
 func (r *Runner) RemoteRepoGPGCheck() bool {
 	return r.remoteRepoGPGCheck
@@ -167,6 +179,11 @@ func (r *Runner) DescriptionDir() string {
 	return r.descriptionDir
 }
 
+// Profile retrieves the kiwi profile configured for this [Runner].
+func (r *Runner) Profile() string {
+	return r.profile
+}
+
 // Build invokes kiwi-ng via sudo to build an image.
 func (r *Runner) Build(ctx context.Context) error {
 	if r.descriptionDir == "" {
@@ -189,10 +206,17 @@ func (r *Runner) Build(ctx context.Context) error {
 	kiwiArgs := []string{
 		KiwiBinary,
 		"--loglevel", logLevel,
+	}
+
+	if r.profile != "" {
+		kiwiArgs = append(kiwiArgs, "--profile", r.profile)
+	}
+
+	kiwiArgs = append(kiwiArgs,
 		"system", "build",
 		"--description", r.descriptionDir,
 		"--target-dir", r.targetDir,
-	}
+	)
 
 	// Add remote repositories using kiwi's --add-repo flag.
 	// These have lower priority (50) than local repos so local repos can override.
@@ -235,6 +259,7 @@ func (r *Runner) Build(ctx context.Context) error {
 
 	slog.Info("Building image with kiwi-ng",
 		"description", r.descriptionDir,
+		"profile", r.profile,
 		"output", r.targetDir,
 	)
 

scenario/__snapshots__/TestSnapshotsContainer_config_generate-schema_stdout_1.snap

@@ -376,6 +376,11 @@
           "type": "string",
           "title": "Path",
           "description": "Path to the image definition file"
+        },
+        "profile": {
+          "type": "string",
+          "title": "Profile",
+          "description": "Optional field that specifies the profile to use when building the image"
         }
       },
       "additionalProperties": false,

scenario/__snapshots__/TestSnapshots_config_generate-schema_stdout_1.snap

@@ -376,6 +376,11 @@
           "type": "string",
           "title": "Path",
           "description": "Path to the image definition file"
+        },
+        "profile": {
+          "type": "string",
+          "title": "Profile",
+          "description": "Optional field that specifies the profile to use when building the image"
         }
       },
       "additionalProperties": false,

schemas/azldev.schema.json

@@ -376,6 +376,11 @@
           "type": "string",
           "title": "Path",
           "description": "Path to the image definition file"
+        },
+        "profile": {
+          "type": "string",
+          "title": "Profile",
+          "description": "Optional field that specifies the profile to use when building the image"
         }
       },
       "additionalProperties": false,