BlueGit

timfa bluegit

Files

bluegit / internal / webhook / preset_test.go

preset_test.go

feat: stuur volledige details mee in webhook-payloads
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
3ca4d219 History
preset_test.go 11.2 KiB Download Raw
1package webhook
2
3import (
4 "encoding/json"
5 "strings"
6 "testing"
7)
8
9func TestPresetPayloads(t *testing.T) {
10 ev := Event{
11 Type: EventPush,
12 Project: `tim/blue "git"`,
13 Summary: "say \"hi\"\nnext",
14 Commit: "abc",
15 Branch: "master",
16 URL: "https://git.example/tim/blue",
17 Actor: "tim",
18 }
19 secrets := map[string]string{
20 "BOT_TOKEN": "secret-value",
21 "GROK_TOKEN": "grok-secret",
22 "NTFY": "ntfy-secret",
23 }
24 wantText := func(body []byte, key string) {
25 t.Helper()
26 var payload map[string]any
27 if err := json.Unmarshal(body, &payload); err != nil {
28 t.Fatalf("%s geen json: %s (%v)", key, body, err)
29 }
30 if payload[key] != ev.Summary {
31 t.Fatalf("%s = %#v, body %s", key, payload[key], body)
32 }
33 }
34
35 spec, err := Prepare(PresetDiscord, Input{URL: "https://discord.example/hook"})
36 if err != nil {
37 t.Fatal(err)
38 }
39 body, err := RenderBody(spec.Body, ev, secrets)
40 if err != nil {
41 t.Fatal(err)
42 }
43 wantText(body, "content")
44 if strings.Contains(spec.Body, "username") || strings.Contains(spec.Body, "avatar_url") {
45 t.Fatalf("lege discord-opties horen weg: %s", spec.Body)
46 }
47 spec, err = Prepare(PresetDiscord, Input{
48 URL: "https://discord.example/hook", Username: `bot "a"`, Avatar: "https://example.test/a.png",
49 })
50 if err != nil {
51 t.Fatal(err)
52 }
53 body, err = RenderBody(spec.Body, ev, secrets)
54 if err != nil {
55 t.Fatal(err)
56 }
57 var discord map[string]any
58 if err := json.Unmarshal(body, &discord); err != nil {
59 t.Fatal(err)
60 }
61 if discord["content"] != ev.Summary || discord["username"] != `bot "a"` || discord["avatar_url"] != "https://example.test/a.png" {
62 t.Fatalf("discord %#v", discord)
63 }
64 headers, err := RenderHeaders(PresetDiscord, spec.Headers, ev, secrets)
65 if err != nil || headers["Content-Type"] != "application/json" || spec.Method != "POST" {
66 t.Fatalf("discord headers %v %s %v", headers, spec.Method, err)
67 }
68
69 for _, preset := range []string{PresetSlack, PresetGoogleChat} {
70 spec, err = Prepare(preset, Input{URL: "https://chat.example/hook"})
71 if err != nil {
72 t.Fatal(preset, err)
73 }
74 body, err = RenderBody(spec.Body, ev, secrets)
75 if err != nil {
76 t.Fatal(preset, err)
77 }
78 wantText(body, "text")
79 if spec.Method != "POST" {
80 t.Fatal(preset, spec.Method)
81 }
82 }
83
84 spec, err = Prepare(PresetTeams, Input{URL: "https://outlook.example/webhook"})
85 if err != nil {
86 t.Fatal(err)
87 }
88 body, err = RenderBody(spec.Body, ev, secrets)
89 if err != nil {
90 t.Fatal(err)
91 }
92 var teams map[string]any
93 if err := json.Unmarshal(body, &teams); err != nil {
94 t.Fatal(err)
95 }
96 if teams["@type"] != "MessageCard" || teams["text"] != ev.Summary || teams["summary"] != ev.Summary {
97 t.Fatalf("teams %#v", teams)
98 }
99
100 spec, err = Prepare(PresetMattermost, Input{URL: "https://chat.example/hooks/a", Username: "blue", Icon: "https://example.test/icon.png"})
101 if err != nil {
102 t.Fatal(err)
103 }
104 body, err = RenderBody(spec.Body, ev, secrets)
105 if err != nil {
106 t.Fatal(err)
107 }
108 var mm map[string]any
109 if err := json.Unmarshal(body, &mm); err != nil {
110 t.Fatal(err)
111 }
112 if mm["text"] != ev.Summary || mm["username"] != "blue" || mm["icon_url"] != "https://example.test/icon.png" {
113 t.Fatalf("mattermost %#v", mm)
114 }
115
116 spec, err = Prepare(PresetRocketChat, Input{URL: "https://chat.example/hooks/b"})
117 if err != nil {
118 t.Fatal(err)
119 }
120 if strings.Contains(spec.Body, "alias") {
121 t.Fatal(spec.Body)
122 }
123 spec, err = Prepare(PresetRocketChat, Input{URL: "https://chat.example/hooks/b", Alias: `rocket "bot"`})
124 if err != nil {
125 t.Fatal(err)
126 }
127 body, err = RenderBody(spec.Body, ev, secrets)
128 if err != nil {
129 t.Fatal(err)
130 }
131 var rocket map[string]any
132 if err := json.Unmarshal(body, &rocket); err != nil {
133 t.Fatal(err)
134 }
135 if rocket["text"] != ev.Summary || rocket["alias"] != `rocket "bot"` {
136 t.Fatalf("rocket %#v", rocket)
137 }
138
139 spec, err = Prepare(PresetTelegram, Input{Token: "BOT_TOKEN", Chat: "42"})
140 if err != nil {
141 t.Fatal(err)
142 }
143 if !strings.Contains(spec.URL, "{{secret.BOT_TOKEN}}") {
144 t.Fatal(spec.URL)
145 }
146 url, err := Expand(spec.URL, ev, secrets)
147 if err != nil || url != "https://api.telegram.org/botsecret-value/sendMessage" {
148 t.Fatalf("telegram url %s %v", url, err)
149 }
150 body, err = RenderBody(spec.Body, ev, secrets)
151 if err != nil {
152 t.Fatal(err)
153 }
154 var tg map[string]any
155 if err := json.Unmarshal(body, &tg); err != nil {
156 t.Fatal(string(body), err)
157 }
158 if tg["chat_id"] != "42" || tg["text"] != ev.Summary {
159 t.Fatalf("telegram %#v", tg)
160 }
161
162 spec, err = Prepare(PresetMatrix, Input{
163 Homeserver: "https://matrix.example/", Token: "BOT_TOKEN", Room: "!abc:example.org",
164 })
165 if err != nil {
166 t.Fatal(err)
167 }
168 if spec.Method != "PUT" || !strings.Contains(spec.URL, "/rooms/%21abc%3Aexample.org/send/m.room.message/bluegit-") {
169 t.Fatalf("matrix %s %s", spec.Method, spec.URL)
170 }
171 if spec.Headers["Authorization"] != "Bearer {{secret.BOT_TOKEN}}" {
172 t.Fatal(spec.Headers)
173 }
174 headers, err = RenderHeaders(PresetMatrix, spec.Headers, ev, secrets)
175 if err != nil || headers["Authorization"] != "Bearer secret-value" {
176 t.Fatalf("matrix auth %v %v", headers, err)
177 }
178 expanded, err := Expand(spec.URL, ev, secrets)
179 if err != nil || !strings.Contains(expanded, "/bluegit-push-abc--") {
180 t.Fatalf("matrix txn %s %v", expanded, err)
181 }
182 body, err = RenderBody(spec.Body, ev, secrets)
183 if err != nil {
184 t.Fatal(err)
185 }
186 var mx map[string]any
187 if err := json.Unmarshal(body, &mx); err != nil {
188 t.Fatal(err)
189 }
190 if mx["msgtype"] != "m.text" || mx["body"] != ev.Summary {
191 t.Fatalf("matrix %#v", mx)
192 }
193
194 spec, err = Prepare(PresetNtfy, Input{Topic: "builds"})
195 if err != nil {
196 t.Fatal(err)
197 }
198 if spec.URL != "https://ntfy.sh/builds" || spec.Headers["Content-Type"] != "text/plain" || spec.Headers["Authorization"] != "" {
199 t.Fatalf("ntfy default %#v %s", spec.Headers, spec.URL)
200 }
201 body, err = RenderBody(spec.Body, ev, secrets)
202 if err != nil || string(body) != ev.Summary {
203 t.Fatalf("ntfy body %q %v", body, err)
204 }
205 headers, err = RenderHeaders(PresetNtfy, spec.Headers, ev, secrets)
206 if err != nil || headers["Content-Type"] != "text/plain" {
207 t.Fatalf("ntfy content-type verliest van de json-preset: %v %v", headers, err)
208 }
209 spec, err = Prepare(PresetNtfy, Input{Server: "https://ntfy.example", Topic: "/alerts/", Token: "NTFY"})
210 if err != nil {
211 t.Fatal(err)
212 }
213 if spec.URL != "https://ntfy.example/alerts" || spec.Headers["Authorization"] != "Bearer {{secret.NTFY}}" {
214 t.Fatalf("ntfy %#v %s", spec.Headers, spec.URL)
215 }
216
217 spec, err = Prepare(PresetGotify, Input{Server: "https://gotify.example/", Token: "BOT_TOKEN"})
218 if err != nil {
219 t.Fatal(err)
220 }
221 if spec.URL != "https://gotify.example/message" || spec.Headers["X-Gotify-Key"] != "{{secret.BOT_TOKEN}}" {
222 t.Fatalf("gotify %#v %s", spec.Headers, spec.URL)
223 }
224 headers, err = RenderHeaders(PresetGotify, spec.Headers, ev, secrets)
225 if err != nil || headers["X-Gotify-Key"] != "secret-value" {
226 t.Fatalf("gotify key %v %v", headers, err)
227 }
228 body, err = RenderBody(spec.Body, ev, secrets)
229 if err != nil {
230 t.Fatal(err)
231 }
232 var gotify map[string]any
233 if err := json.Unmarshal(body, &gotify); err != nil {
234 t.Fatal(err)
235 }
236 if gotify["title"] != ev.Project || gotify["message"] != ev.Summary {
237 t.Fatalf("gotify %#v", gotify)
238 }
239
240 spec, err = Prepare(PresetGrok, Input{URL: "https://api.example/grok", Token: "BOT_TOKEN"})
241 if err != nil {
242 t.Fatal(err)
243 }
244 if spec.Body != "" || spec.Headers["Authorization"] != "Bearer {{secret.BOT_TOKEN}}" {
245 t.Fatalf("grok %#v %q", spec.Headers, spec.Body)
246 }
247 headers, err = RenderHeaders(PresetGrok, spec.Headers, ev, secrets)
248 if err != nil || headers["Authorization"] != "Bearer secret-value" {
249 t.Fatalf("gekozen grok-geheim %v %v", headers, err)
250 }
251 body, err = RenderBody(spec.Body, ev, secrets)
252 if err != nil {
253 t.Fatal(err)
254 }
255 var grok map[string]any
256 if err := json.Unmarshal(body, &grok); err != nil || grok["project"] != ev.Project || strings.Contains(string(body), "secret-value") {
257 t.Fatalf("grok body %s %v", body, err)
258 }
259 legacy, err := RenderHeaders(PresetGrok, nil, ev, secrets)
260 if err != nil || legacy["Authorization"] != "Bearer grok-secret" {
261 t.Fatalf("oude grok-hook houdt GROK_TOKEN: %v %v", legacy, err)
262 }
263
264 spec, err = Prepare(PresetGeneric, Input{URL: "https://example.test/hook"})
265 if err != nil {
266 t.Fatal(err)
267 }
268 if spec.Body != "" || spec.Method != "POST" || spec.Headers["Content-Type"] != "application/json" {
269 t.Fatalf("generic %#v", spec)
270 }
271 body, err = RenderBody(spec.Body, ev, secrets)
272 if err != nil {
273 t.Fatal(err)
274 }
275 var generic map[string]any
276 if err := json.Unmarshal(body, &generic); err != nil || generic["summary"] != ev.Summary || generic["type"] != EventPush {
277 t.Fatalf("generic %s %v", body, err)
278 }
279 oldDiscord, err := RenderBody("", ev, secrets)
280 if err != nil {
281 t.Fatal(err)
282 }
283 if string(oldDiscord) != string(body) {
284 t.Fatalf("lege body blijft de gebeurtenis: %s", oldDiscord)
285 }
286
287 spec, err = Prepare(PresetCustom, Input{
288 URL: "https://example.test/hook", Method: "put", ContentType: "text/plain",
289 Headers: "Authorization: Bearer {{secret.BOT_TOKEN}}\n",
290 Body: "hello {{event.summary}}",
291 })
292 if err != nil {
293 t.Fatal(err)
294 }
295 if spec.Method != "PUT" || spec.Headers["Content-Type"] != "text/plain" || spec.Headers["Authorization"] != "Bearer {{secret.BOT_TOKEN}}" {
296 t.Fatalf("custom %#v %s", spec.Headers, spec.Method)
297 }
298 headers, err = RenderHeaders(PresetCustom, spec.Headers, ev, secrets)
299 if err != nil || headers["Authorization"] != "Bearer secret-value" || headers["Content-Type"] != "text/plain" {
300 t.Fatalf("custom headers %v %v", headers, err)
301 }
302 body, err = RenderBody(spec.Body, ev, secrets)
303 if err != nil || string(body) != "hello "+ev.Summary {
304 t.Fatalf("custom body %q %v", body, err)
305 }
306 empty, err := Prepare(PresetCustom, Input{URL: "https://example.test/hook"})
307 if err != nil || empty.Method != "POST" || empty.Body != "" || empty.Headers["Content-Type"] != "application/json" {
308 t.Fatalf("custom leeg %#v %v", empty, err)
309 }
310}
311
312func TestPresetRejects(t *testing.T) {
313 if _, err := Prepare("nope", Input{}); err == nil {
314 t.Fatal("onbekende preset")
315 }
316 if _, err := Prepare(PresetTelegram, Input{Token: "Ada_Webhook", Chat: "1"}); err != nil {
317 t.Fatal(err)
318 }
319 if _, err := Prepare(PresetTelegram, Input{Token: "1bad", Chat: "1"}); err == nil {
320 t.Fatal("geheime naam")
321 }
322 if _, err := Prepare(PresetTelegram, Input{Token: "BOT_TOKEN", Chat: ""}); err == nil {
323 t.Fatal("lege chat")
324 }
325 if _, err := Prepare(PresetNtfy, Input{Topic: ""}); err == nil {
326 t.Fatal("leeg topic")
327 }
328 if _, err := Prepare(PresetNtfy, Input{Topic: "a b"}); err == nil {
329 t.Fatal("topic met spatie")
330 }
331 if _, err := Prepare(PresetMatrix, Input{Homeserver: "https://matrix.example", Token: "BOT_TOKEN", Room: "room id"}); err == nil {
332 t.Fatal("kamer met spatie")
333 }
334 if _, err := Prepare(PresetGotify, Input{Token: "BOT_TOKEN"}); err == nil {
335 t.Fatal("gotify zonder server")
336 }
337 if _, err := Prepare(PresetCustom, Input{URL: "https://example.test/hook", Method: "DELETE"}); err == nil {
338 t.Fatal("methode")
339 }
340 if _, err := Prepare(PresetCustom, Input{URL: "https://user:pass@example.test/hook"}); err == nil {
341 t.Fatal("userinfo")
342 }
343 if _, err := Prepare(PresetCustom, Input{URL: "https://example.test/hook", Headers: "Authorization Bearer x"}); err == nil {
344 t.Fatal("header zonder dubbele punt")
345 }
346 if !KnownPreset(PresetCustom) || !KnownPreset(PresetGeneric) || KnownPreset("") {
347 t.Fatal("KnownPreset")
348 }
349}