feat: add webhook cmd (#391)

Author: rizul2108

cmd/harbor/root/cmd.go

@@ -29,6 +29,7 @@ import (
 	"github.com/goharbor/harbor-cli/cmd/harbor/root/schedule"
 	"github.com/goharbor/harbor-cli/cmd/harbor/root/tag"
 	"github.com/goharbor/harbor-cli/cmd/harbor/root/user"
+	"github.com/goharbor/harbor-cli/cmd/harbor/root/webhook"
 	"github.com/goharbor/harbor-cli/pkg/utils"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -105,6 +106,7 @@ harbor help
 		schedule.Schedule(),
 		labels.Labels(),
 		InfoCommand(),
+		webhook.Webhook(),
 		instance.Instance(),
 	)
 

cmd/harbor/root/webhook/cmd.go

@@ -0,0 +1,45 @@
+// 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 webhook
+
+import "github.com/spf13/cobra"
+
+func Webhook() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "webhook",
+		Short: "Manage webhook policies in Harbor",
+		Long: `Use this command to manage webhook policies in your Harbor projects.
+
+Webhooks enable external systems to be notified of events in Harbor (e.g., pushing an image, deleting an artifact). 
+This command supports listing, creating, editing, and deleting webhook configurations.`,
+		Example: `  # List webhook policies in a project
+  harbor-cli webhook list my-project
+
+  # Create a new webhook policy
+  harbor-cli webhook create --project my-project --name my-webhook
+
+  # Edit an existing webhook policy
+  harbor-cli webhook edit --project my-project --webhook-id 5
+
+  # Delete a webhook policy
+  harbor-cli webhook delete --project my-project --webhook-id 5`,
+	}
+	cmd.AddCommand(
+		CreateWebhookCmd(),
+		ListWebhookCommand(),
+		DeleteWebhookCmd(),
+		EditWebhookCmd(),
+	)
+	return cmd
+}

cmd/harbor/root/webhook/create.go

@@ -0,0 +1,114 @@
+// 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 webhook
+
+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/goharbor/harbor-cli/pkg/views/webhook/create"
+	"github.com/spf13/cobra"
+)
+
+func CreateWebhookCmd() *cobra.Command {
+	var opts create.CreateView
+
+	cmd := &cobra.Command{
+		Use:   "create [name]",
+		Short: "Create a new webhook for a Harbor project",
+		Long: `This command creates a new webhook policy for a specified Harbor project.
+
+You can either provide all required flags (project name, notify type, endpoint, etc.) directly to create the webhook non-interactively,
+or leave them out and be guided through an interactive prompt to input each field. The webhook name is required as an argument.`,
+		Example: `  # Create a webhook using flags
+  harbor-cli webhook create my-webhook \
+    --project my-project \
+    --notify-type http \
+    --event-type PUSH_ARTIFACT,DELETE_ARTIFACT \
+    --endpoint-url https://example.com/webhook \
+    --description "Webhook for artifact events" \
+    --payload-format Default \
+    --auth-header "Bearer mytoken"
+
+  # Create a webhook using the interactive prompt
+  harbor-cli webhook create my-webhook`,
+		Args: cobra.MaximumNArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var err error
+			if len(args) > 0 {
+				opts.Name = args[0]
+			}
+
+			createView := &create.CreateView{
+				ProjectName:             opts.ProjectName,
+				Name:                    opts.Name,
+				Description:             opts.Description,
+				NotifyType:              opts.NotifyType,
+				PayloadFormat:           opts.PayloadFormat,
+				EventType:               opts.EventType,
+				EndpointURL:             opts.EndpointURL,
+				AuthHeader:              opts.AuthHeader,
+				VerifyRemoteCertificate: opts.VerifyRemoteCertificate,
+			}
+
+			if opts.ProjectName != "" &&
+				opts.Name != "" &&
+				opts.NotifyType != "" &&
+				len(opts.EventType) != 0 &&
+				opts.EndpointURL != "" {
+				err = utils.ValidateURL(opts.EndpointURL)
+				if err != nil {
+					return err
+				}
+				err = api.CreateWebhook(&opts)
+			} else {
+				err = createWebhookView(createView)
+			}
+			if err != nil {
+				return fmt.Errorf("failed to create webhook: %v", err)
+			}
+			return nil
+		},
+	}
+
+	flags := cmd.Flags()
+
+	flags.StringVarP(&opts.ProjectName, "project", "", "", "Project Name")
+	flags.StringVarP(&opts.Description, "description", "", "", "Webhook Description")
+	flags.StringVarP(&opts.NotifyType, "notify-type", "", "", "Notify Type (http, slack)")
+	flags.StringSliceVarP(&opts.EventType, "event-type", "", []string{}, "Event Types (comma separated)")
+	flags.StringVarP(&opts.EndpointURL, "endpoint-url", "", "", "Webhook Endpoint URL")
+	flags.StringVarP(&opts.PayloadFormat, "payload-format", "", "", "Payload Format (Default, CloudEvents)")
+	flags.StringVarP(&opts.AuthHeader, "auth-header", "", "", "Authentication Header")
+	flags.BoolVarP(&opts.VerifyRemoteCertificate, "verify-remote-certificate", "", true, "Verify Remote Certificate")
+
+	return cmd
+}
+
+func createWebhookView(view *create.CreateView) error {
+	var err error
+	if view.ProjectName == "" {
+		view.ProjectName, err = prompt.GetProjectNameFromUser()
+		if err != nil {
+			return err
+		}
+	}
+	err = create.WebhookCreateView(view)
+	if err != nil {
+		return err
+	}
+	return api.CreateWebhook(view)
+}

