BlueGit

timfa bluegit

Files

bluegit / internal / webhook / webhook.go

webhook.go

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