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.

Sign up for GitHub

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 projectID flag option to delete project command #324

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+51 −20
Open

add projectID flag option to delete project command #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions cmd/harbor/root/project/delete.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,20 @@ import (
// DeleteProjectCommand creates a new `harbor delete project` command
func DeleteProjectCommand() *cobra.Command {
var forceDelete bool
var useProjectID bool

cmd := &cobra.Command{
Use: "delete",
Short: "delete project by name or id",
Short: "Delete project by name or ID",
Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
var err error

if len(args) > 0 {
err = api.DeleteProject(args[0], forceDelete)
err = api.DeleteProject(args[0], forceDelete, useProjectID)
} else {
projectName := prompt.GetProjectNameFromUser()
err = api.DeleteProject(projectName, forceDelete)
err = api.DeleteProject(projectName, forceDelete, false)
}
if err != nil {
log.Errorf("failed to delete project: %v", err)
Expand All @@ -45,6 +46,7 @@ func DeleteProjectCommand() *cobra.Command {

flags := cmd.Flags()
flags.BoolVar(&forceDelete, "force", false, "Deletes all repositories and artifacts within the project")
flags.BoolVar(&useProjectID, "projectID", false, "If set, treats the provided argument as a project ID instead of a project name")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest project ID to be a flag to which you can pass project ids. rather than having it as a boolean. since this would allow the args to always be projectname maintaining consistency.

Thanks

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest project ID to be a flag to which you can pass project ids. rather than having it as a boolean. since this would allow the args to always be projectname maintaining consistency.

@bupd
So are you suggesting to make projectName an optional input for the delete command? Because I was under the understanding that we are giving projectID when we did not know the projectName.

Right now, when we don't give projectName, we enter the prompt mode and again choose projectName. So do we want to change that behavior when the projectID flag is given?


return cmd
}
8 changes: 4 additions & 4 deletions cmd/harbor/root/project/view.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ func ViewCommand() *cobra.Command {
Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
var err error
var projectName string
var projectNameOrID string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

have it just projectName and have different var for projectID.

var project *project.GetProjectOK

if len(args) > 0 {
projectName = args[0]
projectNameOrID = args[0]
} else {
projectName = prompt.GetProjectNameFromUser()
projectNameOrID = prompt.GetProjectNameFromUser()
}

project, err = api.GetProject(projectName)
project, err = api.GetProject(projectNameOrID, false)
if err != nil {
log.Errorf("failed to get project: %v", err)
return
Expand Down
4 changes: 2 additions & 2 deletions cmd/harbor/root/repository/delete.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ func RepoDeleteCmd() *cobra.Command {
var err error
if len(args) > 0 {
projectName, repoName := utils.ParseProjectRepo(args[0])
err = api.RepoDelete(projectName, repoName)
err = api.RepoDelete(projectName, repoName, false)
} else {
projectName := prompt.GetProjectNameFromUser()
repoName := prompt.GetRepoNameFromUser(projectName)
err = api.RepoDelete(projectName, repoName)
err = api.RepoDelete(projectName, repoName, false)
}
if err != nil {
log.Errorf("failed to delete repository: %v", err)
Expand Down
2 changes: 1 addition & 1 deletion cmd/harbor/root/repository/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func ListRepositoryCommand() *cobra.Command {
projectName = prompt.GetProjectNameFromUser()
}

repos, err = api.ListRepository(projectName)
repos, err = api.ListRepository(projectName, false)
if err != nil {
log.Errorf("failed to list repositories: %v", err)
return
Expand Down
20 changes: 13 additions & 7 deletions pkg/api/project_handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,18 @@ func CreateProject(opts create.CreateView) error {
return nil
}

func GetProject(projectName string) (*project.GetProjectOK, error) {
func GetProject(projectNameOrID string, useProjectID bool) (*project.GetProjectOK, error) {
ctx, client, err := utils.ContextWithClient()
var response = &project.GetProjectOK{}

if err != nil {
return response, err
}

response, err = client.Project.GetProject(ctx, &project.GetProjectParams{ProjectNameOrID: projectName})
response, err = client.Project.GetProject(ctx, &project.GetProjectParams{
ProjectNameOrID: projectNameOrID,
XIsResourceName: utils.CreateBoolPointer(!useProjectID),
})

if err != nil {
return response, err
Expand All @@ -70,7 +73,7 @@ func GetProject(projectName string) (*project.GetProjectOK, error) {
return response, nil
}

func DeleteProject(projectName string, forceDelete bool) error {
func DeleteProject(projectNameOrID string, forceDelete bool, useProjectID bool) error {
ctx, client, err := utils.ContextWithClient()
if err != nil {
return err
Expand All @@ -79,7 +82,7 @@ func DeleteProject(projectName string, forceDelete bool) error {
if forceDelete {
var resp repository.ListRepositoriesOK

resp, err = ListRepository(projectName)
resp, err = ListRepository(projectNameOrID, useProjectID)

if err != nil {
log.Errorf("failed to list repositories: %v", err)
Expand All @@ -88,7 +91,7 @@ func DeleteProject(projectName string, forceDelete bool) error {

for _, repo := range resp.Payload {
_, repoName := utils.ParseProjectRepo(repo.Name)
err = RepoDelete(projectName, repoName)
err = RepoDelete(projectNameOrID, repoName, useProjectID)

if err != nil {
log.Errorf("failed to delete repository: %v", err)
Expand All @@ -97,13 +100,16 @@ func DeleteProject(projectName string, forceDelete bool) error {
}
}

_, err = client.Project.DeleteProject(ctx, &project.DeleteProjectParams{ProjectNameOrID: projectName})
_, err = client.Project.DeleteProject(ctx, &project.DeleteProjectParams{
ProjectNameOrID: projectNameOrID,
XIsResourceName: utils.CreateBoolPointer(!useProjectID),
})

if err != nil {
return err
}

log.Infof("Project %s deleted successfully", projectName)
log.Infof("Project %s deleted successfully", projectNameOrID)
return nil
}

Expand Down
22 changes: 20 additions & 2 deletions pkg/api/repository_handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,20 @@ import (
log "github.com/sirupsen/logrus"
)

func RepoDelete(projectName, repoName string) error {
func RepoDelete(projectNameOrID, repoName string, useProjectID bool) error {
ctx, client, err := utils.ContextWithClient()
if err != nil {
return err
}

projectName := projectNameOrID
if useProjectID {
project, err := GetProject(projectNameOrID, useProjectID)
if err != nil {
return err
}
projectName = project.Payload.Name
}
_, err = client.Repository.DeleteRepository(ctx, &repository.DeleteRepositoryParams{ProjectName: projectName, RepositoryName: repoName})

if err != nil {
Expand All @@ -51,11 +60,20 @@ func RepoView(projectName, repoName string) (*repository.GetRepositoryOK, error)
return response, nil
}

func ListRepository(projectName string) (repository.ListRepositoriesOK, error) {
func ListRepository(projectNameOrID string, useProjectID bool) (repository.ListRepositoriesOK, error) {
ctx, client, err := utils.ContextWithClient()
if err != nil {
return repository.ListRepositoriesOK{}, err
}
projectName := projectNameOrID
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong wording.


if useProjectID {
project, err := GetProject(projectNameOrID, useProjectID)
if err != nil {
return repository.ListRepositoriesOK{}, err
}
projectName = project.Payload.Name
}

response, err := client.Repository.ListRepositories(ctx, &repository.ListRepositoriesParams{ProjectName: projectName})

Expand Down
2 changes: 1 addition & 1 deletion pkg/prompt/prompt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func GetRepoNameFromUser(projectName string) string {
repositoryName := make(chan string)

go func() {
response, err := api.ListRepository(projectName)
response, err := api.ListRepository(projectName, false)
if err != nil {
log.Fatal(err)
}
Expand Down
5 changes: 5 additions & 0 deletions pkg/utils/helper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,8 @@ func PrintFormat[T any](resp T, format string) error {
}
return fmt.Errorf("unable to output in the specified '%s' format", format)
}

func CreateBoolPointer(b bool) *bool {
return &b
}

Comment on lines +156 to +160
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this