Merge pull request #27153 from rhatdan/cursor

openshift-merge-bot[bot] · web-flow · commit 2455ac327d9a · 2025-10-07T17:09:03.000Z
Add --replace option to podman artifact add command
diff --git a/cmd/podman/artifact/add.go b/cmd/podman/artifact/add.go
@@ -53,6 +53,9 @@ func init() {
 	appendFlagName := "append"
 	flags.BoolVarP(&addOpts.Append, appendFlagName, "a", false, "Append files to an existing artifact")
 
+	replaceFlagName := "replace"
+	flags.BoolVar(&addOpts.Replace, replaceFlagName, false, "Replace an existing artifact")
+
 	fileMIMETypeFlagName := "file-type"
 	flags.StringVarP(&addOpts.FileMIMEType, fileMIMETypeFlagName, "", "", "Set file type to use for the artifact (layer)")
 	_ = addCmd.RegisterFlagCompletionFunc(fileMIMETypeFlagName, completion.AutocompleteNone)
@@ -62,6 +65,10 @@ func add(_ *cobra.Command, args []string) error {
 	artifactName := args[0]
 	blobs := args[1:]
 
+	if addOpts.Append && addOpts.Replace {
+		return fmt.Errorf("--append and --replace options cannot be used together")
+	}
+
 	annots, err := utils.ParseAnnotations(addOpts.AnnotationsCLI)
 	if err != nil {
 		return err
@@ -72,6 +79,7 @@ func add(_ *cobra.Command, args []string) error {
 		ArtifactMIMEType: addOpts.ArtifactMIMEType,
 		Append:           addOpts.Append,
 		FileMIMEType:     addOpts.FileMIMEType,
+		Replace:          addOpts.Replace,
 	}
 
 	artifactBlobs := make([]entities.ArtifactBlob, 0, len(blobs))
diff --git a/docs/source/markdown/podman-artifact-add.1.md.in b/docs/source/markdown/podman-artifact-add.1.md.in
@@ -1,10 +1,10 @@
 % podman-artifact-add 1
 
 ## NAME
-podman\-artifact\-add - Add an OCI artifact to the local store
+podman\-artifact\-add - Add an OCI artifact to local artifact store
 
 ## SYNOPSIS
-**podman artifact add** *name* *file* [*file*]...
+**podman artifact add** [*options*] *artifact-name* *file* [*file* ...]
 
 ## DESCRIPTION
 
@@ -35,6 +35,11 @@ Set the media type of the artifact file instead of allowing detection to determi
 
 Print usage statement.
 
+#### **--replace**
+
+If an artifact with the same name already exists, replace and remove it. The default is **false**.
+This option cannot be used with the **--append** option.
+
 #### **--type**
 
 Set a type for the artifact being added.
@@ -48,25 +53,29 @@ $ podman artifact add quay.io/myartifact/myml:latest /tmp/foobar.ml
 0fe1488ecdef8cc4093e11a55bc048d9fc3e13a4ba846efd24b5a715006c95b3
 ```
 
-Add multiple files to an artifact
+Add OCI artifact to the store with type:
+
 ```
-$ podman artifact add quay.io/myartifact/myml:latest /tmp/foobar1.ml /tmp/foobar2.ml
-1487acae11b5a30948c50762882036b41ac91a7b9514be8012d98015c95ddb78
+$ podman artifact add --artifact-type application/com.example.ai --file-type application/vnd.gguf quay.io/myimage/myartifact:latest /home/user/model.gguf
 ```
 
-Set an annotation for an artifact
+Replace an existing artifact with the same name
+
 ```
-$ podman artifact add --annotation date=2025-01-30 quay.io/myartifact/myml:latest /tmp/foobar1.ml
+$ podman artifact add quay.io/myartifact/myml:latest /tmp/foobar.ml
+0fe1488ecdef8cc4093e11a55bc048d9fc3e13a4ba846efd24b5a715006c95b3
 ```
 
-Append a file to an existing artifact
+Add multiple files to an artifact
 ```
-$ podman artifact add --append quay.io/myartifact/tarballs:latest /tmp/foobar.tar.gz
+$ podman artifact add quay.io/myartifact/myml:latest /tmp/foobar1.ml /tmp/foobar2.ml
+1487acae11b5a30948c50762882036b41ac91a7b9514be8012d98015c95ddb78
 ```
 
-Override the media type of the artifact being added
+Add files to an existing OCI artifact
+
 ```
-$ podman artifact add --file-type text/yaml quay.io/myartifact/descriptors:latest /tmp/info.yaml
+$ podman artifact add --append quay.io/myimage/myartifact:latest /home/user/config.yaml
 ```
 
 
diff --git a/docs/source/markdown/podman-artifact.1.md b/docs/source/markdown/podman-artifact.1.md
@@ -17,7 +17,7 @@ from its local "artifact store".
 
 | Command | Man Page                                                   | Description                                                  |
 |---------|------------------------------------------------------------|--------------------------------------------------------------|
-| add     | [podman-artifact-add(1)](podman-artifact-add.1.md)         | Add an OCI artifact to the local store                       |
+| add     | [podman-artifact-add(1)](podman-artifact-add.1.md)         | Add an OCI artifact to local artifact store              |
 | extract | [podman-artifact-extract(1)](podman-artifact-extract.1.md) | Extract an OCI artifact to a local path                      |
 | inspect | [podman-artifact-inspect(1)](podman-artifact-inspect.1.md) | Inspect an OCI artifact                                      |
 | ls      | [podman-artifact-ls(1)](podman-artifact-ls.1.md)           | List OCI artifacts in local store                            |
diff --git a/pkg/api/handlers/libpod/artifacts.go b/pkg/api/handlers/libpod/artifacts.go
@@ -223,6 +223,7 @@ func AddArtifact(w http.ResponseWriter, r *http.Request) {
 		Annotations      []string `schema:"annotations"`
 		ArtifactMIMEType string   `schema:"artifactMIMEType"`
 		Append           bool     `schema:"append"`
+		Replace          bool     `schema:"replace"`
 	}{}
 
 	if err := decoder.Decode(&query, r.URL.Query()); err != nil {
@@ -246,6 +247,7 @@ func AddArtifact(w http.ResponseWriter, r *http.Request) {
 		Annotations:      annotations,
 		ArtifactMIMEType: query.ArtifactMIMEType,
 		FileMIMEType:     query.FileMIMEType,
+		Replace:          query.Replace,
 	}
 
 	artifactBlobs := []entities.ArtifactBlob{{
diff --git a/pkg/api/server/register_artifacts.go b/pkg/api/server/register_artifacts.go
@@ -191,6 +191,11 @@ func (s *APIServer) registerArtifactHandlers(r *mux.Router) error {
 	//     description: Append files to an existing artifact
 	//     type: boolean
 	//     default: false
+	//   - name: replace
+	//     in: query
+	//     description: Replace an existing artifact with the same name
+	//     type: boolean
+	//     default: false
 	//   - name: inputStream
 	//     in: body
 	//     description: Binary stream of the file to add to an artifact
diff --git a/pkg/bindings/artifacts/types.go b/pkg/bindings/artifacts/types.go
@@ -64,6 +64,7 @@ type AddOptions struct {
 	ArtifactMIMEType *string
 	Append           *bool
 	FileMIMEType     *string
+	Replace          *bool
 }
 
 // ExtractOptions
diff --git a/pkg/bindings/artifacts/types_add_options.go b/pkg/bindings/artifacts/types_add_options.go
diff --git a/pkg/domain/entities/artifact.go b/pkg/domain/entities/artifact.go
@@ -13,6 +13,7 @@ type ArtifactAddOptions struct {
 	ArtifactMIMEType string
 	Append           bool
 	FileMIMEType     string
+	Replace          bool
 }
 
 type ArtifactAddReport = entitiesTypes.ArtifactAddReport
diff --git a/pkg/domain/infra/abi/artifact.go b/pkg/domain/infra/abi/artifact.go
@@ -209,11 +209,19 @@ func (ir *ImageEngine) ArtifactAdd(ctx context.Context, name string, artifactBlo
 		return nil, err
 	}
 
+	// If replace is true, try to remove existing artifact (ignore errors if it doesn't exist)
+	if opts.Replace {
+		if _, err = artStore.Remove(ctx, name); err != nil && !errors.Is(err, types.ErrArtifactNotExist) {
+			logrus.Debugf("Artifact %q removal failed: %s", name, err)
+		}
+	}
+
 	addOptions := types.AddOptions{
 		Annotations:      opts.Annotations,
 		ArtifactMIMEType: opts.ArtifactMIMEType,
 		Append:           opts.Append,
 		FileMIMEType:     opts.FileMIMEType,
+		Replace:          opts.Replace,
 	}
 
 	artifactDigest, err := artStore.Add(ctx, name, artifactBlobs, &addOptions)
diff --git a/pkg/domain/infra/tunnel/artifact.go b/pkg/domain/infra/tunnel/artifact.go
@@ -89,6 +89,7 @@ func (ir *ImageEngine) ArtifactAdd(_ context.Context, name string, artifactBlob
 		Append:           &opts.Append,
 		ArtifactMIMEType: &opts.ArtifactMIMEType,
 		FileMIMEType:     &opts.FileMIMEType,
+		Replace:          &opts.Replace,
 	}
 
 	for k, v := range opts.Annotations {
diff --git a/pkg/libartifact/types/config.go b/pkg/libartifact/types/config.go
@@ -13,6 +13,8 @@ type AddOptions struct {
 	// FileType describes the media type for the layer.  It is an override
 	// for the standard detection
 	FileMIMEType string `json:",omitempty"`
+	// Replace option removes existing artifact before adding new one
+	Replace bool `json:",omitempty"`
 }
 
 // FilterBlobOptions options used to filter for a single blob in an artifact
diff --git a/test/apiv2/python/rest_api/test_v2_0_0_artifact.py b/test/apiv2/python/rest_api/test_v2_0_0_artifact.py
@@ -43,6 +43,65 @@ def test_add(self):
         # Assert blob media type fallback detection is working
         self.assertEqual(artifact_layer["mediaType"], "application/octet-stream")
 
+    def test_add_with_replace(self):
+        ARTIFACT_NAME = "quay.io/myimage/newartifact:latest"
+
+        # Create first artifact
+        file1 = ArtifactFile()
+        parameters1: dict[str, str | list[str]] = {
+            "name": ARTIFACT_NAME,
+            "fileName": file1.name,
+        }
+
+        artifact1 = Artifact(self.uri(""), ARTIFACT_NAME, parameters1, file1)
+        add_response1 = artifact1.add()
+        self.assertEqual(add_response1.status_code, 201, add_response1.text)
+
+        original_digest = add_response1.json()["ArtifactDigest"]
+
+        # Create replacement artifact with replace=true
+        file2 = ArtifactFile()
+        parameters2: dict[str, str | list[str]] = {
+            "name": ARTIFACT_NAME,
+            "fileName": file2.name,
+            "replace": "true",
+        }
+
+        artifact2 = Artifact(self.uri(""), ARTIFACT_NAME, parameters2, file2)
+        add_response2 = artifact2.add()
+        self.assertEqual(add_response2.status_code, 201, add_response2.text)
+
+        new_digest = add_response2.json()["ArtifactDigest"]
+
+        # Verify artifacts were replaced (different digests)
+        self.assertNotEqual(original_digest, new_digest)
+
+        # Verify artifact exists and has the new content
+        inspect_response = artifact2.do_artifact_inspect_request()
+        self.assertEqual(inspect_response.status_code, 200)
+
+        inspect_json = inspect_response.json()
+        artifact_layer = inspect_json["Manifest"]["layers"][0]
+
+        # Should have only one layer (replaced, not appended)
+        self.assertEqual(len(inspect_json["Manifest"]["layers"]), 1)
+
+        # Verify it's the second file's content
+        self.assertEqual(artifact_layer["size"], file2.size)
+        self.assertEqual(
+            artifact_layer["annotations"]["org.opencontainers.image.title"], file2.name
+        )
+
+        url = self.uri("/artifacts/" + ARTIFACT_NAME)
+        r = requests.delete(url)
+        rjson = r.json()
+
+        # Assert correct response code
+        self.assertEqual(r.status_code, 200, r.text)
+
+        # Assert return response is json and contains digest
+        self.assertIn("sha256:", rjson["ArtifactDigests"][0])
+
     def test_add_with_append(self):
         ARTIFACT_NAME = "quay.io/myimage/myartifact:latest"
         file = ArtifactFile(name="test_file_2")
diff --git a/test/system/700-artifact.bats b/test/system/700-artifact.bats
@@ -0,0 +1,113 @@
+#!/usr/bin/env bats   -*- bats -*-
+#
+# Tests for podman artifact functionality
+#
+
+load helpers
+
+function setup() {
+    basic_setup
+}
+
+function teardown() {
+    basic_teardown
+}
+
+# Helper function to create a test artifact file
+create_test_file() {
+    local size=${1:-1024}
+    local filename=$(mktemp --tmpdir="${PODMAN_TMPDIR}" artifactfile.XXXXXX)
+    dd if=/dev/urandom of="$filename" bs=1 count="$size" 2>/dev/null
+    echo "$filename"
+}
+
+# bats test_tags=ci:parallel
+@test "podman artifact add --replace basic functionality" {
+    local artifact_name="localhost/test/replace-artifact"
+    local file1 file2
+
+    file1=$(create_test_file 1024)
+    file2=$(create_test_file 2048)
+
+    # Add initial artifact
+    run_podman artifact add "$artifact_name" "$file1"
+    local first_digest="$output"
+
+    # Verify initial artifact exists
+    run_podman artifact inspect "$artifact_name"
+
+    # Replace with different file
+    run_podman artifact add --replace "$artifact_name" "$file2"
+    local second_digest="$output"
+
+    # Verify artifact was replaced (different digest)
+    assert "$first_digest" != "$second_digest" "Replace should create different digest"
+
+    # Verify artifact still exists and is accessible
+    run_podman artifact inspect "$artifact_name"
+
+    # Cleanup
+    run_podman artifact rm "$artifact_name"
+    rm -f "$file1" "$file2"
+}
+
+# bats test_tags=ci:parallel
+@test "podman artifact add --replace nonexistent artifact" {
+    local artifact_name="localhost/test/nonexistent-artifact"
+    local file1
+
+    file1=$(create_test_file 1024)
+
+    # Using --replace on nonexistent artifact should succeed
+    run_podman artifact add --replace "$artifact_name" "$file1"
+
+    # Verify artifact was created
+    run_podman artifact inspect "$artifact_name"
+
+    # Cleanup
+    run_podman artifact rm "$artifact_name"
+    rm -f "$file1"
+}
+
+# bats test_tags=ci:parallel
+@test "podman artifact add --replace and --append conflict" {
+    local artifact_name="localhost/test/conflict-artifact"
+    local file1
+
+    file1=$(create_test_file 1024)
+
+    # Using --replace and --append together should fail
+    run_podman 125 artifact add --replace --append "$artifact_name" "$file1"
+    assert "$output" =~ "--append and --replace options cannot be used together"
+
+    rm -f "$file1"
+}
+
+# bats test_tags=ci:parallel
+@test "podman artifact add --replace with existing artifact" {
+    local artifact_name="localhost/test/existing-artifact"
+    local file1 file2
+
+    file1=$(create_test_file 512)
+    file2=$(create_test_file 1024)
+
+    # Create initial artifact
+    run_podman artifact add "$artifact_name" "$file1"
+
+    # Verify initial artifact exists
+    run_podman artifact inspect "$artifact_name"
+
+    # Adding same name without --replace should fail
+    run_podman 125 artifact add "$artifact_name" "$file2"
+    assert "$output" =~ "artifact already exists"
+
+    # Replace should succeed
+    run_podman artifact add --replace "$artifact_name" "$file2"
+
+    # Verify artifact was replaced
+    run_podman artifact inspect "$artifact_name"
+
+    # Cleanup
+    run_podman artifact rm "$artifact_name"
+    rm -f "$file1" "$file2"
+}
diff --git a/test/system/701-artifact-created.bats b/test/system/701-artifact-created.bats

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,7 @@ type AddOptions struct {`
`64`	`64`	`ArtifactMIMEType *string`
`65`	`65`	`Append *bool`
`66`	`66`	`FileMIMEType *string`
	`67`	`+ Replace *bool`
`67`	`68`	`}`
`68`	`69`
`69`	`70`	`// ExtractOptions`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ type ArtifactAddOptions struct {`
`13`	`13`	`ArtifactMIMEType string`
`14`	`14`	`Append bool`
`15`	`15`	`FileMIMEType string`
	`16`	`+ Replace bool`
`16`	`17`	`}`
`17`	`18`
`18`	`19`	`type ArtifactAddReport = entitiesTypes.ArtifactAddReport`
Original file line number	Diff line number	Diff line change
`@@ -89,6 +89,7 @@ func (ir *ImageEngine) ArtifactAdd(_ context.Context, name string, artifactBlob`
`89`	`89`	`Append: &opts.Append,`
`90`	`90`	`ArtifactMIMEType: &opts.ArtifactMIMEType,`
`91`	`91`	`FileMIMEType: &opts.FileMIMEType,`
	`92`	`+ Replace: &opts.Replace,`
`92`	`93`	`}`
`93`	`94`
`94`	`95`	`for k, v := range opts.Annotations {`