v0.13.0 dc42452

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.UnimplementedSessionServiceHandler
35	ermiteconnect.UnimplementedRunServiceHandler
36
37	mu     sync.Mutex
38	calls  []string      // procedure names, in order
39	reqs   []any         // request messages, in order
40	header []http.Header // request headers, in order
41
42	listRepos   func(*ermite.ListReposRequest) (*ermite.ListReposResponse, error)
43	getRepo     func(*ermite.GetRepoRequest) (*ermite.GetRepoResponse, error)
44	createRepo  func(*ermite.CreateRepoRequest) (*ermite.CreateRepoResponse, error)
45	updateRepo  func(*ermite.UpdateRepoRequest) (*ermite.UpdateRepoResponse, error)
46	deleteRepo  func(*ermite.DeleteRepoRequest) (*ermite.DeleteRepoResponse, error)
47	createToken func(*ermite.CreateTokenRequest) (*ermite.CreateTokenResponse, error)
48	listTokens  func(*ermite.ListTokensRequest) (*ermite.ListTokensResponse, error)
49	revokeToken func(*ermite.RevokeTokenRequest) (*ermite.RevokeTokenResponse, error)
50	getVersion  func(*ermite.GetVersionRequest) (*ermite.GetVersionResponse, error)
51	watch       func(context.Context, *ermite.WatchRequest, *connect.ServerStream[ermite.WatchResponse]) error
52
53	createMR      func(*ermite.CreateMergeRequestRequest) (*ermite.CreateMergeRequestResponse, error)
54	listMR        func(*ermite.ListMergeRequestsRequest) (*ermite.ListMergeRequestsResponse, error)
55	getMR         func(*ermite.GetMergeRequestRequest) (*ermite.GetMergeRequestResponse, error)
56	addComment    func(*ermite.AddCommentRequest) (*ermite.AddCommentResponse, error)
57	resolveCmt    func(*ermite.ResolveCommentRequest) (*ermite.ResolveCommentResponse, error)
58	closeMR       func(*ermite.CloseMergeRequestRequest) (*ermite.CloseMergeRequestResponse, error)
59	mergeMR       func(*ermite.MergeMergeRequestRequest) (*ermite.MergeMergeRequestResponse, error)
60	markRead      func(*ermite.MarkReadRequest) (*ermite.MarkReadResponse, error)
61	getSigningKey func(*ermite.GetSigningKeyRequest) (*ermite.GetSigningKeyResponse, error)
62
63	listPasskeys  func(*ermite.ListPasskeysRequest) (*ermite.ListPasskeysResponse, error)
64	removePasskey func(*ermite.RemovePasskeyRequest) (*ermite.RemovePasskeyResponse, error)
65}
66
67func (f *fakeAPI) record(name string, h http.Header, req any) {
68	f.mu.Lock()
69	defer f.mu.Unlock()
70	f.calls = append(f.calls, name)
71	f.reqs = append(f.reqs, req)
72	f.header = append(f.header, h.Clone())
73}
74
75func (f *fakeAPI) snapshot() (calls []string, reqs []any) {
76	f.mu.Lock()
77	defer f.mu.Unlock()
78	return append([]string(nil), f.calls...), append([]any(nil), f.reqs...)
79}
80
81func respond[Req, Res any](f *fakeAPI, name string, req *connect.Request[Req], fn func(*Req) (*Res, error)) (*connect.Response[Res], error) {
82	f.record(name, req.Header(), req.Msg)
83	if fn == nil {
84		return nil, connect.NewError(connect.CodeUnimplemented, nil)
85	}
86	res, err := fn(req.Msg)
87	if err != nil {
88		return nil, err
89	}
90	return connect.NewResponse(res), nil
91}
92
93func (f *fakeAPI) ListRepos(_ context.Context, r *connect.Request[ermite.ListReposRequest]) (*connect.Response[ermite.ListReposResponse], error) {
94	return respond(f, "ListRepos", r, f.listRepos)
95}
96func (f *fakeAPI) GetRepo(_ context.Context, r *connect.Request[ermite.GetRepoRequest]) (*connect.Response[ermite.GetRepoResponse], error) {
97	return respond(f, "GetRepo", r, f.getRepo)
98}
99func (f *fakeAPI) CreateRepo(_ context.Context, r *connect.Request[ermite.CreateRepoRequest]) (*connect.Response[ermite.CreateRepoResponse], error) {
100	return respond(f, "CreateRepo", r, f.createRepo)
101}
102func (f *fakeAPI) UpdateRepo(_ context.Context, r *connect.Request[ermite.UpdateRepoRequest]) (*connect.Response[ermite.UpdateRepoResponse], error) {
103	return respond(f, "UpdateRepo", r, f.updateRepo)
104}
105func (f *fakeAPI) DeleteRepo(_ context.Context, r *connect.Request[ermite.DeleteRepoRequest]) (*connect.Response[ermite.DeleteRepoResponse], error) {
106	return respond(f, "DeleteRepo", r, f.deleteRepo)
107}
108func (f *fakeAPI) CreateToken(_ context.Context, r *connect.Request[ermite.CreateTokenRequest]) (*connect.Response[ermite.CreateTokenResponse], error) {
109	return respond(f, "CreateToken", r, f.createToken)
110}
111func (f *fakeAPI) ListTokens(_ context.Context, r *connect.Request[ermite.ListTokensRequest]) (*connect.Response[ermite.ListTokensResponse], error) {
112	return respond(f, "ListTokens", r, f.listTokens)
113}
114func (f *fakeAPI) RevokeToken(_ context.Context, r *connect.Request[ermite.RevokeTokenRequest]) (*connect.Response[ermite.RevokeTokenResponse], error) {
115	return respond(f, "RevokeToken", r, f.revokeToken)
116}
117func (f *fakeAPI) GetVersion(_ context.Context, r *connect.Request[ermite.GetVersionRequest]) (*connect.Response[ermite.GetVersionResponse], error) {
118	return respond(f, "GetVersion", r, f.getVersion)
119}
120func (f *fakeAPI) CreateMergeRequest(_ context.Context, r *connect.Request[ermite.CreateMergeRequestRequest]) (*connect.Response[ermite.CreateMergeRequestResponse], error) {
121	return respond(f, "CreateMergeRequest", r, f.createMR)
122}
123func (f *fakeAPI) ListMergeRequests(_ context.Context, r *connect.Request[ermite.ListMergeRequestsRequest]) (*connect.Response[ermite.ListMergeRequestsResponse], error) {
124	return respond(f, "ListMergeRequests", r, f.listMR)
125}
126func (f *fakeAPI) GetMergeRequest(_ context.Context, r *connect.Request[ermite.GetMergeRequestRequest]) (*connect.Response[ermite.GetMergeRequestResponse], error) {
127	return respond(f, "GetMergeRequest", r, f.getMR)
128}
129func (f *fakeAPI) AddComment(_ context.Context, r *connect.Request[ermite.AddCommentRequest]) (*connect.Response[ermite.AddCommentResponse], error) {
130	return respond(f, "AddComment", r, f.addComment)
131}
132func (f *fakeAPI) ResolveComment(_ context.Context, r *connect.Request[ermite.ResolveCommentRequest]) (*connect.Response[ermite.ResolveCommentResponse], error) {
133	return respond(f, "ResolveComment", r, f.resolveCmt)
134}
135func (f *fakeAPI) CloseMergeRequest(_ context.Context, r *connect.Request[ermite.CloseMergeRequestRequest]) (*connect.Response[ermite.CloseMergeRequestResponse], error) {
136	return respond(f, "CloseMergeRequest", r, f.closeMR)
137}
138func (f *fakeAPI) MergeMergeRequest(_ context.Context, r *connect.Request[ermite.MergeMergeRequestRequest]) (*connect.Response[ermite.MergeMergeRequestResponse], error) {
139	return respond(f, "MergeMergeRequest", r, f.mergeMR)
140}
141func (f *fakeAPI) MarkRead(_ context.Context, r *connect.Request[ermite.MarkReadRequest]) (*connect.Response[ermite.MarkReadResponse], error) {
142	return respond(f, "MarkRead", r, f.markRead)
143}
144func (f *fakeAPI) GetSigningKey(_ context.Context, r *connect.Request[ermite.GetSigningKeyRequest]) (*connect.Response[ermite.GetSigningKeyResponse], error) {
145	return respond(f, "GetSigningKey", r, f.getSigningKey)
146}
147func (f *fakeAPI) ListPasskeys(_ context.Context, r *connect.Request[ermite.ListPasskeysRequest]) (*connect.Response[ermite.ListPasskeysResponse], error) {
148	return respond(f, "ListPasskeys", r, f.listPasskeys)
149}
150func (f *fakeAPI) RemovePasskey(_ context.Context, r *connect.Request[ermite.RemovePasskeyRequest]) (*connect.Response[ermite.RemovePasskeyResponse], error) {
151	return respond(f, "RemovePasskey", r, f.removePasskey)
152}
153func (f *fakeAPI) Watch(ctx context.Context, r *connect.Request[ermite.WatchRequest], st *connect.ServerStream[ermite.WatchResponse]) error {
154	f.record("Watch", r.Header(), r.Msg)
155	if f.watch == nil {
156		return connect.NewError(connect.CodeUnimplemented, nil)
157	}
158	return f.watch(ctx, r.Msg, st)
159}
160
161// serve starts the fake under /-/api and returns its base URL.
162func (f *fakeAPI) serve(t *testing.T) string {
163	t.Helper()
164	mux := http.NewServeMux()
165	mount := func(path string, h http.Handler) { mux.Handle("/-/api"+path, http.StripPrefix("/-/api", h)) }
166	p, h := ermiteconnect.NewRepoServiceHandler(f)
167	mount(p, h)
168	p, h = ermiteconnect.NewTokenServiceHandler(f)
169	mount(p, h)
170	p, h = ermiteconnect.NewServerServiceHandler(f)
171	mount(p, h)
172	p, h = ermiteconnect.NewEventServiceHandler(f)
173	mount(p, h)
174	p, h = ermiteconnect.NewMergeRequestServiceHandler(f)
175	mount(p, h)
176	p, h = ermiteconnect.NewSessionServiceHandler(f)
177	mount(p, h)
178	p, h = ermiteconnect.NewRunServiceHandler(f)
179	mount(p, h)
180	srv := httptest.NewServer(mux)
181	t.Cleanup(srv.Close)
182	return srv.URL
183}
184
185var testNow = time.Date(2026, 10, 10, 12, 0, 0, 0, time.UTC)
186
187// result is the outcome of one CLI run.
188type result struct {
189	stdout, stderr string
190	err            error
191}
192
193// testEnv is a cliEnv with the given variables, the fixed clock, and a config
194// file path inside a fresh temp dir (no file yet) so that a test never reads
195// the developer's own ~/.config/ermite/config. token.cmd must not run unless
196// the test sets runTokenCmd.
197func testEnv(t *testing.T, vars map[string]string) *cliEnv {
198	t.Helper()
199	path := filepath.Join(t.TempDir(), "ermite", "config")
200	return &cliEnv{
201		getenv:     func(k string) string { return vars[k] },
202		now:        func() time.Time { return testNow },
203		version:    "v0.0.1",
204		sleep:      func(ctx context.Context, _ time.Duration) error { return ctx.Err() },
205		configPath: func() (string, error) { return path, nil },
206		runTokenCmd: func(context.Context, string) (string, error) {
207			t.Error("token.cmd must not run")
208			return "", errors.New("token.cmd must not run")
209		},
210	}
211}
212
213// runCLI runs the command tree in process with the given environment.
214func runCLI(t *testing.T, vars map[string]string, stdin string, args ...string) result {
215	t.Helper()
216	return runCLIWith(t, testEnv(t, vars), stdin, args...)
217}
218
219// runCLIWith runs the command tree in process with env.
220func runCLIWith(t *testing.T, env *cliEnv, stdin string, args ...string) result {
221	t.Helper()
222	root := newRootCmdWith(env)
223	var out, errb bytes.Buffer
224	root.SetOut(&out)
225	root.SetErr(&errb)
226	root.SetIn(strings.NewReader(stdin))
227	root.SetArgs(args)
228	ctx, cancel := context.WithTimeout(t.Context(), 20*time.Second)
229	defer cancel()
230	err := root.ExecuteContext(ctx)
231	return result{stdout: out.String(), stderr: errb.String(), err: err}
232}
233
234func (r result) ok(t *testing.T) result {
235	t.Helper()
236	require.NoError(t, r.err, "stderr: %s", r.stderr)
237	return r
238}
239
240func ts(s string) *timestamppb.Timestamp {
241	v, err := time.Parse(time.RFC3339, s)
242	if err != nil {
243		panic(err)
244	}
245	return timestamppb.New(v)
246}

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