beads/cmd/bd/show_comments_tail_test.go
Bee 4c4ba275c4
test(show): tighten the --comments-tail off-state check; share the --watch start/stop choreography (#7383 follow-ups) (#7454)
Follow-up to #7383: the three non-blocking items its adoption review
filed (bd-m9pl8x, bd-zi2dko, bd-5qz7fa). Tests and release notes only.

- bd-m9pl8x: stripShowTips dropped every tip line and normalized trailing
  newlines on both routes, so a stray trailing blank line printed only
  under --comments-tail passed every route test. stripTrailingShowTip
  removes exactly one trailing "\n💡 Tip: …\n" block and nothing else;
  assertCommentsTailOff strips it only on the direct route (tips=true) and
  compares the proxied route byte for byte. Table test added.
- bd-zi2dko: the bd show --watch start / first-render / SIGINT /
  bounded-exit sequence now lives once, as startShowWatch +
  (*showWatch).interrupt; TestProxiedServerShowWatch and runShowWatchOnce
  both use it. Assertions unchanged.
- bd-5qz7fa: drop the blank line that made the CHANGELOG "### Added" list
  loose; direct_json_untouched goes through bdShowRaw.

Mutant check: a go build -overlay mutant printing one extra newline after
printComments only when --comments-tail > 0 passes the test on main (5/5)
and fails exactly direct_off_state_matches_absence here; the control
binary passes 5/5.

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-11 03:51:58 +00:00

358 lines
14 KiB
Go

package main
import (
"fmt"
"strings"
"testing"
"time"
"github.com/steveyegge/beads/internal/types"
"github.com/steveyegge/beads/internal/ui"
"github.com/steveyegge/beads/internal/uimd"
)
// testCommentsTailFormatTime is a fixed, deterministic formatTime for these
// tests — the real callers build one closed over --local-time, but the
// render function under test doesn't care which one it gets.
func testCommentsTailFormatTime(t time.Time) string {
return t.UTC().Format("2006-01-02 15:04")
}
// makeTailTestComments builds n comments with distinguishable Author/Text
// bodies ("author-0"/"body-0" .. "author-(n-1)"/"body-(n-1)") in ascending
// CreatedAt order, matching GetIssueComments' oldest-first contract — the
// same order both show routes hand to printComments today.
func makeTailTestComments(n int) []*types.Comment {
base := time.Date(2026, 1, 1, 0, 0, 0, 0, time.UTC)
comments := make([]*types.Comment, n)
for i := 0; i < n; i++ {
comments[i] = &types.Comment{
ID: fmt.Sprintf("c-%d", i),
Author: fmt.Sprintf("author-%d", i),
Text: fmt.Sprintf("body-%d", i),
CreatedAt: base.Add(time.Duration(i) * time.Minute),
}
}
return comments
}
// legacyRenderComments reproduces, verbatim, the COMMENTS block that lived
// inline in show.go / show_proxied_server.go before --comments-tail
// existed. It gives the "byte-identical to today's output" invariant an
// independent baseline to compare against, rather than comparing
// printComments against itself (which could hide a shared bug in both the
// capped and uncapped branches).
func legacyRenderComments(comments []*types.Comment, formatTime func(time.Time) string) {
if len(comments) > 0 {
fmt.Printf("\n%s\n", ui.RenderBold("COMMENTS"))
for _, comment := range comments {
fmt.Printf(" %s %s\n", ui.RenderMuted(formatTime(comment.CreatedAt)), comment.Author)
rendered := uimd.RenderMarkdown(comment.Text)
for _, line := range strings.Split(strings.TrimRight(rendered, "\n"), "\n") {
fmt.Printf(" %s\n", line)
}
}
}
}
// TestShowCommentsTailFlagRegistration guards the wiring for --comments-tail:
// the flag must exist, default to 0 so a caller that never passes it gets
// today's uncapped output, and be read by the proxied route too — the direct
// and proxied routes gather flags separately (see TestShowBriefDepsFlag),
// so a flag added to one does not reach the other by implication.
func TestShowCommentsTailFlagRegistration(t *testing.T) {
flag := showCmd.Flags().Lookup("comments-tail")
if flag == nil {
t.Fatal("comments-tail flag is not registered on showCmd")
}
if flag.DefValue != "0" {
t.Errorf("comments-tail default = %q, want \"0\": the default output must not change", flag.DefValue)
}
t.Run("proxied route defaults to 0", func(t *testing.T) {
if in := gatherShowProxiedInput(showCmd, []string{"be-abc"}); in.commentsTail != 0 {
t.Errorf("commentsTail defaulted to %d, want 0", in.commentsTail)
}
})
t.Run("proxied route reads it", func(t *testing.T) {
if err := showCmd.Flags().Set("comments-tail", "3"); err != nil {
t.Fatalf("set comments-tail=3: %v", err)
}
t.Cleanup(func() {
_ = showCmd.Flags().Set("comments-tail", "0")
showCmd.Flags().Lookup("comments-tail").Changed = false
})
if in := gatherShowProxiedInput(showCmd, []string{"be-abc"}); in.commentsTail != 3 {
t.Errorf("gatherShowProxiedInput did not carry comments-tail to the proxied request, got %d", in.commentsTail)
}
})
}
// TestValidateCommentsTail pins the negative-value usage error both show
// routes share, following how --max-rows already rejects a negative value
// (resolveMaxRows in max_rows.go).
func TestValidateCommentsTail(t *testing.T) {
if err := validateCommentsTail(0); err != nil {
t.Errorf("0 should be valid, got %v", err)
}
if err := validateCommentsTail(5); err != nil {
t.Errorf("a positive value should be valid, got %v", err)
}
var gotErr error
stderr := captureStderr(t, func() {
gotErr = validateCommentsTail(-1)
})
if gotErr == nil {
t.Fatal("expected an error for a negative --comments-tail")
}
if !strings.Contains(stderr, "--comments-tail") || !strings.Contains(stderr, "non-negative") {
t.Errorf("expected stderr to explain the flag constraint, got: %s", stderr)
}
}
// TestPrintComments_TailSmallerThanCount is scenario 1: a real cap hides the
// older comments behind exactly one elision line naming how many, and
// renders only the newest N bodies, in their existing order and format.
func TestPrintComments_TailSmallerThanCount(t *testing.T) {
comments := makeTailTestComments(5)
out := captureStdout(t, func() error {
printComments(comments, 2, testCommentsTailFormatTime, "ts-1")
return nil
})
for i := 0; i < 3; i++ {
if strings.Contains(out, fmt.Sprintf("body-%d", i)) {
t.Errorf("expected body-%d to be hidden by the cap, found it in:\n%s", i, out)
}
}
for i := 3; i < 5; i++ {
if !strings.Contains(out, fmt.Sprintf("body-%d", i)) {
t.Errorf("expected body-%d (one of the last 2) to render, missing from:\n%s", i, out)
}
}
if n := strings.Count(out, "older comment"); n != 1 {
t.Errorf("expected exactly one elision line, found %d in:\n%s", n, out)
}
wantLine := "… 3 older comments hidden — bd show ts-1 for the full record"
if !strings.Contains(out, wantLine) {
t.Errorf("expected elision line %q, got:\n%s", wantLine, out)
}
}
// TestPrintComments_TailAtOrAboveCount is scenario 2: a cap that does not
// need to hide anything (tailN >= len(comments)) must render byte-identical
// output to the uncapped (tailN == 0) path — no elision line, every comment
// present.
func TestPrintComments_TailAtOrAboveCount(t *testing.T) {
comments := makeTailTestComments(5)
uncapped := captureStdout(t, func() error {
printComments(comments, 0, testCommentsTailFormatTime, "ts-1")
return nil
})
atCount := captureStdout(t, func() error {
printComments(comments, 5, testCommentsTailFormatTime, "ts-1")
return nil
})
aboveCount := captureStdout(t, func() error {
printComments(comments, 100, testCommentsTailFormatTime, "ts-1")
return nil
})
if uncapped != atCount {
t.Errorf("tailN == len(comments) diverged from tailN == 0:\nuncapped:\n%s\natCount:\n%s", uncapped, atCount)
}
if uncapped != aboveCount {
t.Errorf("tailN > len(comments) diverged from tailN == 0:\nuncapped:\n%s\naboveCount:\n%s", uncapped, aboveCount)
}
if strings.Contains(uncapped, "older comment") {
t.Errorf("expected no elision line when nothing is hidden, got:\n%s", uncapped)
}
}
// TestPrintComments_ByteIdenticalToLegacyRender is the strongest form of "the
// flag absent or 0 must not change output": it compares printComments'
// uncapped path against an independent reproduction of the exact code that
// rendered the COMMENTS section before --comments-tail existed, so the two
// can't share a bug that a self-comparison (capped vs. uncapped both going
// through printComments) would hide. Calling printComments(x, 0) and
// comparing it to another printComments(x, 0) call would be vacuous — it
// can't fail — so every subtest here compares against legacyRenderComments
// instead.
func TestPrintComments_ByteIdenticalToLegacyRender(t *testing.T) {
comments := makeTailTestComments(7)
legacy := captureStdout(t, func() error {
legacyRenderComments(comments, testCommentsTailFormatTime)
return nil
})
current := captureStdout(t, func() error {
printComments(comments, 0, testCommentsTailFormatTime, "ts-1")
return nil
})
if legacy != current {
t.Errorf("printComments(tailN=0) diverged from the pre-flag render:\nlegacy:\n%s\ncurrent:\n%s", legacy, current)
}
// scenario 3: the flag absent — which resolves to Go's zero value for an
// unset int flag — must render identically to the pre-flag block, not
// merely to another explicit-0 call.
t.Run("flag absent (zero value)", func(t *testing.T) {
var absentTailN int // an unset --comments-tail flag GetInt()s to this
absent := captureStdout(t, func() error {
printComments(comments, absentTailN, testCommentsTailFormatTime, "ts-1")
return nil
})
if absent != legacy {
t.Errorf("flag-absent output diverged from the pre-flag render:\nabsent:\n%s\nlegacy:\n%s", absent, legacy)
}
})
t.Run("empty comments", func(t *testing.T) {
legacyEmpty := captureStdout(t, func() error {
legacyRenderComments(nil, testCommentsTailFormatTime)
return nil
})
currentEmpty := captureStdout(t, func() error {
printComments(nil, 0, testCommentsTailFormatTime, "ts-1")
return nil
})
if legacyEmpty != currentEmpty || legacyEmpty != "" {
t.Errorf("expected empty output for no comments, got legacy=%q current=%q", legacyEmpty, currentEmpty)
}
})
}
// TestPrintComments_SingularWording is scenario 5: exactly one older comment
// hidden gets "comment", not "comments".
func TestPrintComments_SingularWording(t *testing.T) {
comments := makeTailTestComments(3)
out := captureStdout(t, func() error {
printComments(comments, 2, testCommentsTailFormatTime, "ts-1")
return nil
})
wantLine := "… 1 older comment hidden — bd show ts-1 for the full record"
if !strings.Contains(out, wantLine) {
t.Errorf("expected singular elision line %q, got:\n%s", wantLine, out)
}
if strings.Contains(out, "1 older comments") {
t.Errorf("expected singular \"comment\", found plural in:\n%s", out)
}
}
// legacyWatchRenderComments reproduces, verbatim, the COMMENTS block that
// lived inline in show_display.go's displayShowIssueReturn before
// --comments-tail existed. Unlike legacyRenderComments above (which the
// direct and --proxied-server routes shared), the watch path hardcoded UTC
// unconditionally rather than taking a formatTime parameter — it never
// threaded --local-time — so this is its own, separate baseline.
func legacyWatchRenderComments(comments []*types.Comment) {
if len(comments) > 0 {
fmt.Printf("\n%s\n", ui.RenderBold("COMMENTS"))
for _, comment := range comments {
fmt.Printf(" %s %s\n", ui.RenderMuted(comment.CreatedAt.UTC().Format("2006-01-02 15:04")), comment.Author)
rendered := uimd.RenderMarkdown(comment.Text)
for _, line := range strings.Split(strings.TrimRight(rendered, "\n"), "\n") {
fmt.Printf(" %s\n", line)
}
}
}
}
// TestRenderWatchComments_TailAbsentMatchesLegacy pins that the watch path's
// own render call (renderWatchComments, the exact function
// displayShowIssueReturn calls — see show_display.go) reproduces the old
// watch block byte for byte when --comments-tail is absent (tailN == 0),
// including its hardcoded UTC formatting. This is the "watch mode ignores
// the flag" regression guard: it exercises the real wiring, not a
// hand-picked formatTime, so a future edit that stops threading
// --comments-tail to the watch render — or that starts threading
// --local-time in a way that changes the UTC formatting — would surface
// here.
func TestRenderWatchComments_TailAbsentMatchesLegacy(t *testing.T) {
comments := makeTailTestComments(4)
legacy := captureStdout(t, func() error {
legacyWatchRenderComments(comments)
return nil
})
current := captureStdout(t, func() error {
renderWatchComments(comments, 0, "ts-1")
return nil
})
if legacy != current {
t.Errorf("renderWatchComments(tailN=0) diverged from the pre-flag watch block:\nlegacy:\n%s\ncurrent:\n%s", legacy, current)
}
}
// TestRenderWatchComments_HonoursTail is the watch-path form of scenario 1:
// --comments-tail must cap the watch render the same way it caps the other
// two show routes, through the actual renderWatchComments call
// displayShowIssueReturn makes.
func TestRenderWatchComments_HonoursTail(t *testing.T) {
comments := makeTailTestComments(5)
out := captureStdout(t, func() error {
renderWatchComments(comments, 2, "ts-1")
return nil
})
for i := 0; i < 3; i++ {
if strings.Contains(out, fmt.Sprintf("body-%d", i)) {
t.Errorf("expected body-%d to be hidden by the cap in watch output, found it in:\n%s", i, out)
}
}
for i := 3; i < 5; i++ {
if !strings.Contains(out, fmt.Sprintf("body-%d", i)) {
t.Errorf("expected body-%d to render in watch output, missing from:\n%s", i, out)
}
}
wantLine := "… 3 older comments hidden — bd show ts-1 for the full record"
if !strings.Contains(out, wantLine) {
t.Errorf("expected elision line %q in watch output, got:\n%s", wantLine, out)
}
}
// stripTrailingShowTip removes the one tip block maybeShowTip (tips.go) may
// append after a direct-route text render — "\n💡 Tip: <message>\n" at the
// very end of stdout — and nothing else. Whether a tip prints is a per-run
// probability roll behind a per-tip frequency gate recorded in the store,
// independent of --comments-tail, so of two renders that are otherwise
// identical one can carry the tip and the other not. A tip anywhere but the
// end, or output that does not end in a newline, is returned unchanged; in
// particular no trailing newline is ever normalized away, so the route tests
// that compare two renders (assertCommentsTailOff) still see one.
func stripTrailingShowTip(out string) string {
i := strings.LastIndex(out, "\n💡 Tip: ")
if i < 0 || !strings.HasSuffix(out, "\n") {
return out
}
if strings.Count(out[i+1:], "\n") != 1 {
return out // the tip is not the last line
}
return out[:i]
}
func TestStripTrailingShowTip(t *testing.T) {
const render = "○ ct-1 · Tail me\n\nComments (1):\n CT-NEWEST-CHARLIE\n"
const tip = "\n💡 Tip: run `bd prime` after a compaction\n"
cases := []struct{ name, in, want string }{
{"no_tip_unchanged", render, render},
{"trailing_tip_block_stripped", render + tip, render},
{"stray_trailing_blank_line_kept", render + "\n", render + "\n"},
{"blank_line_after_tip_kept", render + tip + "\n", render + tip + "\n"},
{"tip_followed_by_output_kept", render + tip + "more\n", render + tip + "more\n"},
{"tip_as_first_line_kept", "💡 Tip: x\n" + render, "💡 Tip: x\n" + render},
{"no_final_newline_kept", render + "\n💡 Tip: x", render + "\n💡 Tip: x"},
{"empty", "", ""},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
if got := stripTrailingShowTip(tc.in); got != tc.want {
t.Errorf("stripTrailingShowTip(%q) = %q, want %q", tc.in, got, tc.want)
}
})
}
}