-
Notifications
You must be signed in to change notification settings - Fork 136
tests: Added unit tests for user list command and user view #685
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
Open
rkcoder101
wants to merge
1
commit into
goharbor:main
Choose a base branch
from
rkcoder101:test/user-list
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -16,6 +16,7 @@ package user | |||||||
| import ( | ||||||||
| "fmt" | ||||||||
|
|
||||||||
| "github.com/goharbor/go-client/pkg/sdk/v2.0/client/user" | ||||||||
| "github.com/goharbor/go-client/pkg/sdk/v2.0/models" | ||||||||
| "github.com/goharbor/harbor-cli/pkg/api" | ||||||||
| "github.com/goharbor/harbor-cli/pkg/utils" | ||||||||
|
|
@@ -25,68 +26,78 @@ import ( | |||||||
| "github.com/spf13/viper" | ||||||||
| ) | ||||||||
|
|
||||||||
| func UserListCmd() *cobra.Command { | ||||||||
| var opts api.ListFlags | ||||||||
| func GetUsers(opts api.ListFlags, userListAPI func(opts ...api.ListFlags) (*user.ListUsersOK, error)) ([]*models.UserResp, error) { | ||||||||
| var allUsers []*models.UserResp | ||||||||
|
|
||||||||
| cmd := &cobra.Command{ | ||||||||
| Use: "list", | ||||||||
| Short: "List users", | ||||||||
| Args: cobra.ExactArgs(0), | ||||||||
| Aliases: []string{"ls"}, | ||||||||
| RunE: func(cmd *cobra.Command, args []string) error { | ||||||||
| if opts.PageSize < 0 { | ||||||||
| return fmt.Errorf("page size must be greater than or equal to 0") | ||||||||
| } | ||||||||
|
|
||||||||
| if opts.PageSize > 100 { | ||||||||
| return fmt.Errorf("page size should be less than or equal to 100") | ||||||||
| } | ||||||||
| if opts.PageSize > 100 || opts.PageSize < 0 { | ||||||||
| return nil, fmt.Errorf("page size should be greater than or equal to 0 and less than or equal to 100") | ||||||||
| } | ||||||||
|
|
||||||||
| if opts.PageSize == 0 { | ||||||||
| opts.PageSize = 100 | ||||||||
| opts.Page = 1 | ||||||||
| if opts.PageSize == 0 { | ||||||||
| opts.PageSize = 100 | ||||||||
| opts.Page = 1 | ||||||||
|
|
||||||||
| for { | ||||||||
| response, err := api.ListUsers(opts) | ||||||||
| if err != nil { | ||||||||
| if isUnauthorizedError(err) { | ||||||||
| return fmt.Errorf("Permission denied: Admin privileges are required to execute this command.") | ||||||||
| } | ||||||||
| return fmt.Errorf("failed to list users: %v", err) | ||||||||
| } | ||||||||
| for { | ||||||||
| response, err := userListAPI(opts) | ||||||||
| if err != nil { | ||||||||
| if isUnauthorizedError(err) { | ||||||||
| return nil, fmt.Errorf("Permission denied: Admin privileges are required to execute this command.") | ||||||||
| } | ||||||||
| return nil, fmt.Errorf("failed to list users: %w", err) | ||||||||
| } | ||||||||
|
Comment on lines
+43
to
+47
|
||||||||
|
|
||||||||
| allUsers = append(allUsers, response.Payload...) | ||||||||
| allUsers = append(allUsers, response.Payload...) | ||||||||
|
|
||||||||
| if len(response.Payload) < int(opts.PageSize) { | ||||||||
| break | ||||||||
| } | ||||||||
| opts.Page++ | ||||||||
| } | ||||||||
| } else { | ||||||||
| response, err := api.ListUsers(opts) | ||||||||
| if err != nil { | ||||||||
| if isUnauthorizedError(err) { | ||||||||
| return fmt.Errorf("Permission denied: Admin privileges are required to execute this command.") | ||||||||
| } | ||||||||
| return fmt.Errorf("failed to list users: %v", err) | ||||||||
| } | ||||||||
| allUsers = response.Payload | ||||||||
| if len(response.Payload) < int(opts.PageSize) { | ||||||||
| break | ||||||||
| } | ||||||||
| if len(allUsers) == 0 { | ||||||||
| log.Info("No users found") | ||||||||
| return nil | ||||||||
| opts.Page++ | ||||||||
| } | ||||||||
| } else { | ||||||||
| response, err := userListAPI(opts) | ||||||||
| if err != nil { | ||||||||
| if isUnauthorizedError(err) { | ||||||||
| return nil, fmt.Errorf("Permission denied: Admin privileges are required to execute this command.") | ||||||||
| } | ||||||||
| formatFlag := viper.GetString("output-format") | ||||||||
| if formatFlag != "" { | ||||||||
| err := utils.PrintFormat(allUsers, formatFlag) | ||||||||
| if err != nil { | ||||||||
| log.Error(err) | ||||||||
| } | ||||||||
| } else { | ||||||||
| list.ListUsers(allUsers) | ||||||||
| return nil, fmt.Errorf("failed to list users: %w", err) | ||||||||
| } | ||||||||
|
Comment on lines
+59
to
+63
|
||||||||
| allUsers = response.Payload | ||||||||
| } | ||||||||
| return allUsers, nil | ||||||||
| } | ||||||||
| func PrintUsers(allUsers []*models.UserResp) error { | ||||||||
| if len(allUsers) == 0 { | ||||||||
| log.Info("No users found") | ||||||||
| return nil | ||||||||
| } | ||||||||
| formatFlag := viper.GetString("output-format") | ||||||||
| if formatFlag != "" { | ||||||||
| err := utils.PrintFormat(allUsers, formatFlag) | ||||||||
| if err != nil { | ||||||||
| log.Error(err) | ||||||||
|
||||||||
| log.Error(err) | |
| log.Error(err) | |
| return err |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this file’s
package user, importinggithub.com/goharbor/go-client/pkg/sdk/v2.0/client/userasuseris very easy to confuse with the current package name and makes types like*user.ListUsersOKhard to read. Consider aliasing the import (e.g.,clientuser) and updating the interface return type accordingly.