internal/control/table_test.go

v1.41.0
gitbay/internal/control/table_test.go history · blame · raw

213 lines · 7034 bytes

  1package control
  2
  3import (
  4	"bytes"
  5	"strings"
  6	"testing"
  7	"time"
  8)
  9
 10func fixtureTable(c *Ctx, w *bytes.Buffer) {
 11	tb := c.table(w, "#", "STATE", "TITLE", "AUTHOR")
 12	tb.row(cRef("#252"), cState("open"), cFlex("Dependency updates available for every module"), cText("gitbay-bot"))
 13	tb.row(cRef("#12"), cState("closed"), cFlex("Android app"), cText("cmc"))
 14	tb.flush()
 15}
 16
 17func TestTablePlainIsTabs(t *testing.T) {
 18	var b bytes.Buffer
 19	fixtureTable(&Ctx{}, &b)
 20	want := "#252\topen\tDependency updates available for every module\tgitbay-bot\n" +
 21		"#12\tclosed\tAndroid app\tcmc\n"
 22	if b.String() != want {
 23		t.Errorf("plain:\n%q\nwant\n%q", b.String(), want)
 24	}
 25}
 26
 27func TestTableTerminalFits(t *testing.T) {
 28	var b bytes.Buffer
 29	fixtureTable(&Ctx{Term: Term{Cols: 40}}, &b)
 30	want := "#     STATE   TITLE           AUTHOR\n" +
 31		"#252  open    Dependency up…  gitbay-bot\n" +
 32		"#12   closed  Android app     cmc\n"
 33	if b.String() != want {
 34		t.Errorf("terminal:\n%s\nwant\n%s", b.String(), want)
 35	}
 36}
 37
 38// A column shrunk below its header's width clips the header too.
 39func TestTableClipsHeaderToColumn(t *testing.T) {
 40	var b bytes.Buffer
 41	tb := (&Ctx{Term: Term{Cols: 16}}).table(&b, "FINGERPRINT", "SCOPE")
 42	tb.row(cFlex("SHA256:abcdefghijklmnopqrstuvwxyz"), cState("full"))
 43	tb.flush()
 44	for _, line := range strings.Split(strings.TrimSuffix(b.String(), "\n"), "\n") {
 45		if cells(line) > 16 {
 46			t.Errorf("line of %d cells at 16 columns: %q", cells(line), line)
 47		}
 48	}
 49	if !strings.HasPrefix(b.String(), "FINGERPR…  SCOPE\n") {
 50		t.Errorf("header:\n%s", b.String())
 51	}
 52}
 53
 54func TestTableColourOnlyAddsSGR(t *testing.T) {
 55	var mono, colour bytes.Buffer
 56	fixtureTable(&Ctx{Term: Term{Cols: 40}}, &mono)
 57	fixtureTable(&Ctx{Term: Term{Cols: 40, Color: true}}, &colour)
 58	if !strings.Contains(colour.String(), sgrGreen+"open"+sgrReset) {
 59		t.Errorf("open not green: %q", colour.String())
 60	}
 61	if !strings.HasPrefix(colour.String(), sgrDim) {
 62		t.Errorf("header not dim: %q", colour.String())
 63	}
 64	if stripSGR(colour.String()) != mono.String() {
 65		t.Errorf("colour changed the layout:\n%s\nvs\n%s", stripSGR(colour.String()), mono.String())
 66	}
 67}
 68
 69func TestTableAgesAndPlainStamps(t *testing.T) {
 70	termNow = func() time.Time { return time.Date(2026, 9, 23, 12, 0, 1, 0, time.UTC) }
 71	t.Cleanup(func() { termNow = time.Now })
 72	var plain, term bytes.Buffer
 73	for _, c := range []struct {
 74		ctx *Ctx
 75		w   *bytes.Buffer
 76	}{{&Ctx{}, &plain}, {&Ctx{Term: Term{Cols: 80}}, &term}} {
 77		tb := c.ctx.table(c.w, "#", "UPDATED")
 78		tb.row(cRef("#1"), cAge("2026-09-23T10:00:00.123Z"))
 79		tb.flush()
 80	}
 81	if plain.String() != "#1\t2026-09-23T10:00:00Z\n" {
 82		t.Errorf("plain = %q", plain.String())
 83	}
 84	if term.String() != "#   UPDATED\n#1  2h ago\n" {
 85		t.Errorf("term = %q", term.String())
 86	}
 87}
 88
 89// A row may carry a cell beyond what the header names — repo list's
 90// trailing [archived] marker, only present on some rows. flush must
 91// still render it, not silently drop it because it falls past
 92// len(header).
 93func TestTableKeepsCellsBeyondTheHeader(t *testing.T) {
 94	var b bytes.Buffer
 95	tb := (&Ctx{Term: Term{Cols: 80}}).table(&b, "PATH", "VISIBILITY", "DESCRIPTION")
 96	tb.row(cRef("a/x"), cState("public"), cFlex("one"))
 97	tb.row(cRef("a/y"), cState("public"), cFlex("two"), cText("[archived]"))
 98	tb.flush()
 99
100	out := b.String()
101	if !strings.Contains(out, "[archived]") {
102		t.Fatalf("archived marker dropped:\n%s", out)
103	}
104	lines := strings.Split(strings.TrimRight(out, "\n"), "\n")
105	if len(lines) != 3 {
106		t.Fatalf("want 3 lines, got %d:\n%s", len(lines), out)
107	}
108	header, row1, row2 := lines[0], lines[1], lines[2]
109	descAt := strings.Index(header, "DESCRIPTION")
110	oneAt := strings.Index(row1, "one")
111	twoAt := strings.Index(row2, "two")
112	if descAt < 0 || oneAt < 0 || twoAt < 0 {
113		t.Fatalf("columns not found:\n%s", out)
114	}
115	if descAt != oneAt || descAt != twoAt {
116		t.Errorf("DESCRIPTION column not aligned: header at %d, row1 at %d, row2 at %d\n%s", descAt, oneAt, twoAt, out)
117	}
118}
119
120func TestTableEmptyPrintsNothing(t *testing.T) {
121	var b bytes.Buffer
122	(&Ctx{Term: Term{Cols: 80}}).table(&b, "#").flush()
123	if b.Len() != 0 {
124		t.Errorf("empty table printed %q", b.String())
125	}
126}
127
128func TestTableNoTrailingSpace(t *testing.T) {
129	var b bytes.Buffer
130	tb := (&Ctx{Term: Term{Cols: 80}}).table(&b, "ADDRESS", "STATE")
131	tb.row(cRef("a@example.com"), cState("verified"), cText("primary"))
132	tb.row(cRef("b@example.com"), cState("verified"))
133	tb.flush()
134	for _, line := range strings.Split(b.String(), "\n") {
135		if strings.HasSuffix(line, " ") {
136			t.Errorf("trailing space: %q", line)
137		}
138	}
139}
140
141// A flexible column blank on most rows is capped at a third of the
142// terminal.
143func TestTableCapsSparseFlex(t *testing.T) {
144	var b bytes.Buffer
145	tb := (&Ctx{Term: Term{Cols: 90}}).table(&b, "TAG", "TITLE", "ASSETS")
146	tb.row(cRef("v3"), cFlex(""), cText("2"))
147	tb.row(cRef("v2"), cFlex(""), cText("2"))
148	tb.row(cRef("v1"), cFlex(""), cText("2"))
149	tb.row(cRef("v0"), cFlex(strings.Repeat("x", 60)), cText("2"))
150	tb.flush()
151	lines := strings.Split(b.String(), "\n")
152	if at := strings.Index(lines[0], "ASSETS"); at != len("TAG  ")+30+2 {
153		t.Errorf("ASSETS at %d:\n%s", at, b.String())
154	}
155}
156
157func TestTableSizeCells(t *testing.T) {
158	var plain, term bytes.Buffer
159	for _, c := range []struct {
160		ctx *Ctx
161		w   *bytes.Buffer
162	}{{&Ctx{}, &plain}, {&Ctx{Term: Term{Cols: 80}}, &term}} {
163		tb := c.ctx.table(c.w, "NAME", "SIZE")
164		tb.row(cRef("a"), cSize(2048))
165		tb.flush()
166	}
167	if plain.String() != "a\t2048\n" {
168		t.Errorf("plain = %q", plain.String())
169	}
170	if term.String() != "NAME  SIZE\na     2.0 KiB\n" {
171		t.Errorf("term = %q", term.String())
172	}
173}
174
175func TestTableDropsEmptyColumns(t *testing.T) {
176	var b bytes.Buffer
177	tb := (&Ctx{Term: Term{Cols: 80}}).table(&b, "#", "LABELS", "TITLE")
178	tb.row(cRef("#1"), cText(""), cFlex("one"))
179	tb.row(cRef("#2"), cText(""), cFlex("two"))
180	tb.flush()
181	if b.String() != "#   TITLE\n#1  one\n#2  two\n" {
182		t.Errorf("terminal = %q", b.String())
183	}
184	var plain bytes.Buffer
185	tb = (&Ctx{}).table(&plain, "#", "LABELS", "TITLE")
186	tb.row(cRef("#1"), cText(""), cFlex("one"))
187	tb.flush()
188	if plain.String() != "#1\t\tone\n" {
189		t.Errorf("plain = %q", plain.String())
190	}
191}
192
193// A swatch's dot is counted in the column's width, so the next column
194// stays aligned.
195func TestTableSwatchAligned(t *testing.T) {
196	var b bytes.Buffer
197	tb := (&Ctx{Term: Term{Cols: 80, Color: true, TrueColor: true}}).table(&b, "NAME", "COLOR", "ISSUES")
198	tb.row(cRef("bug"), cSwatch("#cf222e"), cNum(3))
199	tb.row(cRef("none"), cSwatch(""), cNum(1))
200	tb.flush()
201	lines := strings.Split(stripSGR(b.String()), "\n")
202	col := func(line, sub string) int { return cells(line[:strings.Index(line, sub)]) }
203	if at := col(lines[0], "ISSUES"); at != col(lines[1], "3") || at != col(lines[2], "1") {
204		t.Errorf("ISSUES not aligned:\n%s", stripSGR(b.String()))
205	}
206	var plain bytes.Buffer
207	tb = (&Ctx{}).table(&plain, "NAME", "COLOR")
208	tb.row(cRef("bug"), cSwatch("#cf222e"))
209	tb.flush()
210	if plain.String() != "bug\t#cf222e\n" {
211		t.Errorf("plain = %q", plain.String())
212	}
213}