BlueGit

timfa bluegit

Files

bluegit / internal / runner / runner.go

runner.go

runner.go 32.0 KiB Download Raw
1// Package runner voert pipelinejobs uit, elk in een eigen Docker-container.
2package runner
3
4import (
5 "bytes"
6 "context"
7 "errors"
8 "fmt"
9 "io"
10 "log/slog"
11 "os"
12 "os/exec"
13 "path/filepath"
14 "strconv"
15 "strings"
16 "sync"
17 "time"
18
19 "gitlab.com/Timfa/bluegit/internal/access"
20 "gitlab.com/Timfa/bluegit/internal/ci"
21 "gitlab.com/Timfa/bluegit/internal/gitrepo"
22 "gitlab.com/Timfa/bluegit/internal/images"
23 "gitlab.com/Timfa/bluegit/internal/runnercfg"
24 "gitlab.com/Timfa/bluegit/internal/store"
25 "gitlab.com/Timfa/bluegit/internal/webhook"
26)
27
28// Runner plant jobs en stuurt het resultaat door naar webhooks.
29type Runner struct {
30 // Hold houdt een pipeline vast, bijvoorbeeld tijdens een self-update.
31 Hold func(store.Pipeline) bool
32 Store *store.Store
33 GitBin string
34 Docker string
35 Storage string
36 BaseURL string
37 Network string
38 Name string
39 Timeout time.Duration
40 Log *slog.Logger
41 OnEvent func(repoID int64, ev webhook.Event)
42 // Presets zijn de image-aliassen uit ci.presets. Nil is de ingebouwde lijst.
43 Presets map[string]images.Override
44 // Jobs is het overzicht en de pauze (drain) voor de beheer-UI.
45 Jobs *runnercfg.Tracker
46 ctl control
47 slots chan struct{}
48 mu sync.RWMutex
49 cancelMu sync.Mutex
50 cancel map[int64]context.CancelFunc
51}
52
53// Interrupt stopt lopende jobs waarvan een nieuwere pipeline de beurt overneemt.
54func (r *Runner) Interrupt(ids []int64) {
55 r.cancelMu.Lock()
56 defer r.cancelMu.Unlock()
57 for _, id := range ids {
58 if c := r.cancel[id]; c != nil {
59 c()
60 }
61 }
62}
63
64func (r *Runner) track(id int64, cancel context.CancelFunc) {
65 r.cancelMu.Lock()
66 defer r.cancelMu.Unlock()
67 if r.cancel == nil {
68 r.cancel = map[int64]context.CancelFunc{}
69 }
70 r.cancel[id] = cancel
71}
72
73func (r *Runner) untrack(id int64) {
74 r.cancelMu.Lock()
75 defer r.cancelMu.Unlock()
76 delete(r.cancel, id)
77}
78
79// SetStorage wijzigt het pad waarop jobs hun clone en artifacts zetten.
80func (r *Runner) SetStorage(path string) {
81 r.mu.Lock()
82 r.Storage = path
83 r.mu.Unlock()
84}
85
86func (r *Runner) storage() string {
87 r.mu.RLock()
88 defer r.mu.RUnlock()
89 return r.Storage
90}
91
92// Loop blijft jobs oppakken tot ctx afloopt.
93func (r *Runner) Loop(ctx context.Context, concurrency int) {
94 if concurrency < 1 {
95 concurrency = 1
96 }
97 r.slots = make(chan struct{}, maxSlots)
98 r.mu.Lock()
99 if !r.ctl.set {
100 r.ctl.limit = concurrency
101 }
102 r.mu.Unlock()
103 tick := time.NewTicker(2 * time.Second)
104 defer tick.Stop()
105 for {
106 select {
107 case <-ctx.Done():
108 return
109 case <-tick.C:
110 r.Tick(ctx)
111 }
112 }
113}
114
115// Tick bekijkt alle open pipelines één keer.
116// Zonder opslagpad gebeurt er niets.
117func (r *Runner) Tick(ctx context.Context) {
118 if r.storage() == "" {
119 return
120 }
121 pipes, err := r.Store.ActivePipelines(ctx)
122 if err != nil {
123 r.Log.Error("pipelines", "err", err)
124 return
125 }
126 for _, p := range pipes {
127 r.schedule(ctx, p)
128 }
129 r.reapRemote(ctx)
130}
131
132func (r *Runner) schedule(ctx context.Context, p store.Pipeline) {
133 r.settle(ctx, p.ID)
134 if r.Hold != nil && r.Hold(p) {
135 return // wacht op de self-update
136 }
137 jobs, err := r.Store.JobsByPipeline(ctx, p.ID)
138 if err != nil {
139 r.Log.Error("jobs", "err", err)
140 return
141 }
142 specs := make([]ci.Job, len(jobs))
143 status := map[string]string{}
144 for i, j := range jobs {
145 specs[i] = ci.Job{Name: j.Name, Stage: j.Stage, Needs: j.Needs, Optional: j.Optional, NeedsSet: j.NeedsSet, AllowFailure: j.AllowFailure, When: j.When}
146 status[j.Name] = j.Status
147 }
148 tierCache := map[int64][]Tier{}
149 for _, j := range jobs {
150 if j.Status != "queued" && j.Status != "manual" {
151 continue
152 }
153 switch ci.Gate(specs, status, specs[indexOf(jobs, j.Name)]) {
154 case "skip":
155 _ = r.Store.SkipJob(ctx, j.ID, "skipped because an earlier job failed\n")
156 status[j.Name] = "skipped"
157 case "fail":
158 _ = r.Store.FinishJob(ctx, j.ID, "failed", "a required job is not part of this pipeline\n")
159 status[j.Name] = "failed"
160 case "ready":
161 if j.Status != "queued" {
162 continue
163 }
164 if busy, _ := r.Store.ResourceBusy(ctx, j.RepoID, j.ResourceGroup, j.ID); busy {
165 continue
166 }
167 // Meer jobs dan ci.concurrency blijven queued, met een plek
168 // in de wachtrij. Het slot gaat pas vrij als execute klaar is.
169 free := r.acquireSlot()
170 if tiers := r.tiersFor(ctx, tierCache, j.RepoID); len(tiers) > 1 {
171 jr := r.Store.JobRun(ctx, j.ID)
172 step := Advance(tiers, jr.OfferTier, jr.OfferAt, time.Now(), free)
173 if !step.Builtin {
174 if free {
175 r.releaseSlot()
176 }
177 if step.Moved {
178 _ = r.Store.SetJobOffer(ctx, j.ID, step.Tier, time.Now())
179 }
180 continue
181 }
182 }
183 if !free {
184 continue
185 }
186 ok, err := r.Store.MarkJobRunning(ctx, j.ID)
187 if err != nil || !ok {
188 r.releaseSlot()
189 continue
190 }
191 _ = r.Store.SetJobRunner(ctx, j.ID, 0, r.BuiltinName())
192 _ = r.Store.ClearJobOffer(ctx, j.ID)
193 status[j.Name] = "running"
194 job := j
195 pipe := p
196 go r.execute(ctx, pipe, job)
197 }
198 }
199}
200
201// settle slaat jobs over die door een harde mislukking of een
202// overgeslagen need niet meer hoeven. Dat gebeurt meteen, ook als de
203// pipelinestatus al op failed was gezet.
204func (r *Runner) settle(ctx context.Context, pipelineID int64) {
205 for {
206 jobs, err := r.Store.JobsByPipeline(ctx, pipelineID)
207 if err != nil {
208 if r.Log != nil {
209 r.Log.Error("jobs", "err", err)
210 }
211 return
212 }
213 specs := make([]ci.Job, len(jobs))
214 status := map[string]string{}
215 for i, j := range jobs {
216 specs[i] = ci.Job{Name: j.Name, Stage: j.Stage, Needs: j.Needs, Optional: j.Optional, NeedsSet: j.NeedsSet, AllowFailure: j.AllowFailure, When: j.When}
217 status[j.Name] = j.Status
218 }
219 moved := false
220 for _, j := range jobs {
221 if j.Status != "queued" && j.Status != "manual" {
222 continue
223 }
224 switch ci.Gate(specs, status, specs[indexOf(jobs, j.Name)]) {
225 case "skip":
226 if err := r.Store.SkipJob(ctx, j.ID, "skipped because an earlier job failed\n"); err != nil && r.Log != nil {
227 r.Log.Error("skip", "err", err)
228 continue
229 }
230 status[j.Name] = "skipped"
231 moved = true
232 case "fail":
233 if err := r.Store.FinishJob(ctx, j.ID, "failed", "a required job is not part of this pipeline\n"); err != nil && r.Log != nil {
234 r.Log.Error("fail", "err", err)
235 continue
236 }
237 status[j.Name] = "failed"
238 moved = true
239 }
240 }
241 if !moved {
242 return
243 }
244 }
245}
246
247// BuiltinName is de naam van de ingebouwde runner in de job-UI.
248func (r *Runner) BuiltinName() string {
249 if r.Name != "" {
250 return r.Name
251 }
252 return "BlueGit runner"
253}
254
255func (r *Runner) tiersFor(ctx context.Context, cache map[int64][]Tier, repoID int64) []Tier {
256 if t, ok := cache[repoID]; ok {
257 return t
258 }
259 var tiers []Tier
260 if repo, err := r.Store.RepoByID(ctx, repoID); err == nil {
261 tiers, _ = Tiers(ctx, r.Store, repo)
262 }
263 cache[repoID] = tiers
264 return tiers
265}
266
267func indexOf(jobs []store.Job, name string) int {
268 for i, j := range jobs {
269 if j.Name == name {
270 return i
271 }
272 }
273 return 0
274}
275
276func (r *Runner) acquireSlot() bool {
277 if r.Paused() {
278 return false
279 }
280 if r.slots == nil {
281 return true
282 }
283 if l := r.controls().limit; l > 0 && len(r.slots) >= l {
284 return false
285 }
286 select {
287 case r.slots <- struct{}{}:
288 return true
289 default:
290 return false
291 }
292}
293
294func (r *Runner) releaseSlot() {
295 if r.slots == nil {
296 return
297 }
298 select {
299 case <-r.slots:
300 default:
301 }
302}
303
304func (r *Runner) execute(ctx context.Context, p store.Pipeline, job store.Job) {
305 defer r.releaseSlot()
306 before, _ := r.Store.PipelineByID(context.Background(), p.RepoID, p.ID)
307 base, stop := context.WithCancel(ctx)
308 r.track(job.ID, stop)
309 defer func() {
310 r.untrack(job.ID)
311 stop()
312 }()
313 runCtx := base
314 limit := r.Timeout
315 if job.Timeout > 0 {
316 limit = job.Timeout
317 }
318 if m := r.controls().timeout; m > 0 && (limit == 0 || time.Duration(m)*time.Minute < limit) {
319 limit = time.Duration(m) * time.Minute
320 }
321 r.trackStart(job)
322 if limit > 0 {
323 var cancel context.CancelFunc
324 runCtx, cancel = context.WithTimeout(base, limit)
325 defer cancel()
326 }
327 mask, err := r.runOne(runCtx, p, job)
328 status := "success"
329 extra := ""
330 kind := ""
331 switch {
332 case err == nil:
333 case ctx.Err() == nil && base.Err() != nil:
334 status = "canceled"
335 extra = stamp("canceled because a newer pipeline started for the same ref")
336 case errors.Is(runCtx.Err(), context.DeadlineExceeded):
337 status = "failed"
338 kind = "job_execution_timeout"
339 extra = stamp(ci.Mask(err.Error(), mask))
340 default:
341 status = "failed"
342 kind = classifyFailure(err)
343 extra = stamp(ci.Mask(err.Error(), mask))
344 }
345 r.trackDone(job.ID, status)
346 r.complete(p, job, before, status, extra, kind)
347}
348
349// complete rondt een job af: opnieuw proberen, afronden, pipelinestatus
350// en webhook. Gedeeld door de ingebouwde en de aparte runner.
351func (r *Runner) complete(p store.Pipeline, job store.Job, before store.Pipeline, status, extra, kind string) {
352 if status == "failed" && shouldRetry(job, kind) {
353 note := stamp(fmt.Sprintf("retrying (%d/%d) after %s", job.Attempt+1, job.RetryMax, kind))
354 _ = r.Store.ClearJobOffer(context.Background(), job.ID)
355 if ferr := r.Store.RequeueJob(context.Background(), job.ID, job.Attempt+1, note+extra); ferr != nil && r.Log != nil {
356 r.Log.Error("job opnieuw", "err", ferr)
357 } else if ferr == nil {
358 r.settle(context.Background(), p.ID)
359 if _, rerr := r.Store.RefreshPipelineStatus(context.Background(), p.ID); rerr != nil && r.Log != nil {
360 r.Log.Error("pipelinestatus", "err", rerr)
361 }
362 return
363 }
364 }
365 if ferr := r.Store.FinishJob(context.Background(), job.ID, status, extra); ferr != nil {
366 r.Log.Error("job afronden", "err", ferr)
367 }
368 r.settle(context.Background(), p.ID)
369 final, rerr := r.Store.RefreshPipelineStatus(context.Background(), p.ID)
370 if rerr != nil {
371 r.Log.Error("pipelinestatus", "err", rerr)
372 return
373 }
374 if before.Status != final && (final == "success" || final == "failed") && r.OnEvent != nil {
375 kind := webhook.EventPipelineSuccess
376 word := "geslaagd"
377 if final == "failed" {
378 kind = webhook.EventPipelineFailure
379 word = "mislukt"
380 }
381 repo, err := r.Store.RepoByID(context.Background(), p.RepoID)
382 if err != nil {
383 return
384 }
385 branch, _ := gitrepo.BranchOfRef(p.Ref)
386 if branch == "" {
387 branch = strings.TrimPrefix(p.Ref, "refs/heads/")
388 }
389 r.OnEvent(p.RepoID, webhook.Event{
390 Type: kind,
391 Project: repo.FullPath(),
392 Branch: branch,
393 Commit: p.CommitSHA,
394 Summary: fmt.Sprintf("pipeline #%d voor %s is %s", p.ID, repo.FullPath(), word),
395 URL: strings.TrimRight(r.BaseURL, "/") + "/" + repo.FullPath() + "/-/pipelines/" + fmt.Sprint(p.ID),
396 PipelineID: fmt.Sprint(p.ID),
397 })
398 }
399}
400
401func (r *Runner) runOne(ctx context.Context, p store.Pipeline, job store.Job) ([]string, error) {
402 repo, err := r.Store.RepoByID(ctx, p.RepoID)
403 if err != nil {
404 return nil, err
405 }
406 sink := &logSink{store: r.Store, jobID: job.ID}
407 sink.section("prepare", "Preparing the docker executor")
408 work := filepath.Join(r.storage(), "work", fmt.Sprint(p.ID), safeSegment(job.Name))
409 _ = os.RemoveAll(work)
410 if err := os.MkdirAll(work, 0o755); err != nil {
411 sink.closeSection()
412 return nil, err
413 }
414 bare := gitrepo.Dir(r.storage(), repo.OwnerPath, repo.Name)
415 if _, err := execOut(ctx, r.GitBin, cloneArgs(bare, work)...); err != nil {
416 sink.closeSection()
417 return nil, fmt.Errorf("clone: %w", err)
418 }
419 if _, err := execOut(ctx, r.GitBin, "-C", work, "checkout", "--detach", p.CommitSHA); err != nil {
420 sink.closeSection()
421 return nil, fmt.Errorf("checkout %s: %w", p.CommitSHA, err)
422 }
423 if err := r.restoreCache(repo.ID, job, work); err != nil {
424 sink.closeSection()
425 return nil, err
426 }
427 if err := r.materialize(ctx, p, job, work); err != nil {
428 sink.closeSection()
429 return nil, err
430 }
431 scriptPath := filepath.Join(work, ".bluegit-job.sh")
432 host, _ := os.Hostname()
433 script := shellScript(job, placeNote{
434 Runner: r.Name, Host: host, WorkDir: "/workspace",
435 PipelineID: p.ID, JobID: job.ID,
436 })
437 if err := os.WriteFile(scriptPath, []byte(script), 0o755); err != nil {
438 sink.closeSection()
439 return nil, err
440 }
441 token, err := r.Store.CreateJobToken(ctx, job.ID)
442 if err != nil {
443 sink.closeSection()
444 return nil, err
445 }
446 env, mask, err := r.environment(ctx, repo, p, job, token)
447 if err != nil {
448 sink.closeSection()
449 return nil, err
450 }
451 sink.secrets = mask
452 if err := r.execContainer(ctx, sink, job, work, env); err != nil {
453 return mask, err
454 }
455 if err := r.collect(ctx, job, work); err != nil {
456 return mask, err
457 }
458 if err := r.saveCache(repo.ID, job, work); err != nil {
459 return mask, err
460 }
461 return mask, nil
462}
463
464// execContainer haalt het image op, start services en draait het
465// jobscript in de container. De sectie prepare moet open staan.
466func (r *Runner) execContainer(ctx context.Context, sink *logSink, job store.Job, work string, env map[string]string) error {
467 ref, lines, rerr := r.resolveImage(ctx, job.Image)
468 for _, line := range lines {
469 sink.emit(line)
470 }
471 if rerr != nil {
472 sink.closeSection()
473 return rerr
474 }
475 job.Image = ref
476 job.Services = append([]store.Service(nil), job.Services...)
477 for i := range job.Services {
478 sref, slines, serr := r.resolveImage(ctx, job.Services[i].Name)
479 for _, line := range slines {
480 sink.emit(line)
481 }
482 if serr != nil {
483 sink.closeSection()
484 return serr
485 }
486 job.Services[i].Name = sref
487 }
488 network := r.Network
489 if network == "" {
490 network = "bridge"
491 }
492 if len(job.Services) > 0 {
493 net, cleanup, serr := r.startServices(ctx, job)
494 if serr != nil {
495 sink.closeSection()
496 return serr
497 }
498 defer cleanup()
499 network = net
500 }
501 sink.closeSection()
502 // -e NAAM zonder waarde laat Docker de variabele uit de omgeving van
503 // deze client overnemen. Zo blijft een meerregelige sleutel heel en
504 // staat de waarde niet in de proceslijst.
505 args := []string{"run", "--rm", "--network", network, "-v", work + ":/workspace", "-w", "/workspace"}
506 ctl := r.controls()
507 args = append(args, ctl.runArgs...)
508 if ctl.pull == runnercfg.PullNever {
509 args = append(args, "--pull", "never")
510 }
511 cmdEnv := append([]string{}, os.Environ()...)
512 for k, v := range env {
513 args = append(args, "-e", k)
514 cmdEnv = append(cmdEnv, k+"="+v)
515 }
516 args = append(args, "--entrypoint", "sh", job.Image, "/workspace/.bluegit-job.sh")
517 cmd := exec.CommandContext(ctx, r.Docker, args...)
518 cmd.Env = cmdEnv
519 cmd.Stdout = sink
520 cmd.Stderr = sink
521 err := cmd.Run()
522 sink.flush()
523 if err != nil {
524 return fmt.Errorf("container ended with an error: %w", err)
525 }
526 return nil
527}
528
529// placeNote zijn de vaste regels in de sectie Preparing environment.
530type placeNote struct {
531 Runner string
532 Host string
533 WorkDir string
534 PipelineID int64
535 JobID int64
536}
537
538func (n placeNote) lines() []string {
539 runner := strings.TrimSpace(n.Runner)
540 if runner == "" {
541 runner = "Steve"
542 }
543 host := strings.TrimSpace(n.Host)
544 if host == "" {
545 host = "localhost"
546 }
547 dir := strings.TrimSpace(n.WorkDir)
548 if dir == "" {
549 dir = "/workspace"
550 }
551 return []string{
552 fmt.Sprintf("Running on %s via %s...", runner, host),
553 fmt.Sprintf("Working directory: %s", dir),
554 fmt.Sprintf("Pipeline #%d, job #%d", n.PipelineID, n.JobID),
555 }
556}
557
558func shSingle(s string) string {
559 return "'" + strings.ReplaceAll(s, "'", `'"'"'`) + "'"
560}
561
562func shellScript(job store.Job, note placeNote) string {
563 var b strings.Builder
564 b.WriteString("#!/bin/sh\ncd /workspace\nrc=0\n")
565 fmt.Fprintf(&b, "echo \"section_start:before:Preparing environment\"\n")
566 for _, line := range note.lines() {
567 fmt.Fprintf(&b, "echo %s\n", shSingle(line))
568 }
569 if strings.TrimSpace(job.Before) != "" {
570 b.WriteString("(\nset -e\n")
571 b.WriteString(job.Before)
572 if !strings.HasSuffix(job.Before, "\n") {
573 b.WriteByte('\n')
574 }
575 b.WriteString(")\nbrc=$?\n")
576 } else {
577 b.WriteString("brc=0\n")
578 }
579 b.WriteString("echo \"section_end:before:Preparing environment\"\n")
580 b.WriteString("echo \"section_start:script:Running script\"\n")
581 b.WriteString("if [ \"$brc\" -eq 0 ]; then\n(\nset -e\n")
582 b.WriteString(job.Script)
583 if !strings.HasSuffix(job.Script, "\n") {
584 b.WriteByte('\n')
585 }
586 b.WriteString(")\nrc=$?\nelse\nrc=$brc\nfi\n")
587 b.WriteString("echo \"section_end:script:Running script\"\n")
588 b.WriteString("echo \"section_start:after:After script\"\n")
589 if strings.TrimSpace(job.After) != "" {
590 b.WriteString("(\nset -e\n")
591 b.WriteString(job.After)
592 if !strings.HasSuffix(job.After, "\n") {
593 b.WriteByte('\n')
594 }
595 b.WriteString(")\n")
596 }
597 b.WriteString("echo \"section_end:after:After script\"\nexit \"$rc\"\n")
598 return b.String()
599}
600
601// resolveImage kiest het image waarmee de container start.
602// Een alias zoals bluegit/node wordt gebouwd. node:22 blijft zichzelf.
603func (r *Runner) resolveImage(ctx context.Context, image string) (string, []string, error) {
604 image = strings.TrimSpace(image)
605 set, err := images.Effective(r.presetSet())
606 if err != nil {
607 return image, nil, fmt.Errorf("runner_system_failure: %w", err)
608 }
609 missing := fmt.Errorf("runner_system_failure: docker (%s) is not available; the job only runs in a container", r.Docker)
610 if _, lookErr := exec.LookPath(r.Docker); lookErr != nil {
611 if p, ok := images.Find(set, image); ok {
612 return "", imageLog(p.Name, p.From, p.From, "", nil, nil), missing
613 }
614 return image, dockerImageLines(image, "", nil), missing
615 }
616 p, ok := images.Find(set, image)
617 if !ok {
618 if r.controls().pull == runnercfg.PullAlways {
619 _, _ = execOut(ctx, r.Docker, "pull", "--quiet", image)
620 }
621 id, digests := r.inspectImage(ctx, image)
622 return image, dockerImageLines(image, id, digests), nil
623 }
624 ref, built, err := p.Ensure(ctx, r.Docker)
625 if err != nil {
626 return "", imageLog(p.Name, p.From, "", "", nil, nil), fmt.Errorf("runner_system_failure: preset %s: %w", p.Name, err)
627 }
628 var lines []string
629 if built {
630 lines = append(lines, fmt.Sprintf("Building image preset %s ...", p.Name))
631 }
632 id, digests := r.inspectImage(ctx, ref)
633 var baseDigests []string
634 if ref != p.From {
635 _, baseDigests = r.inspectImage(ctx, p.From)
636 }
637 lines = append(lines, imageLog(p.Name, p.From, ref, id, digests, baseDigests)...)
638 return ref, lines, nil
639}
640
641func imageLog(preset, base, ref, id string, digests, baseDigests []string) []string {
642 var lines []string
643 if preset != "" {
644 lines = append(lines, fmt.Sprintf("Using image preset %s based on %s", preset, base))
645 }
646 if ref == "" {
647 return lines
648 }
649 lines = append(lines, dockerImageLines(ref, id, digests)...)
650 if preset != "" && ref != base {
651 digest := matchingDigest(base, baseDigests)
652 if digest == "" && len(baseDigests) > 0 {
653 digest = strings.TrimSpace(baseDigests[0])
654 }
655 if digest != "" {
656 lines = append(lines, fmt.Sprintf("Underlying image %s with digest %s ...", base, digest))
657 } else {
658 lines = append(lines, fmt.Sprintf("Underlying image %s ...", base))
659 }
660 }
661 return lines
662}
663
664func (r *Runner) inspectImage(ctx context.Context, image string) (string, []string) {
665 if strings.TrimSpace(image) == "" || r.Docker == "" {
666 return "", nil
667 }
668 out, err := execOut(ctx, r.Docker, "image", "inspect", "--format", "{{.Id}}\n{{range .RepoDigests}}{{.}}\n{{end}}", image)
669 if err != nil {
670 return "", nil
671 }
672 return parseImageInspect(out)
673}
674
675func parseImageInspect(out string) (string, []string) {
676 lines := strings.Split(out, "\n")
677 id := ""
678 if len(lines) > 0 {
679 id = strings.TrimSpace(lines[0])
680 }
681 var digests []string
682 for _, line := range lines[1:] {
683 line = strings.TrimSpace(line)
684 if line != "" {
685 digests = append(digests, line)
686 }
687 }
688 return id, digests
689}
690
691func dockerImageLines(image, id string, digests []string) []string {
692 image = strings.TrimSpace(image)
693 lines := []string{fmt.Sprintf("Using docker image %s ...", image)}
694 id = strings.TrimSpace(id)
695 digest := matchingDigest(image, digests)
696 switch {
697 case id != "" && digest != "":
698 lines = append(lines, fmt.Sprintf("Using docker image %s for %s with digest %s ...", id, image, digest))
699 case digest != "":
700 lines = append(lines, fmt.Sprintf("Using digest %s for %s ...", digest, image))
701 case id != "":
702 lines = append(lines, fmt.Sprintf("Using docker image %s for %s ...", id, image))
703 }
704 return lines
705}
706
707func matchingDigest(image string, digests []string) string {
708 name := imageName(image)
709 fallback := ""
710 for _, digest := range digests {
711 digest = strings.TrimSpace(digest)
712 at := strings.LastIndex(digest, "@")
713 if digest == "" || at <= 0 {
714 continue
715 }
716 if fallback == "" {
717 fallback = digest
718 }
719 repo := digest[:at]
720 if repo == name || strings.HasSuffix(repo, "/"+name) || imageName(repo) == name {
721 return digest
722 }
723 }
724 return fallback
725}
726
727func imageName(image string) string {
728 image = strings.TrimSpace(image)
729 if i := strings.LastIndex(image, "@"); i >= 0 {
730 image = image[:i]
731 }
732 slash := strings.LastIndex(image, "/")
733 name := image
734 if slash >= 0 {
735 name = image[slash+1:]
736 }
737 if i := strings.Index(name, ":"); i >= 0 {
738 name = name[:i]
739 }
740 return name
741}
742
743func (r *Runner) materialize(ctx context.Context, p store.Pipeline, job store.Job, work string) error {
744 jobs, err := r.Store.JobsByPipeline(ctx, p.ID)
745 if err != nil {
746 return err
747 }
748 wanted := map[string]bool{}
749 if job.NeedsSet {
750 for _, n := range job.Needs {
751 wanted[n] = true
752 }
753 } else {
754 stageOrder := map[string]int{}
755 n := 0
756 for _, j := range jobs {
757 if _, ok := stageOrder[j.Stage]; !ok {
758 stageOrder[j.Stage] = n
759 n++
760 }
761 }
762 my := stageOrder[job.Stage]
763 for _, j := range jobs {
764 if stageOrder[j.Stage] < my {
765 wanted[j.Name] = true
766 }
767 }
768 }
769 for _, j := range jobs {
770 if !wanted[j.Name] || j.Status != "success" {
771 continue
772 }
773 for _, rel := range j.ArtifactPaths {
774 src, err := r.Store.ArtifactPath(ctx, p.ID, j.Name, rel)
775 if err != nil {
776 continue
777 }
778 dst := filepath.Join(work, filepath.FromSlash(rel))
779 if err := copyFile(src, dst); err != nil {
780 return err
781 }
782 }
783 }
784 return nil
785}
786
787func (r *Runner) collect(ctx context.Context, job store.Job, work string) error {
788 var expires *time.Time
789 if job.ArtifactExpire > 0 {
790 t := time.Now().Add(job.ArtifactExpire)
791 expires = &t
792 }
793 for _, rel := range job.ArtifactPaths {
794 src := filepath.Join(work, filepath.FromSlash(rel))
795 info, err := os.Stat(src)
796 if err != nil || info.IsDir() {
797 return fmt.Errorf("artifact %s ontbreekt", rel)
798 }
799 dst := filepath.Join(r.storage(), "artifacts", fmt.Sprint(job.ID), filepath.FromSlash(rel))
800 if err := copyFile(src, dst); err != nil {
801 return err
802 }
803 if err := r.Store.AddArtifact(ctx, job.ID, rel, dst, info.Size(), expires); err != nil {
804 return err
805 }
806 }
807 return nil
808}
809
810func (r *Runner) environment(ctx context.Context, repo store.Repo, p store.Pipeline, job store.Job, token string) (map[string]string, []string, error) {
811 name, _ := ci.SplitRef(p.Ref)
812 patterns, err := r.Store.ProtectedPatterns(ctx, repo.ID)
813 if err != nil {
814 return nil, nil, err
815 }
816 refProtected := access.BranchProtected(patterns, name)
817 env := map[string]string{}
818 var mask []string
819 if repo.OwnerKind == "group" {
820 groupSecrets, err := r.Store.SecretValues(ctx, "group", repo.OwnerID, refProtected)
821 if err != nil {
822 return nil, nil, err
823 }
824 for k, v := range groupSecrets {
825 env[k] = v
826 mask = append(mask, v)
827 }
828 }
829 repoSecrets, err := r.Store.SecretValues(ctx, "repo", repo.ID, refProtected)
830 if err != nil {
831 return nil, nil, err
832 }
833 for k, v := range repoSecrets {
834 env[k] = v
835 mask = append(mask, v)
836 }
837 for k, v := range job.Variables {
838 env[k] = v
839 }
840 base := strings.TrimRight(r.BaseURL, "/")
841 dir := gitrepo.Dir(r.storage(), repo.OwnerPath, repo.Name)
842 var info *ci.MRInfo
843 if p.MRID != 0 {
844 if m, merr := r.Store.MergeRequest(ctx, repo.ID, p.MRID); merr == nil {
845 target := ""
846 if out, gerr := exec.CommandContext(ctx, r.GitBin, "-C", dir, "rev-parse", "--verify", "refs/heads/"+m.TargetBranch).Output(); gerr == nil {
847 target = strings.TrimSpace(string(out))
848 }
849 info = &ci.MRInfo{
850 ID: m.ID, IID: m.Number, Title: m.Title,
851 SourceBranch: m.SourceBranch, TargetBranch: m.TargetBranch,
852 ProjectPath: repo.FullPath(), ProjectURL: base + "/" + repo.FullPath(),
853 TargetSHA: target,
854 }
855 }
856 }
857 stamp, _ := gitrepo.CommitterTimestamp(ctx, r.GitBin, dir, p.CommitSHA)
858 pre := ci.Variables(ci.Ref{
859 SHA: p.CommitSHA, FullRef: p.Ref, Title: p.CommitTitle, Timestamp: stamp,
860 DefaultBranch: repo.DefaultBranch, Source: p.Source,
861 ProjectPath: repo.FullPath(), ProjectURL: base + "/" + repo.FullPath(),
862 APIURL: base + "/api/v1", PipelineID: p.ID, MR: info,
863 })
864 for k, v := range pre {
865 env[k] = v
866 }
867 env["CI_JOB_ID"] = fmt.Sprint(job.ID)
868 env["CI_JOB_NAME"] = job.Name
869 env["CI_JOB_STAGE"] = job.Stage
870 env["CI_JOB_URL"] = base + "/" + repo.FullPath() + "/-/pipelines/" + fmt.Sprint(p.ID) + "/jobs/" + fmt.Sprint(job.ID)
871 env["CI_JOB_TOKEN"] = token
872 if job.Environment != "" {
873 env["CI_ENVIRONMENT_NAME"] = job.Environment
874 if job.EnvironmentURL != "" {
875 env["CI_ENVIRONMENT_URL"] = ci.Expand(job.EnvironmentURL, env)
876 }
877 }
878 for k, v := range job.Variables {
879 if strings.HasPrefix(k, "CI_NODE_") {
880 env[k] = v
881 }
882 }
883 // Na de jobvariabelen, zodat een eigen GIT_CONFIG_COUNT blijft staan
884 // en safe.directory er alsnog bij komt.
885 markWorkspaceSafe(env)
886 mask = append(mask, token)
887 return env, mask, nil
888}
889
890// markWorkspaceSafe zet safe.directory voor elke job.
891// De checkout is van de host-uid; de container-user is dat niet.
892// Git 2.35+ weigert die repo anders. Een job die safe.directory al op
893// * of /workspace zet, blijft zoals hij is.
894func markWorkspaceSafe(env map[string]string) {
895 const key = "safe.directory"
896 n := 0
897 if raw, ok := env["GIT_CONFIG_COUNT"]; ok {
898 if v, err := strconv.Atoi(strings.TrimSpace(raw)); err == nil && v > 0 {
899 n = v
900 }
901 }
902 for i := 0; i < n; i++ {
903 if env[fmt.Sprintf("GIT_CONFIG_KEY_%d", i)] != key {
904 continue
905 }
906 switch env[fmt.Sprintf("GIT_CONFIG_VALUE_%d", i)] {
907 case "*", "/workspace":
908 return
909 }
910 }
911 env[fmt.Sprintf("GIT_CONFIG_KEY_%d", n)] = key
912 env[fmt.Sprintf("GIT_CONFIG_VALUE_%d", n)] = "*"
913 env["GIT_CONFIG_COUNT"] = strconv.Itoa(n + 1)
914}
915
916func (r *Runner) startServices(ctx context.Context, job store.Job) (string, func(), error) {
917 netName := fmt.Sprintf("bluegit-%d", job.ID)
918 if _, err := execOut(ctx, r.Docker, "network", "create", netName); err != nil {
919 return "", func() {}, fmt.Errorf("runner_system_failure: docker network: %w", err)
920 }
921 var names []string
922 cleanup := func() {
923 cctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
924 defer cancel()
925 for _, name := range names {
926 _, _ = execOut(cctx, r.Docker, "rm", "-f", name)
927 }
928 _, _ = execOut(cctx, r.Docker, "network", "rm", netName)
929 }
930 for i, svc := range job.Services {
931 cname := fmt.Sprintf("bluegit-svc-%d-%d", job.ID, i)
932 args := []string{"run", "-d", "--name", cname, "--network", netName}
933 if svc.Alias != "" {
934 args = append(args, "--network-alias", svc.Alias)
935 }
936 cmdEnv := append([]string{}, os.Environ()...)
937 for k, v := range svc.Variables {
938 args = append(args, "-e", k)
939 cmdEnv = append(cmdEnv, k+"="+v)
940 }
941 if len(svc.Entrypoint) > 0 {
942 args = append(args, "--entrypoint", svc.Entrypoint[0])
943 }
944 args = append(args, svc.Name)
945 if len(svc.Entrypoint) > 1 {
946 args = append(args, svc.Entrypoint[1:]...)
947 }
948 args = append(args, svc.Command...)
949 cmd := exec.CommandContext(ctx, r.Docker, args...)
950 cmd.Env = cmdEnv
951 var stderr bytes.Buffer
952 cmd.Stderr = &stderr
953 if err := cmd.Run(); err != nil {
954 cleanup()
955 msg := strings.TrimSpace(stderr.String())
956 if msg == "" {
957 msg = err.Error()
958 }
959 return "", func() {}, fmt.Errorf("runner_system_failure: service %s: %s", svc.Name, msg)
960 }
961 names = append(names, cname)
962 }
963 return netName, cleanup, nil
964}
965
966func shouldRetry(job store.Job, kind string) bool {
967 if job.RetryMax <= 0 || job.Attempt >= job.RetryMax || kind == "" {
968 return false
969 }
970 if len(job.RetryWhen) == 0 || containsStr(job.RetryWhen, "always") {
971 return true
972 }
973 if containsStr(job.RetryWhen, kind) {
974 return true
975 }
976 return kind == "job_execution_timeout" && containsStr(job.RetryWhen, "stuck_or_timeout_failure")
977}
978
979func classifyFailure(err error) string {
980 msg := err.Error()
981 if strings.Contains(msg, "runner_system_failure") || strings.Contains(msg, "is not available") {
982 return "runner_system_failure"
983 }
984 if errors.Is(err, context.DeadlineExceeded) || strings.Contains(msg, "deadline exceeded") {
985 return "job_execution_timeout"
986 }
987 return "script_failure"
988}
989
990func containsStr(list []string, s string) bool {
991 for _, item := range list {
992 if item == s {
993 return true
994 }
995 }
996 return false
997}
998
999func safeSegment(name string) string {
1000 var b strings.Builder
1001 for _, r := range name {
1002 if (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') || (r >= '0' && r <= '9') || r == '.' || r == '_' || r == '-' {
1003 b.WriteRune(r)
1004 } else {
1005 b.WriteByte('_')
1006 }
1007 }
1008 if b.Len() == 0 {
1009 return "job"
1010 }
1011 return b.String()
1012}
1013
1014func (r *Runner) restoreCache(repoID int64, job store.Job, work string) error {
1015 if len(job.CachePaths) == 0 {
1016 return nil
1017 }
1018 root := r.cacheDir(repoID, job.CacheKey)
1019 for _, rel := range job.CachePaths {
1020 src := filepath.Join(root, filepath.FromSlash(rel))
1021 if _, err := os.Stat(src); err != nil {
1022 continue
1023 }
1024 if err := copyFile(src, filepath.Join(work, filepath.FromSlash(rel))); err != nil {
1025 return err
1026 }
1027 }
1028 return nil
1029}
1030
1031func (r *Runner) saveCache(repoID int64, job store.Job, work string) error {
1032 if len(job.CachePaths) == 0 {
1033 return nil
1034 }
1035 root := r.cacheDir(repoID, job.CacheKey)
1036 for _, rel := range job.CachePaths {
1037 src := filepath.Join(work, filepath.FromSlash(rel))
1038 info, err := os.Stat(src)
1039 if err != nil || info.IsDir() {
1040 continue
1041 }
1042 if err := copyFile(src, filepath.Join(root, filepath.FromSlash(rel))); err != nil {
1043 return err
1044 }
1045 }
1046 return nil
1047}
1048
1049func (r *Runner) cacheDir(repoID int64, key string) string {
1050 if key == "" {
1051 key = "default"
1052 }
1053 var b strings.Builder
1054 for _, r := range key {
1055 if (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') || (r >= '0' && r <= '9') || r == '.' || r == '_' || r == '-' {
1056 b.WriteRune(r)
1057 }
1058 }
1059 safe := b.String()
1060 if safe == "" {
1061 safe = "default"
1062 }
1063 return filepath.Join(r.storage(), "cache", fmt.Sprint(repoID), safe)
1064}
1065
1066func stamp(line string) string {
1067 return time.Now().UTC().Format(time.RFC3339) + "\t" + line + "\n"
1068}
1069
1070type logSink struct {
1071 mu sync.Mutex
1072 store *store.Store
1073 jobID int64
1074 out func(string)
1075 secrets []string
1076 partial string
1077 current string
1078 opened time.Time
1079}
1080
1081func (l *logSink) Write(p []byte) (int, error) {
1082 l.mu.Lock()
1083 defer l.mu.Unlock()
1084 l.partial += string(p)
1085 for {
1086 i := strings.IndexByte(l.partial, '\n')
1087 if i < 0 {
1088 break
1089 }
1090 l.emit(strings.TrimRight(l.partial[:i], "\r"))
1091 l.partial = l.partial[i+1:]
1092 }
1093 return len(p), nil
1094}
1095
1096func (l *logSink) flush() {
1097 l.mu.Lock()
1098 defer l.mu.Unlock()
1099 if strings.TrimSpace(l.partial) != "" {
1100 l.emit(l.partial)
1101 }
1102 l.partial = ""
1103}
1104
1105func (l *logSink) emit(line string) {
1106 line = ci.Mask(line, l.secrets)
1107 if strings.HasPrefix(line, "section_start:") || strings.HasPrefix(line, "section_end:") {
1108 if l.current != "" && strings.HasPrefix(line, "section_end:") {
1109 dur := int(time.Since(l.opened).Seconds())
1110 line = line + "\t" + fmt.Sprintf("%02d:%02d", dur/60, dur%60)
1111 l.current = ""
1112 }
1113 if strings.HasPrefix(line, "section_start:") {
1114 l.current = line
1115 l.opened = time.Now()
1116 }
1117 }
1118 if l.out != nil {
1119 l.out(stamp(line))
1120 return
1121 }
1122 _ = l.store.AppendJobLog(context.Background(), l.jobID, stamp(line))
1123}
1124
1125func (l *logSink) section(name, title string) {
1126 l.emit("section_start:" + name + ":" + title)
1127}
1128
1129func (l *logSink) closeSection() {
1130 if l.current == "" {
1131 return
1132 }
1133 name := "prepare"
1134 if parts := strings.SplitN(strings.TrimPrefix(l.current, "section_start:"), ":", 2); len(parts) > 0 && parts[0] != "" {
1135 name = parts[0]
1136 }
1137 l.emit("section_end:" + name + ":done")
1138}
1139
1140func copyFile(src, dst string) error {
1141 if err := os.MkdirAll(filepath.Dir(dst), 0o755); err != nil {
1142 return err
1143 }
1144 in, err := os.Open(src)
1145 if err != nil {
1146 return err
1147 }
1148 defer in.Close()
1149 out, err := os.OpenFile(dst, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0o644)
1150 if err != nil {
1151 return err
1152 }
1153 defer out.Close()
1154 _, err = io.Copy(out, in)
1155 return err
1156}
1157
1158func execOut(ctx context.Context, bin string, args ...string) (string, error) {
1159 if bin == "" {
1160 bin = "git"
1161 }
1162 cmd := exec.CommandContext(ctx, bin, args...)
1163 var stdout, stderr bytes.Buffer
1164 cmd.Stdout = &stdout
1165 cmd.Stderr = &stderr
1166 if err := cmd.Run(); err != nil {
1167 msg := strings.TrimSpace(stderr.String())
1168 if msg == "" {
1169 msg = err.Error()
1170 }
1171 return "", fmt.Errorf("%s", msg)
1172 }
1173 return stdout.String(), nil
1174}
1175
1176// cloneArgs kopieert de objecten in plaats van hardlinks te maken: de
1177// werkmap en de bare repo kunnen andere eigenaars hebben, en met
1178// fs.protected_hardlinks geeft link() dan "Operation not permitted".
1179func cloneArgs(bare, work string) []string {
1180 return []string{"clone", "--no-hardlinks", bare, work}
1181}