Add scanner cmd

cmd/harbor/root/cmd.go

@@ -23,6 +23,7 @@ import (
 	"github.com/goharbor/harbor-cli/cmd/harbor/root/project"
 	"github.com/goharbor/harbor-cli/cmd/harbor/root/registry"
 	repositry "github.com/goharbor/harbor-cli/cmd/harbor/root/repository"
+	"github.com/goharbor/harbor-cli/cmd/harbor/root/scanner"
 	"github.com/goharbor/harbor-cli/cmd/harbor/root/schedule"
 	"github.com/goharbor/harbor-cli/cmd/harbor/root/user"
 	"github.com/goharbor/harbor-cli/pkg/utils"
@@ -96,6 +97,7 @@ harbor help
 		repositry.Repository(),
 		user.User(),
 		artifact.Artifact(),
+		scanner.Scanner(),
 		HealthCommand(),
 		schedule.Schedule(),
 		labels.Labels(),

cmd/harbor/root/scanner/cmd.go

@@ -0,0 +1,35 @@
+// 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 scanner
+
+import "github.com/spf13/cobra"
+
+func Scanner() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "scanner",
+		Short: "scanner commands",
+	}
+
+	cmd.AddCommand(
+		CreateScannerCommand(),
+		ListScannerCommand(),
+		ViewCommand(),
+		MetadataCommand(),
+		SetDefaultCommand(),
+		DeleteCommand(),
+		UpdateCommand(),
+	)
+
+	return cmd
+}

cmd/harbor/root/scanner/create.go

@@ -0,0 +1,62 @@
+// 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 scanner
+
+import (
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/views/scanner/create"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+func CreateScannerCommand() *cobra.Command {
+	var opts create.CreateView
+	var ping bool
+
+	cmd := &cobra.Command{
+		Use:   "create",
+		Short: "Create a scanner",
+		Args:  cobra.NoArgs,
+		Run: func(cmd *cobra.Command, args []string) {
+			if opts.Name == "" || opts.Description == "" || opts.Auth == "" || opts.AccessCredential == "" || opts.URL == "" {
+				create.CreateScannerView(&opts)
+			}
+
+			if ping {
+				err := api.PingScanner(opts)
+				if err != nil {
+					log.Errorf("failed to ping the scanner adapter: %v", err)
+				}
+			} else {
+				err := api.CreateScanner(opts)
+				if err != nil {
+					log.Errorf("failed to create scanner: %v", err.Error())
+				}
+			}
+		},
+	}
+
+	flags := cmd.Flags()
+	flags.StringVarP(&opts.Name, "name", "", "", "Name of the scanner")
+	flags.StringVarP(&opts.Description, "des", "", "", "Description of the scanner")
+	flags.StringVarP(&opts.Auth, "auth", "", "", "Authentication approach of the scanner [None|Basic|Bearer|X-ScannerAdapter-API-Key]")
+	flags.StringVarP(&opts.AccessCredential, "cred", "", "", "HTTP Authorization header value sent with each request to the Scanner Adapter API")
+	flags.StringVarP(&opts.URL, "url", "", "", "Base URL of the scanner adapter")
+	flags.BoolVarP(&opts.Disabled, "disable", "", false, "Indicate whether the registration is enabled or not")
+	flags.BoolVarP(&opts.SkipCertVerify, "skip", "", false, "Indicate if skip the certificate verification when sending HTTP requests")
+	flags.BoolVarP(&opts.UseInternalAddr, "internal", "", false, "Indicate whether use internal registry addr for the scanner to pull content or not")
+	flags.BoolVarP(&ping, "ping", "", false, "Ping the scanner adapter without creating it.")
+
+	return cmd
+}

cmd/harbor/root/scanner/delete.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 scanner
+
+import (
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/prompt"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+func DeleteCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "delete",
+		Short: "delete scanner",
+		Args:  cobra.MaximumNArgs(1),
+		Run: func(cmd *cobra.Command, args []string) {
+			var err error
+			var registrationID string
+			if len(args) > 0 {
+				registrationID = args[0]
+			} else {
+				registrationID = prompt.GetScannerIdFromUser()
+			}
+			err = api.DeleteScanner(registrationID)
+			if err != nil {
+				log.Errorf("failed to delete scanner: %v", err)
+			} else {
+				log.Infof("scanner deleted successfully")
+			}
+		},
+	}
+	return cmd
+}

cmd/harbor/root/scanner/list.go

