Merge pull request #73 from tkdchen/STONEBLD-4388

tkdchen · web-flow · commit a88e1673d596 · 2026-03-06T08:52:40.000+08:00
Allow specifying alternative file name in containerfile artifact image
diff --git a/cmd/image/push_containerfile.go b/cmd/image/push_containerfile.go
@@ -41,6 +41,11 @@ and --containerfile.`,
   # Push source/Containerfile as artifact quay.io/org/app:sha256-1234567.containerfile by passing absolute source path
   konflux-build-cli image push-containerfile --image-url quay.io/org/app --image-digest sha256:1234567 \
     --source /path/to/source
+
+  # Use alternative file name in artifact image rather than the original file name
+  konflux-build-cli image push-containerfile --image-url quay.io/org/app --image-digest sha256:1234567 \
+    --source /path/to/source --context db --containerfile containerfiles/db \
+    --alternative-filename Dockerfile
 `,
 	Run: func(cmd *cobra.Command, args []string) {
 		l.Logger.Debug("Starting push-containerfile")
diff --git a/integration_tests/push_containerfile_test.go b/integration_tests/push_containerfile_test.go
@@ -46,13 +46,14 @@ func setupPushContainerfileContainerWithCleanup(t *testing.T, imageRegistry Imag
 }
 
 type PushContainerfileParams struct {
-	source             string
-	context            string
-	containerfile      string
-	digest             string
-	tagSuffix          string
-	artifactType       string
-	resultPathImageRef string
+	source              string
+	context             string
+	containerfile       string
+	digest              string
+	tagSuffix           string
+	artifactType        string
+	resultPathImageRef  string
+	alternativeFilename string
 }
 
 func TestPushContainerfile(t *testing.T) {
@@ -78,7 +79,7 @@ func TestPushContainerfile(t *testing.T) {
 	for i := 0; i < len(files); i += 2 {
 		fileContent := files[i]
 		fileName := files[i+1]
-		script := fmt.Sprintf(`echo "%s" >%s`, fileContent, fileName)
+		script := fmt.Sprintf(`echo -n "%s" >%s`, fileContent, fileName)
 		err := container.ExecuteCommand("bash", "-c", script)
 		g.Expect(err).ShouldNot(HaveOccurred())
 	}
@@ -152,6 +153,18 @@ func TestPushContainerfile(t *testing.T) {
 			expectedContainerfileDigest:  sourceContainerfileContentDigest,
 			expectedTitleAnnotationValue: "Containerfile",
 		},
+		{
+			name: "Push with an alternative file name",
+			params: PushContainerfileParams{
+				source:              "source",
+				digest:              "sha256:2788b272a5a7c0071906a9c6b654760e44a1fc8226f8268c70848148f19c35b0",
+				containerfile:       "./containerfiles/operator",
+				alternativeFilename: "Dockerfile",
+			},
+			expectedTaggedDigest:         "sha256-2788b272a5a7c0071906a9c6b654760e44a1fc8226f8268c70848148f19c35b0",
+			expectedContainerfileDigest:  sourceContainerfilesOperatorContentDigest,
+			expectedTitleAnnotationValue: "Dockerfile",
+		},
 	}
 
 	for _, tc := range testCases {
@@ -177,6 +190,9 @@ func TestPushContainerfile(t *testing.T) {
 			if tc.params.context != "" {
 				cmd = append(cmd, "--context", tc.params.context)
 			}
+			if tc.params.alternativeFilename != "" {
+				cmd = append(cmd, "--alternative-filename", tc.params.alternativeFilename)
+			}
 
 			err := container.ExecuteBuildCli(cmd...)
 			g.Expect(err).ShouldNot(HaveOccurred())
@@ -202,7 +218,7 @@ func TestPushContainerfile(t *testing.T) {
 			if title, exists := layerAnnotations["org.opencontainers.image.title"]; exists {
 				g.Expect(title).Should(Equal(tc.expectedTitleAnnotationValue))
 			}
-			g.Expect(layerDescriptor.Digest, tc.expectedContainerfileDigest)
+			g.Expect(string(layerDescriptor.Digest)).Should(Equal("sha256:"+tc.expectedContainerfileDigest))
 
 			expectedArtifactType := tc.params.artifactType
 			if expectedArtifactType == "" {
diff --git a/pkg/commands/build_test.go b/pkg/commands/build_test.go
@@ -1285,7 +1285,7 @@ with.hash.char=this comment # is not a comment
 		c := &Build{
 			Params: &BuildParams{
 				SourceDateEpoch: "1767225600",
-				AnnotationsFile:      filepath.Join(tempDir, "annotations.cfg"),
+				AnnotationsFile: filepath.Join(tempDir, "annotations.cfg"),
 			},
 		}
 
diff --git a/pkg/commands/push_containerfile.go b/pkg/commands/push_containerfile.go
@@ -93,17 +93,26 @@ var PushContainerfileParamsConfig = map[string]common.Parameter{
 		Usage:      "Write digested image reference of the pushed Containerfile image into this file.",
 		Required:   false,
 	},
+	"alternative-filename": {
+		Name:       "alternative-filename",
+		ShortName:  "n",
+		EnvVarName: "KBC_PUSH_CONTAINERFILE_ALTERNATIVE_FILENAME",
+		TypeKind:   reflect.String,
+		Usage:      "Alternative file name in the artifact image, e.g. Dockerfile.",
+		Required:   false,
+	},
 }
 
 type PushContainerfileParams struct {
-	ImageUrl           string `paramName:"image-url"`
-	ImageDigest        string `paramName:"image-digest"`
-	Containerfile      string `paramName:"containerfile"`
-	Context            string `paramName:"context"`
-	TagSuffix          string `paramName:"tag-suffix"`
-	ArtifactType       string `paramName:"artifact-type"`
-	Source             string `paramName:"source"`
-	ResultPathImageRef string `paramName:"result-path-image-ref"`
+	ImageUrl            string `paramName:"image-url"`
+	ImageDigest         string `paramName:"image-digest"`
+	Containerfile       string `paramName:"containerfile"`
+	Context             string `paramName:"context"`
+	TagSuffix           string `paramName:"tag-suffix"`
+	ArtifactType        string `paramName:"artifact-type"`
+	Source              string `paramName:"source"`
+	ResultPathImageRef  string `paramName:"result-path-image-ref"`
+	AlternativeFilename string `paramName:"alternative-filename"`
 }
 
 type PushContainerfileResults struct {
@@ -207,7 +216,31 @@ func (c *PushContainerfile) Run() error {
 		return fmt.Errorf("Error on getting absolute path of %s: %w", containerfilePath, err)
 	}
 
-	os.Chdir(filepath.Dir(absContainerfilePath))
+	var pushFilename string
+	var workDir string
+
+	if c.Params.AlternativeFilename != "" {
+		pushFilename = filepath.Base(c.Params.AlternativeFilename)
+		workDir, err = os.MkdirTemp("", "push-containerfile-")
+		if err != nil {
+			return fmt.Errorf("Error on creating temporary directory: %w", err)
+		}
+		defer os.RemoveAll(workDir)
+		content, err := os.ReadFile(absContainerfilePath)
+		if err != nil {
+			return fmt.Errorf("Error on reading file %s: %w", absContainerfilePath, err)
+		}
+		if err := os.WriteFile(filepath.Join(workDir, pushFilename), content, 0644); err != nil {
+			return fmt.Errorf("Error on writing file: %w", err)
+		}
+	} else {
+		pushFilename = filepath.Base(absContainerfilePath)
+		workDir = filepath.Dir(absContainerfilePath)
+	}
+
+	if err := os.Chdir(workDir); err != nil {
+		return fmt.Errorf("Error on changing directory to %s: %w", workDir, err)
+	}
 	defer os.Chdir(curDir)
 
 	stdout, _, err := c.CliWrappers.OrasCli.Push(&cliwrappers.OrasPushArgs{
@@ -216,7 +249,7 @@ func (c *PushContainerfile) Run() error {
 		Format:           "go-template",
 		Template:         "{{.reference}}",
 		DestinationImage: fmt.Sprintf("%s:%s", c.imageName, tag),
-		FileName:         filepath.Base(absContainerfilePath),
+		FileName:         pushFilename,
 	})
 	if err != nil {
 		return fmt.Errorf("Error on pushing Containerfile %s: %w", containerfilePath, err)
@@ -262,6 +295,14 @@ func (c *PushContainerfile) validateParams() error {
 		return fmt.Errorf("Tag suffix includes invalid characters or exceeds the max length of 57 characters.")
 	}
 
+	altFilename := c.Params.AlternativeFilename
+	if strings.Contains(altFilename, "/") {
+		return fmt.Errorf("Path is included in alternative file name '%s'", altFilename)
+	}
+	if len(altFilename) > 100 {
+		return fmt.Errorf("Alternative file name exceeds 100 characters.")
+	}
+
 	return nil
 }
 
@@ -276,4 +317,7 @@ func (c *PushContainerfile) logParams() {
 	if c.Params.ResultPathImageRef != "" {
 		l.Logger.Infof("[param] Image Reference result file: %s", c.Params.ResultPathImageRef)
 	}
+	if c.Params.AlternativeFilename != "" {
+		l.Logger.Infof("[param] Alternative file name: %s", c.Params.AlternativeFilename)
+	}
 }
diff --git a/pkg/commands/push_containerfile_test.go b/pkg/commands/push_containerfile_test.go
@@ -175,6 +175,64 @@ func TestRun(t *testing.T) {
 
 	})
 
+	t.Run("Successful push with an alternative container file name", func(t *testing.T) {
+		artifactImageDigest := "sha256:a7c0071906a9c6b654760e44a1fc8226f8268c70848148f19c35b02788b272a5"
+
+		orasCli := &mockOrasCli{}
+		orasCli.PushFunc = func(args *cliwrappers.OrasPushArgs) (string, string, error) {
+			g.Expect(args.FileName).Should(Equal("Dockerfile"))
+
+			absFilename, err := filepath.Abs("Dockerfile")
+			g.Expect(err).ShouldNot(HaveOccurred(), "Alternative file Dockerfile does not exist")
+			g.Expect(filepath.Dir(absFilename)).ShouldNot(Equal(filepath.Join(workDir, "source")),
+				"Directory was not changed for pushing with an alternative file name")
+
+			originalContainerfile := filepath.Join(workDir, "source", "Containerfile")
+			originalContent, err := os.ReadFile(originalContainerfile)
+			g.Expect(err).ShouldNot(HaveOccurred())
+
+			content, err := os.ReadFile(absFilename)
+			g.Expect(err).ShouldNot(HaveOccurred())
+
+			g.Expect(string(content)).Should(Equal(string(originalContent)), "Container file content is mismatching")
+
+			return "localhost.reg.io/app@" + artifactImageDigest, "", nil
+		}
+
+		testCases := []struct {
+			alternativeFilename string
+			shouldSucceed       bool
+		}{
+			{alternativeFilename: "Dockerfile", shouldSucceed: true},
+			{alternativeFilename: "path/to/Dockerfile", shouldSucceed: false},
+		}
+
+		for _, tc := range testCases {
+			t.Run("use alternative file name "+tc.alternativeFilename, func(t *testing.T) {
+				cmd := &PushContainerfile{
+					Params: &PushContainerfileParams{
+						ImageUrl:            "localhost.reg.io/app",
+						ImageDigest:         imageDigest,
+						Source:              "source",
+						Containerfile:       "Containerfile",
+						Context:             ".",
+						TagSuffix:           ".dockerfile",
+						AlternativeFilename: tc.alternativeFilename,
+					},
+					ResultsWriter: &common.ResultsWriter{},
+					CliWrappers:   PushContainerfileCliWrappers{OrasCli: orasCli},
+				}
+
+				err := cmd.Run()
+				if tc.shouldSucceed {
+					g.Expect(err).ShouldNot(HaveOccurred())
+				} else {
+					g.Expect(err).Should(HaveOccurred())
+				}
+			})
+		}
+	})
+
 	t.Run("should not push and exits as normal if specified Containerfile is not found", func(t *testing.T) {
 		logFilename := filepath.Join(t.TempDir(), "logfile")
 		logFile, _ := os.OpenFile(logFilename, os.O_CREATE|os.O_WRONLY, 0644)

Original file line number	Diff line number	Diff line change
`@@ -1285,7 +1285,7 @@ with.hash.char=this comment # is not a comment`
`1285`	`1285`	`c := &Build{`
`1286`	`1286`	`Params: &BuildParams{`
`1287`	`1287`	`SourceDateEpoch: "1767225600",`
`1288`		`- AnnotationsFile: filepath.Join(tempDir, "annotations.cfg"),`
	`1288`	`+ AnnotationsFile: filepath.Join(tempDir, "annotations.cfg"),`
`1289`	`1289`	`},`
`1290`	`1290`	`}`
`1291`	`1291`