feat: Add label sub-cmd in artifact cmd (goharbor#483)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Prasanth Baskar <bupdprasanth@gmail.com>

Author: 3 people

cmd/harbor/root/artifact/cmd.go

@@ -14,6 +14,7 @@
 package artifact
 
 import (
+	"github.com/goharbor/harbor-cli/cmd/harbor/root/artifact/label"
 	"github.com/spf13/cobra"
 )
 
@@ -31,6 +32,7 @@ func Artifact() *cobra.Command {
 		DeleteArtifactCommand(),
 		ScanArtifactCommand(),
 		ArtifactTagsCmd(),
+		label.LabelsArtifactCommmand(),
 	)
 
 	return cmd

cmd/harbor/root/artifact/delete.go

@@ -14,6 +14,8 @@
 package artifact
 
 import (
+	"fmt"
+
 	"github.com/goharbor/harbor-cli/pkg/api"
 	"github.com/goharbor/harbor-cli/pkg/prompt"
 	"github.com/goharbor/harbor-cli/pkg/utils"
@@ -26,17 +28,13 @@ func DeleteArtifactCommand() *cobra.Command {
 		Use:   "delete",
 		Short: "delete an artifact",
 		Args:  cobra.MaximumNArgs(1),
-		Run: func(cmd *cobra.Command, args []string) {
+		RunE: func(cmd *cobra.Command, args []string) error {
 			var err error
 			var projectName, repoName, reference string
 			if len(args) > 0 {
-				projectName, repoName, reference, parseError := utils.ParseProjectRepoReference(args[0])
-				if parseError != nil {
-					log.Errorf("failed to parse project/repo/reference: %v", parseError)
-				}
-				err = api.DeleteArtifact(projectName, repoName, reference)
+				projectName, repoName, reference, err = utils.ParseProjectRepoReference(args[0])
 				if err != nil {
-					log.Errorf("failed to delete an artifact: %v", err)
+					return fmt.Errorf("failed to parse project/repo/reference: %v", err)
 				}
 			} else {
 				projectName, err = prompt.GetProjectNameFromUser()
@@ -48,8 +46,9 @@ func DeleteArtifactCommand() *cobra.Command {
 			}
 			err = api.DeleteArtifact(projectName, repoName, reference)
 			if err != nil {
-				log.Errorf("failed to delete an artifact: %v", err)
+				return fmt.Errorf("failed to delete an artifact: %v", utils.ParseHarborErrorMsg(err))
 			}
+			return nil
 		},
 	}
 

cmd/harbor/root/artifact/label/add.go

@@ -0,0 +1,92 @@
+// Copyright Project Harbor Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package label
+
+import (
+	"fmt"
+
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/prompt"
+	"github.com/goharbor/harbor-cli/pkg/utils"
+	"github.com/spf13/cobra"
+)
+
+// AddLabelArtifactCommmand adds a label to an artifact
+func AddLabelArtifactCommmand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "add",
+		Short: "Attach a label to an artifact in a Harbor project repository",
+		Long: `Attach an existing label to a specific artifact identified by <project>/<repository>:<reference>.
+You can specify the artifact and label directly as arguments, or interactively select them if arguments are omitted.
+
+Examples:
+  # Add a label to an artifact using project/repo:reference and label name
+  harbor artifact label add myproject/myrepo@sha256:abcdef1234567890 dev
+
+  # Prompt-based label selection for an artifact
+  harbor artifact label add library/nginx:1.21
+
+  # Fully interactive mode (prompt for everything)
+  harbor artifact label add
+`,
+		Args: cobra.MaximumNArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var (
+				projectName, repoName, reference string
+				labelName                        string
+				labelID                          int64
+				err                              error
+			)
+
+			if len(args) >= 1 {
+				projectName, repoName, reference, err = utils.ParseProjectRepoReference(args[0])
+				if err != nil {
+					return fmt.Errorf("failed to parse project/repo/reference: %v", err)
+				}
+			} else {
+				projectName, err = prompt.GetProjectNameFromUser()
+				if err != nil {
+					return fmt.Errorf("failed to get project name: %v", utils.ParseHarborErrorMsg(err))
+				}
+				repoName = prompt.GetRepoNameFromUser(projectName)
+				reference = prompt.GetReferenceFromUser(repoName, projectName)
+			}
+
+			if len(args) == 2 {
+				labelName = args[1]
+				labelID, err = api.GetLabelIdByName(labelName)
+				if err != nil {
+					return fmt.Errorf("failed to get label id: %v", utils.ParseHarborErrorMsg(err))
+				}
+			} else {
+				labels, err := api.ListLabel()
+				if err != nil {
+					return fmt.Errorf("failed to list labels: %v", utils.ParseHarborErrorMsg(err))
+				}
+				labelID = prompt.GetLabelIdFromUser(labels.Payload)
+			}
+
+			label := api.GetLabel(labelID)
+
+			if _, err := api.AddLabelArtifact(projectName, repoName, reference, label); err != nil {
+				return fmt.Errorf("failed to add label to artifact: %v", utils.ParseHarborErrorMsg(err))
+			}
+
+			fmt.Printf("Label '%s' added to artifact %s/%s@%s\n", label.Name, projectName, repoName, reference)
+			return nil
+		},
+	}
+
+	return cmd
+}

cmd/harbor/root/artifact/label/cmd.go

@@ -0,0 +1,34 @@
+// Copyright Project Harbor Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package label
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// LabelsArtifactCommmand compound command to label artifacts
+func LabelsArtifactCommmand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "label",
+		Short: "label command for artifacts",
+		Long:  `label command for artifact`,
+		Example: `harbor artifact label add <project>/<repository>/<reference> <label name>
+harbor artifact label del <project>/<repository>/<reference> <label name>
+		`,
+	}
+	cmd.AddCommand(AddLabelArtifactCommmand())
+	cmd.AddCommand(DelLabelArtifactCommmand())
+	cmd.AddCommand(ListLabelArtifactCommmand())
+	return cmd
+}

