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