v0.30.0 c899179

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,"issues":"off"},
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,"issues":"off"}
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"+
119		"issues                off\n", res.stdout)
120	_, reqs := f.snapshot()
121	assert.Equal(t, "alpha", reqs[0].(*ermite.GetRepoRequest).GetRepo())
122
123	res = runCLI(t, envFor(url), "", "repo", "show", "alpha", "--json").ok(t)
124	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,"issues":"off"}`, res.stdout)
125}
126
127func TestRepoShowNeedsOneArg(t *testing.T) {
128	res := runCLI(t, envFor("http://127.0.0.1:1"), "", "repo", "show")
129	require.Error(t, res.err)
130}
131
132func TestRepoCreateMapsFlags(t *testing.T) {
133	tests := []struct {
134		name   string
135		args   []string
136		want   ermite.Visibility
137		desc   string
138		topics []string
139	}{
140		{"default is private", []string{"x"}, ermite.Visibility_VISIBILITY_PRIVATE, "", nil},
141		{"--visibility public", []string{"x", "--visibility", "public", "--description", "d d"}, ermite.Visibility_VISIBILITY_PUBLIC, "d d", nil},
142		{"case insensitive", []string{"x", "--visibility", "Public"}, ermite.Visibility_VISIBILITY_PUBLIC, "", nil},
143		{"--topics", []string{"x", "--topics", "go,cli"}, ermite.Visibility_VISIBILITY_PRIVATE, "", []string{"go", "cli"}},
144	}
145	for _, tt := range tests {
146		t.Run(tt.name, func(t *testing.T) {
147			f := &fakeAPI{createRepo: func(r *ermite.CreateRepoRequest) (*ermite.CreateRepoResponse, error) {
148				return &ermite.CreateRepoResponse{Repo: repoAlpha}, nil
149			}}
150			runCLI(t, envFor(f.serve(t)), "", append([]string{"repo", "create"}, tt.args...)...).ok(t)
151			_, reqs := f.snapshot()
152			require.Len(t, reqs, 1)
153			got := reqs[0].(*ermite.CreateRepoRequest)
154			assert.Equal(t, "x", got.GetName())
155			assert.Equal(t, tt.want, got.GetVisibility())
156			assert.Equal(t, tt.desc, got.GetDescription())
157			assert.Equal(t, tt.topics, got.GetTopics())
158		})
159	}
160}
161
162func TestRepoCreateRejectsBadFlagsWithoutCalling(t *testing.T) {
163	f := &fakeAPI{}
164	url := f.serve(t)
165	for _, args := range [][]string{
166		{"repo", "create", "x", "--visibility", "secret"},
167	} {
168		res := runCLI(t, envFor(url), "", args...)
169		require.Error(t, res.err, "%v", args)
170	}
171	calls, _ := f.snapshot()
172	assert.Empty(t, calls)
173}
174
175func TestRepoCreateJSON(t *testing.T) {
176	f := &fakeAPI{createRepo: func(r *ermite.CreateRepoRequest) (*ermite.CreateRepoResponse, error) {
177		return &ermite.CreateRepoResponse{Repo: repoBeta}, nil
178	}}
179	res := runCLI(t, envFor(f.serve(t)), "", "repo", "create", "beta", "--json").ok(t)
180	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,"issues":"off"}`, res.stdout)
181}
182
183func TestRepoEditMask(t *testing.T) {
184	tests := []struct {
185		name  string
186		args  []string
187		paths []string
188		check func(*testing.T, *ermite.UpdateRepoRequest)
189	}{
190		{"description only", []string{"--description", "new"}, []string{"description"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
191			assert.Equal(t, "new", r.GetDescription())
192		}},
193		{"clear description", []string{"--description", ""}, []string{"description"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
194			assert.Empty(t, r.GetDescription())
195		}},
196		{"topics", []string{"--topics", "Go,cli"}, []string{"topics"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
197			assert.Equal(t, []string{"Go", "cli"}, r.GetTopics())
198		}},
199		{"clear topics", []string{"--topics", ""}, []string{"topics"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
200			assert.Empty(t, r.GetTopics())
201		}},
202		{"visibility", []string{"--visibility", "public"}, []string{"visibility"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
203			assert.Equal(t, ermite.Visibility_VISIBILITY_PUBLIC, r.GetVisibility())
204		}},
205		{"default branch", []string{"--default-branch", "refs/heads/dev"}, []string{"default_branch"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
206			assert.Equal(t, "dev", r.GetDefaultBranch())
207		}},
208		{"merge modes", []string{"--merge-modes", "squash,ff"}, []string{"settings.allowed_merge_modes"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
209			assert.Equal(t, []ermite.MergeMode{ermite.MergeMode_MERGE_MODE_SQUASH, ermite.MergeMode_MERGE_MODE_FAST_FORWARD}, r.GetSettings().GetAllowedMergeModes())
210		}},
211		{"failing checks do not block", []string{"--failing-checks-block=false"}, []string{"settings.failing_checks_block"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
212			assert.False(t, r.GetSettings().GetFailingChecksBlock())
213			assert.Empty(t, r.GetSettings().GetAllowedMergeModes())
214		}},
215		{"failing checks block", []string{"--failing-checks-block"}, []string{"settings.failing_checks_block"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {
216			assert.True(t, r.GetSettings().GetFailingChecksBlock())
217		}},
218		{"all", []string{"--default-branch", "dev", "--visibility", "private", "--description", "d"},
219			[]string{"description", "visibility", "default_branch"}, func(t *testing.T, r *ermite.UpdateRepoRequest) {}},
220	}
221	for _, tt := range tests {
222		t.Run(tt.name, func(t *testing.T) {
223			f := &fakeAPI{updateRepo: func(r *ermite.UpdateRepoRequest) (*ermite.UpdateRepoResponse, error) {
224				return &ermite.UpdateRepoResponse{Repo: repoAlpha}, nil
225			}}
226			runCLI(t, envFor(f.serve(t)), "", append([]string{"repo", "edit", "alpha"}, tt.args...)...).ok(t)
227			_, reqs := f.snapshot()
228			require.Len(t, reqs, 1)
229			got := reqs[0].(*ermite.UpdateRepoRequest)
230			assert.Equal(t, "alpha", got.GetRepo())
231			assert.ElementsMatch(t, tt.paths, got.GetUpdateMask().GetPaths())
232			tt.check(t, got)
233		})
234	}
235}
236
237func TestRepoEditRejects(t *testing.T) {
238	f := &fakeAPI{}
239	url := f.serve(t)
240	for _, tt := range []struct {
241		args []string
242		want string
243	}{
244		{[]string{"repo", "edit", "alpha"}, "nothing to change"},
245		{[]string{"repo", "edit", "alpha", "--visibility", "x"}, "invalid visibility"},
246		{[]string{"repo", "edit", "alpha", "--default-branch", " "}, "must not be empty"},
247		{[]string{"repo", "edit", "alpha", "--merge-modes", "rebase"}, "invalid merge mode"},
248		{[]string{"repo", "edit", "alpha", "--merge-modes", ""}, "at least one mode"},
249	} {
250		res := runCLI(t, envFor(url), "", tt.args...)
251		require.Error(t, res.err)
252		assert.Contains(t, res.err.Error(), tt.want)
253	}
254	calls, _ := f.snapshot()
255	assert.Empty(t, calls)
256}
257
258func TestRepoDeleteConfirmation(t *testing.T) {
259	newFake := func() *fakeAPI {
260		return &fakeAPI{deleteRepo: func(*ermite.DeleteRepoRequest) (*ermite.DeleteRepoResponse, error) {
261			return &ermite.DeleteRepoResponse{}, nil
262		}}
263	}
264	t.Run("typed name deletes", func(t *testing.T) {
265		f := newFake()
266		res := runCLI(t, envFor(f.serve(t)), "alpha\n", "repo", "delete", "alpha").ok(t)
267		assert.Equal(t, "deleted alpha\n", res.stdout)
268		assert.Contains(t, res.stderr, "Type its name to confirm")
269		calls, reqs := f.snapshot()
270		assert.Equal(t, []string{"DeleteRepo"}, calls)
271		assert.Equal(t, "alpha", reqs[0].(*ermite.DeleteRepoRequest).GetRepo())
272	})
273	t.Run("last line without newline is accepted", func(t *testing.T) {
274		f := newFake()
275		runCLI(t, envFor(f.serve(t)), "alpha", "repo", "delete", "alpha").ok(t)
276		calls, _ := f.snapshot()
277		assert.Equal(t, []string{"DeleteRepo"}, calls)
278	})
279	t.Run("wrong name aborts", func(t *testing.T) {
280		f := newFake()
281		res := runCLI(t, envFor(f.serve(t)), "beta\n", "repo", "delete", "alpha")
282		require.Error(t, res.err)
283		assert.Contains(t, res.err.Error(), "did not match")
284		calls, _ := f.snapshot()
285		assert.Empty(t, calls)
286	})
287	t.Run("empty stdin aborts", func(t *testing.T) {
288		f := newFake()
289		res := runCLI(t, envFor(f.serve(t)), "", "repo", "delete", "alpha")
290		require.Error(t, res.err)
291		assert.Contains(t, res.err.Error(), "--yes")
292		calls, _ := f.snapshot()
293		assert.Empty(t, calls)
294	})
295	t.Run("--yes skips the question", func(t *testing.T) {
296		f := newFake()
297		res := runCLI(t, envFor(f.serve(t)), "", "repo", "delete", "alpha", "--yes").ok(t)
298		assert.Equal(t, "deleted alpha\n", res.stdout)
299		assert.NotContains(t, res.stderr, "confirm")
300	})
301	t.Run("-y", func(t *testing.T) {
302		f := newFake()
303		runCLI(t, envFor(f.serve(t)), "", "repo", "delete", "alpha", "-y").ok(t)
304	})
305}
306
307func TestRepoErrorsAreFriendly(t *testing.T) {
308	f := &fakeAPI{getRepo: func(*ermite.GetRepoRequest) (*ermite.GetRepoResponse, error) {
309		return nil, connect.NewError(connect.CodeNotFound, errors.New("repository \"nope\" not found"))
310	}}
311	res := runCLI(t, envFor(f.serve(t)), "", "repo", "show", "nope")
312	require.Error(t, res.err)
313	assert.Equal(t, "not found: repository \"nope\" not found", res.err.Error())
314}
315
316func TestUnauthenticatedHintsAtToken(t *testing.T) {
317	f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
318		return nil, connect.NewError(connect.CodeUnauthenticated, errors.New("invalid token"))
319	}}
320	res := runCLI(t, map[string]string{"ERMITE_URL": f.serve(t)}, "", "repo", "list")
321	require.Error(t, res.err)
322	assert.Contains(t, res.err.Error(), "ERMITE_TOKEN")
323}
324
325func TestMissingURL(t *testing.T) {
326	res := runCLI(t, nil, "", "repo", "list")
327	require.Error(t, res.err)
328	assert.Contains(t, res.err.Error(), "ERMITE_URL is not set")
329}
330
331func TestInvalidURL(t *testing.T) {
332	res := runCLI(t, map[string]string{"ERMITE_URL": "git.example.com"}, "", "repo", "list")
333	require.Error(t, res.err)
334	assert.Contains(t, res.err.Error(), "ERMITE_URL")
335	assert.Contains(t, res.err.Error(), "http")
336}
337
338func TestUnreachableServer(t *testing.T) {
339	res := runCLI(t, envFor("http://127.0.0.1:1"), "", "repo", "list")
340	require.Error(t, res.err)
341	assert.Contains(t, res.err.Error(), "cannot reach the server at http://127.0.0.1:1")
342	assert.NotContains(t, res.err.Error(), "\n")
343}
344
345func TestInsecureTokenWarningOnStderr(t *testing.T) {
346	// A non-loopback http URL: nothing listens there, the warning comes first.
347	res := runCLI(t, map[string]string{"ERMITE_URL": "http://ermite.invalid:1", "ERMITE_TOKEN": "ermite_tok"}, "", "repo", "list")
348	require.Error(t, res.err)
349	assert.Contains(t, res.stderr, "ermite: warning: ERMITE_TOKEN is sent over plain http to ermite.invalid")
350	assert.NotContains(t, res.stderr, "ermite_tok")
351}
352
353func TestLoopbackHTTPDoesNotWarn(t *testing.T) {
354	f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
355		return &ermite.ListReposResponse{Repos: []*ermite.Repo{repoAlpha}}, nil
356	}}
357	res := runCLI(t, envFor(f.serve(t)), "", "repo", "list").ok(t)
358	assert.Empty(t, res.stderr)
359}
360
361func TestTerminalControlCharactersAreNeutralised(t *testing.T) {
362	evil := &ermite.Repo{Name: "x", Description: "a\x1b[31mred\nline", Visibility: ermite.Visibility_VISIBILITY_PUBLIC}
363	f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
364		return &ermite.ListReposResponse{Repos: []*ermite.Repo{evil}}, nil
365	}}
366	res := runCLI(t, envFor(f.serve(t)), "", "repo", "list").ok(t)
367	assert.NotContains(t, res.stdout, "\x1b")
368	assert.Equal(t, 2, len(splitLines(res.stdout)), "header and one row")
369}
370
371func splitLines(s string) []string {
372	var out []string
373	cur := ""
374	for _, r := range s {
375		if r == '\n' {
376			out = append(out, cur)
377			cur = ""
378			continue
379		}
380		cur += string(r)
381	}
382	if cur != "" {
383		out = append(out, cur)
384	}
385	return out
386}
387
388func TestRepoNameCompletion(t *testing.T) {
389	f := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
390		return &ermite.ListReposResponse{Repos: []*ermite.Repo{repoAlpha, repoBeta}}, nil
391	}}
392	vars := envFor(f.serve(t))
393	res := runCLI(t, vars, "", "__complete", "repo", "show", "a").ok(t)
394	assert.Contains(t, res.stdout, "alpha\tpublic, The first one")
395	assert.NotContains(t, res.stdout, "beta")
396
397	res = runCLI(t, vars, "", "__complete", "repo", "delete", "").ok(t)
398	assert.Contains(t, res.stdout, "alpha")
399	assert.Contains(t, res.stdout, "beta")
400
401	// A second argument gets no repository names.
402	res = runCLI(t, vars, "", "__complete", "repo", "show", "alpha", "").ok(t)
403	assert.NotContains(t, res.stdout, "beta")
404
405	res = runCLI(t, vars, "", "__complete", "watch", "").ok(t)
406	assert.Contains(t, res.stdout, "alpha")
407}
408
409func TestCompletionIsSilentOnErrors(t *testing.T) {
410	denied := &fakeAPI{listRepos: func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error) {
411		return nil, connect.NewError(connect.CodeUnauthenticated, nil)
412	}}
413	for name, vars := range map[string]map[string]string{
414		"no config":   nil,
415		"bad url":     {"ERMITE_URL": "nope"},
416		"unreachable": envFor("http://ermite.invalid:1"),
417		"rejected":    envFor(denied.serve(t)),
418	} {
419		t.Run(name, func(t *testing.T) {
420			res := runCLI(t, vars, "", "__complete", "repo", "show", "").ok(t)
421			assert.NotContains(t, res.stdout, "alpha")
422			assert.NotContains(t, res.stderr, "warning", "completion must not print warnings")
423			assert.Contains(t, res.stdout, ":4", "cobra's no-file-completion directive")
424		})
425	}
426}
427
428func TestShellCompletionScriptIsAvailable(t *testing.T) {
429	res := runCLI(t, nil, "", "completion", "bash").ok(t)
430	assert.Contains(t, res.stdout, "bash completion")
431}
432
433func TestToJSONRepoFromProto(t *testing.T) {
434	r := toJSONRepo(proto.Clone(repoBeta).(*ermite.Repo))
435	assert.Nil(t, r.PushedAt)
436	assert.Equal(t, "private", r.Visibility)
437	assert.Equal(t, "unknown", toJSONRepo(&ermite.Repo{}).Visibility)
438}

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