-
Notifications
You must be signed in to change notification settings - Fork 250
/
d2g.go
513 lines (448 loc) · 17.4 KB
/
d2g.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
//go:generate go run ../../workers/generic-worker/gw-codegen file://../../workers/docker-worker/schemas/v1/payload.yml dockerworker/generated_types.go
//go:generate go run ../../workers/generic-worker/gw-codegen file://../../workers/generic-worker/schemas/multiuser_posix.yml genericworker/generated_types.go
package d2g
import (
"encoding/json"
"fmt"
"path/filepath"
"sort"
"strconv"
"strings"
"github.com/taskcluster/taskcluster/v59/tools/d2g/dockerworker"
"github.com/taskcluster/taskcluster/v59/tools/d2g/genericworker"
"github.com/mcuadros/go-defaults"
"github.com/taskcluster/shell"
)
type (
DockerImageName string
IndexedDockerImage dockerworker.IndexedDockerImage
NamedDockerImage dockerworker.NamedDockerImage
DockerImageArtifact dockerworker.DockerImageArtifact
Image interface {
FileMounts() ([]genericworker.FileMount, error)
String() (string, error)
}
)
func ConvertTaskDefinition(dwTaskDef json.RawMessage) (json.RawMessage, error) {
var gwTaskDef json.RawMessage
var parsedTaskDef map[string]interface{}
err := json.Unmarshal(dwTaskDef, &parsedTaskDef)
if err != nil {
return nil, fmt.Errorf("cannot parse task definition: %v", err)
}
if _, exists := parsedTaskDef["payload"]; !exists {
return nil, fmt.Errorf("task definition does not contain a payload")
}
dwPayload := new(dockerworker.DockerWorkerPayload)
defaults.SetDefaults(dwPayload)
dwPayloadJSON, err := json.Marshal(parsedTaskDef["payload"])
if err != nil {
return nil, fmt.Errorf("cannot marshal Docker Worker payload: %v", err)
}
err = json.Unmarshal(dwPayloadJSON, &dwPayload)
if err != nil {
return nil, fmt.Errorf("cannot unmarshal Docker Worker payload: %v", err)
}
gwPayload, err := Convert(dwPayload)
if err != nil {
return nil, fmt.Errorf("cannot convert Docker Worker payload: %v", err)
}
if scopes, exists := parsedTaskDef["scopes"]; exists {
var dwScopes []string
for _, scope := range scopes.([]interface{}) {
dwScopes = append(dwScopes, scope.(string))
}
var taskQueueID string
if parsedTaskDef["taskQueueId"] == nil {
if parsedTaskDef["provisionerId"] == nil || parsedTaskDef["workerType"] == nil {
return nil, fmt.Errorf("taskQueueId ('provisionerId/workerType') is required")
}
taskQueueID = fmt.Sprintf("%s/%s", parsedTaskDef["provisionerId"].(string), parsedTaskDef["workerType"].(string))
} else {
taskQueueID = parsedTaskDef["taskQueueId"].(string)
}
if taskQueueID == "" {
return nil, fmt.Errorf("taskQueueId ('provisionerId/workerType') is required")
}
parsedTaskDef["scopes"] = Scopes(dwScopes, dwPayload, taskQueueID)
}
d2gConvertedPayloadJSON, err := json.Marshal(*gwPayload)
if err != nil {
return nil, fmt.Errorf("cannot marshal Generic Worker payload: %v", err)
}
parsedTaskDef["payload"] = json.RawMessage(d2gConvertedPayloadJSON)
gwTaskDef, err = json.MarshalIndent(parsedTaskDef, "", " ")
if err != nil {
return nil, fmt.Errorf("cannot marshal Generic Worker task definition: %v", err)
}
return json.RawMessage(gwTaskDef), nil
}
// Scopes takes a slice of Docker Worker task scopes and returns a slice of
// equivalent Generic Worker scopes. These scopes should be used together with
// a converted Docker Worker task payload (see d2g.Convert function) to run
// Docker Worker tasks under Generic Worker.
func Scopes(dwScopes []string, dwPayload *dockerworker.DockerWorkerPayload, taskQueueID string) (gwScopes []string) {
gwScopes = make([]string, len(dwScopes))
for i, s := range dwScopes {
switch true {
case s == "docker-worker:capability:device:loopbackVideo":
gwScopes[i] = "generic-worker:loopback-video:*"
case strings.HasPrefix(s, "docker-worker:capability:device:loopbackVideo:"):
gwScopes[i] = "generic-worker:loopback-video:" + s[len("docker-worker:capability:device:loopbackVideo:"):]
case s == "docker-worker:capability:device:loopbackAudio":
gwScopes[i] = "generic-worker:loopback-audio:*"
case strings.HasPrefix(s, "docker-worker:capability:device:loopbackAudio:"):
gwScopes[i] = "generic-worker:loopback-audio:" + s[len("docker-worker:capability:device:loopbackAudio:"):]
case strings.HasPrefix(s, "docker-worker:"):
gwScopes[i] = "generic-worker:" + s[len("docker-worker:"):]
default:
gwScopes[i] = s
}
}
if dwPayload != nil && dwPayload.Capabilities.Devices.KVM {
gwScopes = append(gwScopes, fmt.Sprintf("generic-worker:os-group:%s/kvm", taskQueueID))
}
return
}
// Dev notes: https://docs.google.com/document/d/1QNfHVpxtzXAlLWqZNz3b5mvbQWOrtsWpvadJHiMNbRc/edit#heading=h.uib8l9zhaz1n
// Convert transforms a Docker Worker task payload into an equivalent Generic
// Worker Multiuser POSIX task payload. The resulting Generic Worker payload is
// a BASH script which uses Podman to contain the Docker Worker payload. Since
// scopes fall outside of the payload in a task definition, scopes need to be
// converted separately (see d2g.Scopes function).
func Convert(dwPayload *dockerworker.DockerWorkerPayload) (gwPayload *genericworker.GenericWorkerPayload, err error) {
gwPayload = new(genericworker.GenericWorkerPayload)
defaults.SetDefaults(gwPayload)
setArtifacts(dwPayload, gwPayload)
gwWritableDirectoryCaches := writableDirectoryCaches(dwPayload.Cache)
dwImage, err := imageObject(&dwPayload.Image)
if err != nil {
return
}
switch dwImage.(type) {
case *IndexedDockerImage:
// we want to be sure that TaskclusterProxy
// is enabled for IndexedDockerImages
// during the remainder of this translation
// it's used to access the index service API
gwPayload.Features.TaskclusterProxy = true
}
err = setCommand(dwPayload, gwPayload, dwImage, gwWritableDirectoryCaches)
if err != nil {
return
}
gwFileMounts, err := dwImage.FileMounts()
if err != nil {
return
}
err = setMounts(gwPayload, gwWritableDirectoryCaches, gwFileMounts)
if err != nil {
return
}
setEnv(dwPayload, gwPayload)
setFeatures(dwPayload, gwPayload)
setLogs(dwPayload, gwPayload)
setMaxRunTime(dwPayload, gwPayload)
setOnExitStatus(dwPayload, gwPayload)
setSupersederURL(dwPayload, gwPayload)
setOSGroups(dwPayload, gwPayload)
return
}
func mounts(gwWritableDirectoryCaches []genericworker.WritableDirectoryCache, gwFileMounts []genericworker.FileMount) (result []json.RawMessage, err error) {
result = make([]json.RawMessage, 0, len(gwWritableDirectoryCaches)+len(gwFileMounts))
marshalAndAddToSlice := func(i interface{}) {
var bytes []byte
bytes, err = json.Marshal(i)
if err != nil {
err = fmt.Errorf("cannot convert a genericworker.WritableDirectoryCache to json: %w", err)
return
}
result = append(result, json.RawMessage(bytes))
}
for _, wdc := range gwWritableDirectoryCaches {
marshalAndAddToSlice(wdc)
}
for _, fm := range gwFileMounts {
marshalAndAddToSlice(fm)
}
return
}
func artifacts(dwPayload *dockerworker.DockerWorkerPayload) []genericworker.Artifact {
gwArtifacts := make([]genericworker.Artifact, len(dwPayload.Artifacts))
names := make([]string, len(dwPayload.Artifacts))
i := 0
for name := range dwPayload.Artifacts {
names[i] = name
i++
}
sort.Strings(names)
for i, name := range names {
gwArt := new(genericworker.Artifact)
defaults.SetDefaults(gwArt)
gwArt.Expires = dwPayload.Artifacts[name].Expires
gwArt.Name = name
ext := filepath.Ext(dwPayload.Artifacts[name].Path)
gwArt.Path = "artifact" + strconv.Itoa(i) + ext
gwArt.Type = dwPayload.Artifacts[name].Type
gwArtifacts[i] = *gwArt
}
if dwPayload.Features.DockerSave {
gwArt := new(genericworker.Artifact)
defaults.SetDefaults(gwArt)
gwArt.Name = "public/dockerImage.tar.gz"
gwArt.Path = "image.tar.gz"
gwArt.Type = "file"
gwArtifacts = append(gwArtifacts, *gwArt)
}
return gwArtifacts
}
func command(dwPayload *dockerworker.DockerWorkerPayload, dwImage Image, gwArtifacts []genericworker.Artifact, gwWritableDirectoryCaches []genericworker.WritableDirectoryCache) ([][]string, error) {
containerName := ""
if len(gwArtifacts) > 0 {
containerName = "taskcontainer"
}
commands := []string{}
podmanRunString, err := podmanRunCommand(containerName, dwPayload, dwImage, gwWritableDirectoryCaches)
if err != nil {
return nil, fmt.Errorf("could not form podman run command: %w", err)
}
commands = append(
commands,
podmanRunString,
)
if containerName != "" {
commands = append(
commands,
"exit_code=$?",
)
}
commands = append(
commands,
podmanCopyArtifacts(containerName, dwPayload, gwArtifacts)...,
)
if dwPayload.Features.DockerSave {
commands = append(
commands,
"podman commit "+containerName+" "+containerName,
"podman save "+containerName+" | gzip > image.tar.gz",
)
}
if containerName != "" {
commands = append(
commands,
"podman rm "+containerName,
`exit "${exit_code}"`,
)
}
return [][]string{
{
"bash",
"-cx",
strings.Join(commands, "\n"),
},
}, nil
}
func podmanRunCommand(containerName string, dwPayload *dockerworker.DockerWorkerPayload, dwImage Image, wdcs []genericworker.WritableDirectoryCache) (string, error) {
command := strings.Builder{}
// Docker Worker used to attach a pseudo tty, see:
// https://github.com/taskcluster/taskcluster/blob/6b99f0ef71d9d8628c50adc17424167647a1c533/workers/docker-worker/src/task.js#L384
command.WriteString("podman run -t")
switch containerName {
case "":
command.WriteString(" --rm")
default:
command.WriteString(" --name " + containerName)
}
if dwPayload.Capabilities.Privileged || dwPayload.Features.Dind {
command.WriteString(" --privileged")
}
if dwPayload.Features.AllowPtrace {
command.WriteString(" --cap-add=SYS_PTRACE")
}
command.WriteString(createVolumeMountsString(dwPayload, wdcs))
if dwPayload.Features.TaskclusterProxy {
command.WriteString(" --add-host=taskcluster:127.0.0.1 --net=host")
}
command.WriteString(podmanEnvMappings(dwPayload))
dockerImageString, err := dwImage.String()
if err != nil {
return "", fmt.Errorf("could not form docker image string: %w", err)
}
// note, dockerImageString is already shell escaped
command.WriteString(" " + dockerImageString)
command.WriteString(" " + shell.Escape(dwPayload.Command...))
return command.String(), nil
}
func podmanCopyArtifacts(containerName string, dwPayload *dockerworker.DockerWorkerPayload, gwArtifacts []genericworker.Artifact) []string {
commands := []string{}
for i := range gwArtifacts {
// An image artifact will be in the generic worker payload
// when dockerSave is enabled. That artifact will not be
// found in either the docker worker payload or the container
// after the podman run command is complete, so no podman cp
// command is needed for it.
// The image artifact is created after the podman run
// command is complete.
if _, ok := dwPayload.Artifacts[gwArtifacts[i].Name]; !ok {
continue
}
commands = append(commands, fmt.Sprintf("podman cp %s:%s %s", containerName, shell.Escape(dwPayload.Artifacts[gwArtifacts[i].Name].Path), shell.Escape(gwArtifacts[i].Path)))
}
return commands
}
func setEnv(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload) {
gwPayload.Env = dwPayload.Env
}
func setFeatures(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload) {
gwPayload.Features.ChainOfTrust = dwPayload.Features.ChainOfTrust
// need to keep TaskclusterProxy to true if it's already been enabled for IndexedDockerImages
gwPayload.Features.TaskclusterProxy = gwPayload.Features.TaskclusterProxy || dwPayload.Features.TaskclusterProxy
gwPayload.Features.Interactive = dwPayload.Features.Interactive
gwPayload.Features.LoopbackVideo = dwPayload.Capabilities.Devices.LoopbackVideo
gwPayload.Features.LoopbackAudio = dwPayload.Capabilities.Devices.LoopbackAudio
switch dwPayload.Features.Artifacts {
case true:
gwPayload.Features.LiveLog = dwPayload.Features.LocalLiveLog
gwPayload.Features.BackingLog = dwPayload.Features.BulkLog
case false:
gwPayload.Features.BackingLog = false
gwPayload.Features.LiveLog = false
}
}
func setArtifacts(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload) {
if dwPayload.Features.Artifacts {
gwPayload.Artifacts = artifacts(dwPayload)
}
}
func setCommand(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload, dwImage Image, gwWritableDirectoryCaches []genericworker.WritableDirectoryCache) (err error) {
gwPayload.Command, err = command(dwPayload, dwImage, gwPayload.Artifacts, gwWritableDirectoryCaches)
return
}
func setMounts(gwPayload *genericworker.GenericWorkerPayload, gwWritableDirectoryCaches []genericworker.WritableDirectoryCache, gwFileMounts []genericworker.FileMount) (err error) {
gwPayload.Mounts, err = mounts(gwWritableDirectoryCaches, gwFileMounts)
return
}
func setMaxRunTime(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload) {
gwPayload.MaxRunTime = dwPayload.MaxRunTime
}
func setOnExitStatus(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload) {
gwPayload.OnExitStatus.Retry = dwPayload.OnExitStatus.Retry
gwPayload.OnExitStatus.PurgeCaches = dwPayload.OnExitStatus.PurgeCaches
// An error sometimes occurs while pulling the docker image:
// Error: reading blob sha256:<SHA>: Get "<URL>": remote error: tls: handshake failure
// And this exits 125, so we'd like to retry.
for _, exitCode := range gwPayload.OnExitStatus.Retry {
if exitCode == 125 {
return
}
}
gwPayload.OnExitStatus.Retry = append(gwPayload.OnExitStatus.Retry, 125)
}
func setSupersederURL(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload) {
gwPayload.SupersederURL = dwPayload.SupersederURL
}
func setOSGroups(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload) {
if dwPayload.Capabilities.Devices.KVM {
// task user needs to be in the kvm group for KVM to work
// https://help.ubuntu.com/community/KVM/Installation
gwPayload.OSGroups = append(gwPayload.OSGroups, "kvm")
}
}
func writableDirectoryCaches(caches map[string]string) []genericworker.WritableDirectoryCache {
wdcs := make([]genericworker.WritableDirectoryCache, len(caches))
i := 0
for cacheName := range caches {
wdc := new(genericworker.WritableDirectoryCache)
defaults.SetDefaults(wdc)
wdc.CacheName = cacheName
wdc.Directory = "cache" + strconv.Itoa(i)
wdcs[i] = *wdc
i++
}
return wdcs
}
func setLogs(dwPayload *dockerworker.DockerWorkerPayload, gwPayload *genericworker.GenericWorkerPayload) {
gwPayload.Logs.Live = dwPayload.Log
gwPayload.Logs.Backing = createBackingLogName(dwPayload.Log)
}
func createBackingLogName(log string) string {
return filepath.Join(filepath.Dir(log), fileNameWithoutExtension(filepath.Base(log))+"_backing"+filepath.Ext(log))
}
func fileNameWithoutExtension(fileName string) string {
return strings.TrimSuffix(fileName, filepath.Ext(fileName))
}
func createVolumeMountsString(dwPayload *dockerworker.DockerWorkerPayload, wdcs []genericworker.WritableDirectoryCache) string {
volumeMounts := strings.Builder{}
for _, wdc := range wdcs {
volumeMounts.WriteString(` -v "$(pwd)/` + wdc.Directory + ":" + dwPayload.Cache[wdc.CacheName] + `"`)
}
if dwPayload.Capabilities.Devices.KVM {
volumeMounts.WriteString(" --device=/dev/kvm")
}
if dwPayload.Capabilities.Devices.HostSharedMemory {
volumeMounts.WriteString(" --device=/dev/shm")
}
if dwPayload.Capabilities.Devices.LoopbackVideo {
volumeMounts.WriteString(` --device="${TASKCLUSTER_VIDEO_DEVICE}"`)
}
if dwPayload.Capabilities.Devices.LoopbackAudio {
volumeMounts.WriteString(" --device=/dev/snd")
}
return volumeMounts.String()
}
func podmanEnvSetting(envVarName string) string {
return fmt.Sprintf(" -e %s", shell.Escape(envVarName))
}
func imageObject(payloadImage *json.RawMessage) (Image, error) {
var parsed interface{}
err := json.Unmarshal(*payloadImage, &parsed)
if err != nil {
return nil, fmt.Errorf("cannot parse docker image: %w", err)
}
switch val := parsed.(type) {
case string:
din := DockerImageName(val)
return &din, nil
case map[string]interface{}: // NamedDockerImage|IndexedDockerImage|DockerImageArtifact
switch val["type"] {
case "docker-image": // NamedDockerImage
namedDockerImage := NamedDockerImage{}
err = json.Unmarshal(*payloadImage, &namedDockerImage)
return &namedDockerImage, err
case "indexed-image": // IndexedDockerImage
indexDockerImage := IndexedDockerImage{}
err = json.Unmarshal(*payloadImage, &indexDockerImage)
return &indexDockerImage, err
case "task-image": // DockerImageArtifact
dockerImageArtifact := DockerImageArtifact{}
err = json.Unmarshal(*payloadImage, &dockerImageArtifact)
return &dockerImageArtifact, err
default:
return nil, fmt.Errorf("parsed docker image %#v is not of a supported type: %w", val, err)
}
default:
return nil, fmt.Errorf("parsed docker image is not of a supported type: %w", err)
}
}
func podmanEnvMappings(dwPayload *dockerworker.DockerWorkerPayload) string {
envStrBuilder := strings.Builder{}
dwManagedEnvVars := []string{
"RUN_ID",
"TASKCLUSTER_ROOT_URL",
"TASK_ID",
"TASKCLUSTER_WORKER_LOCATION",
}
if dwPayload.Features.TaskclusterProxy {
dwManagedEnvVars = append(dwManagedEnvVars, "TASKCLUSTER_PROXY_URL")
}
envVarNames := []string{}
for envVarName := range dwPayload.Env {
envVarNames = append(envVarNames, envVarName)
}
envVarNames = append(envVarNames, dwManagedEnvVars...)
sort.Strings(envVarNames)
for _, envVarName := range envVarNames {
envStrBuilder.WriteString(podmanEnvSetting(envVarName))
}
return envStrBuilder.String()
}