BlueGit

timfa bluegit

Files

bluegit / internal / webhook / webhook.go

webhook.go

feat: stuur volledige details mee in webhook-payloads
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
3ca4d219 History
webhook.go 6.2 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.
44// De platte velden blijven beschikbaar als {{event.veld}}.
45// Pipeline, Jobs, Ref/Before/After/Commits, MergeRequest en Release
46// vullen de JSON-body als het sjabloon leeg is.
47type Event struct {
48 Type string
49 Project string
50 Group string
51 Branch string
52 Commit string
53 Summary string
54 URL string
55 PipelineID string
56 ReleaseTag string
57 Actor string
58
59 Pipeline *PipelineInfo
60 Jobs []JobInfo
61 Ref string
62 Before string
63 After string
64 Commits []CommitInfo
65 MergeRequest *MRInfo
66 Comment string
67 Release *ReleaseInfo
68}
69
70// Hook is de opgeslagen configuratie, zonder geheimen al ingevuld.
71type Hook struct {
72 Preset string
73 Events []string
74 BranchFilter string
75}
76
77// Allows meldt of deze hook de gebeurtenis wil ontvangen.
78// Het branchfilter geldt alleen voor push. Leeg betekent alle branches.
79// "re:" gevolgd door een reguliere expressie, anders een exacte branchnaam.
80func Allows(h Hook, ev Event) (bool, error) {
81 if !KnownEvent(ev.Type) {
82 return false, i18n.E("err.whEvent", ev.Type)
83 }
84 found := false
85 for _, e := range h.Events {
86 if e == ev.Type {
87 found = true
88 break
89 }
90 }
91 if !found {
92 return false, nil
93 }
94 if ev.Type != EventPush {
95 return true, nil
96 }
97 return MatchBranch(h.BranchFilter, ev.Branch)
98}
99
100// MatchBranch past een push-filter toe.
101func MatchBranch(filter, branch string) (bool, error) {
102 filter = strings.TrimSpace(filter)
103 if filter == "" {
104 return true, nil
105 }
106 if strings.HasPrefix(filter, "re:") {
107 re, err := regexp.Compile(strings.TrimPrefix(filter, "re:"))
108 if err != nil {
109 return false, i18n.E("err.whFilter", err.Error())
110 }
111 return re.MatchString(branch), nil
112 }
113 return filter == branch, nil
114}
115
116// Expand vult {{event.veld}} en {{secret.NAAM}}.
117// Een onbekend geheim of veld is een fout, zodat een webhook niet
118// per ongeluk met een leeg token vertrekt.
119func Expand(s string, ev Event, secrets map[string]string) (string, error) {
120 var b strings.Builder
121 for {
122 start := strings.Index(s, "{{")
123 if start < 0 {
124 b.WriteString(s)
125 break
126 }
127 b.WriteString(s[:start])
128 rest := s[start+2:]
129 end := strings.Index(rest, "}}")
130 if end < 0 {
131 return "", i18n.E("err.whTemplate")
132 }
133 key := strings.TrimSpace(rest[:end])
134 val, err := lookup(key, ev, secrets)
135 if err != nil {
136 return "", err
137 }
138 b.WriteString(val)
139 s = rest[end+2:]
140 }
141 return b.String(), nil
142}
143
144func lookup(key string, ev Event, secrets map[string]string) (string, error) {
145 switch {
146 case strings.HasPrefix(key, "secret."):
147 name := strings.TrimPrefix(key, "secret.")
148 v, ok := secrets[name]
149 if !ok {
150 return "", i18n.E("err.whSecret", name)
151 }
152 return v, nil
153 case strings.HasPrefix(key, "event."):
154 field := strings.TrimPrefix(key, "event.")
155 v, ok := eventField(ev, field)
156 if !ok {
157 return "", i18n.E("err.whField", field)
158 }
159 return v, nil
160 default:
161 return "", i18n.E("err.whPlaceholder", key)
162 }
163}
164
165func eventField(ev Event, field string) (string, bool) {
166 if base, ok := strings.CutSuffix(field, "_json"); ok && base != "" {
167 v, ok := eventField(ev, base)
168 if !ok {
169 return "", false
170 }
171 b, err := json.Marshal(v)
172 if err != nil {
173 return "", false
174 }
175 return string(b), true
176 }
177 switch field {
178 case "type":
179 return ev.Type, true
180 case "project":
181 return ev.Project, true
182 case "group":
183 return ev.Group, true
184 case "branch":
185 return ev.Branch, true
186 case "commit":
187 return ev.Commit, true
188 case "summary":
189 return ev.Summary, true
190 case "url":
191 return ev.URL, true
192 case "pipeline_id":
193 return ev.PipelineID, true
194 case "release_tag":
195 return ev.ReleaseTag, true
196 case "actor":
197 return ev.Actor, true
198 case "payload":
199 b, err := json.Marshal(ev.Document())
200 if err != nil {
201 return "", false
202 }
203 return string(b), true
204 default:
205 return "", false
206 }
207}
208
209// PresetDefaults vult URL-headers en body als de gebruiker een preset kiest
210// en een veld leeg laat.
211func PresetDefaults(preset string) (headers map[string]string, body string) {
212 switch preset {
213 case PresetDiscord:
214 return map[string]string{"Content-Type": "application/json"}, `{"content":"{{event.summary}}"}`
215 case PresetGrok:
216 return map[string]string{
217 "Content-Type": "application/json",
218 "Authorization": "Bearer {{secret.GROK_TOKEN}}",
219 }, ""
220 default:
221 return map[string]string{"Content-Type": "application/json"}, ""
222 }
223}
224
225// RenderBody maakt de HTTP-body. Een lege sjabloon wordt de gebeurtenis als JSON.
226func RenderBody(bodyTemplate string, ev Event, secrets map[string]string) ([]byte, error) {
227 if strings.TrimSpace(bodyTemplate) == "" {
228 return json.Marshal(ev.Document())
229 }
230 s, err := Expand(bodyTemplate, ev, secrets)
231 if err != nil {
232 return nil, err
233 }
234 return []byte(s), nil
235}
236
237// RenderHeaders vult geheimen in headers. Preset-headers vullen alleen
238// ontbrekende sleutels aan.
239func RenderHeaders(preset string, configured map[string]string, ev Event, secrets map[string]string) (map[string]string, error) {
240 base, _ := PresetDefaults(preset)
241 if base == nil {
242 base = map[string]string{}
243 }
244 for k, v := range configured {
245 base[k] = v
246 }
247 out := map[string]string{}
248 for k, v := range base {
249 ek, err := Expand(k, ev, secrets)
250 if err != nil {
251 return nil, err
252 }
253 evv, err := Expand(v, ev, secrets)
254 if err != nil {
255 return nil, err
256 }
257 out[ek] = evv
258 }
259 return out, nil
260}