cmd/harbor/root/artifact/label/delete.go

@@ -0,0 +1,97 @@
+// Copyright Project Harbor Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package label
+
+import (
+	"fmt"
+
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/prompt"
+	"github.com/goharbor/harbor-cli/pkg/utils"
+	"github.com/spf13/cobra"
+)
+
+// DelLabelArtifactCommmand deletes a label from an artifact
+func DelLabelArtifactCommmand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "delete",
+		Aliases: []string{"del"},
+		Short:   "Detach a label from an artifact in a Harbor project repository",
+		Long: `Remove an existing label from a specific artifact identified by <project>/<repository>:<reference>.
+You can provide the artifact and label name as arguments, or choose them interactively if not specified.
+
+Examples:
+  # Remove a label by specifying artifact and label name
+  harbor artifact label delete library/nginx:latest stable
+
+  # Prompt-based label selection for a specific artifact
+  harbor artifact label del library/nginx:1.21
+
+  # Fully interactive mode (prompt for project, repo, reference, and label)
+  harbor artifact label delete
+
+  # Remove a label from an artifact identified by digest
+  harbor artifact label del myproject/myrepo@sha256:abcdef1234567890 qa-label`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var (
+				projectName, repoName, reference string
+				labelID                          int64
+				err                              error
+			)
+
+			if len(args) >= 1 {
+				projectName, repoName, reference, err = utils.ParseProjectRepoReference(args[0])
+				if err != nil {
+					return fmt.Errorf("failed to parse project/repo/reference: %v", err)
+				}
+			} else {
+				projectName, err = prompt.GetProjectNameFromUser()
+				if err != nil {
+					return fmt.Errorf("failed to get project name: %v", utils.ParseHarborErrorMsg(err))
+				}
+				repoName = prompt.GetRepoNameFromUser(projectName)
+				reference = prompt.GetReferenceFromUser(repoName, projectName)
+			}
+
+			if len(args) == 2 {
+				labelName := args[1]
+				labelID, err = api.GetLabelIdByName(labelName)
+				if err != nil {
+					return fmt.Errorf("failed to get label id: %v", utils.ParseHarborErrorMsg(err))
+				}
+			} else {
+				artifact, err := api.ViewArtifact(projectName, repoName, reference, true)
+				if err != nil || artifact == nil {
+					return fmt.Errorf("failed to get artifact info: %v", utils.ParseHarborErrorMsg(err))
+				}
+
+				labels := artifact.Payload.Labels
+				if len(labels) == 0 {
+					fmt.Printf("No labels found for artifact %s/%s@%s\n", projectName, repoName, reference)
+					return nil
+				}
+				labelID = prompt.GetLabelIdFromUser(labels)
+			}
+
+			if _, err := api.RemoveLabelArtifact(projectName, repoName, reference, labelID); err != nil {
+				return fmt.Errorf("failed to remove label from artifact: %v", utils.ParseHarborErrorMsg(err))
+			}
+
+			fmt.Println("Label removed successfully")
+			return nil
+		},
+	}
+
+	return cmd
+}

