this repo has no description
tangled.org
1package nixery
2
3import (
4 "context"
5 "errors"
6 "fmt"
7 "io"
8 "log/slog"
9 "os"
10 "path"
11 "runtime"
12 "sync"
13 "time"
14
15 "github.com/docker/docker/api/types/container"
16 "github.com/docker/docker/api/types/image"
17 "github.com/docker/docker/api/types/mount"
18 "github.com/docker/docker/api/types/network"
19 "github.com/docker/docker/client"
20 "github.com/docker/docker/pkg/stdcopy"
21 "gopkg.in/yaml.v3"
22 "tangled.org/core/api/tangled"
23 "tangled.org/core/log"
24 "tangled.org/core/spindle/config"
25 "tangled.org/core/spindle/engine"
26 "tangled.org/core/spindle/models"
27 "tangled.org/core/spindle/secrets"
28)
29
30const (
31 workspaceDir = "/tangled/workspace"
32 homeDir = "/tangled/home"
33)
34
35type cleanupFunc func(context.Context) error
36
37type Engine struct {
38 docker client.APIClient
39 l *slog.Logger
40 cfg *config.Config
41
42 cleanupMu sync.Mutex
43 cleanup map[string][]cleanupFunc
44}
45
46type Step struct {
47 name string
48 kind models.StepKind
49 command string
50 environment map[string]string
51}
52
53func (s Step) Name() string {
54 return s.name
55}
56
57func (s Step) Command() string {
58 return s.command
59}
60
61func (s Step) Kind() models.StepKind {
62 return s.kind
63}
64
65// setupSteps get added to start of Steps
66type setupSteps []models.Step
67
68// addStep adds a step to the beginning of the workflow's steps.
69func (ss *setupSteps) addStep(step models.Step) {
70 *ss = append(*ss, step)
71}
72
73type addlFields struct {
74 image string
75 container string
76}
77
78func (e *Engine) InitWorkflow(twf tangled.Pipeline_Workflow, tpl tangled.Pipeline) (*models.Workflow, error) {
79 swf := &models.Workflow{}
80 addl := addlFields{}
81
82 dwf := &struct {
83 Steps []struct {
84 Command string `yaml:"command"`
85 Name string `yaml:"name"`
86 Environment map[string]string `yaml:"environment"`
87 } `yaml:"steps"`
88 Dependencies map[string][]string `yaml:"dependencies"`
89 Environment map[string]string `yaml:"environment"`
90 }{}
91 err := yaml.Unmarshal([]byte(twf.Raw), &dwf)
92 if err != nil {
93 return nil, err
94 }
95
96 for _, dstep := range dwf.Steps {
97 sstep := Step{}
98 sstep.environment = dstep.Environment
99 sstep.command = dstep.Command
100 sstep.name = dstep.Name
101 sstep.kind = models.StepKindUser
102 swf.Steps = append(swf.Steps, sstep)
103 }
104 swf.Name = twf.Name
105 swf.Environment = dwf.Environment
106 addl.image = workflowImage(dwf.Dependencies, e.cfg.NixeryPipelines.Nixery)
107
108 setup := &setupSteps{}
109
110 setup.addStep(nixConfStep())
111 setup.addStep(models.BuildCloneStep(twf, *tpl.TriggerMetadata, e.cfg.Server.Dev))
112 // this step could be empty
113 if s := dependencyStep(dwf.Dependencies); s != nil {
114 setup.addStep(*s)
115 }
116
117 // append setup steps in order to the start of workflow steps
118 swf.Steps = append(*setup, swf.Steps...)
119 swf.Data = addl
120
121 return swf, nil
122}
123
124func (e *Engine) WorkflowTimeout() time.Duration {
125 workflowTimeoutStr := e.cfg.NixeryPipelines.WorkflowTimeout
126 workflowTimeout, err := time.ParseDuration(workflowTimeoutStr)
127 if err != nil {
128 e.l.Error("failed to parse workflow timeout", "error", err, "timeout", workflowTimeoutStr)
129 workflowTimeout = 5 * time.Minute
130 }
131
132 return workflowTimeout
133}
134
135func workflowImage(deps map[string][]string, nixery string) string {
136 var dependencies string
137 for reg, ds := range deps {
138 if reg == "nixpkgs" {
139 dependencies = path.Join(ds...)
140 }
141 }
142
143 // load defaults from somewhere else
144 dependencies = path.Join(dependencies, "bash", "git", "coreutils", "nix")
145
146 if runtime.GOARCH == "arm64" {
147 dependencies = path.Join("arm64", dependencies)
148 }
149
150 return path.Join(nixery, dependencies)
151}
152
153func New(ctx context.Context, cfg *config.Config) (*Engine, error) {
154 dcli, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
155 if err != nil {
156 return nil, err
157 }
158
159 l := log.FromContext(ctx).With("component", "spindle")
160
161 e := &Engine{
162 docker: dcli,
163 l: l,
164 cfg: cfg,
165 }
166
167 e.cleanup = make(map[string][]cleanupFunc)
168
169 return e, nil
170}
171
172func (e *Engine) SetupWorkflow(ctx context.Context, wid models.WorkflowId, wf *models.Workflow) error {
173 e.l.Info("setting up workflow", "workflow", wid)
174
175 _, err := e.docker.NetworkCreate(ctx, networkName(wid), network.CreateOptions{
176 Driver: "bridge",
177 })
178 if err != nil {
179 return err
180 }
181 e.registerCleanup(wid, func(ctx context.Context) error {
182 if err := e.docker.NetworkRemove(ctx, networkName(wid)); err != nil {
183 return fmt.Errorf("removing network: %w", err)
184 }
185 return nil
186 })
187
188 addl := wf.Data.(addlFields)
189
190 reader, err := e.docker.ImagePull(ctx, addl.image, image.PullOptions{})
191 if err != nil {
192 e.l.Error("pipeline image pull failed!", "image", addl.image, "workflowId", wid, "error", err.Error())
193
194 return fmt.Errorf("pulling image: %w", err)
195 }
196 defer reader.Close()
197 io.Copy(os.Stdout, reader)
198
199 resp, err := e.docker.ContainerCreate(ctx, &container.Config{
200 Image: addl.image,
201 Cmd: []string{"cat"},
202 OpenStdin: true, // so cat stays alive :3
203 Tty: false,
204 Hostname: "spindle",
205 WorkingDir: workspaceDir,
206 Labels: map[string]string{
207 "sh.tangled.pipeline/workflow_id": wid.String(),
208 },
209 // TODO(winter): investigate whether environment variables passed here
210 // get propagated to ContainerExec processes
211 }, &container.HostConfig{
212 Mounts: []mount.Mount{
213 {
214 Type: mount.TypeTmpfs,
215 Target: "/tmp",
216 ReadOnly: false,
217 TmpfsOptions: &mount.TmpfsOptions{
218 Mode: 0o1777, // world-writeable sticky bit
219 Options: [][]string{
220 {"exec"},
221 },
222 },
223 },
224 },
225 ReadonlyRootfs: false,
226 CapDrop: []string{"ALL"},
227 CapAdd: []string{"CAP_DAC_OVERRIDE", "CAP_CHOWN", "CAP_FOWNER", "CAP_SETUID", "CAP_SETGID"},
228 SecurityOpt: []string{"no-new-privileges"},
229 ExtraHosts: []string{"host.docker.internal:host-gateway"},
230 }, nil, nil, "")
231 if err != nil {
232 return fmt.Errorf("creating container: %w", err)
233 }
234 e.registerCleanup(wid, func(ctx context.Context) error {
235 if err := e.docker.ContainerStop(ctx, resp.ID, container.StopOptions{}); err != nil {
236 return fmt.Errorf("stopping container: %w", err)
237 }
238
239 err := e.docker.ContainerRemove(ctx, resp.ID, container.RemoveOptions{
240 RemoveVolumes: true,
241 RemoveLinks: false,
242 Force: false,
243 })
244 if err != nil {
245 return fmt.Errorf("removing container: %w", err)
246 }
247 return nil
248 })
249
250 if err := e.docker.ContainerStart(ctx, resp.ID, container.StartOptions{}); err != nil {
251 return fmt.Errorf("starting container: %w", err)
252 }
253
254 mkExecResp, err := e.docker.ContainerExecCreate(ctx, resp.ID, container.ExecOptions{
255 Cmd: []string{"mkdir", "-p", workspaceDir, homeDir},
256 AttachStdout: true, // NOTE(winter): pretty sure this will make it so that when stdout read is done below, mkdir is done. maybe??
257 AttachStderr: true, // for good measure, backed up by docker/cli ("If -d is not set, attach to everything by default")
258 })
259 if err != nil {
260 return err
261 }
262
263 // This actually *starts* the command. Thanks, Docker!
264 execResp, err := e.docker.ContainerExecAttach(ctx, mkExecResp.ID, container.ExecAttachOptions{})
265 if err != nil {
266 return err
267 }
268 defer execResp.Close()
269
270 // This is apparently best way to wait for the command to complete.
271 _, err = io.ReadAll(execResp.Reader)
272 if err != nil {
273 return err
274 }
275
276 execInspectResp, err := e.docker.ContainerExecInspect(ctx, mkExecResp.ID)
277 if err != nil {
278 return err
279 }
280
281 if execInspectResp.ExitCode != 0 {
282 return fmt.Errorf("mkdir exited with exit code %d", execInspectResp.ExitCode)
283 } else if execInspectResp.Running {
284 return errors.New("mkdir is somehow still running??")
285 }
286
287 addl.container = resp.ID
288 wf.Data = addl
289
290 return nil
291}
292
293func (e *Engine) RunStep(ctx context.Context, wid models.WorkflowId, w *models.Workflow, idx int, secrets []secrets.UnlockedSecret, wfLogger *models.WorkflowLogger) error {
294 addl := w.Data.(addlFields)
295 workflowEnvs := ConstructEnvs(w.Environment)
296 // TODO(winter): should SetupWorkflow also have secret access?
297 // IMO yes, but probably worth thinking on.
298 for _, s := range secrets {
299 workflowEnvs.AddEnv(s.Key, s.Value)
300 }
301
302 step := w.Steps[idx]
303
304 select {
305 case <-ctx.Done():
306 return ctx.Err()
307 default:
308 }
309
310 envs := append(EnvVars(nil), workflowEnvs...)
311 if nixStep, ok := step.(Step); ok {
312 for k, v := range nixStep.environment {
313 envs.AddEnv(k, v)
314 }
315 }
316 envs.AddEnv("HOME", homeDir)
317
318 mkExecResp, err := e.docker.ContainerExecCreate(ctx, addl.container, container.ExecOptions{
319 Cmd: []string{"bash", "-c", step.Command()},
320 AttachStdout: true,
321 AttachStderr: true,
322 Env: envs,
323 })
324 if err != nil {
325 return fmt.Errorf("creating exec: %w", err)
326 }
327
328 // start tailing logs in background
329 tailDone := make(chan error, 1)
330 go func() {
331 tailDone <- e.tailStep(ctx, wfLogger, mkExecResp.ID, wid, idx, step)
332 }()
333
334 select {
335 case <-tailDone:
336
337 case <-ctx.Done():
338 // cleanup will be handled by DestroyWorkflow, since
339 // Docker doesn't provide an API to kill an exec run
340 // (sure, we could grab the PID and kill it ourselves,
341 // but that's wasted effort)
342 e.l.Warn("step timed out", "step", step.Name())
343
344 <-tailDone
345
346 return engine.ErrTimedOut
347 }
348
349 select {
350 case <-ctx.Done():
351 return ctx.Err()
352 default:
353 }
354
355 execInspectResp, err := e.docker.ContainerExecInspect(ctx, mkExecResp.ID)
356 if err != nil {
357 return err
358 }
359
360 if execInspectResp.ExitCode != 0 {
361 inspectResp, err := e.docker.ContainerInspect(ctx, addl.container)
362 if err != nil {
363 return err
364 }
365
366 e.l.Error("workflow failed!", "workflow_id", wid.String(), "exit_code", execInspectResp.ExitCode, "oom_killed", inspectResp.State.OOMKilled)
367
368 if inspectResp.State.OOMKilled {
369 return ErrOOMKilled
370 }
371 return engine.ErrWorkflowFailed
372 }
373
374 return nil
375}
376
377func (e *Engine) tailStep(ctx context.Context, wfLogger *models.WorkflowLogger, execID string, wid models.WorkflowId, stepIdx int, step models.Step) error {
378 if wfLogger == nil {
379 return nil
380 }
381
382 // This actually *starts* the command. Thanks, Docker!
383 logs, err := e.docker.ContainerExecAttach(ctx, execID, container.ExecAttachOptions{})
384 if err != nil {
385 return err
386 }
387 defer logs.Close()
388
389 _, err = stdcopy.StdCopy(
390 wfLogger.DataWriter(stepIdx, "stdout"),
391 wfLogger.DataWriter(stepIdx, "stderr"),
392 logs.Reader,
393 )
394 if err != nil && err != io.EOF && !errors.Is(err, context.DeadlineExceeded) {
395 return fmt.Errorf("failed to copy logs: %w", err)
396 }
397
398 return nil
399}
400
401func (e *Engine) DestroyWorkflow(ctx context.Context, wid models.WorkflowId) error {
402 fns := e.drainCleanups(wid)
403
404 for _, fn := range fns {
405 if err := fn(ctx); err != nil {
406 e.l.Error("failed to cleanup workflow resource", "workflowId", wid, "error", err)
407 }
408 }
409 return nil
410}
411
412func (e *Engine) registerCleanup(wid models.WorkflowId, fn cleanupFunc) {
413 e.cleanupMu.Lock()
414 defer e.cleanupMu.Unlock()
415
416 key := wid.String()
417 e.cleanup[key] = append(e.cleanup[key], fn)
418}
419
420func (e *Engine) drainCleanups(wid models.WorkflowId) []cleanupFunc {
421 e.cleanupMu.Lock()
422 key := wid.String()
423
424 fns := e.cleanup[key]
425 delete(e.cleanup, key)
426 e.cleanupMu.Unlock()
427
428 return fns
429}
430
431func networkName(wid models.WorkflowId) string {
432 return fmt.Sprintf("workflow-network-%s", wid)
433}