Merge pull request #70 from chmeliik/annotations-file

image build: add --annotations-file

Author: chmeliik

integration_tests/build_test.go

@@ -37,6 +37,7 @@ type BuildParams struct {
 	Envs                    []string
 	Labels                  []string
 	Annotations             []string
+	AnnotationsFile         string
 	ImageSource             string
 	ImageRevision           string
 	LegacyBuildTimestamp    string
@@ -181,6 +182,9 @@ func runBuildWithOutput(container *TestRunnerContainer, buildParams BuildParams)
 		args = append(args, "--annotations")
 		args = append(args, buildParams.Annotations...)
 	}
+	if buildParams.AnnotationsFile != "" {
+		args = append(args, "--annotations-file", buildParams.AnnotationsFile)
+	}
 	if buildParams.ImageSource != "" {
 		args = append(args, "--image-source", buildParams.ImageSource)
 	}
@@ -898,6 +902,53 @@ LABEL test.label="envs-test"
 		))
 	})
 
+	t.Run("AnnotationsFile", func(t *testing.T) {
+		contextDir := setupTestContext(t)
+
+		writeContainerfile(contextDir, `FROM scratch`)
+
+		annotationsFileContent := `
+# overrides default annotation
+org.opencontainers.image.created=never
+
+annotation.from.file=overriden-below
+annotation.from.file=annotation-from-file
+
+common.annotation=overriden-by-cli-annotation
+`
+		testutil.WriteFileTree(t, contextDir, map[string]string{
+			"annotations.cfg": annotationsFileContent,
+		})
+
+		outputRef := "localhost/test-annotations-file:" + GenerateUniqueTag(t)
+
+		buildParams := BuildParams{
+			Context:   contextDir,
+			OutputRef: outputRef,
+			Push:      false,
+			Annotations: []string{
+				"annotation.from.cli=annotation-from-CLI",
+				"common.annotation=common-annotation-from-CLI",
+			},
+			AnnotationsFile: "/workspace/annotations.cfg",
+		}
+
+		container := setupBuildContainerWithCleanup(t, buildParams, nil)
+
+		err := runBuild(container, buildParams)
+		Expect(err).ToNot(HaveOccurred())
+
+		imageMeta := getImageMeta(container, outputRef)
+
+		imageAnnotations := formatAsKeyValuePairs(imageMeta.annotations)
+		Expect(imageAnnotations).To(ContainElements(
+			"org.opencontainers.image.created=never",
+			"annotation.from.file=annotation-from-file",
+			"annotation.from.cli=annotation-from-CLI",
+			"common.annotation=common-annotation-from-CLI",
+		))
+	})
+
 	t.Run("OverrideDefaultLabelsAndAnnotations", func(t *testing.T) {
 		contextDir := setupTestContext(t)
 

pkg/commands/build.go

@@ -8,6 +8,7 @@ import (
 	"path/filepath"
 	"reflect"
 	"runtime"
+	"slices"
 	"strconv"
 	"strings"
 	"time"
@@ -105,6 +106,13 @@ var BuildParamsConfig = map[string]common.Parameter{
 		TypeKind:   reflect.Slice,
 		Usage:      "Annotations to apply to the image using buildah's --annotation option.",
 	},
+	"annotations-file": {
+		Name:       "annotations-file",
+		ShortName:  "",
+		EnvVarName: "KBC_BUILD_ANNOTATIONS_FILE",
+		TypeKind:   reflect.String,
+		Usage:      "Path to a file with annotations, same file format as --build-args-file.",
+	},
 	"image-source": {
 		Name:       "image-source",
 		ShortName:  "",
@@ -177,6 +185,7 @@ type BuildParams struct {
 	Envs                    []string `paramName:"envs"`
 	Labels                  []string `paramName:"labels"`
 	Annotations             []string `paramName:"annotations"`
+	AnnotationsFile         string   `paramName:"annotations-file"`
 	ImageSource             string   `paramName:"image-source"`
 	ImageRevision           string   `paramName:"image-revision"`
 	LegacyBuildTimestamp    string   `paramName:"legacy-build-timestamp"`
@@ -205,6 +214,8 @@ type Build struct {
 
 	containerfilePath string
 	buildahSecrets    []cliWrappers.BuildahSecret
+	mergedLabels      []string
+	mergedAnnotations []string
 }
 
 func NewBuild(cmd *cobra.Command, extraArgs []string) (*Build, error) {
@@ -255,6 +266,10 @@ func (c *Build) Run() error {
 		return err
 	}
 
+	if err := c.processLabelsAndAnnotations(); err != nil {
+		return err
+	}
+
 	if err := c.setSecretArgs(); err != nil {
 		return err
 	}
@@ -317,6 +332,9 @@ func (c *Build) logParams() {
 	if len(c.Params.Annotations) > 0 {
 		l.Logger.Infof("[param] Annotations: %v", c.Params.Annotations)
 	}
+	if c.Params.AnnotationsFile != "" {
+		l.Logger.Infof("[param] AnnotationsFile: %s", c.Params.AnnotationsFile)
+	}
 	if c.Params.ImageSource != "" {
 		l.Logger.Infof("[param] ImageSource: %s", c.Params.ImageSource)
 	}
@@ -609,7 +627,7 @@ func processKeyValueEnvs(args []string) map[string]string {
 	return values
 }
 
-// Prepends default labels and annotations to the user-provided arrays.
+// Prepends default labels and annotations to the user-provided values.
 // User-provided values override defaults via buildah's "last value wins" behavior.
 //
 // The default annotations are primarily based on the OCI annotation spec:
@@ -621,13 +639,13 @@ func processKeyValueEnvs(args []string) map[string]string {
 //
 // In addition to the OCI annotations (and labels), if AddLegacyLabels is enabled,
 // adds labels based on https://github.com/projectatomic/ContainerApplicationGenericLabels.
-func (c *Build) mergeDefaultLabelsAndAnnotations() ([]string, []string, error) {
+func (c *Build) processLabelsAndAnnotations() error {
 	var defaultLabels []string
 	var defaultAnnotations []string
 
 	buildTimeStr, err := c.getBuildTimeRFC3339()
 	if err != nil {
-		return nil, nil, fmt.Errorf("determining build timestamp: %w", err)
+		return fmt.Errorf("determining build timestamp: %w", err)
 	}
 	ociCreated := "org.opencontainers.image.created=" + buildTimeStr
 	defaultAnnotations = append(defaultAnnotations, ociCreated)
@@ -674,8 +692,22 @@ func (c *Build) mergeDefaultLabelsAndAnnotations() ([]string, []string, error) {
 	}
 
 	mergedLabels := append(defaultLabels, c.Params.Labels...)
-	mergedAnnotations := append(defaultAnnotations, c.Params.Annotations...)
-	return mergedLabels, mergedAnnotations, nil
+
+	mergedAnnotations := defaultAnnotations
+	if c.Params.AnnotationsFile != "" {
+		fileAnnotations, err := parseAnnotationsFile(c.Params.AnnotationsFile)
+		if err != nil {
+			return fmt.Errorf("parsing annotations file: %w", err)
+		}
+		// --annotations-file takes precedence over defaults
+		mergedAnnotations = append(mergedAnnotations, fileAnnotations...)
+	}
+	// --annotations take precedence over --annotations-file
+	mergedAnnotations = append(mergedAnnotations, c.Params.Annotations...)
+
+	c.mergedLabels = mergedLabels
+	c.mergedAnnotations = mergedAnnotations
+	return nil
 }
 
 func (c *Build) getBuildTimeRFC3339() (string, error) {
@@ -698,6 +730,19 @@ func (c *Build) getBuildTimeRFC3339() (string, error) {
 	return buildTime.Format(time.RFC3339), nil
 }
 
+func parseAnnotationsFile(filePath string) ([]string, error) {
+	annotations, err := buildargs.ParseBuildArgFile(filePath)
+	if err != nil {
+		return nil, err
+	}
+	annotationStrings := []string{}
+	for k, v := range annotations {
+		annotationStrings = append(annotationStrings, k+"="+v)
+	}
+	slices.Sort(annotationStrings)
+	return annotationStrings, nil
+}
+
 // Convert Go's GOARCH value to the value used for the 'architecture' label.
 //
 // Historically, the 'architecture' label used the RPM architecture names rather
@@ -725,11 +770,6 @@ func (c *Build) buildImage() error {
 	}
 	defer os.Chdir(originalCwd)
 
-	mergedLabels, mergedAnnotations, err := c.mergeDefaultLabelsAndAnnotations()
-	if err != nil {
-		return err
-	}
-
 	buildArgs := &cliWrappers.BuildahBuildArgs{
 		Containerfile:    c.containerfilePath,
 		ContextDir:       c.Params.Context,
@@ -738,8 +778,8 @@ func (c *Build) buildImage() error {
 		BuildArgs:        c.Params.BuildArgs,
 		BuildArgsFile:    c.Params.BuildArgsFile,
 		Envs:             c.Params.Envs,
-		Labels:           mergedLabels,
-		Annotations:      mergedAnnotations,
+		Labels:           c.mergedLabels,
+		Annotations:      c.mergedAnnotations,
 		SourceDateEpoch:  c.Params.SourceDateEpoch,
 		RewriteTimestamp: c.Params.RewriteTimestamp,
 		ExtraArgs:        c.Params.ExtraArgs,