cmd/harbor/root/webhook/delete.go

@@ -0,0 +1,98 @@
+// 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 webhook
+
+import (
+	"fmt"
+
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/prompt"
+	"github.com/spf13/cobra"
+)
+
+func DeleteWebhookCmd() *cobra.Command {
+	var (
+		projectName string
+		webhookId   int64 = -1
+	)
+
+	cmd := &cobra.Command{
+		Use:   "delete [webhook-name]",
+		Short: "Delete a webhook from a Harbor project",
+		Long: `Delete a webhook from a specified Harbor project.
+You can either specify the project name and webhook ID using flags,
+pass the webhook name as an argument,
+or interactively select a project and webhook if not provided.`,
+		Example: `  # Delete by project and webhook ID
+  harbor-cli webhook delete --project my-project --webhook 5
+
+  # Delete by project and webhook name
+  harbor-cli webhook delete my-webhook --project my-project
+
+  # Fully interactive deletion
+  harbor-cli webhook delete`,
+		Args: cobra.MaximumNArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var err error
+			var webhookName string
+
+			if len(args) > 0 {
+				webhookName = args[0]
+			}
+
+			if webhookId != -1 && webhookName != "" {
+				return fmt.Errorf("webhook ID and name cannot be provided together")
+			}
+
+			if (webhookId != -1 || webhookName != "") && projectName == "" {
+				return fmt.Errorf("project name must be provided when specifying webhook ID or webhook name")
+			}
+
+			if projectName == "" {
+				projectName, err = prompt.GetProjectNameFromUser()
+				if err != nil {
+					return err
+				}
+			}
+
+			if webhookName != "" {
+				webhookId, err = api.GetWebhookID(projectName, webhookName)
+				if err != nil {
+					return fmt.Errorf("failed to get webhook ID for '%s': %w", webhookName, err)
+				}
+			}
+
+			if webhookId == -1 {
+				selectedWebhook, err := prompt.GetWebhookFromUser(projectName)
+				if err != nil {
+					return fmt.Errorf("failed to select webhook: %w", err)
+				}
+				webhookId = selectedWebhook.ID
+			}
+
+			if err := api.DeleteWebhook(projectName, webhookId); err != nil {
+				return fmt.Errorf("failed to delete webhook: %w", err)
+			}
+
+			fmt.Printf("Webhook deleted successfully from project '%s'\n", projectName)
+			return nil
+		},
+	}
+
+	flags := cmd.Flags()
+	flags.StringVarP(&projectName, "project", "", "", "Project name (required when providing webhook ID or name)")
+	flags.Int64VarP(&webhookId, "webhook-id", "", -1, "Webhook ID (alternative to providing webhook name as argument)")
+
+	return cmd
+}