BlueGit

timfa bluegit

Files

bluegit / internal / webhook / webhook.go

webhook.go

feat: nieuw-formulier, groepsoverzicht, logo's en talen
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
Failed d1203d3b History
webhook.go 5.8 KiB Download Raw
1// Package webhook filtert gebeurtenissen en vult URL, headers en body.
2package webhook
3
4import (
5 "encoding/json"
6 "regexp"
7 "strings"
8
9 "gitlab.com/Timfa/bluegit/internal/i18n"
10)
11
12// Soorten gebeurtenissen.
13const (
14 EventPush = "push"
15 EventMergeRequest = "merge_request"
16 EventPipelineSuccess = "pipeline_success"
17 EventPipelineFailure = "pipeline_failure"
18 EventRelease = "release_published"
19)
20
21// AllEvents is de vaste lijst die een webhook mag aanvinken.
22func AllEvents() []string {
23 return []string{EventPush, EventMergeRequest, EventPipelineSuccess, EventPipelineFailure, EventRelease}
24}
25
26// KnownEvent meldt of name een ondersteunde gebeurtenis is.
27func KnownEvent(name string) bool {
28 for _, e := range AllEvents() {
29 if e == name {
30 return true
31 }
32 }
33 return false
34}
35
36// Presets.
37const (
38 PresetDiscord = "discord"
39 PresetGrok = "grok"
40 PresetGeneric = "generic"
41)
42
43// Event is de gegevensset die een webhook te zien krijgt.
44type Event struct {
45 Type string
46 Project string
47 Group string
48 Branch string
49 Commit string
50 Summary string
51 URL string
52 PipelineID string
53 ReleaseTag string
54 Actor string
55}
56
57// Hook is de opgeslagen configuratie, zonder geheimen al ingevuld.
58type Hook struct {
59 Preset string
60 Events []string
61 BranchFilter string
62}
63
64// Allows meldt of deze hook de gebeurtenis wil ontvangen.
65// Het branchfilter geldt alleen voor push. Leeg betekent alle branches.
66// "re:" gevolgd door een reguliere expressie, anders een exacte branchnaam.
67func Allows(h Hook, ev Event) (bool, error) {
68 if !KnownEvent(ev.Type) {
69 return false, i18n.E("err.whEvent", ev.Type)
70 }
71 found := false
72 for _, e := range h.Events {
73 if e == ev.Type {
74 found = true
75 break
76 }
77 }
78 if !found {
79 return false, nil
80 }
81 if ev.Type != EventPush {
82 return true, nil
83 }
84 return MatchBranch(h.BranchFilter, ev.Branch)
85}
86
87// MatchBranch past een push-filter toe.
88func MatchBranch(filter, branch string) (bool, error) {
89 filter = strings.TrimSpace(filter)
90 if filter == "" {
91 return true, nil
92 }
93 if strings.HasPrefix(filter, "re:") {
94 re, err := regexp.Compile(strings.TrimPrefix(filter, "re:"))
95 if err != nil {
96 return false, i18n.E("err.whFilter", err.Error())
97 }
98 return re.MatchString(branch), nil
99 }
100 return filter == branch, nil
101}
102
103// Expand vult {{event.veld}} en {{secret.NAAM}}.
104// Een onbekend geheim of veld is een fout, zodat een webhook niet
105// per ongeluk met een leeg token vertrekt.
106func Expand(s string, ev Event, secrets map[string]string) (string, error) {
107 var b strings.Builder
108 for {
109 start := strings.Index(s, "{{")
110 if start < 0 {
111 b.WriteString(s)
112 break
113 }
114 b.WriteString(s[:start])
115 rest := s[start+2:]
116 end := strings.Index(rest, "}}")
117 if end < 0 {
118 return "", i18n.E("err.whTemplate")
119 }
120 key := strings.TrimSpace(rest[:end])
121 val, err := lookup(key, ev, secrets)
122 if err != nil {
123 return "", err
124 }
125 b.WriteString(val)
126 s = rest[end+2:]
127 }
128 return b.String(), nil
129}
130
131func lookup(key string, ev Event, secrets map[string]string) (string, error) {
132 switch {
133 case strings.HasPrefix(key, "secret."):
134 name := strings.TrimPrefix(key, "secret.")
135 v, ok := secrets[name]
136 if !ok {
137 return "", i18n.E("err.whSecret", name)
138 }
139 return v, nil
140 case strings.HasPrefix(key, "event."):
141 field := strings.TrimPrefix(key, "event.")
142 v, ok := eventField(ev, field)
143 if !ok {
144 return "", i18n.E("err.whField", field)
145 }
146 return v, nil
147 default:
148 return "", i18n.E("err.whPlaceholder", key)
149 }
150}
151
152func eventField(ev Event, field string) (string, bool) {
153 switch field {
154 case "type":
155 return ev.Type, true
156 case "project":
157 return ev.Project, true
158 case "group":
159 return ev.Group, true
160 case "branch":
161 return ev.Branch, true
162 case "commit":
163 return ev.Commit, true
164 case "summary":
165 return ev.Summary, true
166 case "url":
167 return ev.URL, true
168 case "pipeline_id":
169 return ev.PipelineID, true
170 case "release_tag":
171 return ev.ReleaseTag, true
172 case "actor":
173 return ev.Actor, true
174 default:
175 return "", false
176 }
177}
178
179// PresetDefaults vult URL-headers en body als de gebruiker een preset kiest
180// en een veld leeg laat.
181func PresetDefaults(preset string) (headers map[string]string, body string) {
182 switch preset {
183 case PresetDiscord:
184 return map[string]string{"Content-Type": "application/json"}, `{"content":"{{event.summary}}"}`
185 case PresetGrok:
186 return map[string]string{
187 "Content-Type": "application/json",
188 "Authorization": "Bearer {{secret.GROK_TOKEN}}",
189 }, ""
190 default:
191 return map[string]string{"Content-Type": "application/json"}, ""
192 }
193}
194
195// RenderBody maakt de HTTP-body. Een lege sjabloon wordt de gebeurtenis als JSON.
196func RenderBody(bodyTemplate string, ev Event, secrets map[string]string) ([]byte, error) {
197 if strings.TrimSpace(bodyTemplate) == "" {
198 payload := map[string]string{
199 "type": ev.Type,
200 "project": ev.Project,
201 "group": ev.Group,
202 "branch": ev.Branch,
203 "commit": ev.Commit,
204 "summary": ev.Summary,
205 "url": ev.URL,
206 "pipeline_id": ev.PipelineID,
207 "release_tag": ev.ReleaseTag,
208 "actor": ev.Actor,
209 }
210 return json.Marshal(payload)
211 }
212 s, err := Expand(bodyTemplate, ev, secrets)
213 if err != nil {
214 return nil, err
215 }
216 return []byte(s), nil
217}
218
219// RenderHeaders vult geheimen in headers. Preset-headers vullen alleen
220// ontbrekende sleutels aan.
221func RenderHeaders(preset string, configured map[string]string, ev Event, secrets map[string]string) (map[string]string, error) {
222 base, _ := PresetDefaults(preset)
223 if base == nil {
224 base = map[string]string{}
225 }
226 for k, v := range configured {
227 base[k] = v
228 }
229 out := map[string]string{}
230 for k, v := range base {
231 ek, err := Expand(k, ev, secrets)
232 if err != nil {
233 return nil, err
234 }
235 evv, err := Expand(v, ev, secrets)
236 if err != nil {
237 return nil, err
238 }
239 out[ek] = evv
240 }
241 return out, nil
242}