v0.26.0 df1db36

cli_repo_test.go RawHistoryFolder

1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package app
4
5import (
6	"errors"
7	"testing"
8
9	"connectrpc.com/connect"
10	"github.com/stretchr/testify/assert"
11	"github.com/stretchr/testify/require"
12	"google.golang.org/protobuf/proto"
13
14	"bnema.dev/ermite-api/gen/ermite"
15)
16
17var (
18	repoAlpha = &ermite.Repo{
19		Name: "alpha", Description: "The first one", Topics: []string{"cli", "go"}, Visibility: ermite.Visibility_VISIBILITY_PUBLIC,
20		DefaultBranch: "main", CreatedAt: ts("2026-01-02T03:04:05Z"), PushedAt: ts("2026-03-04T05:06:07Z"),
21		Settings: &ermite.RepoSettings{
22			AllowedMergeModes:  []ermite.MergeMode{ermite.MergeMode_MERGE_MODE_FAST_FORWARD, ermite.MergeMode_MERGE_MODE_SQUASH},
23			FailingChecksBlock: true,
24		},
25	}
26	repoBeta = &ermite.Repo{
27		Name: "beta", Visibility: ermite.Visibility_VISIBILITY_PRIVATE,
28		DefaultBranch: "trunk", CreatedAt: ts("2026-02-02T00:00:00Z"),
29		Settings: &ermite.RepoSettings{AllowedMergeModes: []ermite.MergeMode{ermite.MergeMode_MERGE_MODE_SQUASH}},
30	}
31)
32
33func envFor(url string) map[string]string {
34	return map[string]string{"ERMITE_URL": url, "ERMITE_TOKEN": "ermite_tok"}
35}
36
37func TestRepoList(t *testing.T) {
38	both := []*ermite.Repo{repoAlpha, repoBeta}
39	tests := []struct {
40		name       string
41		repos      []*ermite.Repo
42		args       []string
43		wantStdout string
44		wantJSON   bool // compare stdout as JSON rather than byte for byte
45		wantStderr string
46	}{
47		{
48			name: "table", repos: both, args: []string{"repo", "list"},
49			wantStdout: "" +
50				"NAME   VISIBILITY  BRANCH  LAST PUSH         DESCRIPTION\n" +
51				"alpha  public      main    2026-03-04 05:06  The first one\n" +
52				"beta   private     trunk   never             \n",
53		},
54		{
55			name: "json", repos: both, args: []string{"repo", "list", "--json"}, wantJSON: true,
56			wantStdout: `[
57				{"name":"alpha","description":"The first one","topics":["cli","go"],"visibility":"public","default_branch":"main","created_at":"2026-01-02T03:04:05Z","pushed_at":"2026-03-04T05:06:07Z","merge_modes":["fast-forward","squash"],"failing_checks_block":true},
58				{"name":"beta","description":"","topics":[],"visibility":"private","default_branch":"trunk","created_at":"2026-02-02T00:00:00Z","pushed_at":null,"merge_modes":["squash"],"failing_checks_block":false}
59			]`,
60		},
61		{
62			name: "empty, table", args: []string{"repo", "list"},
63			wantStderr: "ermite: no repositories\n",
64		},
65		{
66			name: "empty, json is [] not null", args: []string{"repo", "list", "--json"},
67			wantStdout: "[]\n",
68		},
69	}
70	for _, tt := range tests {
71		t.Run(tt.name, func(t *testing.T) {
72			f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
73				return &ermite.ListReposResponse{Repos: tt.repos}, nil
74			}}
75			res := runCLI(t, envFor(f.serve(t)), "", tt.args...).ok(t)
76			if tt.wantJSON {
77				assert.JSONEq(t, tt.wantStdout, res.stdout)
78			} else {
79				assert.Equal(t, tt.wantStdout, res.stdout)
80			}
81			assert.Equal(t, tt.wantStderr, res.stderr)
82			assert.Equal(t, "Bearer ermite_tok", f.header[0].Get("Authorization"))
83			assert.Equal(t, "ermite/v0.0.1 (cli)", f.header[0].Get("User-Agent"))
84		})
85	}
86}
87
88func TestRepoListFollowsPages(t *testing.T) {
89	f := &fakeAPI{listRepos: func(r *ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
90		if r.GetPageToken() == "" {
91			return &ermite.ListReposResponse{Repos: []*ermite.Repo{repoAlpha}, NextPageToken: "p2"}, nil
92		}
93		return &ermite.ListReposResponse{Repos: []*ermite.Repo{repoBeta}}, nil
94	}}
95	res := runCLI(t, envFor(f.serve(t)), "", "repo", "list", "--json").ok(t)
96	assert.Contains(t, res.stdout, `"alpha"`)
97	assert.Contains(t, res.stdout, `"beta"`)
98	_, reqs := f.snapshot()
99	require.Len(t, reqs, 2)
100	assert.Equal(t, "p2", reqs[1].(*ermite.ListReposRequest).GetPageToken())
101}
102
103func TestRepoShow(t *testing.T) {
104	f := &fakeAPI{getRepo: func(r *ermite.GetRepoRequest) (*ermite.GetRepoResponse, error) {
105		return &ermite.GetRepoResponse{Repo: repoAlpha}, nil
106	}}
107	url := f.serve(t)
108	res := runCLI(t, envFor(url), "", "repo", "show", "alpha").ok(t)
109	assert.Equal(t, ""+
110		"name                  alpha\n"+
111		"visibility            public\n"+
112		"default branch        main\n"+
113		"description           The first one\n"+
114		"topics                cli, go\n"+
115		"created               2026-01-02 03:04\n"+
116		"last push             2026-03-04 05:06\n"+
117		"merge modes           fast-forward, squash\n"+
118		"failing checks block  true\n", res.stdout)
119	_, reqs := f.snapshot()
120	assert.Equal(t, "alpha", reqs[0].(*ermite.GetRepoRequest).GetRepo())
121
122	res = runCLI(t, envFor(url), "", "repo", "show", "alpha", "--json").ok(t)
123	assert.JSONEq(t, `{"name":"alpha","description":"The first one","topics":["cli","go"],"visibility":"public","default_branch":"main","created_at":"2026-01-02T03:04:05Z","pushed_at":"2026-03-04T05:06:07Z","merge_modes":["fast-forward","squash"],"failing_checks_block":true}`, res.stdout)
124}
125
126func TestRepoShowNeedsOneArg(t *testing.T) {
127	res := runCLI(t, envFor("http://127.0.0.1:1"), "", "repo", "show")
128	require.Error(t, res.err)
129}
130
131func TestRepoCreateMapsFlags(t *testing.T) {
132	tests := []struct {
133		name   string
134		args   []string
135		want   ermite.Visibility
136		desc   string
137		topics []string
138	}{
139		{"default is private", []string{"x"}, ermite.Visibility_VISIBILITY_PRIVATE, "", nil},
140		{"--visibility public", []string{"x", "--visibility", "public", "--description", "d d"}, ermite.Visibility_VISIBILITY_PUBLIC, "d d", nil},
141		{"case insensitive", []string{"x", "--visibility", "Public"}, ermite.Visibility_VISIBILITY_PUBLIC, "", nil},
142		{"--topics", []string{"x", "--topics", "go,cli"}, ermite.Visibility_VISIBILITY_PRIVATE, "", []string{"go", "cli"}},
143	}
144	for _, tt := range tests {
145		t.Run(tt.name, func(t *testing.T) {
146			f := &fakeAPI{createRepo: func(r *ermite.CreateRepoRequest) (*ermite.CreateRepoResponse, error) {
147				return &ermite.CreateRepoResponse{Repo: repoAlpha}, nil
148			}}
149			runCLI(t, envFor(f.serve(t)), "", append([]string{"repo", "create"}, tt.args...)...).ok(t)
150			_, reqs := f.snapshot()
151			require.Len(t, reqs, 1)
152			got := reqs[0].(*ermite.CreateRepoRequest)
153			assert.Equal(t, "x", got.GetName())
154			assert.Equal(t, tt.want, got.GetVisibility())
155			assert.Equal(t, tt.desc, got.GetDescription())
156			assert.Equal(t, tt.topics, got.GetTopics())
157		})
158	}
159}
160
161func TestRepoCreateRejectsBadFlagsWithoutCalling(t *testing.T) {
162	f := &fakeAPI{}
163	url := f.serve(t)
164	for _, args := range [][]string{
165		{"repo", "create", "x", "--visibility", "secret"},
166	} {
167		res := runCLI(t, envFor(url), "", args...)
168		require.Error(t, res.err, "%v", args)
169	}
170	calls, _ := f.snapshot()
171	assert.Empty(t, calls)
172}
173
174func TestRepoCreateJSON(t *testing.T) {
175	f := &fakeAPI{createRepo: func(r *ermite.CreateRepoRequest) (*ermite.CreateRepoResponse, error) {
176		return &ermite.CreateRepoResponse{Repo: repoBeta}, nil
177	}}
178	res := runCLI(t, envFor(f.serve(t)), "", "repo", "create", "beta", "--json").ok(t)
179	assert.JSONEq(t, `{"name":"beta","description":"","topics":[],"visibility":"private","default_branch":"trunk","created_at":"2026-02-02T00:00:00Z","pushed_at":null,"merge_modes":["squash"],"failing_checks_block":false}`, res.stdout)
180}
181
182func TestRepoEditMask(t *testing.T) {
183	tests := []struct {
184		name  string
185		args  []string
186		paths []string
187		check func(*testing.T, *ermite.UpdateRepoRequest)
188	}{
189		{"description only", []string{"--description", "new"}, []string{"description"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
190			assert.Equal(t, "new", r.GetDescription())
191		}},
192		{"clear description", []string{"--description", ""}, []string{"description"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
193			assert.Empty(t, r.GetDescription())
194		}},
195		{"topics", []string{"--topics", "Go,cli"}, []string{"topics"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
196			assert.Equal(t, []string{"Go", "cli"}, r.GetTopics())
197		}},
198		{"clear topics", []string{"--topics", ""}, []string{"topics"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
199			assert.Empty(t, r.GetTopics())
200		}},
201		{"visibility", []string{"--visibility", "public"}, []string{"visibility"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
202			assert.Equal(t, ermite.Visibility_VISIBILITY_PUBLIC, r.GetVisibility())
203		}},
204		{"default branch", []string{"--default-branch", "refs/heads/dev"}, []string{"default_branch"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
205			assert.Equal(t, "dev", r.GetDefaultBranch())
206		}},
207		{"merge modes", []string{"--merge-modes", "squash,ff"}, []string{"settings.allowed_merge_modes"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
208			assert.Equal(t, []ermite.MergeMode{ermite.MergeMode_MERGE_MODE_SQUASH, ermite.MergeMode_MERGE_MODE_FAST_FORWARD}, r.GetSettings().GetAllowedMergeModes())
209		}},
210		{"failing checks do not block", []string{"--failing-checks-block=false"}, []string{"settings.failing_checks_block"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
211			assert.False(t, r.GetSettings().GetFailingChecksBlock())
212			assert.Empty(t, r.GetSettings().GetAllowedMergeModes())
213		}},
214		{"failing checks block", []string{"--failing-checks-block"}, []string{"settings.failing_checks_block"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
215			assert.True(t, r.GetSettings().GetFailingChecksBlock())
216		}},
217		{"all", []string{"--default-branch", "dev", "--visibility", "private", "--description", "d"},
218			[]string{"description", "visibility", "default_branch"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {}},
219	}
220	for _, tt := range tests {
221		t.Run(tt.name, func(t *testing.T) {
222			f := &fakeAPI{updateRepo: func(r *ermite.UpdateRepoRequest) (*ermite.UpdateRepoResponse, error) {
223				return &ermite.UpdateRepoResponse{Repo: repoAlpha}, nil
224			}}
225			runCLI(t, envFor(f.serve(t)), "", append([]string{"repo", "edit", "alpha"}, tt.args...)...).ok(t)
226			_, reqs := f.snapshot()
227			require.Len(t, reqs, 1)
228			got := reqs[0].(*ermite.UpdateRepoRequest)
229			assert.Equal(t, "alpha", got.GetRepo())
230			assert.ElementsMatch(t, tt.paths, got.GetUpdateMask().GetPaths())
231			tt.check(t, got)
232		})
233	}
234}
235
236func TestRepoEditRejects(t *testing.T) {
237	f := &fakeAPI{}
238	url := f.serve(t)
239	for _, tt := range []struct {
240		args []string
241		want string
242	}{
243		{[]string{"repo", "edit", "alpha"}, "nothing to change"},
244		{[]string{"repo", "edit", "alpha", "--visibility", "x"}, "invalid visibility"},
245		{[]string{"repo", "edit", "alpha", "--default-branch", " "}, "must not be empty"},
246		{[]string{"repo", "edit", "alpha", "--merge-modes", "rebase"}, "invalid merge mode"},
247		{[]string{"repo", "edit", "alpha", "--merge-modes", ""}, "at least one mode"},
248	} {
249		res := runCLI(t, envFor(url), "", tt.args...)
250		require.Error(t, res.err)
251		assert.Contains(t, res.err.Error(), tt.want)
252	}
253	calls, _ := f.snapshot()
254	assert.Empty(t, calls)
255}
256
257func TestRepoDeleteConfirmation(t *testing.T) {
258	newFake := func() *fakeAPI {
259		return &fakeAPI{deleteRepo: func(*ermite.DeleteRepoRequest) (*ermite.DeleteRepoResponse, error) {
260			return &ermite.DeleteRepoResponse{}, nil
261		}}
262	}
263	t.Run("typed name deletes", func(t *testing.T) {
264		f := newFake()
265		res := runCLI(t, envFor(f.serve(t)), "alpha\n", "repo", "delete", "alpha").ok(t)
266		assert.Equal(t, "deleted alpha\n", res.stdout)
267		assert.Contains(t, res.stderr, "Type its name to confirm")
268		calls, reqs := f.snapshot()
269		assert.Equal(t, []string{"DeleteRepo"}, calls)
270		assert.Equal(t, "alpha", reqs[0].(*ermite.DeleteRepoRequest).GetRepo())
271	})
272	t.Run("last line without newline is accepted", func(t *testing.T) {
273		f := newFake()
274		runCLI(t, envFor(f.serve(t)), "alpha", "repo", "delete", "alpha").ok(t)
275		calls, _ := f.snapshot()
276		assert.Equal(t, []string{"DeleteRepo"}, calls)
277	})
278	t.Run("wrong name aborts", func(t *testing.T) {
279		f := newFake()
280		res := runCLI(t, envFor(f.serve(t)), "beta\n", "repo", "delete", "alpha")
281		require.Error(t, res.err)
282		assert.Contains(t, res.err.Error(), "did not match")
283		calls, _ := f.snapshot()
284		assert.Empty(t, calls)
285	})
286	t.Run("empty stdin aborts", func(t *testing.T) {
287		f := newFake()
288		res := runCLI(t, envFor(f.serve(t)), "", "repo", "delete", "alpha")
289		require.Error(t, res.err)
290		assert.Contains(t, res.err.Error(), "--yes")
291		calls, _ := f.snapshot()
292		assert.Empty(t, calls)
293	})
294	t.Run("--yes skips the question", func(t *testing.T) {
295		f := newFake()
296		res := runCLI(t, envFor(f.serve(t)), "", "repo", "delete", "alpha", "--yes").ok(t)
297		assert.Equal(t, "deleted alpha\n", res.stdout)
298		assert.NotContains(t, res.stderr, "confirm")
299	})
300	t.Run("-y", func(t *testing.T) {
301		f := newFake()
302		runCLI(t, envFor(f.serve(t)), "", "repo", "delete", "alpha", "-y").ok(t)
303	})
304}
305
306func TestRepoErrorsAreFriendly(t *testing.T) {
307	f := &fakeAPI{getRepo: func(*ermite.GetRepoRequest) (*ermite.GetRepoResponse, error) {
308		return nil, connect.NewError(connect.CodeNotFound, errors.New("repository \"nope\" not found"))
309	}}
310	res := runCLI(t, envFor(f.serve(t)), "", "repo", "show", "nope")
311	require.Error(t, res.err)
312	assert.Equal(t, "not found: repository \"nope\" not found", res.err.Error())
313}
314
315func TestUnauthenticatedHintsAtToken(t *testing.T) {
316	f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
317		return nil, connect.NewError(connect.CodeUnauthenticated, errors.New("invalid token"))
318	}}
319	res := runCLI(t, map[string]string{"ERMITE_URL": f.serve(t)}, "", "repo", "list")
320	require.Error(t, res.err)
321	assert.Contains(t, res.err.Error(), "ERMITE_TOKEN")
322}
323
324func TestMissingURL(t *testing.T) {
325	res := runCLI(t, nil, "", "repo", "list")
326	require.Error(t, res.err)
327	assert.Contains(t, res.err.Error(), "ERMITE_URL is not set")
328}
329
330func TestInvalidURL(t *testing.T) {
331	res := runCLI(t, map[string]string{"ERMITE_URL": "git.example.com"}, "", "repo", "list")
332	require.Error(t, res.err)
333	assert.Contains(t, res.err.Error(), "ERMITE_URL")
334	assert.Contains(t, res.err.Error(), "http")
335}
336
337func TestUnreachableServer(t *testing.T) {
338	res := runCLI(t, envFor("http://127.0.0.1:1"), "", "repo", "list")
339	require.Error(t, res.err)
340	assert.Contains(t, res.err.Error(), "cannot reach the server at http://127.0.0.1:1")
341	assert.NotContains(t, res.err.Error(), "\n")
342}
343
344func TestInsecureTokenWarningOnStderr(t *testing.T) {
345	// A non-loopback http URL: nothing listens there, the warning comes first.
346	res := runCLI(t, map[string]string{"ERMITE_URL": "http://ermite.invalid:1", "ERMITE_TOKEN": "ermite_tok"}, "", "repo", "list")
347	require.Error(t, res.err)
348	assert.Contains(t, res.stderr, "ermite: warning: ERMITE_TOKEN is sent over plain http to ermite.invalid")
349	assert.NotContains(t, res.stderr, "ermite_tok")
350}
351
352func TestLoopbackHTTPDoesNotWarn(t *testing.T) {
353	f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
354		return &ermite.ListReposResponse{Repos: []*ermite.Repo{repoAlpha}}, nil
355	}}
356	res := runCLI(t, envFor(f.serve(t)), "", "repo", "list").ok(t)
357	assert.Empty(t, res.stderr)
358}
359
360func TestTerminalControlCharactersAreNeutralised(t *testing.T) {
361	evil := &ermite.Repo{Name: "x", Description: "a\x1b[31mred\nline", Visibility: ermite.Visibility_VISIBILITY_PUBLIC}
362	f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
363		return &ermite.ListReposResponse{Repos: []*ermite.Repo{evil}}, nil
364	}}
365	res := runCLI(t, envFor(f.serve(t)), "", "repo", "list").ok(t)
366	assert.NotContains(t, res.stdout, "\x1b")
367	assert.Equal(t, 2, len(splitLines(res.stdout)), "header and one row")
368}
369
370func splitLines(s string) []string {
371	var out []string
372	cur := ""
373	for _, r := range s {
374		if r == '\n' {
375			out = append(out, cur)
376			cur = ""
377			continue
378		}
379		cur += string(r)
380	}
381	if cur != "" {
382		out = append(out, cur)
383	}
384	return out
385}
386
387func TestRepoNameCompletion(t *testing.T) {
388	f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
389		return &ermite.ListReposResponse{Repos: []*ermite.Repo{repoAlpha, repoBeta}}, nil
390	}}
391	vars := envFor(f.serve(t))
392	res := runCLI(t, vars, "", "__complete", "repo", "show", "a").ok(t)
393	assert.Contains(t, res.stdout, "alpha\tpublic, The first one")
394	assert.NotContains(t, res.stdout, "beta")
395
396	res = runCLI(t, vars, "", "__complete", "repo", "delete", "").ok(t)
397	assert.Contains(t, res.stdout, "alpha")
398	assert.Contains(t, res.stdout, "beta")
399
400	// A second argument gets no repository names.
401	res = runCLI(t, vars, "", "__complete", "repo", "show", "alpha", "").ok(t)
402	assert.NotContains(t, res.stdout, "beta")
403
404	res = runCLI(t, vars, "", "__complete", "watch", "").ok(t)
405	assert.Contains(t, res.stdout, "alpha")
406}
407
408func TestCompletionIsSilentOnErrors(t *testing.T) {
409	denied := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
410		return nil, connect.NewError(connect.CodeUnauthenticated, nil)
411	}}
412	for name, vars := range map[string]map[string]string{
413		"no config":   nil,
414		"bad url":     {"ERMITE_URL": "nope"},
415		"unreachable": envFor("http://ermite.invalid:1"),
416		"rejected":    envFor(denied.serve(t)),
417	} {
418		t.Run(name, func(t *testing.T) {
419			res := runCLI(t, vars, "", "__complete", "repo", "show", "").ok(t)
420			assert.NotContains(t, res.stdout, "alpha")
421			assert.NotContains(t, res.stderr, "warning", "completion must not print warnings")
422			assert.Contains(t, res.stdout, ":4", "cobra's no-file-completion directive")
423		})
424	}
425}
426
427func TestShellCompletionScriptIsAvailable(t *testing.T) {
428	res := runCLI(t, nil, "", "completion", "bash").ok(t)
429	assert.Contains(t, res.stdout, "bash completion")
430}
431
432func TestToJSONRepoFromProto(t *testing.T) {
433	r := toJSONRepo(proto.Clone(repoBeta).(*ermite.Repo))
434	assert.Nil(t, r.PushedAt)
435	assert.Equal(t, "private", r.Visibility)
436	assert.Equal(t, "unknown", toJSONRepo(&ermite.Repo{}).Visibility)
437}

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 2

Tags 45

↑↓ moveenter openesc close