From 88f5cdcafadbafd992cbf6ea31f9f29512263452 Mon Sep 17 00:00:00 2001 From: Minjie Fang Date: Wed, 24 Jun 2026 17:46:12 +0000 Subject: [PATCH] fix(labels): add org label for ls and pr (#1017) Fix https://gitea.com/gitea/tea/issues/634, https://gitea.com/gitea/tea/issues/669 Reviewed-on: https://gitea.com/gitea/tea/pulls/1017 Reviewed-by: Lunny Xiao Co-authored-by: Minjie Fang Co-committed-by: Minjie Fang --- cmd/flags/generic.go | 2 +- cmd/labels/list.go | 59 +++++++++- docs/CLI.md | 8 ++ modules/print/label.go | 9 +- modules/task/labels.go | 10 ++ tests/integration/cmd_labels_test.go | 162 ++++++++++++++++++++++++++ tests/integration/task_labels_test.go | 124 ++++++++++++++++++++ tests/integration/wiki_test.go | 10 +- 8 files changed, 371 insertions(+), 13 deletions(-) create mode 100644 tests/integration/cmd_labels_test.go create mode 100644 tests/integration/task_labels_test.go diff --git a/cmd/flags/generic.go b/cmd/flags/generic.go index adffd395..56bb65d5 100644 --- a/cmd/flags/generic.go +++ b/cmd/flags/generic.go @@ -7,7 +7,7 @@ import ( "errors" "fmt" - "gitea.dev/sdk" + gitea "gitea.dev/sdk" "github.com/urfave/cli/v3" ) diff --git a/cmd/labels/list.go b/cmd/labels/list.go index 22a1bffe..793b3241 100644 --- a/cmd/labels/list.go +++ b/cmd/labels/list.go @@ -5,8 +5,9 @@ package labels import ( stdctx "context" + "log" - "gitea.dev/sdk" + gitea "gitea.dev/sdk" "gitea.dev/tea/cmd/flags" "gitea.dev/tea/modules/context" @@ -29,6 +30,14 @@ var CmdLabelsList = cli.Command{ Aliases: []string{"s"}, Usage: "Save all the labels as a file", }, + &cli.StringFlag{ + Name: "org", + Usage: "List organization labels", + }, + &cli.BoolFlag{ + Name: "exclude-org", + Usage: "Exclude organization labels from the list", + }, &flags.PaginationPageFlag, &flags.PaginationLimitFlag, }, flags.AllDefaultFlags...), @@ -40,14 +49,18 @@ func RunLabelsList(requestCtx stdctx.Context, cmd *cli.Command) error { if err != nil { return err } - if err := ctx.Ensure(context.CtxRequirement{RemoteRepo: true}); err != nil { - return err + if cmd.String("org") == "" && cmd.String("repo") == "" { + if err := ctx.Ensure(context.CtxRequirement{RemoteRepo: true}); err != nil { + return err + } + } + + if cmd.String("org") != "" && cmd.String("repo") != "" { + log.Printf("Warning: Both --org and --repo flags are set. Ignoring --org and using --repo value as owner.\n") } client := ctx.Login.Client() - labels, _, err := client.Repositories.ListRepoLabels(requestCtx, ctx.Owner, ctx.Repo, gitea.ListLabelsOptions{ - ListOptions: flags.GetListOptions(cmd), - }) + labels, err := collectLabels(requestCtx, client, ctx, cmd) if err != nil { return err } @@ -58,3 +71,37 @@ func RunLabelsList(requestCtx stdctx.Context, cmd *cli.Command) error { return print.LabelsList(labels, ctx.Output) } + +// CollectLabels collects labels based on the provided command flags and context. +func collectLabels(requestCtx stdctx.Context, client *gitea.Client, ctx *context.TeaContext, cmd *cli.Command) ([]*gitea.Label, error) { + var labels []*gitea.Label + var err error + owner := ctx.Owner + + // If --org is set but --repo is not, list organization labels only and skip repository labels. + if cmd.String("org") != "" && cmd.String("repo") == "" { + owner = ctx.Org + } else { + labels, _, err = client.Repositories.ListRepoLabels(requestCtx, owner, ctx.Repo, gitea.ListLabelsOptions{ + ListOptions: flags.GetListOptions(cmd), + }) + if err != nil { + log.Printf("Failed to list repository labels: %v", err) + } + } + + // If --exclude is not set and the owner is an organization, also list organization labels and append them to the list. + if !ctx.IsSet("exclude-org") { + if _, _, err = client.Organizations.GetOrg(requestCtx, owner); err == nil { + orgLabels, _, err := client.Organizations.ListOrgLabels(requestCtx, owner, gitea.ListOrgLabelsOptions{ + ListOptions: flags.GetListOptions(cmd), + }) + if err != nil { + return nil, err + } + labels = append(labels, orgLabels...) + } + } + + return labels, nil +} diff --git a/docs/CLI.md b/docs/CLI.md index 2b1a2020..b410da0a 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -551,10 +551,14 @@ Unresolve a review comment on a pull request Manage issue labels +**--exclude-org**: Exclude organization labels from the list + **--limit, --lm**="": specify limit of items per page (default: 30) **--login, -l**="": Use a different Gitea Login. Optional +**--org**="": List organization labels + **--output, -o**="": Output format. (simple, table, csv, tsv, yaml, json) **--page, -p**="": specify page (default: 1) @@ -569,10 +573,14 @@ Manage issue labels List labels +**--exclude-org**: Exclude organization labels from the list + **--limit, --lm**="": specify limit of items per page (default: 30) **--login, -l**="": Use a different Gitea Login. Optional +**--org**="": List organization labels + **--output, -o**="": Output format. (simple, table, csv, tsv, yaml, json) **--page, -p**="": specify page (default: 1) diff --git a/modules/print/label.go b/modules/print/label.go index 3c2a5b2e..183ecd91 100644 --- a/modules/print/label.go +++ b/modules/print/label.go @@ -5,8 +5,9 @@ package print import ( "strconv" + "strings" - "gitea.dev/sdk" + gitea "gitea.dev/sdk" ) // LabelsList prints a listing of labels @@ -16,14 +17,20 @@ func LabelsList(labels []*gitea.Label, output string) error { "Color", "Name", "Description", + "Level", ) for _, label := range labels { + level := "Repository" + if strings.Contains(label.URL, "/orgs/") { + level = "Organization" + } t.addRow( strconv.FormatInt(label.ID, 10), formatLabel(label, !isMachineReadable(output), label.Color), label.Name, label.Description, + level, ) } return t.print(output) diff --git a/modules/task/labels.go b/modules/task/labels.go index e34608e3..64ba2eaf 100644 --- a/modules/task/labels.go +++ b/modules/task/labels.go @@ -23,6 +23,16 @@ func ResolveLabelNames(requestCtx stdctx.Context, client *gitea.Client, owner, r if err != nil { return nil, err } + if _, _, err := client.Organizations.GetOrg(requestCtx, owner); err == nil { + orgLabels, _, err := client.Organizations.ListOrgLabels(requestCtx, owner, gitea.ListOrgLabelsOptions{ + ListOptions: gitea.ListOptions{Page: page, PageSize: 50}, + }) + if err != nil { + return nil, err + } + labels = append(labels, orgLabels...) + } + for _, l := range labels { if utils.Contains(labelNames, l.Name) { labelIDs = append(labelIDs, l.ID) diff --git a/tests/integration/cmd_labels_test.go b/tests/integration/cmd_labels_test.go new file mode 100644 index 00000000..756de5ed --- /dev/null +++ b/tests/integration/cmd_labels_test.go @@ -0,0 +1,162 @@ +// Copyright 2026 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package integration + +import ( + "context" + "encoding/json" + "fmt" + "strconv" + "testing" + "time" + + gitea "gitea.dev/sdk" + "github.com/stretchr/testify/require" +) + +func setupOrgRepoWithLabels(t *testing.T) (org *gitea.Organization, orgRepo *gitea.Repository, orgLabel, repoLabel *gitea.Label) { + t.Helper() + + login := createIntegrationLogin(t) + client := login.Client() + orgName := fmt.Sprintf("labels-org-%d", time.Now().UnixNano()%1_000_000) + orgRepoName := fmt.Sprintf("labels-repo-%d", time.Now().UnixNano()%1_000_000) + ctx := context.Background() + + // Clean up any existing test data that might interfere with the test. + _, _ = client.Repositories.DeleteRepo(ctx, orgName, orgRepoName) + _, _ = client.Organizations.DeleteOrg(ctx, orgName) + + org, _, err := client.Organizations.CreateOrg(ctx, gitea.CreateOrgOption{Name: orgName}) + require.NoError(t, err) + t.Cleanup(func() { + if _, delErr := client.Organizations.DeleteOrg(ctx, orgName); delErr != nil { + t.Logf("failed to delete integration test org %q: %v", orgName, delErr) + } + }) + + orgRepo, _, err = client.Repositories.CreateOrgRepo(ctx, orgName, gitea.CreateRepoOption{Name: orgRepoName}) + require.NoError(t, err) + t.Cleanup(func() { + if _, delErr := client.Repositories.DeleteRepo(ctx, orgName, orgRepoName); delErr != nil { + t.Logf("failed to delete integration test repo %q: %v", orgRepoName, delErr) + } + }) + + orgLabelName := fmt.Sprintf("org-label-%d", time.Now().UnixNano()%1_000_000) + repoLabelName := fmt.Sprintf("repo-label-%d", time.Now().UnixNano()%1_000_000) + + orgLabel, _, err = client.Organizations.CreateOrgLabel(ctx, orgName, gitea.CreateOrgLabelOption{Name: orgLabelName, Color: "ff0000"}) + require.NoError(t, err) + repoLabel, _, err = client.Repositories.CreateLabel(ctx, orgName, orgRepoName, gitea.CreateLabelOption{Name: repoLabelName, Color: "00ff00"}) + require.NoError(t, err) + return org, orgRepo, orgLabel, repoLabel +} + +func setupRepoWithLabels(t *testing.T) (repo *gitea.Repository, repoLabel *gitea.Label) { + t.Helper() + + login := createIntegrationLogin(t) + client := login.Client() + repoName := fmt.Sprintf("labels-repo-%d", time.Now().UnixNano()%1_000_000) + ctx := context.Background() + + // Clean up any existing test data that might interfere with the test. + _, _ = client.Repositories.DeleteRepo(ctx, login.User, repoName) + + repo, _, err := client.Repositories.CreateRepo(ctx, gitea.CreateRepoOption{Name: repoName}) + require.NoError(t, err) + t.Cleanup(func() { + if _, delErr := client.Repositories.DeleteRepo(ctx, login.User, repoName); delErr != nil { + t.Logf("failed to delete integration test repo %q: %v", repoName, delErr) + } + }) + + repoLabelName := fmt.Sprintf("repo-label-%d", time.Now().UnixNano()%1_000_000) + repoLabel, _, err = client.Repositories.CreateLabel(ctx, login.User, repoName, gitea.CreateLabelOption{Name: repoLabelName, Color: "00ff00"}) + require.NoError(t, err) + return repo, repoLabel +} + +func TestRunLabelsList_OrgFlagReturnsOnlyOrgLabels(t *testing.T) { + // This test verifies that when listing labels with only the --org flag set, + // only organization labels are included in the results, and repository labels are excluded. + _, orgRepo, orgLabel, _ := setupOrgRepoWithLabels(t) + + labelIDs := runTeaCommand(t, "label", "ls", "--org", orgRepo.Owner.UserName, "--output", "json") + var rows []map[string]string + require.NoError(t, json.Unmarshal([]byte(labelIDs), &rows)) + + require.Len(t, rows, 1) + indexInt, err := strconv.ParseInt(rows[0]["index"], 10, 64) + require.NoError(t, err) + require.Equal(t, orgLabel.ID, indexInt) + require.Equal(t, orgLabel.Name, rows[0]["name"]) +} + +func TestRunLabelsList_RepoReturnsNoOrgLabels(t *testing.T) { + // This test verifies that when listing labels for a repository with no organization, + // organization labels are not included in the results. + repo, repoLabel := setupRepoWithLabels(t) + + labelIDs := runTeaCommand(t, "label", "ls", "--repo", repo.FullName, "--output", "json") + var rows []map[string]string + require.NoError(t, json.Unmarshal([]byte(labelIDs), &rows)) + + require.Len(t, rows, 1) + indexInt, err := strconv.ParseInt(rows[0]["index"], 10, 64) + require.NoError(t, err) + require.Equal(t, repoLabel.ID, indexInt) + require.Equal(t, repoLabel.Name, rows[0]["name"]) +} + +func TestRunLabelsList_UseRepoFlagOverOrgFlag(t *testing.T) { + // This test verifies that when both --org and --repo flags are set, + // the command prioritizes the --repo flag and lists labels for the repository, ignoring the --org flag. + repo, repoLabel := setupRepoWithLabels(t) + + labelIDs := runTeaCommand(t, "label", "ls", "--repo", repo.FullName, "--org", "some-other-org", "--output", "json") + var rows []map[string]string + require.NoError(t, json.Unmarshal([]byte(labelIDs), &rows)) + + require.Len(t, rows, 1) + indexInt, err := strconv.ParseInt(rows[0]["index"], 10, 64) + require.NoError(t, err) + require.Equal(t, repoLabel.ID, indexInt) + require.Equal(t, repoLabel.Name, rows[0]["name"]) +} + +func TestRunLabelsList_OrgRepoReturnsRepoAndOrgLabels(t *testing.T) { + // This test verifies that when listing labels for a repository that belongs to an organization, + // both repository and organization labels are included in the results. + _, orgRepo, orgLabel, repoLabel := setupOrgRepoWithLabels(t) + + labelIDs := runTeaCommand(t, "label", "ls", "--repo", orgRepo.FullName, "--output", "json") + var rows []map[string]string + require.NoError(t, json.Unmarshal([]byte(labelIDs), &rows)) + + require.Len(t, rows, 2) + require.ElementsMatch(t, []string{rows[0]["name"], rows[1]["name"]}, []string{orgLabel.Name, repoLabel.Name}) + require.ElementsMatch( + t, + []string{rows[0]["index"], rows[1]["index"]}, + []string{strconv.FormatInt(orgLabel.ID, 10), strconv.FormatInt(repoLabel.ID, 10)}, + ) +} + +func TestRunLabelsList_OrgRepoWithExcludeReturnsOnlyRepoLabels(t *testing.T) { + // This test verifies that when listing labels for a repository that belongs to an organization with the --exclude flag, + // only repository labels are included in the results, and organization labels are excluded. + _, orgRepo, _, repoLabel := setupOrgRepoWithLabels(t) + + labelIDs := runTeaCommand(t, "label", "ls", "--repo", orgRepo.FullName, "--exclude-org", "--output", "json") + var rows []map[string]string + require.NoError(t, json.Unmarshal([]byte(labelIDs), &rows)) + + require.Len(t, rows, 1) + indexInt, err := strconv.ParseInt(rows[0]["index"], 10, 64) + require.NoError(t, err) + require.Equal(t, repoLabel.ID, indexInt) + require.Equal(t, repoLabel.Name, rows[0]["name"]) +} diff --git a/tests/integration/task_labels_test.go b/tests/integration/task_labels_test.go new file mode 100644 index 00000000..746febf9 --- /dev/null +++ b/tests/integration/task_labels_test.go @@ -0,0 +1,124 @@ +// Copyright 2026 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package integration + +import ( + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "os" + "os/exec" + "strings" + "testing" + "time" + + gitea "gitea.dev/sdk" + "github.com/stretchr/testify/require" +) + +func TestResolveLabelNames_ReturnsRepoAndOrgLabels(t *testing.T) { + // This test verifies that ResolveLabelNames correctly returns both repository and organization labels. + // It sets up a test repository and organization with known labels, then calls ResolveLabelNames and checks the results. + login := createIntegrationLogin(t) + client := login.Client() + orgName := fmt.Sprintf("labels-org-%d", time.Now().UnixNano()%1_000_000) + orgRepoName := fmt.Sprintf("labels-repo-%d", time.Now().UnixNano()%1_000_000) + ctx := context.Background() + + // Clean up any existing test data that might interfere with the test. + _, _ = client.Repositories.DeleteRepo(ctx, orgName, orgRepoName) + _, _ = client.Organizations.DeleteOrg(ctx, orgName) + + _, _, err := client.Admin.CreateOrg(ctx, integrationUsername, gitea.CreateOrgOption{Name: orgName}) + require.NoError(t, err) + t.Cleanup(func() { + if _, delErr := client.Organizations.DeleteOrg(ctx, orgName); delErr != nil { + t.Logf("failed to delete integration test org %q: %v", orgName, delErr) + } + }) + + orgRepo, _, err := client.Repositories.CreateOrgRepo(ctx, orgName, gitea.CreateRepoOption{Name: orgRepoName}) + require.NoError(t, err) + t.Cleanup(func() { + if _, delErr := client.Repositories.DeleteRepo(ctx, orgName, orgRepoName); delErr != nil { + t.Logf("failed to delete integration test repo %q: %v", orgRepoName, delErr) + } + }) + + orgLabelName := fmt.Sprintf("org-label-%d", time.Now().UnixNano()%1_000_000) + repoLabelName := fmt.Sprintf("repo-label-%d", time.Now().UnixNano()%1_000_000) + + orgLabel, _, err := client.Organizations.CreateOrgLabel(ctx, orgName, gitea.CreateOrgLabelOption{Name: orgLabelName, Color: "ff0000"}) + require.NoError(t, err) + repoLabel, _, err := client.Repositories.CreateLabel(ctx, orgName, orgRepoName, gitea.CreateLabelOption{Name: repoLabelName, Color: "00ff00"}) + require.NoError(t, err) + + tmpDir := t.TempDir() + + runGit := func(args ...string) { + cmd := exec.Command("git", args...) + cmd.Dir = tmpDir + require.NoError(t, cmd.Run()) + } + + runGit("init") + runGit("config", "user.email", "test@test.com") + runGit("config", "user.name", "test") + httpsURL := fmt.Sprintf("%s/%s.git", login.URL, orgRepo.FullName) + httpsURL = strings.Replace(httpsURL, "://", fmt.Sprintf("://%s:%s@", login.Name, login.Token), 1) + + runGit("remote", "add", "origin", httpsURL) + + runGit("checkout", "-b", "main") + runGit("commit", "--allow-empty", "-m", "Initial commit") + runGit("push", "-u", "origin", "HEAD:main") + + runGit("checkout", "-b", "branch-with-labels") + runGit("commit", "--allow-empty", "-m", "Initial commit") + runGit("push", "-u", "origin", "HEAD:branch-with-labels") + + waitForBranches(t, orgRepo.FullName) + _ = runTeaCommand( + t, "pr", "create", "--repo", orgRepo.FullName, + "--login", login.Name, "--base", "main", "--head", "branch-with-labels", + "--labels", orgLabelName+","+repoLabelName, + ) + + pr, _, err := client.PullRequests.GetPullRequest(ctx, orgName, orgRepoName, 1) + require.NoError(t, err) + labels := pr.Labels + require.Len(t, labels, 2) + require.ElementsMatch(t, labels, []*gitea.Label{orgLabel, repoLabel}) +} + +func waitForBranches(t *testing.T, repoFullName string) { + t.Helper() + url := fmt.Sprintf("%s/api/v1/repos/%s/branches", os.Getenv("GITEA_TEA_TEST_URL"), repoFullName) + + // retry for ~6 seconds + for range 30 { + resp, err := http.Get(url) + if err == nil { + body, _ := io.ReadAll(resp.Body) + resp.Body.Close() + var branches []struct { + Name string `json:"name"` + } + if json.Unmarshal(body, &branches) == nil { + have := map[string]bool{} + for _, b := range branches { + have[b.Name] = true + } + if have["main"] && have["branch-with-labels"] { + return + } + } + + } + time.Sleep(200 * time.Millisecond) + } + t.Fatalf("waitForBranches: branches never appeared in API: %s", url) +} diff --git a/tests/integration/wiki_test.go b/tests/integration/wiki_test.go index 253fa693..1680b47e 100644 --- a/tests/integration/wiki_test.go +++ b/tests/integration/wiki_test.go @@ -14,7 +14,7 @@ import ( "testing" "time" - "gitea.dev/sdk" + gitea "gitea.dev/sdk" teacmd "gitea.dev/tea/cmd" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" @@ -25,10 +25,10 @@ func TestWikiCommandLifecycle(t *testing.T) { client := login.Client() repoName := fmt.Sprintf("tea-wiki-integration-%d", time.Now().UnixNano()) - _, _, err := client.CreateRepo(context.Background(), gitea.CreateRepoOption{Name: repoName}) + _, _, err := client.Repositories.CreateRepo(context.Background(), gitea.CreateRepoOption{Name: repoName}) require.NoError(t, err) t.Cleanup(func() { - if _, delErr := client.DeleteRepo(context.Background(), login.User, repoName); delErr != nil { + if _, delErr := client.Repositories.DeleteRepo(context.Background(), login.User, repoName); delErr != nil { t.Logf("failed to delete integration test repo %q: %v", repoName, delErr) } }) @@ -60,10 +60,10 @@ func TestWikiCommandLifecycle(t *testing.T) { assert.Contains(t, listOutput, "\"title\": \"Home\"") emptyRepoName := fmt.Sprintf("tea-wiki-empty-%d", time.Now().UnixNano()) - _, _, err = client.CreateRepo(context.Background(), gitea.CreateRepoOption{Name: emptyRepoName}) + _, _, err = client.Repositories.CreateRepo(context.Background(), gitea.CreateRepoOption{Name: emptyRepoName}) require.NoError(t, err) t.Cleanup(func() { - if _, delErr := client.DeleteRepo(context.Background(), login.User, emptyRepoName); delErr != nil { + if _, delErr := client.Repositories.DeleteRepo(context.Background(), login.User, emptyRepoName); delErr != nil { t.Logf("failed to delete empty wiki repo %q: %v", emptyRepoName, delErr) } })