@@ -0,0 +1,58 @@
+// 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 scanner
+
+import (
+	"fmt"
+
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/utils"
+	list "github.com/goharbor/harbor-cli/pkg/views/scanner/list"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+func ListScannerCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "list",
+		Short: "List scanners",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			scannersResp, err := api.ListScanners()
+			if err != nil {
+				return fmt.Errorf("failed to list scanners: %v", err)
+			}
+
+			scanners := scannersResp.Payload
+			if len(scanners) == 0 {
+				log.Info("No scanners found")
+				return nil
+			}
+
+			formatFlag := viper.GetString("output-format")
+			if formatFlag != "" {
+				err = utils.PrintFormat(scanners, formatFlag)
+				if err != nil {
+					return err
+				}
+			} else {
+				list.ListScanners(scanners)
+			}
+
+			return nil
+		},
+	}
+	return cmd
+}

cmd/harbor/root/scanner/metadata.go

@@ -0,0 +1,60 @@
+// 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 scanner
+
+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/scanner/metadata"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+func MetadataCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "metadata [scanner-id]",
+		Short: "Get scanner metadata by ID",
+		Args:  cobra.MaximumNArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			var registrationID string
+			if len(args) > 0 {
+				registrationID = args[0]
+			} else {
+				registrationID = prompt.GetScannerIdFromUser()
+			}
+
+			meta, err := api.GetScannerMetadata(registrationID)
+			if err != nil {
+				return fmt.Errorf("failed to get scanner metadata: %v", err)
+			}
+
+			formatFlag := viper.GetString("output-format")
+			if formatFlag != "" {
+				err = utils.PrintFormat(meta, formatFlag)
+				if err != nil {
+					return err
+				}
+			} else {
+				metadata.DisplayScannerMetadata(meta.Payload)
+			}
+
+			return nil
+		},
+	}
+
+	return cmd
+}

cmd/harbor/root/scanner/set_default.go

@@ -0,0 +1,44 @@
+// 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 scanner
+
+import (
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/prompt"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+func SetDefaultCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "set-default",
+		Short:   "set default scanner",
+		Aliases: []string{"sd"},
+		Args:    cobra.MaximumNArgs(1),
+		Run: func(cmd *cobra.Command, args []string) {
+			var err error
+			var registrationID string
+			if len(args) > 0 {
+				registrationID = args[0]
+			} else {
+				registrationID = prompt.GetScannerIdFromUser()
+			}
+			err = api.SetDefaultScanner(registrationID)
+			if err != nil {
+				log.Errorf("failed to set default scanner: %v", err)
+			}
+		},
+	}
+	return cmd
+}

cmd/harbor/root/scanner/update.go

@@ -0,0 +1,66 @@
+// 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 scanner
+
+import (
+	"github.com/goharbor/harbor-cli/pkg/api"
+	"github.com/goharbor/harbor-cli/pkg/prompt"
+	"github.com/goharbor/harbor-cli/pkg/views/scanner/create"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+func UpdateCommand() *cobra.Command {
+	var opts create.CreateView
+
+	cmd := &cobra.Command{
+		Use:   "update",
+		Short: "update scanner",
+		Args:  cobra.MaximumNArgs(1),
+		Run: func(cmd *cobra.Command, args []string) {
+			var err error
+			var registrationID string
+
+			if len(args) > 0 {
+				registrationID = args[0]
+			} else {
+				registrationID = prompt.GetScannerIdFromUser()
+			}
+
+			if opts.Name == "" || opts.Description == "" || opts.Auth == "" || opts.AccessCredential == "" || opts.URL == "" {
+				create.CreateScannerView(&opts)
+			}
+
+			err = api.UpdateScanner(registrationID, opts)
+
+			if err != nil {
+				log.Errorf("failed to update scanner: %v", err)
+			} else {
+				log.Infof("scanner updated successfully")
+			}
+		},
+	}
+
+	flags := cmd.Flags()
+	flags.StringVarP(&opts.Name, "name", "", "", "Name of the scanner")
+	flags.StringVarP(&opts.Description, "des", "", "", "Description of the scanner")
+	flags.StringVarP(&opts.Auth, "auth", "", "", "Authentication approach of the scanner [None|Basic|Bearer|X-ScannerAdapter-API-Key]")
+	flags.StringVarP(&opts.AccessCredential, "cred", "", "", "HTTP Authorization header value sent with each request to the Scanner Adapter API")
+	flags.StringVarP(&opts.URL, "url", "", "", "Base URL of the scanner adapter")
+	flags.BoolVarP(&opts.Disabled, "disable", "", false, "Indicate whether the registration is enabled or not")
+	flags.BoolVarP(&opts.SkipCertVerify, "skip", "", false, "Indicate if skip the certificate verification when sending HTTP requests")
+	flags.BoolVarP(&opts.UseInternalAddr, "internal", "", false, "Indicate whether use internal registry addr for the scanner to pull content or not")
+
+	return cmd
+}