Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add: Project Robot Account Management commands #101

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cmd/harbor/root/project/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ func Project() *cobra.Command {
ViewCommand(),
LogsProjectCommmand(),
SearchProjectCommand(),
Robot(),
)

return cmd
Expand Down
24 changes: 24 additions & 0 deletions cmd/harbor/root/project/robot.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package project

import (
"github.com/goharbor/harbor-cli/cmd/harbor/root/project/robot"
"github.com/spf13/cobra"
)

func Robot() *cobra.Command {
cmd := &cobra.Command{
Use: "robot",
Short: "Manage robot accounts",
Example: ` harbor project robot list`,
}
cmd.AddCommand(
robot.ListRobotCommand(),
robot.DeleteRobotCommand(),
robot.ViewRobotCommand(),
robot.CreateRobotCommand(),
robot.UpdateRobotCommand(),
robot.RefreshSecretCommand(),
)

return cmd
}
106 changes: 106 additions & 0 deletions cmd/harbor/root/project/robot/create.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
package robot

import (
"fmt"

"github.com/atotto/clipboard"
"github.com/goharbor/go-client/pkg/sdk/v2.0/models"
"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/robot/create"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)

func CreateRobotCommand() *cobra.Command {
var (
opts create.CreateView
projectName string
all bool
)

cmd := &cobra.Command{
Use: "create",
Short: "create robot",
Args: cobra.NoArgs,
Run: func(cmd *cobra.Command, args []string) {
var err error

if opts.ProjectName == "" {
opts.ProjectName = prompt.GetProjectNameFromUser()
if opts.ProjectName == "" {
log.Fatalf("Project Name Cannot be empty")
}
}

if len(args) == 0 {
if opts.Name == "" || opts.Duration == 0 {
create.CreateRobotView(&opts)
}
permissions := []models.Permission{}

if all {
perms, _ := api.GetPermissions()
permission := perms.Payload.Project

choices := []models.Permission{}
for _, perm := range permission {
choices = append(choices, *perm)
}
permissions = choices
} else {
permissions = prompt.GetRobotPermissionsFromUser()
}

// []Permission to []*Access
var accesses []*models.Access
for _, perm := range permissions {
access := &models.Access{
Action: perm.Action,
Resource: perm.Resource,
}
accesses = append(accesses, access)
}
// convert []models.permission to []*model.Access
perm := &create.RobotPermission{
Namespace: projectName,
Access: accesses,
}
opts.Permissions = []*create.RobotPermission{perm}
}
response, err := api.CreateRobot(opts, "project")
if err != nil {
log.Fatalf("failed to create robot: %v", err)
}

FormatFlag := viper.GetString("output-format")
if FormatFlag != "" {
name := response.Payload.Name
res, _ := api.GetRobot(response.Payload.ID)
utils.SavePayloadJSON(name, res.Payload)
return
}

name, secret := response.Payload.Name, response.Payload.Secret
create.CreateRobotSecretView(name, secret)
err = clipboard.WriteAll(response.Payload.Secret)
fmt.Println("secret copied to clipboard.")
},
}
flags := cmd.Flags()
flags.BoolVarP(
&all,
"all-permission",
"a",
false,
"Select all permissions for the robot account",
)
flags.StringVarP(&opts.ProjectName, "project", "", "", "set project name")
flags.StringVarP(&opts.Name, "name", "", "", "name of the robot account")
flags.StringVarP(&opts.Description, "description", "", "", "description of the robot account")
flags.Int64VarP(&opts.Duration, "duration", "", 0, "set expiration of robot account in days")

return cmd
}
41 changes: 41 additions & 0 deletions cmd/harbor/root/project/robot/delete.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package robot

import (
"strconv"

"github.com/goharbor/harbor-cli/pkg/api"
"github.com/goharbor/harbor-cli/pkg/prompt"
log "github.com/sirupsen/logrus"

"github.com/spf13/cobra"
)

