Skip to content

tests: Add unit tests for project list command #692

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

Open
rkcoder101 wants to merge 2 commits into
base: main
Choose a base branch
from
+676 −60
Open

tests: Add unit tests for project list command #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2efeb88
test/refactor: refactor project list command and add unit tests (all …
rkcoder101 Feb 19, 2026
3b7752c
fix/added fixes recommended in copilot review
rkcoder101 Feb 19, 2026
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
120 changes: 64 additions & 56 deletions cmd/harbor/root/project/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,70 @@ import (
"github.com/spf13/viper"
)

func PrintProjects(allProjects []*models.Project) error {
log.WithField("count", len(allProjects)).Debug("Number of projects fetched")
if len(allProjects) == 0 {
log.Info("No projects found")
return nil
}
formatFlag := viper.GetString("output-format")
if formatFlag != "" {
log.WithField("output_format", formatFlag).Debug("Output format selected")
err := utils.PrintFormat(allProjects, formatFlag)
if err != nil {
return err
}
} else {
log.Debug("Listing projects using default view")
if err := list.ListProjects(allProjects); err != nil {
return err
}
}
return nil
}
Comment on lines +29 to +49
Copy link
Collaborator

@bupd bupd Feb 18, 2026

Choose a reason for hiding this comment

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

I dont think we need this one. Isnt there a global util function used for printing tables and outputs. ??

Copy link
Contributor Author

@rkcoder101 rkcoder101 Feb 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Actually this is not something which I have written; this piece of code was already written inside the RunE of ListProjectCommand. I just separated out the printing logic into a function for creating a testable unit. The util function which you are referring to (utils.PrintFormat()) is actually used in the above code.

func BuildListOptions(private, public bool, opts *api.ListFlags, fuzzy, match, ranges []string) (func(...api.ListFlags) (project.ListProjectsOK, error), error) {
var listFunc func(...api.ListFlags) (project.ListProjectsOK, error)
log.Debug("Starting project list command")

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 private && public {
return nil, fmt.Errorf("cannot specify both --private and --public flags")
}

if private {
log.Debug("Using private project list function")
opts.Public = false
listFunc = api.ListProject
} else if public {
log.Debug("Using public project list function")
opts.Public = true
listFunc = api.ListProject
} else {
log.Debug("Using list all projects function")
listFunc = api.ListAllProjects
}

if len(fuzzy) != 0 || len(match) != 0 || len(ranges) != 0 { // Only Building Query if a param exists
q, qErr := utils.BuildQueryParam(fuzzy, match, ranges,
[]string{"name", "project_id", "public", "creation_time", "owner_id"},
)
if qErr != nil {
return nil, qErr
}

opts.Q = q
}
return listFunc, nil
}
func ListProjectCommand() *cobra.Command {
var (
opts api.ListFlags
private bool
public bool
allProjects []*models.Project
err error
// For querying, opts.Q
fuzzy []string
match []string
Expand All @@ -43,66 +100,17 @@ func ListProjectCommand() *cobra.Command {
Short: "List projects",
Args: cobra.ExactArgs(0),
RunE: func(cmd *cobra.Command, args []string) error {
log.Debug("Starting project list command")

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 private && public {
return fmt.Errorf("Cannot specify both --private and --public flags")
}

var listFunc func(...api.ListFlags) (project.ListProjectsOK, error)
if private {
log.Debug("Using private project list function")
opts.Public = false
listFunc = api.ListProject
} else if public {
log.Debug("Using public project list function")
opts.Public = true
listFunc = api.ListProject
} else {
log.Debug("Using list all projects function")
listFunc = api.ListAllProjects
}

if len(fuzzy) != 0 || len(match) != 0 || len(ranges) != 0 { // Only Building Query if a param exists
q, qErr := utils.BuildQueryParam(fuzzy, match, ranges,
[]string{"name", "project_id", "public", "creation_time", "owner_id"},
)
if qErr != nil {
return qErr
}

opts.Q = q
listFunc, err := BuildListOptions(private, public, &opts, fuzzy, match, ranges)
if err != nil {
return err
}

log.Debug("Fetching projects...")
allProjects, err = fetchProjects(listFunc, opts)
if err != nil {
return fmt.Errorf("failed to get projects list: %v", utils.ParseHarborErrorMsg(err))
}

log.WithField("count", len(allProjects)).Debug("Number of projects fetched")
if len(allProjects) == 0 {
log.Info("No projects found")
return nil
return fmt.Errorf("failed to get projects list: %s", utils.ParseHarborErrorMsg(err))
}
formatFlag := viper.GetString("output-format")
if formatFlag != "" {
log.WithField("output_format", formatFlag).Debug("Output format selected")
err = utils.PrintFormat(allProjects, formatFlag)
if err != nil {
return err
}
} else {
log.Debug("Listing projects using default view")
list.ListProjects(allProjects)
if err := PrintProjects(allProjects); err != nil {
return err
}
return nil
},
Expand Down
Loading
Loading