cmd/harbor/root/artifact/label/list.go

@@ -0,0 +1,101 @@
+// Copyright Project Harbor Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package label
+
+import (
+	"fmt"
+
+	"github.com/goharbor/go-client/pkg/sdk/v2.0/client/artifact"
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/prompt"
+	"github.com/goharbor/harbor-cli/pkg/utils"
+	"github.com/goharbor/harbor-cli/pkg/views/label/list"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+// DelLabelArtifactCommmand delete label command to artifact
+func ListLabelArtifactCommmand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "list",
+		Short: "Display labels attached to a specific artifact",
+		Long: `This command lists all labels currently associated with a specific artifact in a Harbor project repository.
+You can provide the artifact reference in the format <project>/<repository>:<reference> (where reference is either a tag or a digest).
+If the reference is not provided as an argument, the command will prompt you to select the project, repository, and artifact.
+
+Supports output formatting such as JSON or YAML using the --output (-o) flag.`,
+		Example: `  # List labels for a tagged artifact
+  harbor artifact label list library/nginx:latest
+
+  # List labels for an artifact by digest
+  harbor artifact label list myproject/myrepo@sha256:abc123...
+
+  # Prompt-based interactive selection of artifact
+  harbor artifact label list
+
+  # Output in JSON format
+  harbor artifact label list library/nginx:1.21 -o json`,
+		Args: cobra.MaximumNArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var err error
+			var projectName, repoName, reference string
+			var artifact *artifact.GetArtifactOK
+			getLabel := true
+			if len(args) > 0 {
+				projectName, repoName, reference, err = utils.ParseProjectRepoReference(args[0])
+				if err != nil {
+					return fmt.Errorf("failed to parse project/repo/reference: %v", err)
+				}
+			} else {
+				projectName, err = prompt.GetProjectNameFromUser()
+				if err != nil {
+					return fmt.Errorf("failed to get project name: %v", utils.ParseHarborErrorMsg(err))
+				}
+				repoName = prompt.GetRepoNameFromUser(projectName)
+				reference = prompt.GetReferenceFromUser(repoName, projectName)
+			}
+
+			if reference == "" {
+				if len(args) > 0 {
+					return fmt.Errorf("Invalid artifact reference format: %s", args[0])
+				} else {
+					return fmt.Errorf("Invalid artifact reference format: no arguments provided")
+				}
+			}
+
+			artifact, err = api.ViewArtifact(projectName, repoName, reference, getLabel)
+
+			if err != nil || artifact == nil {
+				return fmt.Errorf("failed to get info of an artifact: %v", utils.ParseHarborErrorMsg(err))
+			}
+			labelList := artifact.Payload.Labels
+			if len(labelList) == 0 {
+				fmt.Printf("No labels found for artifact %s/%s@%s", projectName, repoName, reference)
+				return nil
+			}
+			formatFlag := viper.GetString("output-format")
+			if formatFlag != "" {
+				err = utils.PrintFormat(labelList, formatFlag)
+				if err != nil {
+					return err
+				}
+			} else {
+				list.ListLabels(labelList)
+			}
+			return nil
+		},
+	}
+
+	return cmd
+}