BlueGit

timfa bluegit

Files

bluegit / internal / server / api_test.go

api_test.go

feat: beschrijf de API-objecten en geef ze een web_url
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
Passed 2f39b617 History
api_test.go 13.8 KiB Download Raw
1package server
2
3import (
4 "context"
5 "encoding/json"
6 "net/http"
7 "net/http/httptest"
8 "os/exec"
9 "path/filepath"
10 "strings"
11 "testing"
12 "time"
13
14 "gitlab.com/Timfa/bluegit/internal/auth"
15 "gitlab.com/Timfa/bluegit/internal/config"
16 "gitlab.com/Timfa/bluegit/internal/store"
17)
18
19func TestAPICatalogCoversResources(t *testing.T) {
20 var b strings.Builder
21 b.WriteString("GET /api/v1/openapi.json\n")
22 for _, rt := range apiCatalog {
23 b.WriteString(rt.Method)
24 b.WriteByte(' ')
25 b.WriteString(rt.Path)
26 b.WriteByte('\n')
27 }
28 blob := b.String()
29 for _, want := range []string{
30 "GET /api/v1/user\n",
31 "PUT /api/v1/user\n",
32 "GET /api/v1/user/export\n",
33 "POST /api/v1/user/tokens\n",
34 "DELETE /api/v1/user/tokens/{id}\n",
35 "POST /api/v1/user/keys\n",
36 "POST /api/v1/groups\n",
37 "POST /api/v1/groups/{path}/transfer\n",
38 "POST /api/v1/groups/{path}/members\n",
39 "POST /api/v1/groups/{path}/secrets\n",
40 "POST /api/v1/groups/{path}/webhooks\n",
41 "PUT /api/v1/groups/{path}/approvals\n",
42 "POST /api/v1/groups/{path}/logo\n",
43 "POST /api/v1/projects\n",
44 "DELETE /api/v1/projects/{owner}/{repo}\n",
45 "POST /api/v1/projects/{owner}/{repo}/members\n",
46 "POST /api/v1/projects/{owner}/{repo}/protected_branches\n",
47 "POST /api/v1/projects/{owner}/{repo}/protected_tags\n",
48 "POST /api/v1/projects/{owner}/{repo}/repository/branches\n",
49 "DELETE /api/v1/projects/{owner}/{repo}/repository/branches/{branch...}\n",
50 "POST /api/v1/projects/{owner}/{repo}/repository/tags\n",
51 "GET /api/v1/projects/{owner}/{repo}/repository/files/{path...}\n",
52 "POST /api/v1/projects/{owner}/{repo}/repository/commits\n",
53 "GET /api/v1/projects/{owner}/{repo}/repository/commits/{sha}/diff\n",
54 "GET /api/v1/repos/{owner}/{repo}/issues\n",
55 "POST /api/v1/repos/{owner}/{repo}/issues\n",
56 "PUT /api/v1/repos/{owner}/{repo}/issues/{number}\n",
57 "POST /api/v1/repos/{owner}/{repo}/issues/{number}/notes\n",
58 "POST /api/v1/projects/{owner}/{repo}/merge_requests\n",
59 "POST /api/v1/projects/{owner}/{repo}/merge_requests/{number}/notes\n",
60 "POST /api/v1/projects/{owner}/{repo}/merge_requests/{number}/reviews\n",
61 "POST /api/v1/projects/{owner}/{repo}/merge_requests/{number}/suggestions\n",
62 "POST /api/v1/projects/{owner}/{repo}/merge_requests/{number}/merge\n",
63 "POST /api/v1/projects/{owner}/{repo}/pipelines\n",
64 "POST /api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/play\n",
65 "POST /api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/retry\n",
66 "POST /api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/cancel\n",
67 "GET /api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/log\n",
68 "GET /api/v1/projects/{owner}/{repo}/pipelines/{id}/jobs/{job}/artifacts\n",
69 "PUT /api/v1/projects/{owner}/{repo}/ci/file\n",
70 "POST /api/v1/projects/{owner}/{repo}/ci/lint\n",
71 "GET /api/v1/ci/spec\n",
72 "GET /api/v1/ci/presets\n",
73 "POST /api/v1/projects/{owner}/{repo}/releases\n",
74 "POST /api/v1/repos/{owner}/{repo}/releases\n",
75 "PUT /api/v1/admin/storage\n",
76 } {
77 if !strings.Contains(blob, want) {
78 t.Errorf("catalog mist %s", strings.TrimSpace(want))
79 }
80 }
81}
82
83func TestAPIPermissionsAndResources(t *testing.T) {
84 if _, err := exec.LookPath("git"); err != nil {
85 t.Skip("git ontbreekt")
86 }
87 storage := t.TempDir()
88 st, err := store.Open(filepath.Join(storage, "bluegit.db"), bytes32())
89 if err != nil {
90 t.Fatal(err)
91 }
92 t.Cleanup(func() { _ = st.Close() })
93 ctx := context.Background()
94 ada, err := st.UpsertUser(ctx, 1, "ada", "", false)
95 if err != nil || !ada.InstanceAdmin {
96 t.Fatalf("ada admin: %+v %v", ada, err)
97 }
98 dev, err := st.UpsertUser(ctx, 2, "dev", "", false)
99 if err != nil {
100 t.Fatal(err)
101 }
102 ro, err := st.UpsertUser(ctx, 3, "ro", "", false)
103 if err != nil {
104 t.Fatal(err)
105 }
106 issue := func(u store.User, name, scopes string, exp time.Time) string {
107 t.Helper()
108 plain, _, err := st.IssueToken(ctx, u.ID, store.TokenRequest{Name: name, Scopes: scopes, ExpiresAt: exp})
109 if err != nil {
110 t.Fatal(err)
111 }
112 return plain
113 }
114 adaTok := issue(ada, "ada", "api", time.Time{})
115 devTok := issue(dev, "dev", "api", time.Time{})
116 roTok := issue(ro, "ro", "api", time.Time{})
117 readAPI := issue(ada, "read", "read_api", time.Time{})
118 writeRepo := issue(dev, "wrepo", "write_repository", time.Time{})
119 readRepo := issue(dev, "rrepo", "read_repository", time.Time{})
120 expired := issue(ada, "old", "api", time.Now().Add(40*time.Millisecond))
121 time.Sleep(80 * time.Millisecond)
122
123 cfg := config.Config{
124 BaseURL: "http://127.0.0.1:9", StoragePath: storage,
125 Auth: config.Auth{Mode: "dev", DevUser: "ada", DevAuthID: 1},
126 Git: config.Git{Binary: "git", DefaultBranch: "master"},
127 CI: config.CI{Enabled: true},
128 }
129 srv := &Server{Cfg: cfg, Store: st, Auth: auth.Dev{Username: "ada", AuthID: 1}, Git: "git", HookBin: "/bin/true", StateDir: t.TempDir()}
130 ts := httptest.NewServer(srv.Handler())
131 t.Cleanup(ts.Close)
132
133 call := func(method, path, token, body string, hdr string) (int, string) {
134 t.Helper()
135 req, err := http.NewRequest(method, ts.URL+path, strings.NewReader(body))
136 if err != nil {
137 t.Fatal(err)
138 }
139 if body != "" {
140 req.Header.Set("Content-Type", "application/json")
141 }
142 switch hdr {
143 case "private":
144 req.Header.Set("PRIVATE-TOKEN", token)
145 case "basic":
146 req.SetBasicAuth("git", token)
147 default:
148 if token != "" {
149 req.Header.Set("Authorization", "Bearer "+token)
150 }
151 }
152 res, err := http.DefaultClient.Do(req)
153 if err != nil {
154 t.Fatal(err)
155 }
156 return res.StatusCode, read(t, res)
157 }
158 want := func(got int, body, label string, status int, contains string) {
159 t.Helper()
160 if got != status || (contains != "" && !strings.Contains(body, contains)) {
161 t.Fatalf("%s: status %d body %s", label, got, body)
162 }
163 }
164
165 code, body := call(http.MethodGet, "/api/v1/user", "", "", "")
166 want(code, body, "anoniem", 401, "message")
167 code, body = call(http.MethodGet, "/api/v1/openapi.json", "", "", "")
168 want(code, body, "openapi", 200, `"openapi":"3.0.3"`)
169 if !strings.Contains(body, "privateToken") || !strings.Contains(body, "/projects/{owner}/{repo}/merge_requests") {
170 t.Fatalf("openapi dekt niet: %s", body[:200])
171 }
172 code, body = call(http.MethodGet, "/api/v1/ci/spec", "", "", "")
173 want(code, body, "spec", 200, "blue-ci-cd.yml")
174 code, body = call(http.MethodGet, "/api/v1/ci/presets", "", "", "")
175 want(code, body, "presets", 200, "bluegit/")
176 code, body = call(http.MethodGet, "/api/v1/user", expired, "", "")
177 want(code, body, "verlopen", 401, "message")
178 code, body = call(http.MethodGet, "/api/v1/user", adaTok, "", "private")
179 want(code, body, "private-token", 200, `"username":"ada"`)
180 code, body = call(http.MethodGet, "/api/v1/user", adaTok, "", "basic")
181 want(code, body, "basic", 200, `"instance_admin":true`)
182 code, body = call(http.MethodPost, "/api/v1/user/tokens", readAPI, `{"name":"no"}`, "")
183 want(code, body, "read_api schrijft niet", 403, "message")
184 code, body = call(http.MethodGet, "/api/v1/user", readRepo, "", "")
185 want(code, body, "read_repository is geen api-lezen", 403, "message")
186
187 code, body = call(http.MethodPost, "/api/v1/projects", adaTok, `{"name":"Demo","description":"leeg","visibility":"private"}`, "")
188 want(code, body, "leeg project", 201, `"path":"ada/demo"`)
189 code, body = call(http.MethodGet, "/api/v1/projects/ada/demo/repository/commits", adaTok, "", "")
190 want(code, body, "geen commits", 200, "[]")
191 code, body = call(http.MethodPost, "/api/v1/projects", adaTok, `{"name":"Readme","initialize_with_readme":true}`, "")
192 want(code, body, "readme", 201, `"path":"ada/readme"`)
193 code, body = call(http.MethodGet, "/api/v1/projects/ada/readme/repository/files/README.md", adaTok, "", "")
194 want(code, body, "bestand", 200, "# readme")
195
196 code, body = call(http.MethodGet, "/api/v1/projects/ada/demo", roTok, "", "")
197 want(code, body, "prive zonder rol", 404, "message")
198 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/members", adaTok, `{"username":"ro","role":"readonly"}`, "")
199 want(code, body, "lid ro", 200, `"username":"ro"`)
200 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/members", adaTok, `{"username":"dev","role":"developer"}`, "")
201 want(code, body, "lid dev", 200, "developer")
202 code, body = call(http.MethodGet, "/api/v1/projects/ada/demo", roTok, "", "")
203 want(code, body, "readonly ziet", 200, "ada/demo")
204 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/repository/branches", roTok, `{"name":"nope"}`, "")
205 want(code, body, "readonly branch", 403, "message")
206 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/secrets", devTok, `{"name":"TOKEN","value":"x"}`, "")
207 want(code, body, "dev secret", 403, "message")
208 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/secrets", adaTok, `{"name":"TOKEN","value":"geheim"}`, "")
209 want(code, body, "secret", 200, "TOKEN")
210 code, body = call(http.MethodDelete, "/api/v1/projects/ada/demo", devTok, `{"confirm":"demo"}`, "")
211 want(code, body, "dev verwijdert niet", 403, "message")
212
213 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/repository/commits", adaTok, `{"branch":"master","commit_message":"eerste","actions":[{"action":"create","file_path":"a.txt","content":"hoi\n"}]}`, "")
214 want(code, body, "eerste commit", 201, `"id":`)
215 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/repository/commits", writeRepo, `{"branch":"side","start_branch":"master","commit_message":"zijtak","actions":[{"action":"create","file_path":"b.txt","content":"meer\n"}]}`, "")
216 want(code, body, "write_repository commit", 201, `"id":`)
217 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/members", writeRepo, `{"username":"ro","role":"developer"}`, "")
218 want(code, body, "write_repository geen leden", 403, "message")
219 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/repository/commits", readRepo, `{"branch":"master","commit_message":"nee","actions":[{"action":"update","file_path":"a.txt","content":"x"}]}`, "")
220 want(code, body, "read_repository schrijft niet", 403, "message")
221 code, body = call(http.MethodGet, "/api/v1/projects/ada/demo/repository/commits", readAPI, "", "")
222 want(code, body, "read_api leest commits", 200, "eerste")
223
224 code, list := call(http.MethodGet, "/api/v1/projects/ada/demo/repository/commits", adaTok, "", "")
225 want(code, list, "lijst", 200, "eerste")
226 var rows []map[string]any
227 if err := json.Unmarshal([]byte(list), &rows); err != nil || len(rows) == 0 {
228 t.Fatalf("commits json %v %s", err, list)
229 }
230 sha, _ := rows[0]["id"].(string)
231 code, body = call(http.MethodGet, "/api/v1/projects/ada/demo/repository/commits/"+sha+"/diff", adaTok, "", "")
232 want(code, body, "diff", 200, "a.txt")
233
234 req, err := http.NewRequest(http.MethodGet, ts.URL+"/ada/demo.git/info/refs?service=git-upload-pack", nil)
235 if err != nil {
236 t.Fatal(err)
237 }
238 req.SetBasicAuth("ada", readAPI)
239 res, err := http.DefaultClient.Do(req)
240 if err != nil {
241 t.Fatal(err)
242 }
243 _ = read(t, res)
244 if res.StatusCode != http.StatusForbidden {
245 t.Fatalf("read_api clone %d", res.StatusCode)
246 }
247 req, _ = http.NewRequest(http.MethodGet, ts.URL+"/ada/demo.git/info/refs?service=git-upload-pack", nil)
248 req.SetBasicAuth("dev", writeRepo)
249 res, err = http.DefaultClient.Do(req)
250 if err != nil {
251 t.Fatal(err)
252 }
253 _ = read(t, res)
254 if res.StatusCode == http.StatusForbidden || res.StatusCode == http.StatusUnauthorized {
255 t.Fatalf("write_repository leest git niet: %d", res.StatusCode)
256 }
257
258 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/repository/branches", devTok, `{"name":"feature","from":"master"}`, "")
259 want(code, body, "branch", 201, "feature")
260 code, body = call(http.MethodPut, "/api/v1/projects/ada/demo/ci/file", devTok, `{"branch":"feature","base":"master","message":"ci","content":"stages: [test]\n"}`, "")
261 want(code, body, "ci-editor", 200, `"id"`)
262 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/ci/lint", roTok, `{"body":"stages: [test]\n","ref":"feature"}`, "")
263 want(code, body, "lint", 200, "status")
264 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/merge_requests", adaTok, `{"title":"Werk","source_branch":"feature","target_branch":"master"}`, "")
265 want(code, body, "mr", 201, `"iid":`)
266 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/merge_requests", readAPI, `{"title":"Nee","source_branch":"feature","target_branch":"master"}`, "")
267 want(code, body, "read_api mr", 403, "message")
268 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/merge_requests/1/notes", roTok, `{"body":"gezien"}`, "")
269 want(code, body, "note", 201, `"id"`)
270 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/merge_requests/1/close", devTok, `{}`, "")
271 want(code, body, "dev sluit andermans mr niet", 403, "message")
272 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/merge_requests/1/close", adaTok, `{}`, "")
273 want(code, body, "sluiten", 200, "closed")
274 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/merge_requests/1/reopen", adaTok, `{}`, "")
275 want(code, body, "heropenen", 200, "open")
276 code, body = call(http.MethodPost, "/api/v1/projects/ada/demo/pipelines", devTok, `{"ref":"feature"}`, "")
277 want(code, body, "pipeline", 201, `"id"`)
278
279 code, body = call(http.MethodPost, "/api/v1/groups", adaTok, `{"name":"Team","description":"samen"}`, "")
280 want(code, body, "groep", 201, `"path":"team"`)
281 code, body = call(http.MethodPut, "/api/v1/groups/team/approvals", adaTok, `{"maintainer_required":true,"required_count":1}`, "")
282 want(code, body, "approvals", 200, "maintainer_required")
283 code, body = call(http.MethodPost, "/api/v1/groups/team/webhooks", adaTok, `{"name":"ping","preset":"generic","url":"https://example.com/hook","events":["push"]}`, "")
284 want(code, body, "webhook", 201, `"id"`)
285 code, body = call(http.MethodPut, "/api/v1/admin/storage", devTok, `{"path":"/tmp"}`, "")
286 want(code, body, "dev geen admin", 403, "message")
287 code, body = call(http.MethodGet, "/api/v1/admin/storage", adaTok, "", "")
288 want(code, body, "storage", 200, storage)
289
290 status, raw := srv.CallAPI(ctx, ada, http.MethodGet, "/user", nil)
291 if status != 200 || !strings.Contains(string(raw), `"username":"ada"`) {
292 t.Fatalf("ssh-api %d %s", status, raw)
293 }
294}