gitlab: Support -l/--label flag (#781)

Follow up to #773 adding support for adding/updating labels
for GitLab Merge Requests.

Author: abhinav

internal/forge/gitlab/edit.go

@@ -19,7 +19,7 @@ var _draftRegex = regexp.MustCompile(`(?i)^\s*(\[Draft]|Draft:|\(Draft\))\s*`)
 
 // EditChange edits an existing change in a repository.
 func (r *Repository) EditChange(ctx context.Context, id forge.ChangeID, opts forge.EditChangeOptions) error {
-	if cmputil.Zero(opts.Base) && cmputil.Zero(opts.Draft) {
+	if cmputil.Zero(opts.Base) && cmputil.Zero(opts.Draft) && len(opts.Labels) == 0 {
 		return nil // nothing to do
 	}
 
@@ -56,6 +56,10 @@ func (r *Repository) EditChange(ctx context.Context, id forge.ChangeID, opts for
 		logUpdates = append(logUpdates, slog.Bool("draft", *opts.Draft))
 	}
 
+	if len(opts.Labels) > 0 {
+		updateOptions.AddLabels = (*gitlab.LabelOptions)(&opts.Labels)
+	}
+
 	_, _, err := r.client.MergeRequests.UpdateMergeRequest(
 		r.repoID, mr.Number, &updateOptions,
 		gitlab.WithContext(ctx),

internal/forge/gitlab/integration_test.go

@@ -408,6 +408,121 @@ func TestIntegration_Repository_SubmitEditChange(t *testing.T) {
 	})
 }
 
+func TestIntegration_Repository_SubmitEditChange_labels(t *testing.T) {
+	label1 := fixturetest.New(_fixtures, "label1", func() string { return randomString(8) }).Get(t)
+	label2 := fixturetest.New(_fixtures, "label2", func() string { return randomString(8) }).Get(t)
+	label3 := fixturetest.New(_fixtures, "label3", func() string { return randomString(8) }).Get(t)
+
+	branchFixture := fixturetest.New(_fixtures, "branch", func() string {
+		return randomString(8)
+	})
+
+	branchName := branchFixture.Get(t)
+	t.Logf("Creating branch: %s", branchName)
+
+	var (
+		gitRepo *git.Repository // only when _update is true
+		gitWork *git.Worktree
+	)
+	if *_update {
+		t.Setenv("GIT_AUTHOR_EMAIL", "[email protected]")
+		t.Setenv("GIT_AUTHOR_NAME", "gs-test[bot]")
+		t.Setenv("GIT_COMMITTER_EMAIL", "[email protected]")
+		t.Setenv("GIT_COMMITTER_NAME", "gs-test[bot]")
+
+		output := ioutil.TestLogWriter(t, "[git] ")
+
+		ctx := t.Context()
+
+		t.Logf("Cloning test-repo...")
+		repoDir := t.TempDir()
+		cmd := exec.Command("git", "clone", "[email protected]:abg/test-repo.git", repoDir)
+		cmd.Stdout = output
+		cmd.Stdout = output
+		require.NoError(t, cmd.Run(), "failed to clone test-repo")
+
+		var err error
+		gitWork, err = git.OpenWorktree(ctx, repoDir, git.OpenOptions{
+			Log: silogtest.New(t),
+		})
+		require.NoError(t, err, "failed to open git repo")
+		gitRepo = gitWork.Repository()
+
+		require.NoError(t, gitRepo.CreateBranch(ctx, git.CreateBranchRequest{
+			Name: branchName,
+		}), "could not create branch: %s", branchName)
+		require.NoError(t, gitWork.Checkout(ctx, branchName),
+			"could not checkout branch: %s", branchName)
+		require.NoError(t, os.WriteFile(
+			filepath.Join(repoDir, branchName+".txt"),
+			[]byte(randomString(32)),
+			0o644,
+		), "could not write file to branch")
+
+		cmd = exec.Command("git", "add", ".")
+		cmd.Dir = repoDir
+		cmd.Stdout = output
+		cmd.Stderr = output
+		require.NoError(t, cmd.Run(), "git add failed")
+		require.NoError(t, gitWork.Commit(ctx, git.CommitRequest{
+			Message: "commit from test",
+		}), "could not commit changes")
+
+		t.Logf("Pushing to origin")
+		require.NoError(t,
+			gitWork.Push(ctx, git.PushOptions{
+				Remote:  "origin",
+				Refspec: git.Refspec(branchName),
+			}), "error pushing branch")
+
+		t.Cleanup(func() {
+			ctx := context.WithoutCancel(t.Context())
+			t.Logf("Deleting remote branch: %s", branchName)
+			assert.NoError(t,
+				gitWork.Push(ctx, git.PushOptions{
+					Remote:  "origin",
+					Refspec: git.Refspec(":" + branchName),
+				}), "error deleting branch")
+		})
+	}
+
+	ctx := t.Context()
+	rec := newRecorder(t, t.Name())
+	ghc := newGitLabClient(rec.GetDefaultClient())
+	repo, err := gitlab.NewRepository(
+		ctx, new(gitlab.Forge), "abg", "test-repo", silogtest.New(t), ghc, _testRepoID,
+	)
+	require.NoError(t, err)
+
+	change, err := repo.SubmitChange(ctx, forge.SubmitChangeRequest{
+		Subject: branchName,
+		Body:    "Test PR",
+		Base:    "main",
+		Head:    branchName,
+		Labels:  []string{label1},
+	})
+	require.NoError(t, err, "error creating PR")
+	changeID := change.ID
+
+	t.Run("AddNewLabel", func(t *testing.T) {
+		require.NoError(t,
+			repo.EditChange(t.Context(), changeID, forge.EditChangeOptions{
+				Labels: []string{label2},
+			}), "could not add labels to PR")
+	})
+
+	t.Run("AddExistingLabel", func(t *testing.T) {
+		require.NoError(t,
+			repo.EditChange(t.Context(), changeID, forge.EditChangeOptions{
+				Labels: []string{label2, label3},
+			}), "could not add existing label to PR")
+	})
+
+	gotLabels, err := repo.ChangeLabels(t.Context(), changeID)
+	require.NoError(t, err, "could not get labels for PR")
+	assert.ElementsMatch(t, []string{label1, label2, label3}, gotLabels)
+}
+
 func TestIntegration_Repository_comments(t *testing.T) {
 	ctx := t.Context()
 	rec := newRecorder(t, t.Name())

internal/forge/gitlab/label_test.go

@@ -0,0 +1,16 @@
+package gitlab
+
+import (
+	"context"
+
+	gitlab "gitlab.com/gitlab-org/api/client-go"
+	"go.abhg.dev/gs/internal/forge"
+)
+
+func (r *Repository) ChangeLabels(ctx context.Context, id forge.ChangeID) ([]string, error) {
+	mr := mustMR(id)
+	mergeReq, _, err := r.client.MergeRequests.GetMergeRequest(
+		r.repoID, mr.Number, nil, gitlab.WithContext(ctx),
+	)
+	return []string(mergeReq.Labels), err
+}

internal/forge/gitlab/submit.go

@@ -25,6 +25,9 @@ func (r *Repository) SubmitChange(ctx context.Context, req forge.SubmitChangeReq
 	if req.Draft {
 		input.Title = gitlab.Ptr(fmt.Sprintf("%s %s", _draftPrefix, req.Subject))
 	}
+	if len(req.Labels) > 0 {
+		input.Labels = (*gitlab.LabelOptions)(&req.Labels)
+	}
 	request, _, err := r.client.MergeRequests.CreateMergeRequest(
 		r.repoID, input,
 		gitlab.WithContext(ctx),

internal/forge/gitlab/testdata/TestIntegration_Repository_SubmitEditChange_labels/branch

@@ -0,0 +1 @@
+"aetM8eVz"

internal/forge/gitlab/testdata/TestIntegration_Repository_SubmitEditChange_labels/label1

@@ -0,0 +1 @@
+"oMKe7xZ6"

internal/forge/gitlab/testdata/TestIntegration_Repository_SubmitEditChange_labels/label2

@@ -0,0 +1 @@
+"wYRydUzt"

internal/forge/gitlab/testdata/TestIntegration_Repository_SubmitEditChange_labels/label3

@@ -0,0 +1 @@
+"dLdkaVw2"