v0.8.0 eaf4295

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

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