Files
gitea-tea/tests/integration/comments_test.go
T
dinsmoor 09fc09c2f7 feat(comments): add list/edit/delete subcommands to tea comment (#1015)
## Why

Today `tea comment` can only *add* a comment. Editing or deleting requires falling back to `tea api`. This came up while I was iterating on PRs in this same repo earlier today and had to correct a couple of comments by hand. Every comparable forge CLI (gh, glab, etc.) exposes these operations as first-class commands.

## What

Restructures `tea comment` from a single-action command into a parent with four subcommands. The parent's default action remains the existing "add" behavior, so the historical shorthand keeps working.

| Command | Purpose |
|---|---|
| `tea comment add <idx> [<body>]` | Add a comment (explicit subcommand) |
| `tea comment list <idx>` | Tabular listing including comment IDs |
| `tea comment edit <id> [<body>]` | Replace the body of one comment |
| `tea comment delete <id> [<id>...]` | Delete one or more comments |
| `tea comment <idx> [<body>]` | Unchanged — still routes to `add` |

The `list` command exists specifically so users can discover the IDs that `edit` and `delete` accept.

## Backward compatibility

The whole point of routing the parent's default `Action` through `add` is to preserve every existing invocation. `tea comment 1 "body"` still does what it did before. No flag or arg names change.

## Input forms (for add and edit)

Same pattern as the original `tea comment`:

1. Positional body (`tea comment edit <id> "new body"`) — wins if present.
2. Piped stdin if no positional body is given.
3. External `$EDITOR` (pre-populated with the current body, on `edit`) if neither.

This matches the stdin-handling fix in #1011 — positional body wins over a non-TTY stdin so the command doesn't hang in CI/subshells.

## Verification

All four subcommands were exercised live against `https://gitea.com/dinsmoor/tea-testing` issue #1. The test artifacts and a summary log are visible on that issue right now. Specifically:

- The annotated summary comment lists every operation tested and the comment IDs each one acted on.
- Comments 1197162 (legacy add), 1197163 (subcommand add, later edited), 1197164 (stdin add) are still there to be inspected.
- Comment 1197166 was created and then deleted; its absence from `tea comment list` output is evidence that delete works.

## New files

- `cmd/comments/add.go` — extracted from the old `cmd/comment.go`
- `cmd/comments/list.go`
- `cmd/comments/edit.go`
- `cmd/comments/delete.go`
- `modules/print/comment.go` — adds `CommentsList` helper for the tabular output

`cmd/comment.go` is rewritten as a thin parent that wires these together.

## Open questions for the reviewer

- **Naming**: should the top-level command be `comments` (plural) or stay `comment` (singular)? I kept it singular with `comments` as an alias to match the existing user-visible name.
- **Delete confirmation**: I did not add a confirmation prompt — `delete` just deletes. Some projects gate this behind `--yes` / interactive `[y/N]`. I'd rather follow whatever convention the maintainers prefer.
- **Output format on list**: currently uses the existing `print.tableWithHeader` helper, matching `tea organizations list` etc. Other tea listings support `--output json` / `--output csv` via the shared `--output` flag, which works here automatically through the same helper.

---

This patch was authored interactively with an AI assistant, driven and reviewed by a human (Tyler / @dinsmoor) every step.

*pull request created by Tyler's lovingly wrangled demon machine <3*

Reviewed-on: https://gitea.com/gitea/tea/pulls/1015
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: dinsmoor <204368+dinsmoor@noreply.gitea.com>
Co-committed-by: dinsmoor <204368+dinsmoor@noreply.gitea.com>
2026-05-31 22:20:48 +00:00

118 lines
3.6 KiB
Go

// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package integration
import (
"context"
"fmt"
"strconv"
"strings"
"testing"
"time"
"gitea.dev/sdk"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// TestCommentsCommandLifecycle exercises `tea comments add`, `list`, `edit`,
// and `delete` end-to-end against a live Gitea instance. It creates a throwaway
// repo with one issue, then drives the comment subcommands and verifies state
// via the SDK after each step.
func TestCommentsCommandLifecycle(t *testing.T) {
login := createIntegrationLogin(t)
client := login.Client()
ctx := context.Background()
repoName := fmt.Sprintf("tea-comments-integration-%d", time.Now().UnixNano())
_, _, err := client.CreateRepo(ctx, gitea.CreateRepoOption{Name: repoName, AutoInit: true})
require.NoError(t, err)
t.Cleanup(func() {
if _, delErr := client.DeleteRepo(ctx, login.User, repoName); delErr != nil {
t.Logf("failed to delete integration test repo %q: %v", repoName, delErr)
}
})
repoSlug := fmt.Sprintf("%s/%s", login.User, repoName)
issue, _, err := client.Issues.CreateIssue(ctx, login.User, repoName, gitea.CreateIssueOption{
Title: "comment test issue",
Body: "scratch issue for tea comment integration tests",
})
require.NoError(t, err)
issueIdx := strconv.FormatInt(issue.Index, 10)
// add via positional body
addOutput := runTeaCommand(t,
"comments", "add",
"--login", login.Name,
"--repo", repoSlug,
issueIdx, "first comment",
)
assert.Contains(t, addOutput, "first comment")
// add via the historical shorthand (parent command, no "add" subcommand)
runTeaCommand(t,
"comments",
"--login", login.Name,
"--repo", repoSlug,
issueIdx, "second comment",
)
// list should now show both, in tabular form with IDs
listOutput := runTeaCommand(t,
"comments", "list",
"--login", login.Name,
"--repo", repoSlug,
issueIdx,
)
assert.Contains(t, listOutput, "first comment")
assert.Contains(t, listOutput, "second comment")
// pull the real IDs from the server so edit/delete have something to act on
apiComments, _, err := client.Issues.ListIssueComments(ctx, login.User, repoName, issue.Index, gitea.ListIssueCommentOptions{})
require.NoError(t, err)
require.Len(t, apiComments, 2)
var firstID, secondID int64
for _, c := range apiComments {
switch {
case strings.Contains(c.Body, "first comment"):
firstID = c.ID
case strings.Contains(c.Body, "second comment"):
secondID = c.ID
}
}
require.NotZero(t, firstID, "first comment id not found in listing")
require.NotZero(t, secondID, "second comment id not found in listing")
// edit the first comment via positional body
editOutput := runTeaCommand(t,
"comments", "edit",
"--login", login.Name,
"--repo", repoSlug,
strconv.FormatInt(firstID, 10), "first comment (edited)",
)
assert.Contains(t, editOutput, "first comment (edited)")
edited, _, err := client.Issues.GetIssueComment(ctx, login.User, repoName, firstID)
require.NoError(t, err)
assert.Equal(t, "first comment (edited)", edited.Body)
// delete both comments in one batch
deleteOutput := runTeaCommand(t,
"comments", "delete",
"--login", login.Name,
"--repo", repoSlug,
strconv.FormatInt(firstID, 10),
strconv.FormatInt(secondID, 10),
)
assert.Contains(t, deleteOutput, fmt.Sprintf("Deleted comment %d", firstID))
assert.Contains(t, deleteOutput, fmt.Sprintf("Deleted comment %d", secondID))
remaining, _, err := client.Issues.ListIssueComments(ctx, login.User, repoName, issue.Index, gitea.ListIssueCommentOptions{})
require.NoError(t, err)
assert.Empty(t, remaining, "expected all comments to be deleted")
}