feat: stuur volledige details mee in webhook-payloads
Een leeg body-sjabloon stuurt nu de pipeline, push, merge request of release met de bijbehorende velden. Een gefaalde job voegt het staartje van de log toe, met geheimen gemaskeerd, log_truncated en een URL naar de volledige log. Het formaat staat op de infopagina en in een OpenAPI-document. Co-authored-by: tim <tim@timfalken.com>
@@ -639,6 +639,26 @@ func allZero(sha string) bool {
639
639
return strings.Trim(sha, "0") == ""
640
640
}
641
641
642
// RangeLog geeft de commits die newSHA bereikt en old niet, nieuwste eerst.
643
// Een lege of nul-old is de geschiedenis van newSHA.
644
func RangeLog(ctx context.Context, gitBin, dir, old, newSHA string) ([]Commit, error) {
645
if newSHA == "" || allZero(newSHA) {
646
return nil, nil
647
}
648
args := []string{"-C", dir, "log", "--format=%H%x1f%an%x1f%ae%x1f%ad%x1f%at%x1f%s%x1f%b%x1e", "--date=short", newSHA}
649
if old != "" && !allZero(old) {
650
args = append(args, "--not", old)
651
}
652
out, err := run(ctx, gitBin, nil, args...)
653
if err != nil {
654
if emptyHistory(err) {
655
return nil, nil
656
}
657
return nil, err
658
}
659
return parseLog(out), nil
660
}
661
642
662
// BranchOfRef haalt de branch uit refs/heads/… .
643
663
func BranchOfRef(ref string) (string, bool) {
644
664
const p = "refs/heads/"
@@ -639,6 +639,26 @@ func allZero(sha string) bool {639
return strings.Trim(sha, "0") == ""639
return strings.Trim(sha, "0") == ""640
}640
}641
641
642
// RangeLog geeft de commits die newSHA bereikt en old niet, nieuwste eerst.643
// Een lege of nul-old is de geschiedenis van newSHA.644
func RangeLog(ctx context.Context, gitBin, dir, old, newSHA string) ([]Commit, error) {645
if newSHA == "" || allZero(newSHA) {646
return nil, nil647
}648
args := []string{"-C", dir, "log", "--format=%H%x1f%an%x1f%ae%x1f%ad%x1f%at%x1f%s%x1f%b%x1e", "--date=short", newSHA}649
if old != "" && !allZero(old) {650
args = append(args, "--not", old)651
}652
out, err := run(ctx, gitBin, nil, args...)653
if err != nil {654
if emptyHistory(err) {655
return nil, nil656
}657
return nil, err658
}659
return parseLog(out), nil660
}661
642
// BranchOfRef haalt de branch uit refs/heads/… .662
// BranchOfRef haalt de branch uit refs/heads/… .643
func BranchOfRef(ref string) (string, bool) {663
func BranchOfRef(ref string) (string, bool) {644
const p = "refs/heads/"664
const p = "refs/heads/"@@ -0,0 +1,40 @@
1
package i18n
2
3
func init() {
4
addCatalog(en, webhookEN)
5
addCatalog(nl, webhookNL)
6
addCatalog(de, webhookDE)
7
addCatalog(fr, webhookFR)
8
}
9
10
var webhookEN = map[string]string{
11
"info.sec.webhooks": "Webhook payloads",
12
"info.wh.spec": "OpenAPI",
13
"info.wh.lead": "An empty body template sends this JSON document. pipeline_success and pipeline_failure include the pipeline id, status, ref, sha, commit message, author and duration, and every job with its name, stage, status, duration, allow_failure and web URL. A failed job also includes the last 200 log lines, at most 64 KiB. Secret values of at least 8 characters are replaced with [MASKED]. log_truncated is true when the log was cut. log_url points at the full log. A push includes ref, before, after and up to 20 commits, each with sha, message, author and URL. A merge request includes id, title, description, source branch, target branch, status, author and the action opened, merged or commented. A comment action also includes the comment text. A release includes the tag, name, commit and assets with URLs.",
14
"hook.mrMerged": "merge request !%s merged: %s",
15
"hook.mrComment": "comment on merge request !%s",
16
}
17
18
var webhookNL = map[string]string{
19
"info.sec.webhooks": "Webhook-payloads",
20
"info.wh.spec": "OpenAPI",
21
"info.wh.lead": "Een leeg body-sjabloon stuurt dit JSON-document. pipeline_success en pipeline_failure bevatten het pipeline-id, de status, ref, sha, commitboodschap, auteur en duur, en elke job met naam, stage, status, duur, allow_failure en web-URL. Een gefaalde job bevat ook de laatste 200 logregels, maximaal 64 KiB. Geheimwaarden van minstens 8 tekens worden [MASKED]. log_truncated is true als de log is afgekapt. log_url wijst naar de volledige log. Een push bevat ref, before, after en hoogstens 20 commits, elk met sha, message, auteur en URL. Een merge request bevat id, titel, beschrijving, bronbranch, doelbranch, status, auteur en de actie opened, merged of commented. Bij een commentaar hoort ook de tekst. Een release bevat tag, naam, commit en assets met URL's.",
22
"hook.mrMerged": "merge request !%s samengevoegd: %s",
23
"hook.mrComment": "reactie op merge request !%s",
24
}
25
26
var webhookDE = map[string]string{
27
"info.sec.webhooks": "Webhook-Nutzdaten",
28
"info.wh.spec": "OpenAPI",
29
"info.wh.lead": "Eine leere Body-Vorlage sendet dieses JSON-Dokument. pipeline_success und pipeline_failure enthalten Pipeline-Id, Status, Ref, SHA, Commit-Nachricht, Autor und Dauer, sowie jeden Job mit Name, Stage, Status, Dauer, allow_failure und Web-URL. Ein fehlgeschlagener Job enthält außerdem die letzten 200 Logzeilen, höchstens 64 KiB. Geheimwerte ab 8 Zeichen werden zu [MASKED]. log_truncated ist true, wenn das Log gekürzt wurde. log_url zeigt auf das vollständige Log. Ein Push enthält ref, before, after und höchstens 20 Commits mit SHA, Nachricht, Autor und URL. Ein Merge Request enthält Id, Titel, Beschreibung, Quellbranch, Zielbranch, Status, Autor und die Aktion opened, merged oder commented. Bei einem Kommentar steht der Text dabei. Ein Release enthält Tag, Name, Commit und Assets mit URLs.",
30
"hook.mrMerged": "Merge-Request !%s zusammengeführt: %s",
31
"hook.mrComment": "Kommentar zu Merge-Request !%s",
32
}
33
34
var webhookFR = map[string]string{
35
"info.sec.webhooks": "Charges utiles des webhooks",
36
"info.wh.spec": "OpenAPI",
37
"info.wh.lead": "Un modèle de corps vide envoie ce document JSON. pipeline_success et pipeline_failure contiennent l'id du pipeline, le statut, la ref, le sha, le message de commit, l'auteur et la durée, plus chaque job avec nom, stage, statut, durée, allow_failure et URL web. Un job en échec ajoute les 200 dernières lignes de log, 64 KiB au plus. Les valeurs secrètes d'au moins 8 caractères deviennent [MASKED]. log_truncated vaut true quand le log est coupé. log_url pointe vers le log complet. Un push contient ref, before, after et 20 commits au plus, chacun avec sha, message, auteur et URL. Une merge request contient id, titre, description, branche source, branche cible, statut, auteur et l'action opened, merged ou commented. Une action commented contient aussi le texte. Une release contient le tag, le nom, le commit et les assets avec leurs URL.",
38
"hook.mrMerged": "merge request !%s fusionnée : %s",
39
"hook.mrComment": "commentaire sur la merge request !%s",
40
}
@@ -0,0 +1,40 @@1
package i18n2
3
func init() {4
addCatalog(en, webhookEN)5
addCatalog(nl, webhookNL)6
addCatalog(de, webhookDE)7
addCatalog(fr, webhookFR)8
}9
10
var webhookEN = map[string]string{11
"info.sec.webhooks": "Webhook payloads",12
"info.wh.spec": "OpenAPI",13
"info.wh.lead": "An empty body template sends this JSON document. pipeline_success and pipeline_failure include the pipeline id, status, ref, sha, commit message, author and duration, and every job with its name, stage, status, duration, allow_failure and web URL. A failed job also includes the last 200 log lines, at most 64 KiB. Secret values of at least 8 characters are replaced with [MASKED]. log_truncated is true when the log was cut. log_url points at the full log. A push includes ref, before, after and up to 20 commits, each with sha, message, author and URL. A merge request includes id, title, description, source branch, target branch, status, author and the action opened, merged or commented. A comment action also includes the comment text. A release includes the tag, name, commit and assets with URLs.",14
"hook.mrMerged": "merge request !%s merged: %s",15
"hook.mrComment": "comment on merge request !%s",16
}17
18
var webhookNL = map[string]string{19
"info.sec.webhooks": "Webhook-payloads",20
"info.wh.spec": "OpenAPI",21
"info.wh.lead": "Een leeg body-sjabloon stuurt dit JSON-document. pipeline_success en pipeline_failure bevatten het pipeline-id, de status, ref, sha, commitboodschap, auteur en duur, en elke job met naam, stage, status, duur, allow_failure en web-URL. Een gefaalde job bevat ook de laatste 200 logregels, maximaal 64 KiB. Geheimwaarden van minstens 8 tekens worden [MASKED]. log_truncated is true als de log is afgekapt. log_url wijst naar de volledige log. Een push bevat ref, before, after en hoogstens 20 commits, elk met sha, message, auteur en URL. Een merge request bevat id, titel, beschrijving, bronbranch, doelbranch, status, auteur en de actie opened, merged of commented. Bij een commentaar hoort ook de tekst. Een release bevat tag, naam, commit en assets met URL's.",22
"hook.mrMerged": "merge request !%s samengevoegd: %s",23
"hook.mrComment": "reactie op merge request !%s",24
}25
26
var webhookDE = map[string]string{27
"info.sec.webhooks": "Webhook-Nutzdaten",28
"info.wh.spec": "OpenAPI",29
"info.wh.lead": "Eine leere Body-Vorlage sendet dieses JSON-Dokument. pipeline_success und pipeline_failure enthalten Pipeline-Id, Status, Ref, SHA, Commit-Nachricht, Autor und Dauer, sowie jeden Job mit Name, Stage, Status, Dauer, allow_failure und Web-URL. Ein fehlgeschlagener Job enthält außerdem die letzten 200 Logzeilen, höchstens 64 KiB. Geheimwerte ab 8 Zeichen werden zu [MASKED]. log_truncated ist true, wenn das Log gekürzt wurde. log_url zeigt auf das vollständige Log. Ein Push enthält ref, before, after und höchstens 20 Commits mit SHA, Nachricht, Autor und URL. Ein Merge Request enthält Id, Titel, Beschreibung, Quellbranch, Zielbranch, Status, Autor und die Aktion opened, merged oder commented. Bei einem Kommentar steht der Text dabei. Ein Release enthält Tag, Name, Commit und Assets mit URLs.",30
"hook.mrMerged": "Merge-Request !%s zusammengeführt: %s",31
"hook.mrComment": "Kommentar zu Merge-Request !%s",32
}33
34
var webhookFR = map[string]string{35
"info.sec.webhooks": "Charges utiles des webhooks",36
"info.wh.spec": "OpenAPI",37
"info.wh.lead": "Un modèle de corps vide envoie ce document JSON. pipeline_success et pipeline_failure contiennent l'id du pipeline, le statut, la ref, le sha, le message de commit, l'auteur et la durée, plus chaque job avec nom, stage, statut, durée, allow_failure et URL web. Un job en échec ajoute les 200 dernières lignes de log, 64 KiB au plus. Les valeurs secrètes d'au moins 8 caractères deviennent [MASKED]. log_truncated vaut true quand le log est coupé. log_url pointe vers le log complet. Un push contient ref, before, after et 20 commits au plus, chacun avec sha, message, auteur et URL. Une merge request contient id, titre, description, branche source, branche cible, statut, auteur et l'action opened, merged ou commented. Une action commented contient aussi le texte. Une release contient le tag, le nom, le commit et les assets avec leurs URL.",38
"hook.mrMerged": "merge request !%s fusionnée : %s",39
"hook.mrComment": "commentaire sur la merge request !%s",40
}@@ -152,11 +152,10 @@ func (s *Server) openCIMergeRequest(r *http.Request, repo store.Repo, author sto
152
152
if err != nil {
153
153
return 0, err
154
154
}
155
num := strconv.FormatInt(mr.Number, 10)
156
155
if sha := gitOne(r.Context(), s.Git, dir, "rev-parse", "--verify", "refs/heads/"+branch); sha != "" {
157
156
s.startOneMergePipeline(r.Context(), repo, sha, author.Username, "", mr)
158
157
}
159
s.Dispatch(repo.ID, pushEvent(repo, "merge_request", target, "", author.Username, s.tr(r, "hook.mr", num, mr.Title), repoURL(repo)+"/-/merge-requests/"+num))
158
s.mrHook(repo, mr, author.Username, "opened", "")
160
159
s.recordContribution(author.ID, repo.ID, "merge_request", mrRef(mr.ID), mr.CreatedAt)
161
160
return mr.Number, nil
162
161
}
@@ -152,11 +152,10 @@ func (s *Server) openCIMergeRequest(r *http.Request, repo store.Repo, author sto152
if err != nil {152
if err != nil {153
return 0, err153
return 0, err154
}154
}155
num := strconv.FormatInt(mr.Number, 10)156
if sha := gitOne(r.Context(), s.Git, dir, "rev-parse", "--verify", "refs/heads/"+branch); sha != "" {155
if sha := gitOne(r.Context(), s.Git, dir, "rev-parse", "--verify", "refs/heads/"+branch); sha != "" {157
s.startOneMergePipeline(r.Context(), repo, sha, author.Username, "", mr)156
s.startOneMergePipeline(r.Context(), repo, sha, author.Username, "", mr)158
}157
}159
s.Dispatch(repo.ID, pushEvent(repo, "merge_request", target, "", author.Username, s.tr(r, "hook.mr", num, mr.Title), repoURL(repo)+"/-/merge-requests/"+num))158
s.mrHook(repo, mr, author.Username, "opened", "")160
s.recordContribution(author.ID, repo.ID, "merge_request", mrRef(mr.ID), mr.CreatedAt)159
s.recordContribution(author.ID, repo.ID, "merge_request", mrRef(mr.ID), mr.CreatedAt)161
return mr.Number, nil160
return mr.Number, nil162
}161
}@@ -54,10 +54,9 @@ func (s *Server) AfterPush(repo store.Repo, user store.User, before, after map[s
54
54
}
55
55
commit := s.peeled(repo, sha)
56
56
if strings.HasPrefix(ref, "refs/tags/") {
57
name := strings.TrimPrefix(ref, "refs/tags/")
58
57
s.startPipeline(context.Background(), repo, commit, ref, actor, "push", before[ref], nil)
59
58
s.recordContribution(user.ID, repo.ID, "tag", ref, time.Now().UTC())
60
s.pushHook(repo, actor, name, commit)
59
s.pushHook(repo, actor, ref, before[ref], sha)
61
60
continue
62
61
}
63
62
branch, ok := gitrepo.BranchOfRef(ref)
@@ -69,17 +68,24 @@ func (s *Server) AfterPush(repo store.Repo, user store.User, before, after map[s
69
68
s.startMergeRequestPipelines(context.Background(), repo, commit, branch, actor, before[ref])
70
69
s.recordMRPushes(repo, user, branch, before[ref], sha)
71
70
s.rerunMergeRequestsOnTarget(context.Background(), repo, branch, actor)
72
s.pushHook(repo, actor, branch, commit)
71
s.pushHook(repo, actor, ref, before[ref], sha)
73
72
}
74
73
}
75
74
76
func (s *Server) pushHook(repo store.Repo, actor, branch, commit string) {
75
func (s *Server) pushHook(repo store.Repo, actor, ref, before, after string) {
76
if isZero(before) {
77
before = strings.Repeat("0", 40)
78
}
79
name := refName(ref)
77
80
s.Dispatch(repo.ID, webhook.Event{
78
81
Type: webhook.EventPush,
79
82
Project: repo.FullPath(),
80
Branch: branch,
81
Commit: commit,
82
Summary: i18n.T(i18n.EN, "hook.push", actor, branch, repo.FullPath()),
83
Branch: name,
84
Ref: ref,
85
Before: before,
86
After: after,
87
Commit: after,
88
Summary: i18n.T(i18n.EN, "hook.push", actor, name, repo.FullPath()),
83
89
URL: strings.TrimRight(s.Cfg.BaseURL, "/") + "/" + repo.FullPath(),
84
90
Actor: actor,
85
91
})
@@ -188,13 +194,6 @@ func changedFiles(ctx context.Context, gitBin, dir, sha, before string, all []st
188
194
return strings.Split(text, "\n")
189
195
}
190
196
191
func pushEvent(repo store.Repo, kind, branch, commit, actor, summary, path string) webhook.Event {
192
return webhook.Event{
193
Type: kind, Project: repo.FullPath(), Branch: branch, Commit: commit,
194
Actor: actor, Summary: summary, URL: path,
195
}
196
}
197
198
197
func (s *Server) Dispatch(repoID int64, ev webhook.Event) {
199
198
ctx := context.Background()
200
199
repo, err := s.Store.RepoByID(ctx, repoID)
@@ -212,6 +211,7 @@ func (s *Server) Dispatch(repoID int64, ev webhook.Event) {
212
211
ev.Group = g.Path
213
212
}
214
213
}
214
ev = s.enrichEvent(ctx, repo, ev)
215
215
patterns, _ := s.Store.ProtectedPatterns(ctx, repo.ID)
216
216
protected := access.BranchProtected(patterns, ev.Branch)
217
217
s.deliver(ctx, "repo", repo.ID, ev, protected, repo)
@@ -270,6 +270,11 @@ func (s *Server) deliver(ctx context.Context, kind string, scopeID int64, ev web
270
270
_ = s.Store.AddDelivery(ctx, h.ID, ev.Type, 0, err.Error())
271
271
continue
272
272
}
273
if s.hookSink != nil {
274
s.hookSink(body)
275
_ = s.Store.AddDelivery(ctx, h.ID, ev.Type, 0, "")
276
continue
277
}
273
278
method := h.Method
274
279
if method == "" {
275
280
method = http.MethodPost
@@ -54,10 +54,9 @@ func (s *Server) AfterPush(repo store.Repo, user store.User, before, after map[s54
}54
}55
commit := s.peeled(repo, sha)55
commit := s.peeled(repo, sha)56
if strings.HasPrefix(ref, "refs/tags/") {56
if strings.HasPrefix(ref, "refs/tags/") {57
name := strings.TrimPrefix(ref, "refs/tags/")58
s.startPipeline(context.Background(), repo, commit, ref, actor, "push", before[ref], nil)57
s.startPipeline(context.Background(), repo, commit, ref, actor, "push", before[ref], nil)59
s.recordContribution(user.ID, repo.ID, "tag", ref, time.Now().UTC())58
s.recordContribution(user.ID, repo.ID, "tag", ref, time.Now().UTC())60
s.pushHook(repo, actor, name, commit)59
s.pushHook(repo, actor, ref, before[ref], sha)61
continue60
continue62
}61
}63
branch, ok := gitrepo.BranchOfRef(ref)62
branch, ok := gitrepo.BranchOfRef(ref)@@ -69,17 +68,24 @@ func (s *Server) AfterPush(repo store.Repo, user store.User, before, after map[s69
s.startMergeRequestPipelines(context.Background(), repo, commit, branch, actor, before[ref])68
s.startMergeRequestPipelines(context.Background(), repo, commit, branch, actor, before[ref])70
s.recordMRPushes(repo, user, branch, before[ref], sha)69
s.recordMRPushes(repo, user, branch, before[ref], sha)71
s.rerunMergeRequestsOnTarget(context.Background(), repo, branch, actor)70
s.rerunMergeRequestsOnTarget(context.Background(), repo, branch, actor)72
s.pushHook(repo, actor, branch, commit)71
s.pushHook(repo, actor, ref, before[ref], sha)73
}72
}74
}73
}75
74
76
func (s *Server) pushHook(repo store.Repo, actor, branch, commit string) {75
func (s *Server) pushHook(repo store.Repo, actor, ref, before, after string) {76
if isZero(before) {77
before = strings.Repeat("0", 40)78
}79
name := refName(ref)77
s.Dispatch(repo.ID, webhook.Event{80
s.Dispatch(repo.ID, webhook.Event{78
Type: webhook.EventPush,81
Type: webhook.EventPush,79
Project: repo.FullPath(),82
Project: repo.FullPath(),80
Branch: branch,83
Branch: name,81
Commit: commit,84
Ref: ref,82
Summary: i18n.T(i18n.EN, "hook.push", actor, branch, repo.FullPath()),85
Before: before,86
After: after,87
Commit: after,88
Summary: i18n.T(i18n.EN, "hook.push", actor, name, repo.FullPath()),83
URL: strings.TrimRight(s.Cfg.BaseURL, "/") + "/" + repo.FullPath(),89
URL: strings.TrimRight(s.Cfg.BaseURL, "/") + "/" + repo.FullPath(),84
Actor: actor,90
Actor: actor,85
})91
})@@ -188,13 +194,6 @@ func changedFiles(ctx context.Context, gitBin, dir, sha, before string, all []st188
return strings.Split(text, "\n")194
return strings.Split(text, "\n")189
}195
}190
196
191
func pushEvent(repo store.Repo, kind, branch, commit, actor, summary, path string) webhook.Event {192
return webhook.Event{193
Type: kind, Project: repo.FullPath(), Branch: branch, Commit: commit,194
Actor: actor, Summary: summary, URL: path,195
}196
}197
198
func (s *Server) Dispatch(repoID int64, ev webhook.Event) {197
func (s *Server) Dispatch(repoID int64, ev webhook.Event) {199
ctx := context.Background()198
ctx := context.Background()200
repo, err := s.Store.RepoByID(ctx, repoID)199
repo, err := s.Store.RepoByID(ctx, repoID)@@ -212,6 +211,7 @@ func (s *Server) Dispatch(repoID int64, ev webhook.Event) {212
ev.Group = g.Path211
ev.Group = g.Path213
}212
}214
}213
}214
ev = s.enrichEvent(ctx, repo, ev)215
patterns, _ := s.Store.ProtectedPatterns(ctx, repo.ID)215
patterns, _ := s.Store.ProtectedPatterns(ctx, repo.ID)216
protected := access.BranchProtected(patterns, ev.Branch)216
protected := access.BranchProtected(patterns, ev.Branch)217
s.deliver(ctx, "repo", repo.ID, ev, protected, repo)217
s.deliver(ctx, "repo", repo.ID, ev, protected, repo)@@ -270,6 +270,11 @@ func (s *Server) deliver(ctx context.Context, kind string, scopeID int64, ev web270
_ = s.Store.AddDelivery(ctx, h.ID, ev.Type, 0, err.Error())270
_ = s.Store.AddDelivery(ctx, h.ID, ev.Type, 0, err.Error())271
continue271
continue272
}272
}273
if s.hookSink != nil {274
s.hookSink(body)275
_ = s.Store.AddDelivery(ctx, h.ID, ev.Type, 0, "")276
continue277
}273
method := h.Method278
method := h.Method274
if method == "" {279
if method == "" {275
method = http.MethodPost280
method = http.MethodPost@@ -0,0 +1,227 @@
1
package server
2
3
import (
4
"context"
5
"math"
6
"net/url"
7
"strconv"
8
"strings"
9
"time"
10
11
"gitlab.com/Timfa/bluegit/internal/gitrepo"
12
"gitlab.com/Timfa/bluegit/internal/i18n"
13
"gitlab.com/Timfa/bluegit/internal/store"
14
"gitlab.com/Timfa/bluegit/internal/webhook"
15
)
16
17
// enrichEvent vult de details die de JSON-body van een webhook meestuurt.
18
func (s *Server) enrichEvent(ctx context.Context, repo store.Repo, ev webhook.Event) webhook.Event {
19
switch ev.Type {
20
case webhook.EventPipelineSuccess, webhook.EventPipelineFailure:
21
s.fillPipelineEvent(ctx, repo, &ev)
22
case webhook.EventPush:
23
s.fillPushEvent(ctx, repo, &ev)
24
}
25
return ev
26
}
27
28
func (s *Server) fillPipelineEvent(ctx context.Context, repo store.Repo, ev *webhook.Event) {
29
id, err := strconv.ParseInt(ev.PipelineID, 10, 64)
30
if err != nil || id <= 0 || s.Store == nil {
31
return
32
}
33
p, err := s.Store.PipelineByID(ctx, repo.ID, id)
34
if err != nil {
35
return
36
}
37
base := strings.TrimRight(s.Cfg.BaseURL, "/")
38
pipeURL := base + "/" + repo.FullPath() + "/-/pipelines/" + strconv.FormatInt(p.ID, 10)
39
if ev.URL == "" || !strings.HasPrefix(ev.URL, "http") {
40
ev.URL = pipeURL
41
}
42
if ev.Commit == "" {
43
ev.Commit = p.CommitSHA
44
}
45
if ev.Branch == "" {
46
ev.Branch = refName(p.Ref)
47
}
48
if ev.Actor == "" {
49
ev.Actor = p.Actor
50
}
51
msg := p.CommitTitle
52
author := p.Actor
53
if s.Git != "" && s.StoragePath() != "" && p.CommitSHA != "" {
54
dir := gitrepo.Dir(s.StoragePath(), repo.OwnerPath, repo.Name)
55
if c, err := gitrepo.Show(ctx, s.Git, dir, p.CommitSHA); err == nil && c.SHA != "" {
56
if text := commitText(c); text != "" {
57
msg = text
58
}
59
if author == "" {
60
author = commitAuthor(c)
61
}
62
}
63
}
64
ev.PipelineID = strconv.FormatInt(p.ID, 10)
65
ev.Pipeline = &webhook.PipelineInfo{
66
ID: p.ID, Status: p.Status, Ref: p.Ref, SHA: p.CommitSHA,
67
CommitMessage: msg, Author: author, Duration: elapsedSeconds(p.StartedAt, p.FinishedAt),
68
URL: pipeURL,
69
}
70
jobs, err := s.Store.JobsByPipeline(ctx, p.ID)
71
if err != nil {
72
return
73
}
74
secrets := s.maskSecrets(ctx, repo)
75
ev.Jobs = make([]webhook.JobInfo, 0, len(jobs))
76
for _, j := range jobs {
77
info := webhook.JobInfo{
78
Name: j.Name, Stage: j.Stage, Status: j.Status,
79
Duration: elapsedSeconds(j.StartedAt, j.FinishedAt),
80
AllowFailure: j.AllowFailure,
81
WebURL: pipeURL + "/jobs/" + strconv.FormatInt(j.ID, 10),
82
}
83
if j.Status == "failed" {
84
log, truncated := webhook.TailLog(j.Log, secrets)
85
info.Log = log
86
info.LogTruncated = &truncated
87
info.LogURL = info.WebURL + "/log?raw=1"
88
}
89
ev.Jobs = append(ev.Jobs, info)
90
}
91
}
92
93
func (s *Server) fillPushEvent(ctx context.Context, repo store.Repo, ev *webhook.Event) {
94
if ev.Commits != nil || s.Git == "" || s.StoragePath() == "" || ev.After == "" {
95
if ev.Commits == nil {
96
ev.Commits = []webhook.CommitInfo{}
97
}
98
return
99
}
100
dir := gitrepo.Dir(s.StoragePath(), repo.OwnerPath, repo.Name)
101
list, err := gitrepo.RangeLog(ctx, s.Git, dir, ev.Before, ev.After)
102
if err != nil || len(list) == 0 {
103
ev.Commits = []webhook.CommitInfo{}
104
return
105
}
106
if len(list) > webhook.MaxPushCommits {
107
list = list[:webhook.MaxPushCommits]
108
}
109
base := strings.TrimRight(s.Cfg.BaseURL, "/")
110
ev.Commits = make([]webhook.CommitInfo, 0, len(list))
111
for i := len(list) - 1; i >= 0; i-- {
112
c := list[i]
113
ev.Commits = append(ev.Commits, webhook.CommitInfo{
114
SHA: c.SHA, Message: commitText(c), Author: commitAuthor(c),
115
URL: base + "/" + repo.FullPath() + "/-/commit/" + c.SHA,
116
})
117
}
118
}
119
120
func (s *Server) maskSecrets(ctx context.Context, repo store.Repo) []string {
121
if s.Store == nil {
122
return nil
123
}
124
var out []string
125
add := func(kind string, id int64) {
126
vals, err := s.Store.SecretValues(ctx, kind, id, true)
127
if err != nil {
128
return
129
}
130
for _, v := range vals {
131
out = append(out, v)
132
}
133
}
134
add("repo", repo.ID)
135
if repo.OwnerKind == "group" {
136
add("group", repo.OwnerID)
137
}
138
return out
139
}
140
141
func (s *Server) mrEvent(repo store.Repo, mr store.MergeRequest, actor, action, comment string) webhook.Event {
142
num := strconv.FormatInt(mr.Number, 10)
143
path := strings.TrimRight(s.Cfg.BaseURL, "/") + repoURL(repo) + "/-/merge-requests/" + num
144
summary := i18n.T(i18n.EN, "hook.mr", num, mr.Title)
145
switch action {
146
case "merged":
147
summary = i18n.T(i18n.EN, "hook.mrMerged", num, mr.Title)
148
case "commented":
149
summary = i18n.T(i18n.EN, "hook.mrComment", num)
150
}
151
return webhook.Event{
152
Type: webhook.EventMergeRequest,
153
Project: repo.FullPath(),
154
Branch: mr.TargetBranch,
155
Actor: actor,
156
Summary: summary,
157
URL: path,
158
Comment: comment,
159
MergeRequest: &webhook.MRInfo{
160
ID: mr.Number, Title: mr.Title, Description: mr.Description,
161
SourceBranch: mr.SourceBranch, TargetBranch: mr.TargetBranch,
162
Status: mr.Status, Author: mr.Author, Action: action, URL: path,
163
},
164
}
165
}
166
167
func (s *Server) mrHook(repo store.Repo, mr store.MergeRequest, actor, action, comment string) {
168
s.Dispatch(repo.ID, s.mrEvent(repo, mr, actor, action, comment))
169
}
170
171
func (s *Server) releaseEvent(repo store.Repo, tag, name, commit string, assets []store.ReleaseAsset) webhook.Event {
172
base := strings.TrimRight(s.Cfg.BaseURL, "/")
173
page := base + repoURL(repo) + "/-/releases"
174
list := make([]webhook.AssetInfo, 0, len(assets))
175
for _, a := range assets {
176
list = append(list, webhook.AssetInfo{
177
Name: a.Name, Size: a.Size,
178
URL: base + repoURL(repo) + "/-/releases/" + url.PathEscape(tag) + "/assets/" + url.PathEscape(a.Name),
179
})
180
}
181
return webhook.Event{
182
Type: webhook.EventRelease, Project: repo.FullPath(), Commit: commit,
183
ReleaseTag: tag, Summary: i18n.T(i18n.EN, "hook.release", tag, repo.FullPath()),
184
URL: page,
185
Release: &webhook.ReleaseInfo{Tag: tag, Name: name, Commit: commit, Assets: list},
186
}
187
}
188
189
func refName(ref string) string {
190
if b, ok := gitrepo.BranchOfRef(ref); ok {
191
return b
192
}
193
if name, ok := strings.CutPrefix(ref, "refs/tags/"); ok && name != "" {
194
return name
195
}
196
return ref
197
}
198
199
func commitText(c gitrepo.Commit) string {
200
if c.Subject == "" {
201
return strings.TrimSpace(c.Body)
202
}
203
if strings.TrimSpace(c.Body) == "" {
204
return c.Subject
205
}
206
return c.Subject + "\n\n" + strings.TrimSpace(c.Body)
207
}
208
209
func commitAuthor(c gitrepo.Commit) string {
210
name := strings.TrimSpace(c.Author)
211
email := strings.TrimSpace(c.Email)
212
switch {
213
case name == "":
214
return email
215
case email == "":
216
return name
217
default:
218
return name + " <" + email + ">"
219
}
220
}
221
222
func elapsedSeconds(start, end time.Time) float64 {
223
if start.IsZero() || end.IsZero() || end.Before(start) {
224
return 0
225
}
226
return math.Round(end.Sub(start).Seconds()*1000) / 1000
227
}
@@ -0,0 +1,227 @@1
package server2
3
import (4
"context"5
"math"6
"net/url"7
"strconv"8
"strings"9
"time"10
11
"gitlab.com/Timfa/bluegit/internal/gitrepo"12
"gitlab.com/Timfa/bluegit/internal/i18n"13
"gitlab.com/Timfa/bluegit/internal/store"14
"gitlab.com/Timfa/bluegit/internal/webhook"15
)16
17
// enrichEvent vult de details die de JSON-body van een webhook meestuurt.18
func (s *Server) enrichEvent(ctx context.Context, repo store.Repo, ev webhook.Event) webhook.Event {19
switch ev.Type {20
case webhook.EventPipelineSuccess, webhook.EventPipelineFailure:21
s.fillPipelineEvent(ctx, repo, &ev)22
case webhook.EventPush:23
s.fillPushEvent(ctx, repo, &ev)24
}25
return ev26
}27
28
func (s *Server) fillPipelineEvent(ctx context.Context, repo store.Repo, ev *webhook.Event) {29
id, err := strconv.ParseInt(ev.PipelineID, 10, 64)30
if err != nil || id <= 0 || s.Store == nil {31
return32
}33
p, err := s.Store.PipelineByID(ctx, repo.ID, id)34
if err != nil {35
return36
}37
base := strings.TrimRight(s.Cfg.BaseURL, "/")38
pipeURL := base + "/" + repo.FullPath() + "/-/pipelines/" + strconv.FormatInt(p.ID, 10)39
if ev.URL == "" || !strings.HasPrefix(ev.URL, "http") {40
ev.URL = pipeURL41
}42
if ev.Commit == "" {43
ev.Commit = p.CommitSHA44
}45
if ev.Branch == "" {46
ev.Branch = refName(p.Ref)47
}48
if ev.Actor == "" {49
ev.Actor = p.Actor50
}51
msg := p.CommitTitle52
author := p.Actor53
if s.Git != "" && s.StoragePath() != "" && p.CommitSHA != "" {54
dir := gitrepo.Dir(s.StoragePath(), repo.OwnerPath, repo.Name)55
if c, err := gitrepo.Show(ctx, s.Git, dir, p.CommitSHA); err == nil && c.SHA != "" {56
if text := commitText(c); text != "" {57
msg = text58
}59
if author == "" {60
author = commitAuthor(c)61
}62
}63
}64
ev.PipelineID = strconv.FormatInt(p.ID, 10)65
ev.Pipeline = &webhook.PipelineInfo{66
ID: p.ID, Status: p.Status, Ref: p.Ref, SHA: p.CommitSHA,67
CommitMessage: msg, Author: author, Duration: elapsedSeconds(p.StartedAt, p.FinishedAt),68
URL: pipeURL,69
}70
jobs, err := s.Store.JobsByPipeline(ctx, p.ID)71
if err != nil {72
return73
}74
secrets := s.maskSecrets(ctx, repo)75
ev.Jobs = make([]webhook.JobInfo, 0, len(jobs))76
for _, j := range jobs {77
info := webhook.JobInfo{78
Name: j.Name, Stage: j.Stage, Status: j.Status,79
Duration: elapsedSeconds(j.StartedAt, j.FinishedAt),80
AllowFailure: j.AllowFailure,81
WebURL: pipeURL + "/jobs/" + strconv.FormatInt(j.ID, 10),82
}83
if j.Status == "failed" {84
log, truncated := webhook.TailLog(j.Log, secrets)85
info.Log = log86
info.LogTruncated = &truncated87
info.LogURL = info.WebURL + "/log?raw=1"88
}89
ev.Jobs = append(ev.Jobs, info)90
}91
}92
93
func (s *Server) fillPushEvent(ctx context.Context, repo store.Repo, ev *webhook.Event) {94
if ev.Commits != nil || s.Git == "" || s.StoragePath() == "" || ev.After == "" {95
if ev.Commits == nil {96
ev.Commits = []webhook.CommitInfo{}97
}98
return99
}100
dir := gitrepo.Dir(s.StoragePath(), repo.OwnerPath, repo.Name)101
list, err := gitrepo.RangeLog(ctx, s.Git, dir, ev.Before, ev.After)102
if err != nil || len(list) == 0 {103
ev.Commits = []webhook.CommitInfo{}104
return105
}106
if len(list) > webhook.MaxPushCommits {107
list = list[:webhook.MaxPushCommits]108
}109
base := strings.TrimRight(s.Cfg.BaseURL, "/")110
ev.Commits = make([]webhook.CommitInfo, 0, len(list))111
for i := len(list) - 1; i >= 0; i-- {112
c := list[i]113
ev.Commits = append(ev.Commits, webhook.CommitInfo{114
SHA: c.SHA, Message: commitText(c), Author: commitAuthor(c),115
URL: base + "/" + repo.FullPath() + "/-/commit/" + c.SHA,116
})117
}118
}119
120
func (s *Server) maskSecrets(ctx context.Context, repo store.Repo) []string {121
if s.Store == nil {122
return nil123
}124
var out []string125
add := func(kind string, id int64) {126
vals, err := s.Store.SecretValues(ctx, kind, id, true)127
if err != nil {128
return129
}130
for _, v := range vals {131
out = append(out, v)132
}133
}134
add("repo", repo.ID)135
if repo.OwnerKind == "group" {136
add("group", repo.OwnerID)137
}138
return out139
}140
141
func (s *Server) mrEvent(repo store.Repo, mr store.MergeRequest, actor, action, comment string) webhook.Event {142
num := strconv.FormatInt(mr.Number, 10)143
path := strings.TrimRight(s.Cfg.BaseURL, "/") + repoURL(repo) + "/-/merge-requests/" + num144
summary := i18n.T(i18n.EN, "hook.mr", num, mr.Title)145
switch action {146
case "merged":147
summary = i18n.T(i18n.EN, "hook.mrMerged", num, mr.Title)148
case "commented":149
summary = i18n.T(i18n.EN, "hook.mrComment", num)150
}151
return webhook.Event{152
Type: webhook.EventMergeRequest,153
Project: repo.FullPath(),154
Branch: mr.TargetBranch,155
Actor: actor,156
Summary: summary,157
URL: path,158
Comment: comment,159
MergeRequest: &webhook.MRInfo{160
ID: mr.Number, Title: mr.Title, Description: mr.Description,161
SourceBranch: mr.SourceBranch, TargetBranch: mr.TargetBranch,162
Status: mr.Status, Author: mr.Author, Action: action, URL: path,163
},164
}165
}166
167
func (s *Server) mrHook(repo store.Repo, mr store.MergeRequest, actor, action, comment string) {168
s.Dispatch(repo.ID, s.mrEvent(repo, mr, actor, action, comment))169
}170
171
func (s *Server) releaseEvent(repo store.Repo, tag, name, commit string, assets []store.ReleaseAsset) webhook.Event {172
base := strings.TrimRight(s.Cfg.BaseURL, "/")173
page := base + repoURL(repo) + "/-/releases"174
list := make([]webhook.AssetInfo, 0, len(assets))175
for _, a := range assets {176
list = append(list, webhook.AssetInfo{177
Name: a.Name, Size: a.Size,178
URL: base + repoURL(repo) + "/-/releases/" + url.PathEscape(tag) + "/assets/" + url.PathEscape(a.Name),179
})180
}181
return webhook.Event{182
Type: webhook.EventRelease, Project: repo.FullPath(), Commit: commit,183
ReleaseTag: tag, Summary: i18n.T(i18n.EN, "hook.release", tag, repo.FullPath()),184
URL: page,185
Release: &webhook.ReleaseInfo{Tag: tag, Name: name, Commit: commit, Assets: list},186
}187
}188
189
func refName(ref string) string {190
if b, ok := gitrepo.BranchOfRef(ref); ok {191
return b192
}193
if name, ok := strings.CutPrefix(ref, "refs/tags/"); ok && name != "" {194
return name195
}196
return ref197
}198
199
func commitText(c gitrepo.Commit) string {200
if c.Subject == "" {201
return strings.TrimSpace(c.Body)202
}203
if strings.TrimSpace(c.Body) == "" {204
return c.Subject205
}206
return c.Subject + "\n\n" + strings.TrimSpace(c.Body)207
}208
209
func commitAuthor(c gitrepo.Commit) string {210
name := strings.TrimSpace(c.Author)211
email := strings.TrimSpace(c.Email)212
switch {213
case name == "":214
return email215
case email == "":216
return name217
default:218
return name + " <" + email + ">"219
}220
}221
222
func elapsedSeconds(start, end time.Time) float64 {223
if start.IsZero() || end.IsZero() || end.Before(start) {224
return 0225
}226
return math.Round(end.Sub(start).Seconds()*1000) / 1000227
}@@ -0,0 +1,317 @@
1
package server
2
3
import (
4
"context"
5
"encoding/json"
6
"net/http"
7
"net/http/cookiejar"
8
"net/http/httptest"
9
"net/url"
10
"os/exec"
11
"path/filepath"
12
"strconv"
13
"strings"
14
"testing"
15
"time"
16
17
"gitlab.com/Timfa/bluegit/internal/auth"
18
"gitlab.com/Timfa/bluegit/internal/config"
19
"gitlab.com/Timfa/bluegit/internal/store"
20
"gitlab.com/Timfa/bluegit/internal/webhook"
21
)
22
23
func TestWebhookPayloads(t *testing.T) {
24
if _, err := exec.LookPath("git"); err != nil {
25
t.Skip("git ontbreekt")
26
}
27
storage := t.TempDir()
28
st, err := store.Open(filepath.Join(storage, "bluegit.db"), bytes32())
29
if err != nil {
30
t.Fatal(err)
31
}
32
t.Cleanup(func() { _ = st.Close() })
33
cfg := config.Config{
34
BaseURL: "http://git.example", Listen: "127.0.0.1:0", StoragePath: storage,
35
Auth: config.Auth{Mode: "dev", DevUser: "tim", DevAuthID: 1, UserAgent: "test", BaseURL: "https://auth.timfalken.com"},
36
Git: config.Git{Binary: "git", DefaultBranch: "master"},
37
}
38
var bodies [][]byte
39
srv := &Server{Cfg: cfg, Store: st, Auth: auth.Dev{Username: "tim", AuthID: 1}, Dev: true, Git: "git", HookBin: "/bin/true"}
40
srv.hookSink = func(b []byte) {
41
bodies = append(bodies, append([]byte(nil), b...))
42
}
43
ts := httptest.NewServer(srv.Handler())
44
t.Cleanup(ts.Close)
45
jar, _ := cookiejar.New(nil)
46
tim := &http.Client{Jar: jar}
47
page := read(t, mustGet(t, tim, ts.URL+"/login"))
48
page = read(t, mustPost(t, tim, ts.URL+"/new/repo", url.Values{
49
"csrf": {csrfOf(t, page)}, "name": {"hooks"}, "visibility": {"public"},
50
}))
51
ctx := context.Background()
52
repo, err := st.RepoByPath(ctx, "tim", "hooks")
53
if err != nil {
54
t.Fatal(err)
55
}
56
if _, err := st.CreateWebhook(ctx, store.Webhook{
57
ScopeKind: "repo", ScopeID: repo.ID, Name: "alles", Preset: "generic",
58
URLTemplate: "https://example.test/hook",
59
Events: []string{"push", "merge_request", "pipeline_failure", "release_published"},
60
}); err != nil {
61
t.Fatal(err)
62
}
63
if err := st.PutSecret(ctx, "repo", repo.ID, "DEPLOY_TOKEN", "super-secret-token", true); err != nil {
64
t.Fatal(err)
65
}
66
67
page = read(t, mustPost(t, tim, ts.URL+"/settings/tokens", url.Values{
68
"csrf": {csrfOf(t, page)}, "name": {"laptop"},
69
}))
70
token := between(page, `<p class="code">`, "</p>")
71
remote := strings.Replace(ts.URL, "http://", "http://tim:"+token+"@", 1) + "/tim/hooks.git"
72
work := t.TempDir()
73
git(t, work, "init", "-b", "master")
74
git(t, work, "config", "user.email", "tim@users.git.timfalken.com")
75
git(t, work, "config", "user.name", "tim")
76
writeFile(t, filepath.Join(work, "README.md"), "a\n")
77
git(t, work, "add", "README.md")
78
git(t, work, "commit", "-m", "eerste regel", "-m", "meer tekst")
79
writeFile(t, filepath.Join(work, "README.md"), "b\n")
80
git(t, work, "add", "README.md")
81
git(t, work, "commit", "-m", "tweede")
82
git(t, work, "remote", "add", "origin", remote)
83
git(t, work, "push", "-u", "origin", "master")
84
85
push := decodeKind(t, bodies, "push")
86
if push["ref"] != "refs/heads/master" || push["before"] != strings.Repeat("0", 40) {
87
t.Fatalf("push ref/before %v", push)
88
}
89
commits := push["commits"].([]any)
90
if len(commits) != 2 {
91
t.Fatalf("commits %d %s", len(commits), mustJSON(t, push))
92
}
93
first := commits[0].(map[string]any)
94
second := commits[1].(map[string]any)
95
if first["message"] != "eerste regel\n\nmeer tekst" || second["message"] != "tweede" {
96
t.Fatalf("berichten %v %v", first["message"], second["message"])
97
}
98
if first["author"] != "tim <tim@users.git.timfalken.com>" || !strings.Contains(first["url"].(string), "/tim/hooks/-/commit/") {
99
t.Fatalf("auteur of url %v", first)
100
}
101
if push["after"] != second["sha"] {
102
t.Fatalf("after %v tip %v", push["after"], second["sha"])
103
}
104
105
git(t, work, "checkout", "-b", "topic")
106
writeFile(t, filepath.Join(work, "extra.txt"), "c\n")
107
git(t, work, "add", "extra.txt")
108
git(t, work, "commit", "-m", "derde")
109
git(t, work, "push", "-u", "origin", "topic")
110
111
page = read(t, mustGet(t, tim, ts.URL+"/tim/hooks/-/merge-requests/new?source=topic&target=master"))
112
page = read(t, mustPost(t, tim, ts.URL+"/tim/hooks/-/merge-requests", url.Values{
113
"csrf": {csrfOf(t, page)}, "source": {"topic"}, "target": {"master"},
114
"title": {"Toon de kloon-URL"}, "description": {"SSH en HTTPS."},
115
}))
116
opened := decodeAction(t, bodies, "opened")
117
mr := opened["merge_request"].(map[string]any)
118
if mr["title"] != "Toon de kloon-URL" || mr["description"] != "SSH en HTTPS." || mr["source_branch"] != "topic" || mr["target_branch"] != "master" || mr["status"] != "open" || mr["author"] != "tim" || mr["id"] != float64(1) {
119
t.Fatalf("opened %s", mustJSON(t, mr))
120
}
121
if _, ok := opened["comment"]; ok {
122
t.Fatalf("opened heeft een comment: %s", mustJSON(t, opened))
123
}
124
125
page = read(t, mustPost(t, tim, ts.URL+"/tim/hooks/-/merge-requests/1/notes", url.Values{
126
"csrf": {csrfOf(t, page)}, "body": {"dit is het commentaar"},
127
}))
128
commented := decodeAction(t, bodies, "commented")
129
if commented["comment"] != "dit is het commentaar" {
130
t.Fatalf("comment %s", mustJSON(t, commented))
131
}
132
133
page = read(t, mustPost(t, tim, ts.URL+"/tim/hooks/-/merge-requests/1/merge", url.Values{
134
"csrf": {csrfOf(t, page)},
135
}))
136
if strings.Contains(page, "flash") && strings.Contains(strings.ToLower(page), "error") {
137
t.Fatalf("merge pagina:\n%s", page)
138
}
139
merged := decodeAction(t, bodies, "merged")
140
if merged["merge_request"].(map[string]any)["status"] != "merged" {
141
t.Fatalf("merged %s", mustJSON(t, merged))
142
}
143
144
sha := second["sha"].(string)
145
id, err := st.CreatePipeline(ctx, repo.ID, sha, "refs/heads/master", "push", "tim", "tweede", []store.NewJob{
146
{Name: "test", Stage: "test", Script: "exit 1"},
147
{Name: "build", Stage: "build", Script: "echo ok"},
148
{Name: "soft", Stage: "test", Script: "exit 1", AllowFailure: true},
149
})
150
if err != nil {
151
t.Fatal(err)
152
}
153
jobs, err := st.JobsByPipeline(ctx, id)
154
if err != nil {
155
t.Fatal(err)
156
}
157
var lines []string
158
for i := 0; i < webhook.LogMaxLines+40; i++ {
159
lines = append(lines, "regel")
160
}
161
lines = append(lines, "token super-secret-token")
162
log := strings.Join(lines, "\n")
163
for _, j := range jobs {
164
if _, err := st.MarkJobRunning(ctx, j.ID); err != nil {
165
t.Fatal(err)
166
}
167
switch j.Name {
168
case "test":
169
if err := st.AppendJobLog(ctx, j.ID, log); err != nil {
170
t.Fatal(err)
171
}
172
if err := st.FinishJob(ctx, j.ID, "failed", ""); err != nil {
173
t.Fatal(err)
174
}
175
case "soft":
176
if err := st.AppendJobLog(ctx, j.ID, "zacht super-secret-token\n"); err != nil {
177
t.Fatal(err)
178
}
179
if err := st.FinishJob(ctx, j.ID, "failed", ""); err != nil {
180
t.Fatal(err)
181
}
182
default:
183
if err := st.FinishJob(ctx, j.ID, "success", ""); err != nil {
184
t.Fatal(err)
185
}
186
}
187
}
188
if _, err := st.RefreshPipelineStatus(ctx, id); err != nil {
189
t.Fatal(err)
190
}
191
before := len(bodies)
192
srv.Dispatch(repo.ID, webhook.Event{
193
Type: webhook.EventPipelineFailure, PipelineID: strconv.FormatInt(id, 10),
194
})
195
if len(bodies) == before {
196
t.Fatal("geen pipeline-payload")
197
}
198
var pipe map[string]any
199
if err := json.Unmarshal(bodies[len(bodies)-1], &pipe); err != nil {
200
t.Fatal(err)
201
}
202
if pipe["object_kind"] != "pipeline" || pipe["type"] != "pipeline_failure" {
203
t.Fatalf("pipeline %s", bodies[len(bodies)-1])
204
}
205
detail := pipe["pipeline"].(map[string]any)
206
if detail["id"] != float64(id) || detail["status"] != "failed" || detail["ref"] != "refs/heads/master" || detail["sha"] != sha || detail["author"] != "tim" {
207
t.Fatalf("detail %s", mustJSON(t, detail))
208
}
209
if !strings.Contains(detail["commit_message"].(string), "tweede") {
210
t.Fatalf("commit_message %v", detail["commit_message"])
211
}
212
if _, ok := detail["duration"]; !ok {
213
t.Fatal("duur ontbreekt")
214
}
215
for _, item := range pipe["jobs"].([]any) {
216
job := item.(map[string]any)
217
raw, _ := json.Marshal(job)
218
if strings.Contains(string(raw), "super-secret-token") {
219
t.Fatalf("geheim in job %s", raw)
220
}
221
switch job["name"] {
222
case "test":
223
if job["log_truncated"] != true || job["allow_failure"] != false {
224
t.Fatalf("test %s", raw)
225
}
226
text := job["log"].(string)
227
if !strings.Contains(text, "[MASKED]") || len(strings.Split(text, "\n")) != webhook.LogMaxLines {
228
t.Fatalf("log %d regels, staart %q", len(strings.Split(text, "\n")), text[max(0, len(text)-40):])
229
}
230
if !strings.Contains(job["log_url"].(string), "/log?raw=1") || !strings.Contains(job["web_url"].(string), "/jobs/") {
231
t.Fatalf("urls %s", raw)
232
}
233
case "build":
234
if _, ok := job["log"]; ok || job["status"] != "success" {
235
t.Fatalf("build %s", raw)
236
}
237
case "soft":
238
if job["allow_failure"] != true || !strings.Contains(job["log"].(string), "[MASKED]") {
239
t.Fatalf("soft %s", raw)
240
}
241
}
242
}
243
244
rel := srv.releaseEvent(repo, "v1.2.0", "BlueGit 1.2.0", sha, []store.ReleaseAsset{{Name: "blue git", Size: 9}})
245
raw, err := webhook.RenderBody("", rel, nil)
246
if err != nil {
247
t.Fatal(err)
248
}
249
var release map[string]any
250
if err := json.Unmarshal(raw, &release); err != nil {
251
t.Fatal(err)
252
}
253
info := release["release"].(map[string]any)
254
asset := info["assets"].([]any)[0].(map[string]any)
255
if info["tag"] != "v1.2.0" || info["name"] != "BlueGit 1.2.0" || info["commit"] != sha || !strings.Contains(asset["url"].(string), "/-/releases/v1.2.0/assets/blue%20git") {
256
t.Fatalf("release %s", raw)
257
}
258
259
if elapsedSeconds(time.Unix(10, 0), time.Unix(12, 0)) != 2 {
260
t.Fatal("duur")
261
}
262
263
infoPage := read(t, mustGet(t, tim, ts.URL+"/-/info"))
264
for _, want := range []string{"Webhook payloads", "log_truncated", "log_url", "/api/v1/webhooks/openapi.json", "commit_message", "source_branch"} {
265
if !strings.Contains(infoPage, want) {
266
t.Errorf("infopagina mist %q", want)
267
}
268
}
269
specRes, err := http.Get(ts.URL + "/api/v1/webhooks/openapi.json")
270
if err != nil {
271
t.Fatal(err)
272
}
273
spec := read(t, specRes)
274
if specRes.StatusCode != 200 || !strings.Contains(spec, `"openapi": "3.1.0"`) || !strings.Contains(spec, "log_truncated") {
275
t.Fatalf("spec %d %s", specRes.StatusCode, spec[:min(200, len(spec))])
276
}
277
}
278
279
func decodeKind(t *testing.T, bodies [][]byte, kind string) map[string]any {
280
t.Helper()
281
for i := len(bodies) - 1; i >= 0; i-- {
282
var doc map[string]any
283
if err := json.Unmarshal(bodies[i], &doc); err != nil {
284
continue
285
}
286
if doc["object_kind"] == kind {
287
return doc
288
}
289
}
290
t.Fatalf("geen %s in %d payloads", kind, len(bodies))
291
return nil
292
}
293
294
func decodeAction(t *testing.T, bodies [][]byte, action string) map[string]any {
295
t.Helper()
296
for i := len(bodies) - 1; i >= 0; i-- {
297
var doc map[string]any
298
if err := json.Unmarshal(bodies[i], &doc); err != nil {
299
continue
300
}
301
mr, _ := doc["merge_request"].(map[string]any)
302
if mr != nil && mr["action"] == action {
303
return doc
304
}
305
}
306
t.Fatalf("geen actie %s", action)
307
return nil
308
}
309
310
func mustJSON(t *testing.T, v any) string {
311
t.Helper()
312
b, err := json.Marshal(v)
313
if err != nil {
314
t.Fatal(err)
315
}
316
return string(b)
317
}
@@ -0,0 +1,317 @@1
package server2
3
import (4
"context"5
"encoding/json"6
"net/http"7
"net/http/cookiejar"8
"net/http/httptest"9
"net/url"10
"os/exec"11
"path/filepath"12
"strconv"13
"strings"14
"testing"15
"time"16
17
"gitlab.com/Timfa/bluegit/internal/auth"18
"gitlab.com/Timfa/bluegit/internal/config"19
"gitlab.com/Timfa/bluegit/internal/store"20
"gitlab.com/Timfa/bluegit/internal/webhook"21
)22
23
func TestWebhookPayloads(t *testing.T) {24
if _, err := exec.LookPath("git"); err != nil {25
t.Skip("git ontbreekt")26
}27
storage := t.TempDir()28
st, err := store.Open(filepath.Join(storage, "bluegit.db"), bytes32())29
if err != nil {30
t.Fatal(err)31
}32
t.Cleanup(func() { _ = st.Close() })33
cfg := config.Config{34
BaseURL: "http://git.example", Listen: "127.0.0.1:0", StoragePath: storage,35
Auth: config.Auth{Mode: "dev", DevUser: "tim", DevAuthID: 1, UserAgent: "test", BaseURL: "https://auth.timfalken.com"},36
Git: config.Git{Binary: "git", DefaultBranch: "master"},37
}38
var bodies [][]byte39
srv := &Server{Cfg: cfg, Store: st, Auth: auth.Dev{Username: "tim", AuthID: 1}, Dev: true, Git: "git", HookBin: "/bin/true"}40
srv.hookSink = func(b []byte) {41
bodies = append(bodies, append([]byte(nil), b...))42
}43
ts := httptest.NewServer(srv.Handler())44
t.Cleanup(ts.Close)45
jar, _ := cookiejar.New(nil)46
tim := &http.Client{Jar: jar}47
page := read(t, mustGet(t, tim, ts.URL+"/login"))48
page = read(t, mustPost(t, tim, ts.URL+"/new/repo", url.Values{49
"csrf": {csrfOf(t, page)}, "name": {"hooks"}, "visibility": {"public"},50
}))51
ctx := context.Background()52
repo, err := st.RepoByPath(ctx, "tim", "hooks")53
if err != nil {54
t.Fatal(err)55
}56
if _, err := st.CreateWebhook(ctx, store.Webhook{57
ScopeKind: "repo", ScopeID: repo.ID, Name: "alles", Preset: "generic",58
URLTemplate: "https://example.test/hook",59
Events: []string{"push", "merge_request", "pipeline_failure", "release_published"},60
}); err != nil {61
t.Fatal(err)62
}63
if err := st.PutSecret(ctx, "repo", repo.ID, "DEPLOY_TOKEN", "super-secret-token", true); err != nil {64
t.Fatal(err)65
}66
67
page = read(t, mustPost(t, tim, ts.URL+"/settings/tokens", url.Values{68
"csrf": {csrfOf(t, page)}, "name": {"laptop"},69
}))70
token := between(page, `<p class="code">`, "</p>")71
remote := strings.Replace(ts.URL, "http://", "http://tim:"+token+"@", 1) + "/tim/hooks.git"72
work := t.TempDir()73
git(t, work, "init", "-b", "master")74
git(t, work, "config", "user.email", "tim@users.git.timfalken.com")75
git(t, work, "config", "user.name", "tim")76
writeFile(t, filepath.Join(work, "README.md"), "a\n")77
git(t, work, "add", "README.md")78
git(t, work, "commit", "-m", "eerste regel", "-m", "meer tekst")79
writeFile(t, filepath.Join(work, "README.md"), "b\n")80
git(t, work, "add", "README.md")81
git(t, work, "commit", "-m", "tweede")82
git(t, work, "remote", "add", "origin", remote)83
git(t, work, "push", "-u", "origin", "master")84
85
push := decodeKind(t, bodies, "push")86
if push["ref"] != "refs/heads/master" || push["before"] != strings.Repeat("0", 40) {87
t.Fatalf("push ref/before %v", push)88
}89
commits := push["commits"].([]any)90
if len(commits) != 2 {91
t.Fatalf("commits %d %s", len(commits), mustJSON(t, push))92
}93
first := commits[0].(map[string]any)94
second := commits[1].(map[string]any)95
if first["message"] != "eerste regel\n\nmeer tekst" || second["message"] != "tweede" {96
t.Fatalf("berichten %v %v", first["message"], second["message"])97
}98
if first["author"] != "tim <tim@users.git.timfalken.com>" || !strings.Contains(first["url"].(string), "/tim/hooks/-/commit/") {99
t.Fatalf("auteur of url %v", first)100
}101
if push["after"] != second["sha"] {102
t.Fatalf("after %v tip %v", push["after"], second["sha"])103
}104
105
git(t, work, "checkout", "-b", "topic")106
writeFile(t, filepath.Join(work, "extra.txt"), "c\n")107
git(t, work, "add", "extra.txt")108
git(t, work, "commit", "-m", "derde")109
git(t, work, "push", "-u", "origin", "topic")110
111
page = read(t, mustGet(t, tim, ts.URL+"/tim/hooks/-/merge-requests/new?source=topic&target=master"))112
page = read(t, mustPost(t, tim, ts.URL+"/tim/hooks/-/merge-requests", url.Values{113
"csrf": {csrfOf(t, page)}, "source": {"topic"}, "target": {"master"},114
"title": {"Toon de kloon-URL"}, "description": {"SSH en HTTPS."},115
}))116
opened := decodeAction(t, bodies, "opened")117
mr := opened["merge_request"].(map[string]any)118
if mr["title"] != "Toon de kloon-URL" || mr["description"] != "SSH en HTTPS." || mr["source_branch"] != "topic" || mr["target_branch"] != "master" || mr["status"] != "open" || mr["author"] != "tim" || mr["id"] != float64(1) {119
t.Fatalf("opened %s", mustJSON(t, mr))120
}121
if _, ok := opened["comment"]; ok {122
t.Fatalf("opened heeft een comment: %s", mustJSON(t, opened))123
}124
125
page = read(t, mustPost(t, tim, ts.URL+"/tim/hooks/-/merge-requests/1/notes", url.Values{126
"csrf": {csrfOf(t, page)}, "body": {"dit is het commentaar"},127
}))128
commented := decodeAction(t, bodies, "commented")129
if commented["comment"] != "dit is het commentaar" {130
t.Fatalf("comment %s", mustJSON(t, commented))131
}132
133
page = read(t, mustPost(t, tim, ts.URL+"/tim/hooks/-/merge-requests/1/merge", url.Values{134
"csrf": {csrfOf(t, page)},135
}))136
if strings.Contains(page, "flash") && strings.Contains(strings.ToLower(page), "error") {137
t.Fatalf("merge pagina:\n%s", page)138
}139
merged := decodeAction(t, bodies, "merged")140
if merged["merge_request"].(map[string]any)["status"] != "merged" {141
t.Fatalf("merged %s", mustJSON(t, merged))142
}143
144
sha := second["sha"].(string)145
id, err := st.CreatePipeline(ctx, repo.ID, sha, "refs/heads/master", "push", "tim", "tweede", []store.NewJob{146
{Name: "test", Stage: "test", Script: "exit 1"},147
{Name: "build", Stage: "build", Script: "echo ok"},148
{Name: "soft", Stage: "test", Script: "exit 1", AllowFailure: true},149
})150
if err != nil {151
t.Fatal(err)152
}153
jobs, err := st.JobsByPipeline(ctx, id)154
if err != nil {155
t.Fatal(err)156
}157
var lines []string158
for i := 0; i < webhook.LogMaxLines+40; i++ {159
lines = append(lines, "regel")160
}161
lines = append(lines, "token super-secret-token")162
log := strings.Join(lines, "\n")163
for _, j := range jobs {164
if _, err := st.MarkJobRunning(ctx, j.ID); err != nil {165
t.Fatal(err)166
}167
switch j.Name {168
case "test":169
if err := st.AppendJobLog(ctx, j.ID, log); err != nil {170
t.Fatal(err)171
}172
if err := st.FinishJob(ctx, j.ID, "failed", ""); err != nil {173
t.Fatal(err)174
}175
case "soft":176
if err := st.AppendJobLog(ctx, j.ID, "zacht super-secret-token\n"); err != nil {177
t.Fatal(err)178
}179
if err := st.FinishJob(ctx, j.ID, "failed", ""); err != nil {180
t.Fatal(err)181
}182
default:183
if err := st.FinishJob(ctx, j.ID, "success", ""); err != nil {184
t.Fatal(err)185
}186
}187
}188
if _, err := st.RefreshPipelineStatus(ctx, id); err != nil {189
t.Fatal(err)190
}191
before := len(bodies)192
srv.Dispatch(repo.ID, webhook.Event{193
Type: webhook.EventPipelineFailure, PipelineID: strconv.FormatInt(id, 10),194
})195
if len(bodies) == before {196
t.Fatal("geen pipeline-payload")197
}198
var pipe map[string]any199
if err := json.Unmarshal(bodies[len(bodies)-1], &pipe); err != nil {200
t.Fatal(err)201
}202
if pipe["object_kind"] != "pipeline" || pipe["type"] != "pipeline_failure" {203
t.Fatalf("pipeline %s", bodies[len(bodies)-1])204
}205
detail := pipe["pipeline"].(map[string]any)206
if detail["id"] != float64(id) || detail["status"] != "failed" || detail["ref"] != "refs/heads/master" || detail["sha"] != sha || detail["author"] != "tim" {207
t.Fatalf("detail %s", mustJSON(t, detail))208
}209
if !strings.Contains(detail["commit_message"].(string), "tweede") {210
t.Fatalf("commit_message %v", detail["commit_message"])211
}212
if _, ok := detail["duration"]; !ok {213
t.Fatal("duur ontbreekt")214
}215
for _, item := range pipe["jobs"].([]any) {216
job := item.(map[string]any)217
raw, _ := json.Marshal(job)218
if strings.Contains(string(raw), "super-secret-token") {219
t.Fatalf("geheim in job %s", raw)220
}221
switch job["name"] {222
case "test":223
if job["log_truncated"] != true || job["allow_failure"] != false {224
t.Fatalf("test %s", raw)225
}226
text := job["log"].(string)227
if !strings.Contains(text, "[MASKED]") || len(strings.Split(text, "\n")) != webhook.LogMaxLines {228
t.Fatalf("log %d regels, staart %q", len(strings.Split(text, "\n")), text[max(0, len(text)-40):])229
}230
if !strings.Contains(job["log_url"].(string), "/log?raw=1") || !strings.Contains(job["web_url"].(string), "/jobs/") {231
t.Fatalf("urls %s", raw)232
}233
case "build":234
if _, ok := job["log"]; ok || job["status"] != "success" {235
t.Fatalf("build %s", raw)236
}237
case "soft":238
if job["allow_failure"] != true || !strings.Contains(job["log"].(string), "[MASKED]") {239
t.Fatalf("soft %s", raw)240
}241
}242
}243
244
rel := srv.releaseEvent(repo, "v1.2.0", "BlueGit 1.2.0", sha, []store.ReleaseAsset{{Name: "blue git", Size: 9}})245
raw, err := webhook.RenderBody("", rel, nil)246
if err != nil {247
t.Fatal(err)248
}249
var release map[string]any250
if err := json.Unmarshal(raw, &release); err != nil {251
t.Fatal(err)252
}253
info := release["release"].(map[string]any)254
asset := info["assets"].([]any)[0].(map[string]any)255
if info["tag"] != "v1.2.0" || info["name"] != "BlueGit 1.2.0" || info["commit"] != sha || !strings.Contains(asset["url"].(string), "/-/releases/v1.2.0/assets/blue%20git") {256
t.Fatalf("release %s", raw)257
}258
259
if elapsedSeconds(time.Unix(10, 0), time.Unix(12, 0)) != 2 {260
t.Fatal("duur")261
}262
263
infoPage := read(t, mustGet(t, tim, ts.URL+"/-/info"))264
for _, want := range []string{"Webhook payloads", "log_truncated", "log_url", "/api/v1/webhooks/openapi.json", "commit_message", "source_branch"} {265
if !strings.Contains(infoPage, want) {266
t.Errorf("infopagina mist %q", want)267
}268
}269
specRes, err := http.Get(ts.URL + "/api/v1/webhooks/openapi.json")270
if err != nil {271
t.Fatal(err)272
}273
spec := read(t, specRes)274
if specRes.StatusCode != 200 || !strings.Contains(spec, `"openapi": "3.1.0"`) || !strings.Contains(spec, "log_truncated") {275
t.Fatalf("spec %d %s", specRes.StatusCode, spec[:min(200, len(spec))])276
}277
}278
279
func decodeKind(t *testing.T, bodies [][]byte, kind string) map[string]any {280
t.Helper()281
for i := len(bodies) - 1; i >= 0; i-- {282
var doc map[string]any283
if err := json.Unmarshal(bodies[i], &doc); err != nil {284
continue285
}286
if doc["object_kind"] == kind {287
return doc288
}289
}290
t.Fatalf("geen %s in %d payloads", kind, len(bodies))291
return nil292
}293
294
func decodeAction(t *testing.T, bodies [][]byte, action string) map[string]any {295
t.Helper()296
for i := len(bodies) - 1; i >= 0; i-- {297
var doc map[string]any298
if err := json.Unmarshal(bodies[i], &doc); err != nil {299
continue300
}301
mr, _ := doc["merge_request"].(map[string]any)302
if mr != nil && mr["action"] == action {303
return doc304
}305
}306
t.Fatalf("geen actie %s", action)307
return nil308
}309
310
func mustJSON(t *testing.T, v any) string {311
t.Helper()312
b, err := json.Marshal(v)313
if err != nil {314
t.Fatal(err)315
}316
return string(b)317
}@@ -7,6 +7,7 @@ import (
7
7
"gitlab.com/Timfa/bluegit/internal/cispec"
8
8
"gitlab.com/Timfa/bluegit/internal/i18n"
9
9
"gitlab.com/Timfa/bluegit/internal/images"
10
"gitlab.com/Timfa/bluegit/internal/webhook"
10
11
)
11
12
12
13
func (s *Server) infoPage(w http.ResponseWriter, r *http.Request) {
@@ -21,10 +22,17 @@ func (s *Server) infoPage(w http.ResponseWriter, r *http.Request) {
21
22
v.Spec = doc
22
23
v.SpecJSON = template.JS(raw)
23
24
v.APIJSON = template.JS(apiIndex())
25
v.HookDoc = webhook.Example()
24
26
s.attachUpdate(&v, s.langOf(r))
25
27
s.render(w, "info", v)
26
28
}
27
29
30
func (s *Server) webhookSpec(w http.ResponseWriter, r *http.Request) {
31
w.Header().Set("Content-Type", "application/json; charset=utf-8")
32
w.Header().Set("Cache-Control", "no-store")
33
_, _ = w.Write(webhook.OpenAPI())
34
}
35
28
36
func (s *Server) ciSpec(w http.ResponseWriter, r *http.Request) {
29
37
lang := i18n.EN
30
38
if q := r.URL.Query().Get("lang"); q != "" {
@@ -7,6 +7,7 @@ import (7
"gitlab.com/Timfa/bluegit/internal/cispec"7
"gitlab.com/Timfa/bluegit/internal/cispec"8
"gitlab.com/Timfa/bluegit/internal/i18n"8
"gitlab.com/Timfa/bluegit/internal/i18n"9
"gitlab.com/Timfa/bluegit/internal/images"9
"gitlab.com/Timfa/bluegit/internal/images"10
"gitlab.com/Timfa/bluegit/internal/webhook"10
)11
)11
12
12
func (s *Server) infoPage(w http.ResponseWriter, r *http.Request) {13
func (s *Server) infoPage(w http.ResponseWriter, r *http.Request) {@@ -21,10 +22,17 @@ func (s *Server) infoPage(w http.ResponseWriter, r *http.Request) {21
v.Spec = doc22
v.Spec = doc22
v.SpecJSON = template.JS(raw)23
v.SpecJSON = template.JS(raw)23
v.APIJSON = template.JS(apiIndex())24
v.APIJSON = template.JS(apiIndex())25
v.HookDoc = webhook.Example()24
s.attachUpdate(&v, s.langOf(r))26
s.attachUpdate(&v, s.langOf(r))25
s.render(w, "info", v)27
s.render(w, "info", v)26
}28
}27
29
30
func (s *Server) webhookSpec(w http.ResponseWriter, r *http.Request) {31
w.Header().Set("Content-Type", "application/json; charset=utf-8")32
w.Header().Set("Cache-Control", "no-store")33
_, _ = w.Write(webhook.OpenAPI())34
}35
28
func (s *Server) ciSpec(w http.ResponseWriter, r *http.Request) {36
func (s *Server) ciSpec(w http.ResponseWriter, r *http.Request) {29
lang := i18n.EN37
lang := i18n.EN30
if q := r.URL.Query().Get("lang"); q != "" {38
if q := r.URL.Query().Get("lang"); q != "" {@@ -241,11 +241,7 @@ func (s *Server) opPublishRelease(ctx context.Context, repo store.Repo, author s
241
241
if err != nil {
242
242
return 0, fail(400, err)
243
243
}
244
s.Dispatch(repo.ID, webhook.Event{
245
Type: webhook.EventRelease, Project: repo.FullPath(), Commit: req.Commit,
246
ReleaseTag: req.Tag, Summary: i18n.T(i18n.EN, "hook.release", req.Tag, repo.FullPath()),
247
URL: strings.TrimRight(s.Cfg.BaseURL, "/") + repoURL(repo) + "/-/releases",
248
})
244
s.Dispatch(repo.ID, s.releaseEvent(repo, req.Tag, req.Name, req.Commit, assets))
249
245
return id, nil
250
246
}
251
247
@@ -241,11 +241,7 @@ func (s *Server) opPublishRelease(ctx context.Context, repo store.Repo, author s241
if err != nil {241
if err != nil {242
return 0, fail(400, err)242
return 0, fail(400, err)243
}243
}244
s.Dispatch(repo.ID, webhook.Event{244
s.Dispatch(repo.ID, s.releaseEvent(repo, req.Tag, req.Name, req.Commit, assets))245
Type: webhook.EventRelease, Project: repo.FullPath(), Commit: req.Commit,246
ReleaseTag: req.Tag, Summary: i18n.T(i18n.EN, "hook.release", req.Tag, repo.FullPath()),247
URL: strings.TrimRight(s.Cfg.BaseURL, "/") + repoURL(repo) + "/-/releases",248
})249
return id, nil245
return id, nil250
}246
}251
247
@@ -38,8 +38,7 @@ func (s *Server) opCreateMR(ctx context.Context, user store.User, repo store.Rep
38
38
if sha := gitOne(ctx, s.Git, dir, "rev-parse", "--verify", "refs/heads/"+source); sha != "" {
39
39
s.startOneMergePipeline(ctx, repo, sha, user.Username, "", mr)
40
40
}
41
num := strconv.FormatInt(mr.Number, 10)
42
s.Dispatch(repo.ID, pushEvent(repo, "merge_request", target, "", user.Username, i18n.T(i18n.EN, "hook.mr", num, mr.Title), repoURL(repo)+"/-/merge-requests/"+num))
41
s.mrHook(repo, mr, user.Username, "opened", "")
43
42
s.recordContribution(user.ID, repo.ID, "merge_request", mrRef(mr.ID), mr.CreatedAt)
44
43
return mr, nil
45
44
}
@@ -94,12 +93,14 @@ func (s *Server) opAddNote(r *http.Request, user store.User, repo store.Repo, nu
94
93
if err != nil {
95
94
return store.Note{}, fail(400, err)
96
95
}
96
s.mrHook(repo, mr, user.Username, "commented", body)
97
97
return note, nil
98
98
}
99
99
note, err := s.Store.AddNote(ctx, repo.ID, mr.ID, user.ID, body)
100
100
if err != nil {
101
101
return store.Note{}, fail(400, err)
102
102
}
103
s.mrHook(repo, mr, user.Username, "commented", body)
103
104
return note, nil
104
105
}
105
106
dir := gitrepo.Dir(s.StoragePath(), repo.OwnerPath, repo.Name)
@@ -118,6 +119,7 @@ func (s *Server) opAddNote(r *http.Request, user store.User, repo store.Repo, nu
118
119
return store.Note{}, fail(400, err)
119
120
}
120
121
s.noteRequestsChanges(r, repo, mr, user.ID, suggestion)
122
s.mrHook(repo, mr, user.Username, "commented", body)
121
123
return note, nil
122
124
}
123
125
@@ -284,6 +286,8 @@ func (s *Server) opMergeMR(r *http.Request, user store.User, repo store.Repo, nu
284
286
}
285
287
_ = s.Store.SetMergeRequestStatus(ctx, mr.ID, "merged")
286
288
_ = s.Store.AddMREvent(ctx, repo.ID, mr.ID, user.ID, "merged", "")
289
mr.Status = "merged"
290
s.mrHook(repo, mr, user.Username, "merged", "")
287
291
return nil
288
292
}
289
293
@@ -38,8 +38,7 @@ func (s *Server) opCreateMR(ctx context.Context, user store.User, repo store.Rep38
if sha := gitOne(ctx, s.Git, dir, "rev-parse", "--verify", "refs/heads/"+source); sha != "" {38
if sha := gitOne(ctx, s.Git, dir, "rev-parse", "--verify", "refs/heads/"+source); sha != "" {39
s.startOneMergePipeline(ctx, repo, sha, user.Username, "", mr)39
s.startOneMergePipeline(ctx, repo, sha, user.Username, "", mr)40
}40
}41
num := strconv.FormatInt(mr.Number, 10)41
s.mrHook(repo, mr, user.Username, "opened", "")42
s.Dispatch(repo.ID, pushEvent(repo, "merge_request", target, "", user.Username, i18n.T(i18n.EN, "hook.mr", num, mr.Title), repoURL(repo)+"/-/merge-requests/"+num))43
s.recordContribution(user.ID, repo.ID, "merge_request", mrRef(mr.ID), mr.CreatedAt)42
s.recordContribution(user.ID, repo.ID, "merge_request", mrRef(mr.ID), mr.CreatedAt)44
return mr, nil43
return mr, nil45
}44
}@@ -94,12 +93,14 @@ func (s *Server) opAddNote(r *http.Request, user store.User, repo store.Repo, nu94
if err != nil {93
if err != nil {95
return store.Note{}, fail(400, err)94
return store.Note{}, fail(400, err)96
}95
}96
s.mrHook(repo, mr, user.Username, "commented", body)97
return note, nil97
return note, nil98
}98
}99
note, err := s.Store.AddNote(ctx, repo.ID, mr.ID, user.ID, body)99
note, err := s.Store.AddNote(ctx, repo.ID, mr.ID, user.ID, body)100
if err != nil {100
if err != nil {101
return store.Note{}, fail(400, err)101
return store.Note{}, fail(400, err)102
}102
}103
s.mrHook(repo, mr, user.Username, "commented", body)103
return note, nil104
return note, nil104
}105
}105
dir := gitrepo.Dir(s.StoragePath(), repo.OwnerPath, repo.Name)106
dir := gitrepo.Dir(s.StoragePath(), repo.OwnerPath, repo.Name)@@ -118,6 +119,7 @@ func (s *Server) opAddNote(r *http.Request, user store.User, repo store.Repo, nu118
return store.Note{}, fail(400, err)119
return store.Note{}, fail(400, err)119
}120
}120
s.noteRequestsChanges(r, repo, mr, user.ID, suggestion)121
s.noteRequestsChanges(r, repo, mr, user.ID, suggestion)122
s.mrHook(repo, mr, user.Username, "commented", body)121
return note, nil123
return note, nil122
}124
}123
125
@@ -284,6 +286,8 @@ func (s *Server) opMergeMR(r *http.Request, user store.User, repo store.Repo, nu284
}286
}285
_ = s.Store.SetMergeRequestStatus(ctx, mr.ID, "merged")287
_ = s.Store.SetMergeRequestStatus(ctx, mr.ID, "merged")286
_ = s.Store.AddMREvent(ctx, repo.ID, mr.ID, user.ID, "merged", "")288
_ = s.Store.AddMREvent(ctx, repo.ID, mr.ID, user.ID, "merged", "")289
mr.Status = "merged"290
s.mrHook(repo, mr, user.Username, "merged", "")287
return nil291
return nil288
}292
}289
293
@@ -41,6 +41,8 @@ type Server struct {
41
41
HookBin string
42
42
Runner *runner.Runner
43
43
Log *slog.Logger
44
// hookSink vangt de JSON-body af in tests, vóór het HTTP-verzoek.
45
hookSink func([]byte)
44
46
// StateDir is de map met database en het bestand storage_path.
45
47
StateDir string
46
48
// AfterStorage krijgt het nieuwe datadisk-pad, voor runner en SSH.
@@ -73,6 +75,7 @@ func (s *Server) Handler() http.Handler {
73
75
s.mountAPI(mux)
74
76
mux.HandleFunc("GET /api/v1/admin/self-update", s.selfUpdateStatus)
75
77
mux.HandleFunc("POST /api/v1/admin/self-update", s.selfUpdate)
78
mux.HandleFunc("GET /api/v1/webhooks/openapi.json", s.webhookSpec)
76
79
mux.HandleFunc("GET /healthz", func(w http.ResponseWriter, r *http.Request) {
77
80
w.WriteHeader(http.StatusOK)
78
81
_, _ = w.Write([]byte("ok\n"))
@@ -541,6 +544,7 @@ type View struct {
541
544
Info bool
542
545
ShowUpdate bool
543
546
Update *UpdateView
547
HookDoc string
544
548
Spec cispec.Doc
545
549
SpecJSON template.JS
546
550
APIJSON template.JS
@@ -41,6 +41,8 @@ type Server struct {41
HookBin string41
HookBin string42
Runner *runner.Runner42
Runner *runner.Runner43
Log *slog.Logger43
Log *slog.Logger44
// hookSink vangt de JSON-body af in tests, vóór het HTTP-verzoek.45
hookSink func([]byte)44
// StateDir is de map met database en het bestand storage_path.46
// StateDir is de map met database en het bestand storage_path.45
StateDir string47
StateDir string46
// AfterStorage krijgt het nieuwe datadisk-pad, voor runner en SSH.48
// AfterStorage krijgt het nieuwe datadisk-pad, voor runner en SSH.@@ -73,6 +75,7 @@ func (s *Server) Handler() http.Handler {73
s.mountAPI(mux)75
s.mountAPI(mux)74
mux.HandleFunc("GET /api/v1/admin/self-update", s.selfUpdateStatus)76
mux.HandleFunc("GET /api/v1/admin/self-update", s.selfUpdateStatus)75
mux.HandleFunc("POST /api/v1/admin/self-update", s.selfUpdate)77
mux.HandleFunc("POST /api/v1/admin/self-update", s.selfUpdate)78
mux.HandleFunc("GET /api/v1/webhooks/openapi.json", s.webhookSpec)76
mux.HandleFunc("GET /healthz", func(w http.ResponseWriter, r *http.Request) {79
mux.HandleFunc("GET /healthz", func(w http.ResponseWriter, r *http.Request) {77
w.WriteHeader(http.StatusOK)80
w.WriteHeader(http.StatusOK)78
_, _ = w.Write([]byte("ok\n"))81
_, _ = w.Write([]byte("ok\n"))@@ -541,6 +544,7 @@ type View struct {541
Info bool544
Info bool542
ShowUpdate bool545
ShowUpdate bool543
Update *UpdateView546
Update *UpdateView547
HookDoc string544
Spec cispec.Doc548
Spec cispec.Doc545
SpecJSON template.JS549
SpecJSON template.JS546
APIJSON template.JS550
APIJSON template.JS@@ -16,7 +16,7 @@ func (s *Server) noStorageText(r *http.Request) string {
16
16
17
17
func allowsWithoutStorage(r *http.Request) bool {
18
18
switch r.URL.Path {
19
case "/healthz", "/login", "/auth/callback", "/logout", "/setup", "/-/info", "/api/v1/ci/spec", "/api/v1/ci/presets", "/api/v1/openapi.json", "/api/v1/admin/storage", "/api/v1/admin/self-update":
19
case "/healthz", "/login", "/auth/callback", "/logout", "/setup", "/-/info", "/api/v1/ci/spec", "/api/v1/ci/presets", "/api/v1/openapi.json", "/api/v1/webhooks/openapi.json", "/api/v1/admin/storage", "/api/v1/admin/self-update":
20
20
return true
21
21
}
22
22
return strings.HasPrefix(r.URL.Path, "/assets/")
@@ -16,7 +16,7 @@ func (s *Server) noStorageText(r *http.Request) string {16
16
17
func allowsWithoutStorage(r *http.Request) bool {17
func allowsWithoutStorage(r *http.Request) bool {18
switch r.URL.Path {18
switch r.URL.Path {19
case "/healthz", "/login", "/auth/callback", "/logout", "/setup", "/-/info", "/api/v1/ci/spec", "/api/v1/ci/presets", "/api/v1/openapi.json", "/api/v1/admin/storage", "/api/v1/admin/self-update":19
case "/healthz", "/login", "/auth/callback", "/logout", "/setup", "/-/info", "/api/v1/ci/spec", "/api/v1/ci/presets", "/api/v1/openapi.json", "/api/v1/webhooks/openapi.json", "/api/v1/admin/storage", "/api/v1/admin/self-update":20
return true20
return true21
}21
}22
return strings.HasPrefix(r.URL.Path, "/assets/")22
return strings.HasPrefix(r.URL.Path, "/assets/")@@ -58,6 +58,10 @@
58
58
<p>{{t "info.api.auth"}}</p>
59
59
<p>{{t "info.api.ssh"}}</p>
60
60
<p><a href="/api/v1/openapi.json">{{t "info.api.spec"}}</a></p>
61
<h2 id="webhooks">{{t "info.sec.webhooks"}}</h2>
62
<p>{{t "info.wh.lead"}}</p>
63
<p><a href="/api/v1/webhooks/openapi.json">{{t "info.wh.spec"}}</a></p>
64
<pre class="spec-example">{{.HookDoc}}</pre>
61
65
<script type="application/json" id="bluegit-ci-spec">{{.SpecJSON}}</script>
62
66
<script type="application/json" id="bluegit-api">{{.APIJSON}}</script>
63
67
</article>
@@ -58,6 +58,10 @@58
<p>{{t "info.api.auth"}}</p>58
<p>{{t "info.api.auth"}}</p>59
<p>{{t "info.api.ssh"}}</p>59
<p>{{t "info.api.ssh"}}</p>60
<p><a href="/api/v1/openapi.json">{{t "info.api.spec"}}</a></p>60
<p><a href="/api/v1/openapi.json">{{t "info.api.spec"}}</a></p>61
<h2 id="webhooks">{{t "info.sec.webhooks"}}</h2>62
<p>{{t "info.wh.lead"}}</p>63
<p><a href="/api/v1/webhooks/openapi.json">{{t "info.wh.spec"}}</a></p>64
<pre class="spec-example">{{.HookDoc}}</pre>61
<script type="application/json" id="bluegit-ci-spec">{{.SpecJSON}}</script>65
<script type="application/json" id="bluegit-ci-spec">{{.SpecJSON}}</script>62
<script type="application/json" id="bluegit-api">{{.APIJSON}}</script>66
<script type="application/json" id="bluegit-api">{{.APIJSON}}</script>63
</article>67
</article>@@ -0,0 +1,152 @@
1
package webhook
2
3
import "encoding/json"
4
5
// OpenAPI beschrijft de JSON-body die een webhook ontvangt.
6
func OpenAPI() []byte {
7
obj := func(desc string, props map[string]any, required []string) map[string]any {
8
return map[string]any{
9
"type": "object", "description": desc,
10
"properties": props, "required": required,
11
}
12
}
13
str := func(desc string) map[string]any {
14
return map[string]any{"type": "string", "description": desc}
15
}
16
num := func(desc string) map[string]any {
17
return map[string]any{"type": "number", "description": desc}
18
}
19
boolean := func(desc string) map[string]any {
20
return map[string]any{"type": "boolean", "description": desc}
21
}
22
post := func(summary, ref string) map[string]any {
23
return map[string]any{
24
"post": map[string]any{
25
"summary": summary,
26
"requestBody": map[string]any{
27
"required": true,
28
"content": map[string]any{
29
"application/json": map[string]any{
30
"schema": map[string]any{"$ref": ref},
31
},
32
},
33
},
34
"responses": map[string]any{"200": map[string]any{"description": "The receiver accepted the event."}},
35
},
36
}
37
}
38
doc := map[string]any{
39
"openapi": "3.1.0",
40
"info": map[string]any{
41
"title": "BlueGit webhook payloads",
42
"version": "1",
43
"description": "JSON body of a BlueGit webhook when the body template is empty. " +
44
"pipeline_success and pipeline_failure include the pipeline and every job. " +
45
"A failed job adds the last 200 log lines, at most 64 KiB. Secret values of at least 8 characters are replaced with [MASKED]. " +
46
"log_truncated is true when the log was cut. log_url is the full log. " +
47
"A push lists ref, before, after and up to 20 commits. " +
48
"A merge request uses action opened, merged or commented, and commented includes the comment text. " +
49
"A release lists the tag, name, commit and asset URLs.",
50
},
51
"webhooks": map[string]any{
52
"pipeline": post("Pipeline finished", "#/components/schemas/PipelineEvent"),
53
"push": post("Push", "#/components/schemas/PushEvent"),
54
"merge_request": post("Merge request", "#/components/schemas/MergeRequestEvent"),
55
"release": post("Release published", "#/components/schemas/ReleaseEvent"),
56
},
57
"components": map[string]any{
58
"schemas": map[string]any{
59
"PipelineEvent": obj("pipeline_success or pipeline_failure.", map[string]any{
60
"object_kind": str("Always pipeline."),
61
"type": str("pipeline_success or pipeline_failure."),
62
"project": str("owner/name."),
63
"actor": str("User who started the pipeline."),
64
"summary": str("One-line summary."),
65
"url": str("Pipeline page."),
66
"pipeline_id": str("Same id as pipeline.id, as text."),
67
"pipeline": map[string]any{"$ref": "#/components/schemas/Pipeline"},
68
"jobs": map[string]any{"type": "array", "items": map[string]any{"$ref": "#/components/schemas/Job"}},
69
}, []string{"object_kind", "type", "project", "pipeline", "jobs"}),
70
"Pipeline": obj("The pipeline this event is about.", map[string]any{
71
"id": map[string]any{"type": "integer", "description": "Pipeline id."},
72
"status": str("success or failed."),
73
"ref": str("Full ref, such as refs/heads/master."),
74
"sha": str("Commit SHA."),
75
"commit_message": str("Subject and body of the commit."),
76
"author": str("User who started the pipeline."),
77
"duration": num("Seconds from start to finish."),
78
"url": str("Pipeline page."),
79
}, []string{"id", "status", "ref", "sha", "commit_message", "author", "duration"}),
80
"Job": obj("One job. log, log_truncated and log_url are present only when status is failed.", map[string]any{
81
"name": str("Job name."),
82
"stage": str("Stage name."),
83
"status": str("Job status."),
84
"duration": num("Seconds the job ran."),
85
"allow_failure": boolean("True when a failure does not fail the pipeline."),
86
"web_url": str("Job page."),
87
"log": str("Tail of the console output."),
88
"log_truncated": boolean("True when log is not the full console output."),
89
"log_url": str("Plain-text URL of the full log."),
90
}, []string{"name", "stage", "status", "duration", "allow_failure", "web_url"}),
91
"PushEvent": obj("A branch or tag update.", map[string]any{
92
"object_kind": str("Always push."),
93
"type": str("Always push."),
94
"project": str("owner/name."),
95
"actor": str("User who pushed."),
96
"ref": str("Full ref."),
97
"before": str("Previous SHA, or 40 zeros when the ref is new."),
98
"after": str("New SHA."),
99
"commits": map[string]any{"type": "array", "items": map[string]any{"$ref": "#/components/schemas/Commit"}},
100
}, []string{"object_kind", "type", "project", "ref", "before", "after", "commits"}),
101
"Commit": obj("One commit made reachable by the push.", map[string]any{
102
"sha": str("Commit SHA."),
103
"message": str("Subject and body."),
104
"author": str("Name and email."),
105
"url": str("Commit page."),
106
}, []string{"sha", "message", "author", "url"}),
107
"MergeRequestEvent": obj("Opened, merged or commented.", map[string]any{
108
"object_kind": str("Always merge_request."),
109
"type": str("Always merge_request."),
110
"project": str("owner/name."),
111
"actor": str("User who did this action."),
112
"merge_request": map[string]any{"$ref": "#/components/schemas/MergeRequest"},
113
"comment": str("Comment text. Present only when action is commented."),
114
}, []string{"object_kind", "type", "project", "merge_request"}),
115
"MergeRequest": obj("The merge request.", map[string]any{
116
"id": map[string]any{"type": "integer", "description": "Number in the project."},
117
"title": str("Title."),
118
"description": str("Description. May be empty."),
119
"source_branch": str("Source branch."),
120
"target_branch": str("Target branch."),
121
"status": str("open, merged or closed."),
122
"author": str("User who opened the merge request."),
123
"action": str("opened, merged or commented."),
124
"url": str("Merge request page."),
125
}, []string{"id", "title", "description", "source_branch", "target_branch", "status", "author", "action"}),
126
"ReleaseEvent": obj("A published release.", map[string]any{
127
"object_kind": str("Always release."),
128
"type": str("Always release_published."),
129
"project": str("owner/name."),
130
"release_tag": str("Same value as release.tag."),
131
"release": map[string]any{"$ref": "#/components/schemas/Release"},
132
}, []string{"object_kind", "type", "project", "release"}),
133
"Release": obj("The release.", map[string]any{
134
"tag": str("Tag name."),
135
"name": str("Release title."),
136
"commit": str("Commit SHA."),
137
"assets": map[string]any{"type": "array", "items": map[string]any{"$ref": "#/components/schemas/Asset"}},
138
}, []string{"tag", "name", "commit", "assets"}),
139
"Asset": obj("A file attached to the release.", map[string]any{
140
"name": str("File name."),
141
"url": str("Download URL."),
142
"size": map[string]any{"type": "integer", "description": "Size in bytes."},
143
}, []string{"name", "url", "size"}),
144
},
145
},
146
}
147
raw, err := json.MarshalIndent(doc, "", " ")
148
if err != nil {
149
return []byte("{}\n")
150
}
151
return append(raw, '\n')
152
}
@@ -0,0 +1,152 @@1
package webhook2
3
import "encoding/json"4
5
// OpenAPI beschrijft de JSON-body die een webhook ontvangt.6
func OpenAPI() []byte {7
obj := func(desc string, props map[string]any, required []string) map[string]any {8
return map[string]any{9
"type": "object", "description": desc,10
"properties": props, "required": required,11
}12
}13
str := func(desc string) map[string]any {14
return map[string]any{"type": "string", "description": desc}15
}16
num := func(desc string) map[string]any {17
return map[string]any{"type": "number", "description": desc}18
}19
boolean := func(desc string) map[string]any {20
return map[string]any{"type": "boolean", "description": desc}21
}22
post := func(summary, ref string) map[string]any {23
return map[string]any{24
"post": map[string]any{25
"summary": summary,26
"requestBody": map[string]any{27
"required": true,28
"content": map[string]any{29
"application/json": map[string]any{30
"schema": map[string]any{"$ref": ref},31
},32
},33
},34
"responses": map[string]any{"200": map[string]any{"description": "The receiver accepted the event."}},35
},36
}37
}38
doc := map[string]any{39
"openapi": "3.1.0",40
"info": map[string]any{41
"title": "BlueGit webhook payloads",42
"version": "1",43
"description": "JSON body of a BlueGit webhook when the body template is empty. " +44
"pipeline_success and pipeline_failure include the pipeline and every job. " +45
"A failed job adds the last 200 log lines, at most 64 KiB. Secret values of at least 8 characters are replaced with [MASKED]. " +46
"log_truncated is true when the log was cut. log_url is the full log. " +47
"A push lists ref, before, after and up to 20 commits. " +48
"A merge request uses action opened, merged or commented, and commented includes the comment text. " +49
"A release lists the tag, name, commit and asset URLs.",50
},51
"webhooks": map[string]any{52
"pipeline": post("Pipeline finished", "#/components/schemas/PipelineEvent"),53
"push": post("Push", "#/components/schemas/PushEvent"),54
"merge_request": post("Merge request", "#/components/schemas/MergeRequestEvent"),55
"release": post("Release published", "#/components/schemas/ReleaseEvent"),56
},57
"components": map[string]any{58
"schemas": map[string]any{59
"PipelineEvent": obj("pipeline_success or pipeline_failure.", map[string]any{60
"object_kind": str("Always pipeline."),61
"type": str("pipeline_success or pipeline_failure."),62
"project": str("owner/name."),63
"actor": str("User who started the pipeline."),64
"summary": str("One-line summary."),65
"url": str("Pipeline page."),66
"pipeline_id": str("Same id as pipeline.id, as text."),67
"pipeline": map[string]any{"$ref": "#/components/schemas/Pipeline"},68
"jobs": map[string]any{"type": "array", "items": map[string]any{"$ref": "#/components/schemas/Job"}},69
}, []string{"object_kind", "type", "project", "pipeline", "jobs"}),70
"Pipeline": obj("The pipeline this event is about.", map[string]any{71
"id": map[string]any{"type": "integer", "description": "Pipeline id."},72
"status": str("success or failed."),73
"ref": str("Full ref, such as refs/heads/master."),74
"sha": str("Commit SHA."),75
"commit_message": str("Subject and body of the commit."),76
"author": str("User who started the pipeline."),77
"duration": num("Seconds from start to finish."),78
"url": str("Pipeline page."),79
}, []string{"id", "status", "ref", "sha", "commit_message", "author", "duration"}),80
"Job": obj("One job. log, log_truncated and log_url are present only when status is failed.", map[string]any{81
"name": str("Job name."),82
"stage": str("Stage name."),83
"status": str("Job status."),84
"duration": num("Seconds the job ran."),85
"allow_failure": boolean("True when a failure does not fail the pipeline."),86
"web_url": str("Job page."),87
"log": str("Tail of the console output."),88
"log_truncated": boolean("True when log is not the full console output."),89
"log_url": str("Plain-text URL of the full log."),90
}, []string{"name", "stage", "status", "duration", "allow_failure", "web_url"}),91
"PushEvent": obj("A branch or tag update.", map[string]any{92
"object_kind": str("Always push."),93
"type": str("Always push."),94
"project": str("owner/name."),95
"actor": str("User who pushed."),96
"ref": str("Full ref."),97
"before": str("Previous SHA, or 40 zeros when the ref is new."),98
"after": str("New SHA."),99
"commits": map[string]any{"type": "array", "items": map[string]any{"$ref": "#/components/schemas/Commit"}},100
}, []string{"object_kind", "type", "project", "ref", "before", "after", "commits"}),101
"Commit": obj("One commit made reachable by the push.", map[string]any{102
"sha": str("Commit SHA."),103
"message": str("Subject and body."),104
"author": str("Name and email."),105
"url": str("Commit page."),106
}, []string{"sha", "message", "author", "url"}),107
"MergeRequestEvent": obj("Opened, merged or commented.", map[string]any{108
"object_kind": str("Always merge_request."),109
"type": str("Always merge_request."),110
"project": str("owner/name."),111
"actor": str("User who did this action."),112
"merge_request": map[string]any{"$ref": "#/components/schemas/MergeRequest"},113
"comment": str("Comment text. Present only when action is commented."),114
}, []string{"object_kind", "type", "project", "merge_request"}),115
"MergeRequest": obj("The merge request.", map[string]any{116
"id": map[string]any{"type": "integer", "description": "Number in the project."},117
"title": str("Title."),118
"description": str("Description. May be empty."),119
"source_branch": str("Source branch."),120
"target_branch": str("Target branch."),121
"status": str("open, merged or closed."),122
"author": str("User who opened the merge request."),123
"action": str("opened, merged or commented."),124
"url": str("Merge request page."),125
}, []string{"id", "title", "description", "source_branch", "target_branch", "status", "author", "action"}),126
"ReleaseEvent": obj("A published release.", map[string]any{127
"object_kind": str("Always release."),128
"type": str("Always release_published."),129
"project": str("owner/name."),130
"release_tag": str("Same value as release.tag."),131
"release": map[string]any{"$ref": "#/components/schemas/Release"},132
}, []string{"object_kind", "type", "project", "release"}),133
"Release": obj("The release.", map[string]any{134
"tag": str("Tag name."),135
"name": str("Release title."),136
"commit": str("Commit SHA."),137
"assets": map[string]any{"type": "array", "items": map[string]any{"$ref": "#/components/schemas/Asset"}},138
}, []string{"tag", "name", "commit", "assets"}),139
"Asset": obj("A file attached to the release.", map[string]any{140
"name": str("File name."),141
"url": str("Download URL."),142
"size": map[string]any{"type": "integer", "description": "Size in bytes."},143
}, []string{"name", "url", "size"}),144
},145
},146
}147
raw, err := json.MarshalIndent(doc, "", " ")148
if err != nil {149
return []byte("{}\n")150
}151
return append(raw, '\n')152
}@@ -0,0 +1,270 @@
1
package webhook
2
3
import (
4
"encoding/json"
5
"strings"
6
7
"gitlab.com/Timfa/bluegit/internal/ci"
8
)
9
10
// Grenzen voor wat een webhook van een gefaalde job meestuurt.
11
const (
12
LogMaxLines = 200
13
LogMaxBytes = 64 << 10
14
)
15
16
// MaxPushCommits is het aantal commits in een push-payload.
17
// Dat zijn de nieuwste in het bereik, oudste eerst.
18
const MaxPushCommits = 20
19
20
// Document is de JSON-body van een webhook zonder eigen sjabloon.
21
type Document struct {
22
ObjectKind string `json:"object_kind"`
23
Type string `json:"type"`
24
Project string `json:"project"`
25
Group string `json:"group,omitempty"`
26
Actor string `json:"actor,omitempty"`
27
Summary string `json:"summary,omitempty"`
28
URL string `json:"url,omitempty"`
29
Branch string `json:"branch,omitempty"`
30
Commit string `json:"commit,omitempty"`
31
PipelineID string `json:"pipeline_id,omitempty"`
32
ReleaseTag string `json:"release_tag,omitempty"`
33
34
Pipeline *PipelineInfo `json:"pipeline,omitempty"`
35
Jobs *[]JobInfo `json:"jobs,omitempty"`
36
37
Ref string `json:"ref,omitempty"`
38
Before string `json:"before,omitempty"`
39
After string `json:"after,omitempty"`
40
Commits *[]CommitInfo `json:"commits,omitempty"`
41
42
MergeRequest *MRInfo `json:"merge_request,omitempty"`
43
Comment string `json:"comment,omitempty"`
44
45
Release *ReleaseInfo `json:"release,omitempty"`
46
}
47
48
// PipelineInfo is de pipeline waar het event over gaat.
49
type PipelineInfo struct {
50
ID int64 `json:"id"`
51
Status string `json:"status"`
52
Ref string `json:"ref"`
53
SHA string `json:"sha"`
54
CommitMessage string `json:"commit_message"`
55
Author string `json:"author"`
56
Duration float64 `json:"duration"`
57
URL string `json:"url,omitempty"`
58
}
59
60
// JobInfo is één job in een pipeline-event.
61
// Log, log_truncated en log_url staan er alleen bij een gefaalde job.
62
type JobInfo struct {
63
Name string `json:"name"`
64
Stage string `json:"stage"`
65
Status string `json:"status"`
66
Duration float64 `json:"duration"`
67
AllowFailure bool `json:"allow_failure"`
68
WebURL string `json:"web_url"`
69
Log string `json:"log,omitempty"`
70
LogTruncated *bool `json:"log_truncated,omitempty"`
71
LogURL string `json:"log_url,omitempty"`
72
}
73
74
// CommitInfo is één commit in een push.
75
type CommitInfo struct {
76
SHA string `json:"sha"`
77
Message string `json:"message"`
78
Author string `json:"author"`
79
URL string `json:"url"`
80
}
81
82
// MRInfo is de merge request van het event.
83
type MRInfo struct {
84
ID int64 `json:"id"`
85
Title string `json:"title"`
86
Description string `json:"description"`
87
SourceBranch string `json:"source_branch"`
88
TargetBranch string `json:"target_branch"`
89
Status string `json:"status"`
90
Author string `json:"author"`
91
Action string `json:"action"`
92
URL string `json:"url,omitempty"`
93
}
94
95
// ReleaseInfo is een gepubliceerde release.
96
type ReleaseInfo struct {
97
Tag string `json:"tag"`
98
Name string `json:"name"`
99
Commit string `json:"commit"`
100
Assets []AssetInfo `json:"assets"`
101
}
102
103
// AssetInfo is een bestand bij een release.
104
type AssetInfo struct {
105
Name string `json:"name"`
106
URL string `json:"url"`
107
Size int64 `json:"size"`
108
}
109
110
// Document bouwt de JSON-structuur. Lege deelobjecten blijven weg.
111
func (ev Event) Document() Document {
112
d := Document{
113
ObjectKind: objectKind(ev.Type),
114
Type: ev.Type,
115
Project: ev.Project,
116
Group: ev.Group,
117
Actor: ev.Actor,
118
Summary: ev.Summary,
119
URL: ev.URL,
120
Branch: ev.Branch,
121
Commit: ev.Commit,
122
PipelineID: ev.PipelineID,
123
ReleaseTag: ev.ReleaseTag,
124
Pipeline: ev.Pipeline,
125
Ref: ev.Ref,
126
Before: ev.Before,
127
After: ev.After,
128
MergeRequest: ev.MergeRequest,
129
Release: ev.Release,
130
}
131
switch ev.Type {
132
case EventPush:
133
commits := ev.Commits
134
if commits == nil {
135
commits = []CommitInfo{}
136
}
137
d.Commits = &commits
138
case EventPipelineSuccess, EventPipelineFailure:
139
jobs := ev.Jobs
140
if jobs == nil {
141
jobs = []JobInfo{}
142
}
143
d.Jobs = &jobs
144
case EventMergeRequest:
145
if ev.MergeRequest != nil && ev.MergeRequest.Action == "commented" {
146
d.Comment = ev.Comment
147
}
148
}
149
if d.Release != nil && d.Release.Assets == nil {
150
rel := *d.Release
151
rel.Assets = []AssetInfo{}
152
d.Release = &rel
153
}
154
return d
155
}
156
157
func objectKind(eventType string) string {
158
switch eventType {
159
case EventPipelineSuccess, EventPipelineFailure:
160
return "pipeline"
161
case EventRelease:
162
return "release"
163
case EventMergeRequest:
164
return "merge_request"
165
default:
166
return eventType
167
}
168
}
169
170
// TailLog houdt de laatste LogMaxLines regels en hoogstens LogMaxBytes.
171
// Geheimwaarden van minstens 8 tekens worden [MASKED], net als in de joblog.
172
// truncated is true zodra er regels of bytes af zijn.
173
func TailLog(text string, secrets []string) (string, bool) {
174
text = ci.Mask(text, secrets)
175
if text == "" {
176
return "", false
177
}
178
truncated := false
179
lines := strings.Split(text, "\n")
180
if len(lines) > LogMaxLines {
181
lines = lines[len(lines)-LogMaxLines:]
182
truncated = true
183
}
184
out := strings.Join(lines, "\n")
185
if len(out) > LogMaxBytes {
186
out = cutUTF8Tail(out, LogMaxBytes)
187
truncated = true
188
}
189
return out, truncated
190
}
191
192
func cutUTF8Tail(s string, max int) string {
193
if len(s) <= max {
194
return s
195
}
196
s = s[len(s)-max:]
197
for len(s) > 0 && s[0]&0xC0 == 0x80 {
198
s = s[1:]
199
}
200
return s
201
}
202
203
// Example is het voorbeeld op de infopagina.
204
func Example() string {
205
trunc := true
206
samples := []Event{
207
{
208
Type: EventPipelineFailure, Project: "tim/app", Actor: "tim",
209
Summary: "pipeline #26 voor tim/app is mislukt",
210
URL: "https://git.example/tim/app/-/pipelines/26",
211
Branch: "master", Commit: "725e6947", PipelineID: "26",
212
Pipeline: &PipelineInfo{
213
ID: 26, Status: "failed", Ref: "refs/heads/master", SHA: "725e6947",
214
CommitMessage: "fix de build", Author: "tim", Duration: 12.4,
215
URL: "https://git.example/tim/app/-/pipelines/26",
216
},
217
Jobs: []JobInfo{
218
{
219
Name: "test", Stage: "test", Status: "failed", Duration: 4.1,
220
AllowFailure: false, WebURL: "https://git.example/tim/app/-/pipelines/26/jobs/7",
221
Log: "go: token [MASKED]\nFAIL", LogTruncated: &trunc,
222
LogURL: "https://git.example/tim/app/-/pipelines/26/jobs/7/log?raw=1",
223
},
224
{
225
Name: "build", Stage: "build", Status: "skipped", Duration: 0,
226
WebURL: "https://git.example/tim/app/-/pipelines/26/jobs/8",
227
},
228
},
229
},
230
{
231
Type: EventPush, Project: "tim/app", Actor: "tim", Branch: "master",
232
Ref: "refs/heads/master", Before: strings.Repeat("0", 40), After: "abc123",
233
Commits: []CommitInfo{{
234
SHA: "abc123", Message: "fix de build", Author: "Tim <tim@example.com>",
235
URL: "https://git.example/tim/app/-/commit/abc123",
236
}},
237
},
238
{
239
Type: EventMergeRequest, Project: "tim/app", Actor: "ada",
240
MergeRequest: &MRInfo{
241
ID: 4, Title: "Toon de kloon-URL", Description: "SSH en HTTPS.",
242
SourceBranch: "feature", TargetBranch: "master", Status: "open",
243
Author: "ada", Action: "opened",
244
URL: "https://git.example/tim/app/-/merge-requests/4",
245
},
246
},
247
{
248
Type: EventRelease, Project: "tim/app", ReleaseTag: "v1.2.0", Commit: "abc123",
249
Release: &ReleaseInfo{
250
Tag: "v1.2.0", Name: "BlueGit 1.2.0", Commit: "abc123",
251
Assets: []AssetInfo{{
252
Name: "bluegit", Size: 8123456,
253
URL: "https://git.example/tim/app/-/releases/v1.2.0/assets/bluegit",
254
}},
255
},
256
},
257
}
258
var b strings.Builder
259
for i, ev := range samples {
260
if i > 0 {
261
b.WriteString("\n\n")
262
}
263
raw, err := json.MarshalIndent(ev.Document(), "", " ")
264
if err != nil {
265
continue
266
}
267
b.Write(raw)
268
}
269
return b.String()
270
}
@@ -0,0 +1,270 @@1
package webhook2
3
import (4
"encoding/json"5
"strings"6
7
"gitlab.com/Timfa/bluegit/internal/ci"8
)9
10
// Grenzen voor wat een webhook van een gefaalde job meestuurt.11
const (12
LogMaxLines = 20013
LogMaxBytes = 64 << 1014
)15
16
// MaxPushCommits is het aantal commits in een push-payload.17
// Dat zijn de nieuwste in het bereik, oudste eerst.18
const MaxPushCommits = 2019
20
// Document is de JSON-body van een webhook zonder eigen sjabloon.21
type Document struct {22
ObjectKind string `json:"object_kind"`23
Type string `json:"type"`24
Project string `json:"project"`25
Group string `json:"group,omitempty"`26
Actor string `json:"actor,omitempty"`27
Summary string `json:"summary,omitempty"`28
URL string `json:"url,omitempty"`29
Branch string `json:"branch,omitempty"`30
Commit string `json:"commit,omitempty"`31
PipelineID string `json:"pipeline_id,omitempty"`32
ReleaseTag string `json:"release_tag,omitempty"`33
34
Pipeline *PipelineInfo `json:"pipeline,omitempty"`35
Jobs *[]JobInfo `json:"jobs,omitempty"`36
37
Ref string `json:"ref,omitempty"`38
Before string `json:"before,omitempty"`39
After string `json:"after,omitempty"`40
Commits *[]CommitInfo `json:"commits,omitempty"`41
42
MergeRequest *MRInfo `json:"merge_request,omitempty"`43
Comment string `json:"comment,omitempty"`44
45
Release *ReleaseInfo `json:"release,omitempty"`46
}47
48
// PipelineInfo is de pipeline waar het event over gaat.49
type PipelineInfo struct {50
ID int64 `json:"id"`51
Status string `json:"status"`52
Ref string `json:"ref"`53
SHA string `json:"sha"`54
CommitMessage string `json:"commit_message"`55
Author string `json:"author"`56
Duration float64 `json:"duration"`57
URL string `json:"url,omitempty"`58
}59
60
// JobInfo is één job in een pipeline-event.61
// Log, log_truncated en log_url staan er alleen bij een gefaalde job.62
type JobInfo struct {63
Name string `json:"name"`64
Stage string `json:"stage"`65
Status string `json:"status"`66
Duration float64 `json:"duration"`67
AllowFailure bool `json:"allow_failure"`68
WebURL string `json:"web_url"`69
Log string `json:"log,omitempty"`70
LogTruncated *bool `json:"log_truncated,omitempty"`71
LogURL string `json:"log_url,omitempty"`72
}73
74
// CommitInfo is één commit in een push.75
type CommitInfo struct {76
SHA string `json:"sha"`77
Message string `json:"message"`78
Author string `json:"author"`79
URL string `json:"url"`80
}81
82
// MRInfo is de merge request van het event.83
type MRInfo struct {84
ID int64 `json:"id"`85
Title string `json:"title"`86
Description string `json:"description"`87
SourceBranch string `json:"source_branch"`88
TargetBranch string `json:"target_branch"`89
Status string `json:"status"`90
Author string `json:"author"`91
Action string `json:"action"`92
URL string `json:"url,omitempty"`93
}94
95
// ReleaseInfo is een gepubliceerde release.96
type ReleaseInfo struct {97
Tag string `json:"tag"`98
Name string `json:"name"`99
Commit string `json:"commit"`100
Assets []AssetInfo `json:"assets"`101
}102
103
// AssetInfo is een bestand bij een release.104
type AssetInfo struct {105
Name string `json:"name"`106
URL string `json:"url"`107
Size int64 `json:"size"`108
}109
110
// Document bouwt de JSON-structuur. Lege deelobjecten blijven weg.111
func (ev Event) Document() Document {112
d := Document{113
ObjectKind: objectKind(ev.Type),114
Type: ev.Type,115
Project: ev.Project,116
Group: ev.Group,117
Actor: ev.Actor,118
Summary: ev.Summary,119
URL: ev.URL,120
Branch: ev.Branch,121
Commit: ev.Commit,122
PipelineID: ev.PipelineID,123
ReleaseTag: ev.ReleaseTag,124
Pipeline: ev.Pipeline,125
Ref: ev.Ref,126
Before: ev.Before,127
After: ev.After,128
MergeRequest: ev.MergeRequest,129
Release: ev.Release,130
}131
switch ev.Type {132
case EventPush:133
commits := ev.Commits134
if commits == nil {135
commits = []CommitInfo{}136
}137
d.Commits = &commits138
case EventPipelineSuccess, EventPipelineFailure:139
jobs := ev.Jobs140
if jobs == nil {141
jobs = []JobInfo{}142
}143
d.Jobs = &jobs144
case EventMergeRequest:145
if ev.MergeRequest != nil && ev.MergeRequest.Action == "commented" {146
d.Comment = ev.Comment147
}148
}149
if d.Release != nil && d.Release.Assets == nil {150
rel := *d.Release151
rel.Assets = []AssetInfo{}152
d.Release = &rel153
}154
return d155
}156
157
func objectKind(eventType string) string {158
switch eventType {159
case EventPipelineSuccess, EventPipelineFailure:160
return "pipeline"161
case EventRelease:162
return "release"163
case EventMergeRequest:164
return "merge_request"165
default:166
return eventType167
}168
}169
170
// TailLog houdt de laatste LogMaxLines regels en hoogstens LogMaxBytes.171
// Geheimwaarden van minstens 8 tekens worden [MASKED], net als in de joblog.172
// truncated is true zodra er regels of bytes af zijn.173
func TailLog(text string, secrets []string) (string, bool) {174
text = ci.Mask(text, secrets)175
if text == "" {176
return "", false177
}178
truncated := false179
lines := strings.Split(text, "\n")180
if len(lines) > LogMaxLines {181
lines = lines[len(lines)-LogMaxLines:]182
truncated = true183
}184
out := strings.Join(lines, "\n")185
if len(out) > LogMaxBytes {186
out = cutUTF8Tail(out, LogMaxBytes)187
truncated = true188
}189
return out, truncated190
}191
192
func cutUTF8Tail(s string, max int) string {193
if len(s) <= max {194
return s195
}196
s = s[len(s)-max:]197
for len(s) > 0 && s[0]&0xC0 == 0x80 {198
s = s[1:]199
}200
return s201
}202
203
// Example is het voorbeeld op de infopagina.204
func Example() string {205
trunc := true206
samples := []Event{207
{208
Type: EventPipelineFailure, Project: "tim/app", Actor: "tim",209
Summary: "pipeline #26 voor tim/app is mislukt",210
URL: "https://git.example/tim/app/-/pipelines/26",211
Branch: "master", Commit: "725e6947", PipelineID: "26",212
Pipeline: &PipelineInfo{213
ID: 26, Status: "failed", Ref: "refs/heads/master", SHA: "725e6947",214
CommitMessage: "fix de build", Author: "tim", Duration: 12.4,215
URL: "https://git.example/tim/app/-/pipelines/26",216
},217
Jobs: []JobInfo{218
{219
Name: "test", Stage: "test", Status: "failed", Duration: 4.1,220
AllowFailure: false, WebURL: "https://git.example/tim/app/-/pipelines/26/jobs/7",221
Log: "go: token [MASKED]\nFAIL", LogTruncated: &trunc,222
LogURL: "https://git.example/tim/app/-/pipelines/26/jobs/7/log?raw=1",223
},224
{225
Name: "build", Stage: "build", Status: "skipped", Duration: 0,226
WebURL: "https://git.example/tim/app/-/pipelines/26/jobs/8",227
},228
},229
},230
{231
Type: EventPush, Project: "tim/app", Actor: "tim", Branch: "master",232
Ref: "refs/heads/master", Before: strings.Repeat("0", 40), After: "abc123",233
Commits: []CommitInfo{{234
SHA: "abc123", Message: "fix de build", Author: "Tim <tim@example.com>",235
URL: "https://git.example/tim/app/-/commit/abc123",236
}},237
},238
{239
Type: EventMergeRequest, Project: "tim/app", Actor: "ada",240
MergeRequest: &MRInfo{241
ID: 4, Title: "Toon de kloon-URL", Description: "SSH en HTTPS.",242
SourceBranch: "feature", TargetBranch: "master", Status: "open",243
Author: "ada", Action: "opened",244
URL: "https://git.example/tim/app/-/merge-requests/4",245
},246
},247
{248
Type: EventRelease, Project: "tim/app", ReleaseTag: "v1.2.0", Commit: "abc123",249
Release: &ReleaseInfo{250
Tag: "v1.2.0", Name: "BlueGit 1.2.0", Commit: "abc123",251
Assets: []AssetInfo{{252
Name: "bluegit", Size: 8123456,253
URL: "https://git.example/tim/app/-/releases/v1.2.0/assets/bluegit",254
}},255
},256
},257
}258
var b strings.Builder259
for i, ev := range samples {260
if i > 0 {261
b.WriteString("\n\n")262
}263
raw, err := json.MarshalIndent(ev.Document(), "", " ")264
if err != nil {265
continue266
}267
b.Write(raw)268
}269
return b.String()270
}@@ -0,0 +1,157 @@
1
package webhook
2
3
import (
4
"encoding/json"
5
"strings"
6
"testing"
7
)
8
9
func TestTailLogMasksAndCuts(t *testing.T) {
10
secret := "super-secret-token"
11
var lines []string
12
for i := 0; i < LogMaxLines+40; i++ {
13
lines = append(lines, "regel")
14
}
15
lines = append(lines, "token "+secret)
16
got, truncated := TailLog(strings.Join(lines, "\n"), []string{secret})
17
if !truncated {
18
t.Fatal("te lange log hoort afgekapt")
19
}
20
if n := len(strings.Split(got, "\n")); n != LogMaxLines {
21
t.Fatalf("regels %d", n)
22
}
23
if strings.Contains(got, secret) || !strings.Contains(got, "[MASKED]") {
24
t.Fatalf("masker: %s", got[len(got)-80:])
25
}
26
if _, truncated := TailLog("kort\n", []string{secret}); truncated {
27
t.Fatal("korte log")
28
}
29
got, _ = TailLog("code "+secret, nil)
30
if strings.Contains(got, "[MASKED]") {
31
t.Fatal("zonder geheimen niets maskeren")
32
}
33
huge := strings.Repeat("x", LogMaxBytes+100)
34
got, truncated = TailLog(huge, nil)
35
if !truncated || len(got) > LogMaxBytes {
36
t.Fatalf("bytes %d truncated %v", len(got), truncated)
37
}
38
}
39
40
func TestDocumentShapes(t *testing.T) {
41
trunc := false
42
pipe := Event{
43
Type: EventPipelineFailure, Project: "tim/app", PipelineID: "9",
44
Pipeline: &PipelineInfo{ID: 9, Status: "failed", Ref: "refs/heads/master", SHA: "abc", CommitMessage: "fix", Author: "tim", Duration: 1.5},
45
Jobs: []JobInfo{
46
{Name: "test", Stage: "test", Status: "failed", Duration: 1, AllowFailure: false, WebURL: "https://git.example/job", Log: "boom", LogTruncated: &trunc, LogURL: "https://git.example/log"},
47
{Name: "build", Stage: "build", Status: "success", WebURL: "https://git.example/build"},
48
},
49
}
50
body, err := RenderBody("", pipe, nil)
51
if err != nil {
52
t.Fatal(err)
53
}
54
var doc map[string]any
55
if err := json.Unmarshal(body, &doc); err != nil {
56
t.Fatal(err)
57
}
58
if doc["object_kind"] != "pipeline" || doc["pipeline_id"] != "9" {
59
t.Fatalf("pipeline %s", body)
60
}
61
jobs := doc["jobs"].([]any)
62
failed := jobs[0].(map[string]any)
63
if failed["log"] != "boom" || failed["log_truncated"] != false || failed["allow_failure"] != false || failed["log_url"] == "" {
64
t.Fatalf("gefaalde job %v", failed)
65
}
66
ok := jobs[1].(map[string]any)
67
if _, has := ok["log"]; has {
68
t.Fatalf("geslaagde job heeft een log: %v", ok)
69
}
70
if _, has := ok["log_truncated"]; has {
71
t.Fatalf("geslaagde job heeft log_truncated: %v", ok)
72
}
73
74
push := Event{Type: EventPush, Project: "tim/app", Ref: "refs/heads/master", Before: "a", After: "b"}
75
body, err = RenderBody("", push, nil)
76
if err != nil {
77
t.Fatal(err)
78
}
79
if err := json.Unmarshal(body, &doc); err != nil {
80
t.Fatal(err)
81
}
82
if doc["object_kind"] != "push" || doc["before"] != "a" || doc["commits"] == nil {
83
t.Fatalf("push %s", body)
84
}
85
86
mr := Event{
87
Type: EventMergeRequest, Project: "tim/app", Comment: "hoort niet mee",
88
MergeRequest: &MRInfo{ID: 3, Title: "titel", Description: "tekst", SourceBranch: "f", TargetBranch: "master", Status: "open", Author: "ada", Action: "opened"},
89
}
90
body, err = RenderBody("", mr, nil)
91
if err != nil {
92
t.Fatal(err)
93
}
94
if strings.Contains(string(body), "hoort niet mee") || !strings.Contains(string(body), `"action":"opened"`) {
95
t.Fatalf("opened lekt commentaar: %s", body)
96
}
97
mr.MergeRequest.Action = "commented"
98
mr.Comment = "mooie opmerking"
99
body, err = RenderBody("", mr, nil)
100
if err != nil || !strings.Contains(string(body), "mooie opmerking") {
101
t.Fatalf("commented %s %v", body, err)
102
}
103
104
rel := Event{
105
Type: EventRelease, Project: "tim/app", ReleaseTag: "v1",
106
Release: &ReleaseInfo{Tag: "v1", Name: "Een", Commit: "abc", Assets: []AssetInfo{{Name: "bluegit", URL: "https://git.example/a", Size: 4}}},
107
}
108
body, err = RenderBody("", rel, nil)
109
if err != nil {
110
t.Fatal(err)
111
}
112
if err := json.Unmarshal(body, &doc); err != nil {
113
t.Fatal(err)
114
}
115
if doc["object_kind"] != "release" {
116
t.Fatal(string(body))
117
}
118
release := doc["release"].(map[string]any)
119
assets := release["assets"].([]any)
120
if release["tag"] != "v1" || release["commit"] != "abc" || assets[0].(map[string]any)["url"] != "https://git.example/a" {
121
t.Fatalf("release %s", body)
122
}
123
124
rendered, err := Expand("{{event.payload}}", pipe, nil)
125
if err != nil || !strings.Contains(rendered, `"log":"boom"`) {
126
t.Fatalf("payload-placeholder %s %v", rendered, err)
127
}
128
}
129
130
func TestOpenAPIMatchesExample(t *testing.T) {
131
var spec map[string]any
132
if err := json.Unmarshal(OpenAPI(), &spec); err != nil {
133
t.Fatal(err)
134
}
135
if spec["openapi"] != "3.1.0" {
136
t.Fatalf("versie %v", spec["openapi"])
137
}
138
raw := string(OpenAPI())
139
for _, want := range []string{
140
"PipelineEvent", "PushEvent", "MergeRequestEvent", "ReleaseEvent",
141
"commit_message", "allow_failure", "log_truncated", "log_url",
142
"source_branch", "target_branch", "before", "after", "assets",
143
} {
144
if !strings.Contains(raw, want) {
145
t.Errorf("openapi mist %s", want)
146
}
147
}
148
example := Example()
149
for _, want := range []string{"log_truncated", "commit_message", "source_branch", "refs/heads/master", "assets", "commented"} {
150
if !strings.Contains(example, want) && want != "commented" {
151
t.Errorf("voorbeeld mist %s", want)
152
}
153
}
154
if !strings.Contains(example, `"action": "opened"`) {
155
t.Fatalf("voorbeeld:\n%s", example)
156
}
157
}
@@ -0,0 +1,157 @@1
package webhook2
3
import (4
"encoding/json"5
"strings"6
"testing"7
)8
9
func TestTailLogMasksAndCuts(t *testing.T) {10
secret := "super-secret-token"11
var lines []string12
for i := 0; i < LogMaxLines+40; i++ {13
lines = append(lines, "regel")14
}15
lines = append(lines, "token "+secret)16
got, truncated := TailLog(strings.Join(lines, "\n"), []string{secret})17
if !truncated {18
t.Fatal("te lange log hoort afgekapt")19
}20
if n := len(strings.Split(got, "\n")); n != LogMaxLines {21
t.Fatalf("regels %d", n)22
}23
if strings.Contains(got, secret) || !strings.Contains(got, "[MASKED]") {24
t.Fatalf("masker: %s", got[len(got)-80:])25
}26
if _, truncated := TailLog("kort\n", []string{secret}); truncated {27
t.Fatal("korte log")28
}29
got, _ = TailLog("code "+secret, nil)30
if strings.Contains(got, "[MASKED]") {31
t.Fatal("zonder geheimen niets maskeren")32
}33
huge := strings.Repeat("x", LogMaxBytes+100)34
got, truncated = TailLog(huge, nil)35
if !truncated || len(got) > LogMaxBytes {36
t.Fatalf("bytes %d truncated %v", len(got), truncated)37
}38
}39
40
func TestDocumentShapes(t *testing.T) {41
trunc := false42
pipe := Event{43
Type: EventPipelineFailure, Project: "tim/app", PipelineID: "9",44
Pipeline: &PipelineInfo{ID: 9, Status: "failed", Ref: "refs/heads/master", SHA: "abc", CommitMessage: "fix", Author: "tim", Duration: 1.5},45
Jobs: []JobInfo{46
{Name: "test", Stage: "test", Status: "failed", Duration: 1, AllowFailure: false, WebURL: "https://git.example/job", Log: "boom", LogTruncated: &trunc, LogURL: "https://git.example/log"},47
{Name: "build", Stage: "build", Status: "success", WebURL: "https://git.example/build"},48
},49
}50
body, err := RenderBody("", pipe, nil)51
if err != nil {52
t.Fatal(err)53
}54
var doc map[string]any55
if err := json.Unmarshal(body, &doc); err != nil {56
t.Fatal(err)57
}58
if doc["object_kind"] != "pipeline" || doc["pipeline_id"] != "9" {59
t.Fatalf("pipeline %s", body)60
}61
jobs := doc["jobs"].([]any)62
failed := jobs[0].(map[string]any)63
if failed["log"] != "boom" || failed["log_truncated"] != false || failed["allow_failure"] != false || failed["log_url"] == "" {64
t.Fatalf("gefaalde job %v", failed)65
}66
ok := jobs[1].(map[string]any)67
if _, has := ok["log"]; has {68
t.Fatalf("geslaagde job heeft een log: %v", ok)69
}70
if _, has := ok["log_truncated"]; has {71
t.Fatalf("geslaagde job heeft log_truncated: %v", ok)72
}73
74
push := Event{Type: EventPush, Project: "tim/app", Ref: "refs/heads/master", Before: "a", After: "b"}75
body, err = RenderBody("", push, nil)76
if err != nil {77
t.Fatal(err)78
}79
if err := json.Unmarshal(body, &doc); err != nil {80
t.Fatal(err)81
}82
if doc["object_kind"] != "push" || doc["before"] != "a" || doc["commits"] == nil {83
t.Fatalf("push %s", body)84
}85
86
mr := Event{87
Type: EventMergeRequest, Project: "tim/app", Comment: "hoort niet mee",88
MergeRequest: &MRInfo{ID: 3, Title: "titel", Description: "tekst", SourceBranch: "f", TargetBranch: "master", Status: "open", Author: "ada", Action: "opened"},89
}90
body, err = RenderBody("", mr, nil)91
if err != nil {92
t.Fatal(err)93
}94
if strings.Contains(string(body), "hoort niet mee") || !strings.Contains(string(body), `"action":"opened"`) {95
t.Fatalf("opened lekt commentaar: %s", body)96
}97
mr.MergeRequest.Action = "commented"98
mr.Comment = "mooie opmerking"99
body, err = RenderBody("", mr, nil)100
if err != nil || !strings.Contains(string(body), "mooie opmerking") {101
t.Fatalf("commented %s %v", body, err)102
}103
104
rel := Event{105
Type: EventRelease, Project: "tim/app", ReleaseTag: "v1",106
Release: &ReleaseInfo{Tag: "v1", Name: "Een", Commit: "abc", Assets: []AssetInfo{{Name: "bluegit", URL: "https://git.example/a", Size: 4}}},107
}108
body, err = RenderBody("", rel, nil)109
if err != nil {110
t.Fatal(err)111
}112
if err := json.Unmarshal(body, &doc); err != nil {113
t.Fatal(err)114
}115
if doc["object_kind"] != "release" {116
t.Fatal(string(body))117
}118
release := doc["release"].(map[string]any)119
assets := release["assets"].([]any)120
if release["tag"] != "v1" || release["commit"] != "abc" || assets[0].(map[string]any)["url"] != "https://git.example/a" {121
t.Fatalf("release %s", body)122
}123
124
rendered, err := Expand("{{event.payload}}", pipe, nil)125
if err != nil || !strings.Contains(rendered, `"log":"boom"`) {126
t.Fatalf("payload-placeholder %s %v", rendered, err)127
}128
}129
130
func TestOpenAPIMatchesExample(t *testing.T) {131
var spec map[string]any132
if err := json.Unmarshal(OpenAPI(), &spec); err != nil {133
t.Fatal(err)134
}135
if spec["openapi"] != "3.1.0" {136
t.Fatalf("versie %v", spec["openapi"])137
}138
raw := string(OpenAPI())139
for _, want := range []string{140
"PipelineEvent", "PushEvent", "MergeRequestEvent", "ReleaseEvent",141
"commit_message", "allow_failure", "log_truncated", "log_url",142
"source_branch", "target_branch", "before", "after", "assets",143
} {144
if !strings.Contains(raw, want) {145
t.Errorf("openapi mist %s", want)146
}147
}148
example := Example()149
for _, want := range []string{"log_truncated", "commit_message", "source_branch", "refs/heads/master", "assets", "commented"} {150
if !strings.Contains(example, want) && want != "commented" {151
t.Errorf("voorbeeld mist %s", want)152
}153
}154
if !strings.Contains(example, `"action": "opened"`) {155
t.Fatalf("voorbeeld:\n%s", example)156
}157
}@@ -252,7 +252,7 @@ func TestPresetPayloads(t *testing.T) {
252
252
if err != nil {
253
253
t.Fatal(err)
254
254
}
255
var grok map[string]string
255
var grok map[string]any
256
256
if err := json.Unmarshal(body, &grok); err != nil || grok["project"] != ev.Project || strings.Contains(string(body), "secret-value") {
257
257
t.Fatalf("grok body %s %v", body, err)
258
258
}
@@ -272,7 +272,7 @@ func TestPresetPayloads(t *testing.T) {
272
272
if err != nil {
273
273
t.Fatal(err)
274
274
}
275
var generic map[string]string
275
var generic map[string]any
276
276
if err := json.Unmarshal(body, &generic); err != nil || generic["summary"] != ev.Summary || generic["type"] != EventPush {
277
277
t.Fatalf("generic %s %v", body, err)
278
278
}
@@ -252,7 +252,7 @@ func TestPresetPayloads(t *testing.T) {252
if err != nil {252
if err != nil {253
t.Fatal(err)253
t.Fatal(err)254
}254
}255
var grok map[string]string255
var grok map[string]any256
if err := json.Unmarshal(body, &grok); err != nil || grok["project"] != ev.Project || strings.Contains(string(body), "secret-value") {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)257
t.Fatalf("grok body %s %v", body, err)258
}258
}@@ -272,7 +272,7 @@ func TestPresetPayloads(t *testing.T) {272
if err != nil {272
if err != nil {273
t.Fatal(err)273
t.Fatal(err)274
}274
}275
var generic map[string]string275
var generic map[string]any276
if err := json.Unmarshal(body, &generic); err != nil || generic["summary"] != ev.Summary || generic["type"] != EventPush {276
if err := json.Unmarshal(body, &generic); err != nil || generic["summary"] != ev.Summary || generic["type"] != EventPush {277
t.Fatalf("generic %s %v", body, err)277
t.Fatalf("generic %s %v", body, err)278
}278
}@@ -41,6 +41,9 @@ const (
41
41
)
42
42
43
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.
44
47
type Event struct {
45
48
Type string
46
49
Project string
@@ -52,6 +55,16 @@ type Event struct {
52
55
PipelineID string
53
56
ReleaseTag string
54
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
55
68
}
56
69
57
70
// Hook is de opgeslagen configuratie, zonder geheimen al ingevuld.
@@ -182,6 +195,12 @@ func eventField(ev Event, field string) (string, bool) {
182
195
return ev.ReleaseTag, true
183
196
case "actor":
184
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
185
204
default:
186
205
return "", false
187
206
}
@@ -206,19 +225,7 @@ func PresetDefaults(preset string) (headers map[string]string, body string) {
206
225
// RenderBody maakt de HTTP-body. Een lege sjabloon wordt de gebeurtenis als JSON.
207
226
func RenderBody(bodyTemplate string, ev Event, secrets map[string]string) ([]byte, error) {
208
227
if strings.TrimSpace(bodyTemplate) == "" {
209
payload := map[string]string{
210
"type": ev.Type,
211
"project": ev.Project,
212
"group": ev.Group,
213
"branch": ev.Branch,
214
"commit": ev.Commit,
215
"summary": ev.Summary,
216
"url": ev.URL,
217
"pipeline_id": ev.PipelineID,
218
"release_tag": ev.ReleaseTag,
219
"actor": ev.Actor,
220
}
221
return json.Marshal(payload)
228
return json.Marshal(ev.Document())
222
229
}
223
230
s, err := Expand(bodyTemplate, ev, secrets)
224
231
if err != nil {
@@ -41,6 +41,9 @@ const (41
)41
)42
42
43
// Event is de gegevensset die een webhook te zien krijgt.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 Release46
// vullen de JSON-body als het sjabloon leeg is.44
type Event struct {47
type Event struct {45
Type string48
Type string46
Project string49
Project string@@ -52,6 +55,16 @@ type Event struct {52
PipelineID string55
PipelineID string53
ReleaseTag string56
ReleaseTag string54
Actor string57
Actor string58
59
Pipeline *PipelineInfo60
Jobs []JobInfo61
Ref string62
Before string63
After string64
Commits []CommitInfo65
MergeRequest *MRInfo66
Comment string67
Release *ReleaseInfo55
}68
}56
69
57
// Hook is de opgeslagen configuratie, zonder geheimen al ingevuld.70
// Hook is de opgeslagen configuratie, zonder geheimen al ingevuld.@@ -182,6 +195,12 @@ func eventField(ev Event, field string) (string, bool) {182
return ev.ReleaseTag, true195
return ev.ReleaseTag, true183
case "actor":196
case "actor":184
return ev.Actor, true197
return ev.Actor, true198
case "payload":199
b, err := json.Marshal(ev.Document())200
if err != nil {201
return "", false202
}203
return string(b), true185
default:204
default:186
return "", false205
return "", false187
}206
}@@ -206,19 +225,7 @@ func PresetDefaults(preset string) (headers map[string]string, body string) {206
// RenderBody maakt de HTTP-body. Een lege sjabloon wordt de gebeurtenis als JSON.225
// RenderBody maakt de HTTP-body. Een lege sjabloon wordt de gebeurtenis als JSON.207
func RenderBody(bodyTemplate string, ev Event, secrets map[string]string) ([]byte, error) {226
func RenderBody(bodyTemplate string, ev Event, secrets map[string]string) ([]byte, error) {208
if strings.TrimSpace(bodyTemplate) == "" {227
if strings.TrimSpace(bodyTemplate) == "" {209
payload := map[string]string{228
return json.Marshal(ev.Document())210
"type": ev.Type,211
"project": ev.Project,212
"group": ev.Group,213
"branch": ev.Branch,214
"commit": ev.Commit,215
"summary": ev.Summary,216
"url": ev.URL,217
"pipeline_id": ev.PipelineID,218
"release_tag": ev.ReleaseTag,219
"actor": ev.Actor,220
}221
return json.Marshal(payload)222
}229
}223
s, err := Expand(bodyTemplate, ev, secrets)230
s, err := Expand(bodyTemplate, ev, secrets)224
if err != nil {231
if err != nil {@@ -92,11 +92,11 @@ func TestExpandAndPresets(t *testing.T) {
92
92
if err != nil {
93
93
t.Fatal(err)
94
94
}
95
var payload map[string]string
95
var payload map[string]any
96
96
if err := json.Unmarshal(body, &payload); err != nil {
97
97
t.Fatal(err)
98
98
}
99
if payload["project"] != "tim/bluegit" || strings.Contains(string(body), "geheim-token") {
99
if payload["project"] != "tim/bluegit" || payload["object_kind"] != "push" || strings.Contains(string(body), "geheim-token") {
100
100
t.Fatalf("body lekt of mist project: %s", body)
101
101
}
102
102
@@ -92,11 +92,11 @@ func TestExpandAndPresets(t *testing.T) {92
if err != nil {92
if err != nil {93
t.Fatal(err)93
t.Fatal(err)94
}94
}95
var payload map[string]string95
var payload map[string]any96
if err := json.Unmarshal(body, &payload); err != nil {96
if err := json.Unmarshal(body, &payload); err != nil {97
t.Fatal(err)97
t.Fatal(err)98
}98
}99
if payload["project"] != "tim/bluegit" || strings.Contains(string(body), "geheim-token") {99
if payload["project"] != "tim/bluegit" || payload["object_kind"] != "push" || strings.Contains(string(body), "geheim-token") {100
t.Fatalf("body lekt of mist project: %s", body)100
t.Fatalf("body lekt of mist project: %s", body)101
}101
}102
102