detached 83e495f

cli_fake_test.go RawHistoryFolder

1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package app
4
5import (
6	"bytes"
7	"context"
8	"errors"
9	"net/http"
10	"net/http/httptest"
11	"path/filepath"
12	"strings"
13	"sync"
14	"testing"
15	"time"
16
17	"connectrpc.com/connect"
18	"github.com/stretchr/testify/require"
19	"google.golang.org/protobuf/types/known/timestamppb"
20
21	"bnema.dev/ermite-api/gen/ermite"
22	"bnema.dev/ermite-api/gen/ermite/ermiteconnect"
23)
24
25// fakeAPI is a Connect server with stub services: each field, when set,
26// answers the matching RPC; the others answer unimplemented. It records the
27// requests it receives.
28type fakeAPI struct {
29	ermiteconnect.UnimplementedRepoServiceHandler
30	ermiteconnect.UnimplementedTokenServiceHandler
31	ermiteconnect.UnimplementedServerServiceHandler
32	ermiteconnect.UnimplementedEventServiceHandler
33	ermiteconnect.UnimplementedMergeRequestServiceHandler
34	ermiteconnect.UnimplementedIssueServiceHandler
35	ermiteconnect.UnimplementedSessionServiceHandler
36	ermiteconnect.UnimplementedRunServiceHandler
37	ermiteconnect.UnimplementedTrustedKeyServiceHandler
38
39	runners []*ermite.Runner // ListRunners answer; nil means one default runner
40
41	mu     sync.Mutex
42	calls  []string      // procedure names, in order
43	reqs   []any         // request messages, in order
44	header []http.Header // request headers, in order
45
46	listRepos   func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error)
47	getRepo     func(*ermite.GetRepoRequest) (*ermite.GetRepoResponse, error)
48	createRepo  func(*ermite.CreateRepoRequest) (*ermite.CreateRepoResponse, error)
49	updateRepo  func(*ermite.UpdateRepoRequest) (*ermite.UpdateRepoResponse, error)
50	deleteRepo  func(*ermite.DeleteRepoRequest) (*ermite.DeleteRepoResponse, error)
51	createToken func(*ermite.CreateTokenRequest) (*ermite.CreateTokenResponse, error)
52	listTokens  func(*ermite.ListTokensRequest) (*ermite.ListTokensResponse, error)
53	revokeToken func(*ermite.RevokeTokenRequest) (*ermite.RevokeTokenResponse, error)
54	getVersion  func(*ermite.GetVersionRequest) (*ermite.GetVersionResponse, error)
55	watch       func(context.Context, *ermite.WatchRequest, *connect.ServerStream[ermite.WatchResponse]) error
56
57	createMR      func(*ermite.CreateMergeRequestRequest) (*ermite.CreateMergeRequestResponse, error)
58	listMR        func(*ermite.ListMergeRequestsRequest) (*ermite.ListMergeRequestsResponse, error)
59	getMR         func(*ermite.GetMergeRequestRequest) (*ermite.GetMergeRequestResponse, error)
60	addComment    func(*ermite.AddCommentRequest) (*ermite.AddCommentResponse, error)
61	resolveCmt    func(*ermite.ResolveCommentRequest) (*ermite.ResolveCommentResponse, error)
62	closeMR       func(*ermite.CloseMergeRequestRequest) (*ermite.CloseMergeRequestResponse, error)
63	mergeMR       func(*ermite.MergeMergeRequestRequest) (*ermite.MergeMergeRequestResponse, error)
64	markRead      func(*ermite.MarkReadRequest) (*ermite.MarkReadResponse, error)
65	createIssue   func(*ermite.CreateIssueRequest) (*ermite.CreateIssueResponse, error)
66	listIssues    func(*ermite.ListIssuesRequest) (*ermite.ListIssuesResponse, error)
67	getIssue      func(*ermite.GetIssueRequest) (*ermite.GetIssueResponse, error)
68	addIssueCmt   func(*ermite.AddIssueCommentRequest) (*ermite.AddIssueCommentResponse, error)
69	closeIssue    func(*ermite.CloseIssueRequest) (*ermite.CloseIssueResponse, error)
70	reopenIssue   func(*ermite.ReopenIssueRequest) (*ermite.ReopenIssueResponse, error)
71	getSigningKey func(*ermite.GetSigningKeyRequest) (*ermite.GetSigningKeyResponse, error)
72
73	listPasskeys  func(*ermite.ListPasskeysRequest) (*ermite.ListPasskeysResponse, error)
74	removePasskey func(*ermite.RemovePasskeyRequest) (*ermite.RemovePasskeyResponse, error)
75
76	listTrustedKeys  func(*ermite.ListTrustedKeysRequest) (*ermite.ListTrustedKeysResponse, error)
77	addTrustedKey    func(*ermite.AddTrustedKeyRequest) (*ermite.AddTrustedKeyResponse, error)
78	removeTrustedKey func(*ermite.RemoveTrustedKeyRequest) (*ermite.RemoveTrustedKeyResponse, error)
79}
80
81func (f *fakeAPI) record(name string, h http.Header, req any) {
82	f.mu.Lock()
83	defer f.mu.Unlock()
84	f.calls = append(f.calls, name)
85	f.reqs = append(f.reqs, req)
86	f.header = append(f.header, h.Clone())
87}
88
89func (f *fakeAPI) snapshot() (calls []string, reqs []any) {
90	f.mu.Lock()
91	defer f.mu.Unlock()
92	return append([]string(nil), f.calls...), append([]any(nil), f.reqs...)
93}
94
95func respond[Req, Res any](f *fakeAPI, name string, req *connect.Request[Req], fn func(*Req) (*Res, error)) (*connect.Response[Res], error) {
96	f.record(name, req.Header(), req.Msg)
97	if fn == nil {
98		return nil, connect.NewError(connect.CodeUnimplemented, nil)
99	}
100	res, err := fn(req.Msg)
101	if err != nil {
102		return nil, err
103	}
104	return connect.NewResponse(res), nil
105}
106
107func (f *fakeAPI) ListRepos(_ context.Context, r *connect.Request[ermite.ListReposRequest]) (*connect.Response[ermite.ListReposResponse], error) {
108	return respond(f, "ListRepos", r, f.listRepos)
109}
110func (f *fakeAPI) GetRepo(_ context.Context, r *connect.Request[ermite.GetRepoRequest]) (*connect.Response[ermite.GetRepoResponse], error) {
111	return respond(f, "GetRepo", r, f.getRepo)
112}
113func (f *fakeAPI) CreateRepo(_ context.Context, r *connect.Request[ermite.CreateRepoRequest]) (*connect.Response[ermite.CreateRepoResponse], error) {
114	return respond(f, "CreateRepo", r, f.createRepo)
115}
116func (f *fakeAPI) UpdateRepo(_ context.Context, r *connect.Request[ermite.UpdateRepoRequest]) (*connect.Response[ermite.UpdateRepoResponse], error) {
117	return respond(f, "UpdateRepo", r, f.updateRepo)
118}
119func (f *fakeAPI) DeleteRepo(_ context.Context, r *connect.Request[ermite.DeleteRepoRequest]) (*connect.Response[ermite.DeleteRepoResponse], error) {
120	return respond(f, "DeleteRepo", r, f.deleteRepo)
121}
122func (f *fakeAPI) CreateToken(_ context.Context, r *connect.Request[ermite.CreateTokenRequest]) (*connect.Response[ermite.CreateTokenResponse], error) {
123	return respond(f, "CreateToken", r, f.createToken)
124}
125func (f *fakeAPI) ListTokens(_ context.Context, r *connect.Request[ermite.ListTokensRequest]) (*connect.Response[ermite.ListTokensResponse], error) {
126	return respond(f, "ListTokens", r, f.listTokens)
127}
128func (f *fakeAPI) RevokeToken(_ context.Context, r *connect.Request[ermite.RevokeTokenRequest]) (*connect.Response[ermite.RevokeTokenResponse], error) {
129	return respond(f, "RevokeToken", r, f.revokeToken)
130}
131func (f *fakeAPI) GetVersion(_ context.Context, r *connect.Request[ermite.GetVersionRequest]) (*connect.Response[ermite.GetVersionResponse], error) {
132	return respond(f, "GetVersion", r, f.getVersion)
133}
134func (f *fakeAPI) CreateMergeRequest(_ context.Context, r *connect.Request[ermite.CreateMergeRequestRequest]) (*connect.Response[ermite.CreateMergeRequestResponse], error) {
135	return respond(f, "CreateMergeRequest", r, f.createMR)
136}
137func (f *fakeAPI) ListMergeRequests(_ context.Context, r *connect.Request[ermite.ListMergeRequestsRequest]) (*connect.Response[ermite.ListMergeRequestsResponse], error) {
138	return respond(f, "ListMergeRequests", r, f.listMR)
139}
140func (f *fakeAPI) GetMergeRequest(_ context.Context, r *connect.Request[ermite.GetMergeRequestRequest]) (*connect.Response[ermite.GetMergeRequestResponse], error) {
141	return respond(f, "GetMergeRequest", r, f.getMR)
142}
143func (f *fakeAPI) AddComment(_ context.Context, r *connect.Request[ermite.AddCommentRequest]) (*connect.Response[ermite.AddCommentResponse], error) {
144	return respond(f, "AddComment", r, f.addComment)
145}
146func (f *fakeAPI) ResolveComment(_ context.Context, r *connect.Request[ermite.ResolveCommentRequest]) (*connect.Response[ermite.ResolveCommentResponse], error) {
147	return respond(f, "ResolveComment", r, f.resolveCmt)
148}
149func (f *fakeAPI) CloseMergeRequest(_ context.Context, r *connect.Request[ermite.CloseMergeRequestRequest]) (*connect.Response[ermite.CloseMergeRequestResponse], error) {
150	return respond(f, "CloseMergeRequest", r, f.closeMR)
151}
152func (f *fakeAPI) MergeMergeRequest(_ context.Context, r *connect.Request[ermite.MergeMergeRequestRequest]) (*connect.Response[ermite.MergeMergeRequestResponse], error) {
153	return respond(f, "MergeMergeRequest", r, f.mergeMR)
154}
155func (f *fakeAPI) MarkRead(_ context.Context, r *connect.Request[ermite.MarkReadRequest]) (*connect.Response[ermite.MarkReadResponse], error) {
156	return respond(f, "MarkRead", r, f.markRead)
157}
158func (f *fakeAPI) CreateIssue(_ context.Context, r *connect.Request[ermite.CreateIssueRequest]) (*connect.Response[ermite.CreateIssueResponse], error) {
159	return respond(f, "CreateIssue", r, f.createIssue)
160}
161func (f *fakeAPI) ListIssues(_ context.Context, r *connect.Request[ermite.ListIssuesRequest]) (*connect.Response[ermite.ListIssuesResponse], error) {
162	return respond(f, "ListIssues", r, f.listIssues)
163}
164func (f *fakeAPI) GetIssue(_ context.Context, r *connect.Request[ermite.GetIssueRequest]) (*connect.Response[ermite.GetIssueResponse], error) {
165	return respond(f, "GetIssue", r, f.getIssue)
166}
167func (f *fakeAPI) AddIssueComment(_ context.Context, r *connect.Request[ermite.AddIssueCommentRequest]) (*connect.Response[ermite.AddIssueCommentResponse], error) {
168	return respond(f, "AddIssueComment", r, f.addIssueCmt)
169}
170func (f *fakeAPI) CloseIssue(_ context.Context, r *connect.Request[ermite.CloseIssueRequest]) (*connect.Response[ermite.CloseIssueResponse], error) {
171	return respond(f, "CloseIssue", r, f.closeIssue)
172}
173func (f *fakeAPI) ReopenIssue(_ context.Context, r *connect.Request[ermite.ReopenIssueRequest]) (*connect.Response[ermite.ReopenIssueResponse], error) {
174	return respond(f, "ReopenIssue", r, f.reopenIssue)
175}
176func (f *fakeAPI) GetSigningKey(_ context.Context, r *connect.Request[ermite.GetSigningKeyRequest]) (*connect.Response[ermite.GetSigningKeyResponse], error) {
177	return respond(f, "GetSigningKey", r, f.getSigningKey)
178}
179func (f *fakeAPI) ListPasskeys(_ context.Context, r *connect.Request[ermite.ListPasskeysRequest]) (*connect.Response[ermite.ListPasskeysResponse], error) {
180	return respond(f, "ListPasskeys", r, f.listPasskeys)
181}
182func (f *fakeAPI) RemovePasskey(_ context.Context, r *connect.Request[ermite.RemovePasskeyRequest]) (*connect.Response[ermite.RemovePasskeyResponse], error) {
183	return respond(f, "RemovePasskey", r, f.removePasskey)
184}
185func (f *fakeAPI) ListTrustedKeys(_ context.Context, r *connect.Request[ermite.ListTrustedKeysRequest]) (*connect.Response[ermite.ListTrustedKeysResponse], error) {
186	return respond(f, "ListTrustedKeys", r, f.listTrustedKeys)
187}
188func (f *fakeAPI) AddTrustedKey(_ context.Context, r *connect.Request[ermite.AddTrustedKeyRequest]) (*connect.Response[ermite.AddTrustedKeyResponse], error) {
189	return respond(f, "AddTrustedKey", r, f.addTrustedKey)
190}
191func (f *fakeAPI) RemoveTrustedKey(_ context.Context, r *connect.Request[ermite.RemoveTrustedKeyRequest]) (*connect.Response[ermite.RemoveTrustedKeyResponse], error) {
192	return respond(f, "RemoveTrustedKey", r, f.removeTrustedKey)
193}
194func (f *fakeAPI) Watch(ctx context.Context, r *connect.Request[ermite.WatchRequest], st *connect.ServerStream[ermite.WatchResponse]) error {
195	f.record("Watch", r.Header(), r.Msg)
196	if f.watch == nil {
197		return connect.NewError(connect.CodeUnimplemented, nil)
198	}
199	return f.watch(ctx, r.Msg, st)
200}
201
202// serve starts the fake under /-/api and returns its base URL.
203func (f *fakeAPI) serve(t *testing.T) string {
204	t.Helper()
205	mux := http.NewServeMux()
206	mount := func(path string, h http.Handler) { mux.Handle("/-/api"+path, http.StripPrefix("/-/api", h)) }
207	p, h := ermiteconnect.NewRepoServiceHandler(f)
208	mount(p, h)
209	p, h = ermiteconnect.NewTokenServiceHandler(f)
210	mount(p, h)
211	p, h = ermiteconnect.NewServerServiceHandler(f)
212	mount(p, h)
213	p, h = ermiteconnect.NewEventServiceHandler(f)
214	mount(p, h)
215	p, h = ermiteconnect.NewMergeRequestServiceHandler(f)
216	mount(p, h)
217	p, h = ermiteconnect.NewIssueServiceHandler(f)
218	mount(p, h)
219	p, h = ermiteconnect.NewSessionServiceHandler(f)
220	mount(p, h)
221	p, h = ermiteconnect.NewRunServiceHandler(f)
222	mount(p, h)
223	p, h = ermiteconnect.NewTrustedKeyServiceHandler(f)
224	mount(p, h)
225	srv := httptest.NewServer(mux)
226	t.Cleanup(srv.Close)
227	return srv.URL
228}
229
230var testNow = time.Date(2026, 10, 10, 12, 0, 0, 0, time.UTC)
231
232// result is the outcome of one CLI run.
233type result struct {
234	stdout, stderr string
235	err            error
236}
237
238// testEnv is a cliEnv with the given variables, the fixed clock, and a config
239// file path inside a fresh temp dir (no file yet) so that a test never reads
240// the developer's own ~/.config/ermite/config. token.cmd must not run unless
241// the test sets runTokenCmd.
242func testEnv(t *testing.T, vars map[string]string) *cliEnv {
243	t.Helper()
244	path := filepath.Join(t.TempDir(), "ermite", "config")
245	return &cliEnv{
246		getenv:     func(k string) string { return vars[k] },
247		now:        func() time.Time { return testNow },
248		version:    "v0.0.1",
249		sleep:      func(ctx context.Context, _ time.Duration) error { return ctx.Err() },
250		configPath: func() (string, error) { return path, nil },
251		runTokenCmd: func(context.Context, string) (string, error) {
252			t.Error("token.cmd must not run")
253			return "", errors.New("token.cmd must not run")
254		},
255	}
256}
257
258// runCLI runs the command tree in process with the given environment.
259func runCLI(t *testing.T, vars map[string]string, stdin string, args ...string) result {
260	t.Helper()
261	return runCLIWith(t, testEnv(t, vars), stdin, args...)
262}
263
264// runCLIWith runs the command tree in process with env.
265func runCLIWith(t *testing.T, env *cliEnv, stdin string, args ...string) result {
266	t.Helper()
267	root := newRootCmdWith(env)
268	var out, errb bytes.Buffer
269	root.SetOut(&out)
270	root.SetErr(&errb)
271	root.SetIn(strings.NewReader(stdin))
272	root.SetArgs(args)
273	ctx, cancel := context.WithTimeout(t.Context(), 20*time.Second)
274	defer cancel()
275	err := root.ExecuteContext(ctx)
276	return result{stdout: out.String(), stderr: errb.String(), err: err}
277}
278
279func (r result) ok(t *testing.T) result {
280	t.Helper()
281	require.NoError(t, r.err, "stderr: %s", r.stderr)
282	return r
283}
284
285func ts(s string) *timestamppb.Timestamp {
286	v, err := time.Parse(time.RFC3339, s)
287	if err != nil {
288		panic(err)
289	}
290	return timestamppb.New(v)
291}

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 4

Tags 45

↑↓ moveenter openesc close