// to-do improve DeleteRobotCommand and multi select & delete
func DeleteRobotCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "delete [robotID]",
Short: "delete robot by id",
Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
var (
robotID int64
err error
)
if len(args) == 1 {
robotID, err = strconv.ParseInt(args[0], 10, 64)
if err != nil {
log.Fatalf("failed to parse robot ID: %v", err)
}
} else {
projectID := prompt.GetProjectIDFromUser()
robotID = prompt.GetRobotIDFromUser(projectID)
}
err = api.DeleteRobot(robotID)
if err != nil {
log.Fatalf("failed to Delete robots")
}
},
}

return cmd
}
63 changes: 63 additions & 0 deletions cmd/harbor/root/project/robot/list.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package robot

import (
"log"
"strconv"

"github.com/goharbor/harbor-cli/pkg/api"
"github.com/goharbor/harbor-cli/pkg/constants"
"github.com/goharbor/harbor-cli/pkg/prompt"
"github.com/goharbor/harbor-cli/pkg/utils"
"github.com/goharbor/harbor-cli/pkg/views/robot/list"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)

// ListRobotCommand creates a new `harbor project robot list` command
func ListRobotCommand() *cobra.Command {
var opts api.ListFlags

projectQString := constants.ProjectQString
cmd := &cobra.Command{
Use: "list [projectID]",
Short: "list robot",
Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
if len(args) > 0 {
opts.Q = projectQString + args[0]
} else if opts.Q != "" {
opts.Q = projectQString + opts.Q
} else {
projectID := prompt.GetProjectIDFromUser()
opts.Q = projectQString + strconv.FormatInt(projectID, 10)
}

robots, err := api.ListRobot(opts)
if err != nil {
log.Fatalf("failed to get robots list: %v", err)
}

FormatFlag := viper.GetString("output-format")
if FormatFlag != "" {
utils.PrintPayloadInJSONFormat(robots)
return
}

list.ListRobots(robots.Payload)
},
}

flags := cmd.Flags()
flags.Int64VarP(&opts.Page, "page", "", 1, "Page number")
flags.Int64VarP(&opts.PageSize, "page-size", "", 10, "Size of per page")
flags.StringVarP(&opts.Q, "query", "q", "", "Query string to query resources")
flags.StringVarP(
&opts.Sort,
"sort",
"",
"",
"Sort the resource list in ascending or descending order",
)

return cmd
}
87 changes: 87 additions & 0 deletions cmd/harbor/root/project/robot/refresh.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
package robot

import (
"fmt"
"strconv"

"github.com/atotto/clipboard"
"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/robot/create"
log "github.com/sirupsen/logrus"

"github.com/spf13/cobra"
)

func RefreshSecretCommand() *cobra.Command {
var (
robotID int64
secret string
secretStdin bool
)
cmd := &cobra.Command{
Use: "refresh [robotID]",
Short: "refresh robot secret by id",
Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
var err error
if len(args) == 1 {
robotID, err = strconv.ParseInt(args[0], 10, 64)
if err != nil {
log.Fatalf("failed to parse robot ID: %v", err)
}
} else {
projectID := prompt.GetProjectIDFromUser()
robotID = prompt.GetRobotIDFromUser(projectID)
}

if secret != "" {
err = utils.ValidatePassword(secret)
if err != nil {
log.Fatalf("Invalid secret: %v\n", err)
}
}
if secretStdin {
secret = getSecret()
}

response, err := api.RefreshSecret(secret, robotID)
if err != nil {
log.Fatalf("failed to refresh robot secret: %v\n", err)
}

log.Info("Secret updated successfully.")

if response.Payload.Secret != "" {
secret = response.Payload.Secret
create.CreateRobotSecretView("", secret)

err = clipboard.WriteAll(response.Payload.Secret)
if err != nil {
log.Fatalf("failed to write the secret to the clipboard: %v", err)
}
fmt.Println("secret copied to clipboard.")
}
},
}

flags := cmd.Flags()
flags.StringVarP(&secret, "secret", "", "", "secret")
flags.BoolVarP(&secretStdin, "secret-stdin", "", false, "Take the robot secret from stdin")

return cmd
}

// getSecret from commandline
func getSecret() string {
secret, err := utils.GetSecretStdin("Enter your secret: ")
if err != nil {
log.Fatalf("Error reading secret: %v\n", err)
}

if err := utils.ValidatePassword(secret); err != nil {
log.Fatalf("Invalid secret: %v\n", err)
}
return secret
}
Loading
Loading