/
artifacts.go
547 lines (507 loc) · 17.9 KB
/
artifacts.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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
package main
import (
"compress/gzip"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"log"
"mime"
"net"
"net/http"
"net/http/httputil"
"net/url"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/taskcluster/httpbackoff/v3"
tcurls "github.com/taskcluster/taskcluster-lib-urls"
tcclient "github.com/taskcluster/taskcluster/v41/clients/client-go"
"github.com/taskcluster/taskcluster/v41/clients/client-go/tcqueue"
)
var (
// for overriding/complementing system mime type mappings
customMimeMappings = map[string]string{
// keys *must* be lower-case
".log": "text/plain",
}
)
type (
// TaskArtifact is the interface that all artifact types implement
// (S3Artifact, RedirectArtifact, ErrorArtifact), for publishing artifacts
// according to the tcqueue.CreateArtifact docs.
TaskArtifact interface {
// RequestObject returns a pointer to a go type containing the data for
// marshaling into tcqueue.PostArtifactRequest for passing to
// tcqueue.CreateArtifact.
//
// For example, this is a *tcqueue.S3ArtifactRequest for type
// S3Artifact.
RequestObject() interface{}
// ResponseObject returns a pointer to an empty go type for
// unmarshaling the result of a tcqueue.CreateArtifact API call into.
//
// For example, this would be new(tcqueue.RedirectArtifactRequest) for
// RedirectArtifact.
ResponseObject() interface{}
// ProcessResponse is a callback for performing actions after
// tcqueue.CreateArtifact API is called. response is the object
// returned by ResponseObject(), but populated with the result of
// tcqueue.CreateArtifact.
//
// For example, ProcessResponse for S3Artifact uploads the artifact to
// S3, since the tcqueue.CreateArtifact API call only informs the Queue
// that the artifact exists without uploading it.
//
// ProcessResponse can be an empty method if no post
// tcqueue.CreateArtifact steps are required.
ProcessResponse(response interface{}, task *TaskRun) error
// Base returns a *BaseArtifact which stores the properties common to
// all implementations
Base() *BaseArtifact
}
// Common properties across all implementations.
BaseArtifact struct {
Name string
Expires tcclient.Time
}
S3Artifact struct {
*BaseArtifact
Path string
ContentEncoding string
ContentType string
}
RedirectArtifact struct {
*BaseArtifact
URL string
ContentType string
}
LinkArtifact struct {
*BaseArtifact
Artifact string
ContentType string
}
ErrorArtifact struct {
*BaseArtifact
Path string
Message string
Reason string
}
)
func (base *BaseArtifact) Base() *BaseArtifact {
return base
}
func (redirectArtifact *RedirectArtifact) ProcessResponse(response interface{}, task *TaskRun) error {
task.Infof("Uploading redirect artifact %v to URL %v with mime type %q and expiry %v", redirectArtifact.Name, redirectArtifact.URL, redirectArtifact.ContentType, redirectArtifact.Expires)
// nothing to do
return nil
}
func (redirectArtifact *RedirectArtifact) RequestObject() interface{} {
return &tcqueue.RedirectArtifactRequest{
ContentType: redirectArtifact.ContentType,
Expires: redirectArtifact.Expires,
StorageType: "reference",
URL: redirectArtifact.URL,
}
}
func (redirectArtifact *RedirectArtifact) ResponseObject() interface{} {
return new(tcqueue.RedirectArtifactResponse)
}
func (linkArtifact *LinkArtifact) ProcessResponse(response interface{}, task *TaskRun) error {
task.Infof("Uploading link artifact %v to artifact %v with expiry %v", linkArtifact.Name, linkArtifact.Artifact, linkArtifact.Expires)
// nothing to do
return nil
}
func (linkArtifact *LinkArtifact) RequestObject() interface{} {
return &tcqueue.LinkArtifactRequest{
Expires: linkArtifact.Expires,
StorageType: "link",
ContentType: linkArtifact.ContentType,
Artifact: linkArtifact.Artifact,
}
}
func (linkArtifact *LinkArtifact) ResponseObject() interface{} {
return new(tcqueue.LinkArtifactResponse)
}
func (errArtifact *ErrorArtifact) ProcessResponse(response interface{}, task *TaskRun) error {
task.Errorf("Uploading error artifact %v from file %v with message %q, reason %q and expiry %v", errArtifact.Name, errArtifact.Path, errArtifact.Message, errArtifact.Reason, errArtifact.Expires)
// TODO: process error response
return nil
}
func (errArtifact *ErrorArtifact) RequestObject() interface{} {
return &tcqueue.ErrorArtifactRequest{
Expires: errArtifact.Expires,
Message: errArtifact.Message,
Reason: errArtifact.Reason,
StorageType: "error",
}
}
func (errArtifact *ErrorArtifact) ResponseObject() interface{} {
return new(tcqueue.ErrorArtifactResponse)
}
func (errArtifact *ErrorArtifact) String() string {
return fmt.Sprintf("%v", *errArtifact)
}
// createTempFileForPUTBody gzip-compresses the file at path rawContentFile and writes
// it to a temporary file. The file path of the generated temporary file is returned.
// It is the responsibility of the caller to delete the temporary file.
func (s3Artifact *S3Artifact) CreateTempFileForPUTBody() string {
rawContentFile := filepath.Join(taskContext.TaskDir, s3Artifact.Path)
baseName := filepath.Base(rawContentFile)
tmpFile, err := ioutil.TempFile("", baseName)
if err != nil {
panic(err)
}
defer tmpFile.Close()
var target io.Writer = tmpFile
if s3Artifact.ContentEncoding == "gzip" {
gzipLogWriter := gzip.NewWriter(tmpFile)
defer gzipLogWriter.Close()
gzipLogWriter.Name = baseName
target = gzipLogWriter
}
source, err := os.Open(rawContentFile)
if err != nil {
panic(err)
}
defer source.Close()
_, _ = io.Copy(target, source)
return tmpFile.Name()
}
func (s3Artifact *S3Artifact) ProcessResponse(resp interface{}, task *TaskRun) (err error) {
response := resp.(*tcqueue.S3ArtifactResponse)
task.Infof("Uploading artifact %v from file %v with content encoding %q, mime type %q and expiry %v", s3Artifact.Name, s3Artifact.Path, s3Artifact.ContentEncoding, s3Artifact.ContentType, s3Artifact.Expires)
transferContentFile := s3Artifact.CreateTempFileForPUTBody()
defer os.Remove(transferContentFile)
// perform http PUT to upload to S3...
httpClient := &http.Client{}
httpCall := func() (putResp *http.Response, tempError error, permError error) {
var transferContent *os.File
transferContent, permError = os.Open(transferContentFile)
if permError != nil {
return
}
defer transferContent.Close()
var transferContentFileInfo os.FileInfo
transferContentFileInfo, permError = transferContent.Stat()
if permError != nil {
return
}
transferContentLength := transferContentFileInfo.Size()
var httpRequest *http.Request
httpRequest, permError = http.NewRequest("PUT", response.PutURL, transferContent)
if permError != nil {
return
}
httpRequest.Header.Set("Content-Type", response.ContentType)
httpRequest.ContentLength = transferContentLength
if enc := s3Artifact.ContentEncoding; enc != "" {
httpRequest.Header.Set("Content-Encoding", enc)
}
requestHeaders, dumpError := httputil.DumpRequestOut(httpRequest, false)
if dumpError != nil {
log.Print("Could not dump request, never mind...")
} else {
log.Print("Request")
log.Print(string(requestHeaders))
}
putResp, tempError = httpClient.Do(httpRequest)
if tempError != nil {
return
}
// bug 1394557: s3 incorrectly returns HTTP 400 for connection inactivity,
// which can/should be retried, so explicitly handle...
if putResp.StatusCode == 400 {
tempError = fmt.Errorf("S3 returned status code 400 which could be an intermittent issue - see https://bugzilla.mozilla.org/show_bug.cgi?id=1394557")
}
return
}
putResp, putAttempts, err := httpbackoff.Retry(httpCall)
log.Printf("%v put requests issued to %v", putAttempts, response.PutURL)
if putResp != nil {
defer putResp.Body.Close()
respBody, dumpError := httputil.DumpResponse(putResp, true)
if dumpError != nil {
log.Print("Could not dump response output, never mind...")
} else {
log.Print("Response")
log.Print(string(respBody))
}
}
return err
}
func (s3Artifact *S3Artifact) RequestObject() interface{} {
return &tcqueue.S3ArtifactRequest{
ContentType: s3Artifact.ContentType,
Expires: s3Artifact.Expires,
StorageType: "s3",
}
}
func (s3Artifact *S3Artifact) ResponseObject() interface{} {
return new(tcqueue.S3ArtifactResponse)
}
func (s3Artifact *S3Artifact) String() string {
return fmt.Sprintf("S3 Artifact - Name: '%v', Path: '%v', Expires: %v, Content Encoding: '%v', MIME Type: '%v'", s3Artifact.Name, s3Artifact.Path, s3Artifact.Expires, s3Artifact.ContentEncoding, s3Artifact.ContentType)
}
// PayloadArtifacts returns the artifacts as listed in the payload of the task (note this does
// not include log files)
func (task *TaskRun) PayloadArtifacts() []TaskArtifact {
artifacts := make([]TaskArtifact, 0)
for _, artifact := range task.Payload.Artifacts {
basePath := artifact.Path
base := &BaseArtifact{
Name: artifact.Name,
Expires: artifact.Expires,
}
// if no name given, use canonical path
if base.Name == "" {
base.Name = canonicalPath(basePath)
}
// default expiry should be task expiry
if time.Time(base.Expires).IsZero() {
base.Expires = task.Definition.Expires
}
switch artifact.Type {
case "file":
artifacts = append(artifacts, resolve(base, "file", basePath, artifact.ContentType, artifact.ContentEncoding))
case "directory":
if errArtifact := resolve(base, "directory", basePath, artifact.ContentType, artifact.ContentEncoding); errArtifact != nil {
artifacts = append(artifacts, errArtifact)
continue
}
walkFn := func(path string, info os.FileInfo, incomingErr error) error {
// I think we don't need to handle incomingErr != nil since
// resolve(...) gets called which should catch the same issues
// raised in incomingErr - *** I GUESS *** !!
subPath, err := filepath.Rel(taskContext.TaskDir, path)
if err != nil {
// this indicates a bug in the code
panic(err)
}
relativePath, err := filepath.Rel(basePath, subPath)
if err != nil {
// this indicates a bug in the code
panic(err)
}
subName := filepath.Join(base.Name, relativePath)
b := &BaseArtifact{
Name: canonicalPath(subName),
Expires: base.Expires,
}
switch {
case info.IsDir():
if errArtifact := resolve(b, "directory", subPath, artifact.ContentType, artifact.ContentEncoding); errArtifact != nil {
artifacts = append(artifacts, errArtifact)
}
default:
artifacts = append(artifacts, resolve(b, "file", subPath, artifact.ContentType, artifact.ContentEncoding))
}
return nil
}
_ = filepath.Walk(filepath.Join(taskContext.TaskDir, basePath), walkFn)
}
}
return artifacts
}
// File should be resolved as an S3Artifact if file exists as file and is
// readable, otherwise i) if it does not exist or ii) cannot be read, as a
// "file-missing-on-worker" ErrorArtifact, otherwise if it exists as a
// directory, as "invalid-resource-on-worker" ErrorArtifact. A directory should
// resolve as `nil` if directory exists as directory and is readable, otherwise
// i) if it does not exist or ii) cannot be read, as a "file-missing-on-worker"
// ErrorArtifact, otherwise if it exists as a file, as
// "invalid-resource-on-worker" ErrorArtifact
// TODO: need to also handle "too-large-file-on-worker"
func resolve(base *BaseArtifact, artifactType string, path string, contentType string, contentEncoding string) TaskArtifact {
fullPath := filepath.Join(taskContext.TaskDir, path)
fileReader, err := os.Open(fullPath)
if err != nil {
// cannot read file/dir, create an error artifact
return &ErrorArtifact{
BaseArtifact: base,
Message: fmt.Sprintf("Could not read %s '%s'", artifactType, fullPath),
Reason: "file-missing-on-worker",
Path: path,
}
}
defer fileReader.Close()
// ok it exists, but is it right type?
fileinfo, err := fileReader.Stat()
if err != nil {
return &ErrorArtifact{
BaseArtifact: base,
Message: fmt.Sprintf("Could not stat %s '%s'", artifactType, fullPath),
Reason: "invalid-resource-on-worker",
Path: path,
}
}
if artifactType == "file" && fileinfo.IsDir() {
return &ErrorArtifact{
BaseArtifact: base,
Message: fmt.Sprintf("File artifact '%s' exists as a directory, not a file, on the worker", fullPath),
Reason: "invalid-resource-on-worker",
Path: path,
}
}
if artifactType == "directory" && !fileinfo.IsDir() {
return &ErrorArtifact{
BaseArtifact: base,
Message: fmt.Sprintf("Directory artifact '%s' exists as a file, not a directory, on the worker", fullPath),
Reason: "invalid-resource-on-worker",
Path: path,
}
}
if artifactType == "directory" {
return nil
}
// Is content type specified in task payload?
if contentType == "" {
extension := filepath.Ext(path)
// first look up our own custom mime type mappings
contentType = customMimeMappings[strings.ToLower(extension)]
// then fall back to system mime type mappings
if contentType == "" {
contentType = mime.TypeByExtension(extension)
}
// lastly, fall back to application/octet-stream in the absense of any other value
if contentType == "" {
// application/octet-stream is the mime type for "unknown"
contentType = "application/octet-stream"
}
}
// Is content encoding specified in task payload?
if contentEncoding == "" {
extension := filepath.Ext(path)
// originally based on https://github.com/evansd/whitenoise/blob/03f6ea846394e01cbfe0c730141b81eb8dd6e88a/whitenoise/compress.py#L21-L29
SkipCompressionExtensions := map[string]bool{
".7z": true,
".bz2": true,
".dmg": true,
".flv": true,
".gif": true,
".gz": true,
".jpeg": true,
".jpg": true,
".png": true,
".swf": true,
".tbz": true,
".tgz": true,
".webp": true,
".whl": true, // Python wheel are already zip file
".woff": true,
".woff2": true,
".xz": true,
".zip": true,
".zst": true,
}
// When the file extension is blacklisted in SkipCompressionExtensions then "identity" should be used, otherwise "gzip".
if SkipCompressionExtensions[extension] {
contentEncoding = "identity"
} else {
contentEncoding = "gzip"
}
}
s3Artifact := &S3Artifact{
BaseArtifact: base,
Path: path,
ContentType: contentType,
ContentEncoding: contentEncoding,
}
return s3Artifact
}
// The Queue expects paths to use a forward slash, so let's make sure we have a
// way to generate a path in this format
func canonicalPath(path string) string {
if os.PathSeparator == '/' {
return path
}
return strings.Replace(path, string(os.PathSeparator), "/", -1)
}
func (task *TaskRun) uploadLog(name, path string) *CommandExecutionError {
return task.uploadArtifact(
&S3Artifact{
BaseArtifact: &BaseArtifact{
Name: name,
// logs expire when task expires
Expires: task.Definition.Expires,
},
ContentType: "text/plain; charset=utf-8",
Path: path,
ContentEncoding: "gzip",
},
)
}
func (task *TaskRun) uploadArtifact(artifact TaskArtifact) *CommandExecutionError {
task.Artifacts[artifact.Base().Name] = artifact
payload, err := json.Marshal(artifact.RequestObject())
if err != nil {
panic(err)
}
par := tcqueue.PostArtifactRequest(json.RawMessage(payload))
task.queueMux.RLock()
parsp, err := task.Queue.CreateArtifact(
task.TaskID,
strconv.Itoa(int(task.RunID)),
artifact.Base().Name,
&par,
)
task.queueMux.RUnlock()
if err != nil {
switch t := err.(type) {
case *tcclient.APICallException:
switch rootCause := t.RootCause.(type) {
case httpbackoff.BadHttpResponseCode:
if rootCause.HttpResponseCode/100 == 5 {
return ResourceUnavailable(fmt.Errorf("TASK EXCEPTION due to response code %v from Queue when uploading artifact %#v with CreateArtifact payload %v - HTTP response body: %v", rootCause.HttpResponseCode, artifact, string(payload), t.CallSummary.HTTPResponseBody))
}
// was artifact already uploaded ( => malformed payload)?
if rootCause.HttpResponseCode == 409 {
fullError := fmt.Errorf(
"There was a conflict uploading artifact %v - this suggests artifact %v was already uploaded to this task with different content earlier on in this task.\n"+
"Check the artifacts section of the task payload at %v\n"+
"%v",
artifact.Base().Name,
artifact.Base().Name,
tcurls.API(config.RootURL, "queue", "v1", "task/"+task.TaskID),
rootCause,
)
return MalformedPayloadError(fullError)
}
// was task cancelled or deadline exceeded?
task.StatusManager.UpdateStatus()
status := task.StatusManager.LastKnownStatus()
if status == deadlineExceeded || status == cancelled {
return nil
}
// assume a problem with the request == worker bug
panic(fmt.Errorf("WORKER EXCEPTION due to response code %v from Queue when uploading artifact %#v with CreateArtifact payload %v - HTTP response body: %v", rootCause.HttpResponseCode, artifact, string(payload), t.CallSummary.HTTPResponseBody))
case *url.Error:
switch subCause := rootCause.Err.(type) {
case *net.OpError:
log.Printf("Got *net.OpError - probably got no network at the moment: %#v", *subCause)
return nil
default:
panic(fmt.Errorf("WORKER EXCEPTION due to unexpected *url.Error when requesting url from queue to upload artifact to: %#v", subCause))
}
default:
panic(fmt.Errorf("WORKER EXCEPTION due to *tcclient.APICallException error when requesting url from queue to upload artifact to. Root cause: %#v", rootCause))
}
default:
panic(fmt.Errorf("WORKER EXCEPTION due to non-recoverable error when requesting url from queue to upload artifact to: %#v", t))
}
}
// unmarshal response into object
resp := artifact.ResponseObject()
e := json.Unmarshal(*parsp, resp)
if e != nil {
panic(e)
}
e = artifact.ProcessResponse(resp, task)
if e != nil {
task.Errorf("Error uploading artifact: %v", e)
}
// note: ResourceUnavailable(nil) returns nil, so this only returns an error if e != nil
return ResourceUnavailable(e)
}