-
Notifications
You must be signed in to change notification settings - Fork 28
/
compile.go
583 lines (478 loc) · 15.9 KB
/
compile.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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
// SPDX-License-Identifier: Apache-2.0
package native
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"strings"
"time"
yml "github.com/buildkite/yaml"
"github.com/hashicorp/go-cleanhttp"
"github.com/hashicorp/go-retryablehttp"
api "github.com/go-vela/server/api/types"
"github.com/go-vela/server/compiler/types/pipeline"
"github.com/go-vela/server/compiler/types/raw"
"github.com/go-vela/server/compiler/types/yaml"
"github.com/go-vela/types/constants"
)
// ModifyRequest contains the payload passed to the modification endpoint.
type ModifyRequest struct {
Pipeline string `json:"pipeline,omitempty"`
Build int `json:"build,omitempty"`
Repo string `json:"repo,omitempty"`
Org string `json:"org,omitempty"`
User string `json:"user,omitempty"`
}
// ModifyResponse contains the payload returned by the modification endpoint.
type ModifyResponse struct {
Pipeline string `json:"pipeline,omitempty"`
}
// Compile produces an executable pipeline from a yaml configuration.
func (c *client) Compile(ctx context.Context, v interface{}) (*pipeline.Build, *api.Pipeline, error) {
p, data, err := c.Parse(v, c.repo.GetPipelineType(), new(yaml.Template))
if err != nil {
return nil, nil, err
}
// create the API pipeline object from the yaml configuration
_pipeline := p.ToPipelineAPI()
_pipeline.SetData(data)
_pipeline.SetType(c.repo.GetPipelineType())
// create map of templates for easy lookup
templates := mapFromTemplates(p.Templates)
event := c.build.GetEvent()
action := c.build.GetEventAction()
// if the build has an event action, concatenate event and event action for matching
if !strings.EqualFold(action, "") {
event = event + ":" + action
}
// create the ruledata to purge steps
r := &pipeline.RuleData{
Branch: c.build.GetBranch(),
Comment: c.comment,
Event: event,
Path: c.files,
Repo: c.repo.GetFullName(),
Tag: strings.TrimPrefix(c.build.GetRef(), "refs/tags/"),
Target: c.build.GetDeploy(),
Label: c.labels,
}
// add instance when we have the metadata (local exec will not)
if c.metadata != nil && c.metadata.Vela != nil {
r.Instance = c.metadata.Vela.Address
}
switch {
case p.Metadata.RenderInline:
newPipeline, err := c.compileInline(ctx, p, c.GetTemplateDepth())
if err != nil {
return nil, _pipeline, err
}
// validate the yaml configuration
err = c.Validate(newPipeline)
if err != nil {
return nil, _pipeline, err
}
if len(newPipeline.Stages) > 0 {
return c.compileStages(ctx, newPipeline, _pipeline, map[string]*yaml.Template{}, r)
}
return c.compileSteps(ctx, newPipeline, _pipeline, map[string]*yaml.Template{}, r)
case len(p.Stages) > 0:
return c.compileStages(ctx, p, _pipeline, templates, r)
default:
return c.compileSteps(ctx, p, _pipeline, templates, r)
}
}
// CompileLite produces a partial of an executable pipeline from a yaml configuration.
func (c *client) CompileLite(ctx context.Context, v interface{}, ruleData *pipeline.RuleData, substitute bool) (*yaml.Build, *api.Pipeline, error) {
p, data, err := c.Parse(v, c.repo.GetPipelineType(), new(yaml.Template))
if err != nil {
return nil, nil, err
}
// create the library pipeline object from the yaml configuration
_pipeline := p.ToPipelineAPI()
_pipeline.SetData(data)
_pipeline.SetType(c.repo.GetPipelineType())
if p.Metadata.RenderInline {
newPipeline, err := c.compileInline(ctx, p, c.GetTemplateDepth())
if err != nil {
return nil, _pipeline, err
}
// validate the yaml configuration
err = c.Validate(newPipeline)
if err != nil {
return nil, _pipeline, err
}
p = newPipeline
}
// create map of templates for easy lookup
templates := mapFromTemplates(p.Templates)
switch {
case len(p.Stages) > 0:
// inject the templates into the steps
p, err = c.ExpandStages(ctx, p, templates, ruleData)
if err != nil {
return nil, _pipeline, err
}
if substitute {
// inject the substituted environment variables into the steps
p.Stages, err = c.SubstituteStages(p.Stages)
if err != nil {
return nil, _pipeline, err
}
}
if ruleData != nil {
purgedStages := new(yaml.StageSlice)
for _, stg := range p.Stages {
purgedSteps := new(yaml.StepSlice)
for _, s := range stg.Steps {
cRuleset := s.Ruleset.ToPipeline()
if match, err := cRuleset.Match(ruleData); err == nil && match {
*purgedSteps = append(*purgedSteps, s)
}
}
stg.Steps = *purgedSteps
if len(stg.Steps) > 0 {
*purgedStages = append(*purgedStages, stg)
}
}
p.Stages = *purgedStages
}
case len(p.Steps) > 0:
// inject the templates into the steps
p, err = c.ExpandSteps(ctx, p, templates, ruleData, c.GetTemplateDepth())
if err != nil {
return nil, _pipeline, err
}
if substitute {
// inject the substituted environment variables into the steps
p.Steps, err = c.SubstituteSteps(p.Steps)
if err != nil {
return nil, _pipeline, err
}
}
if ruleData != nil {
purgedSteps := new(yaml.StepSlice)
for _, s := range p.Steps {
cRuleset := s.Ruleset.ToPipeline()
if match, err := cRuleset.Match(ruleData); err == nil && match {
*purgedSteps = append(*purgedSteps, s)
}
}
p.Steps = *purgedSteps
}
}
// validate the yaml configuration
err = c.Validate(p)
if err != nil {
return nil, _pipeline, err
}
return p, _pipeline, nil
}
// compileInline parses and expands out inline pipelines.
func (c *client) compileInline(ctx context.Context, p *yaml.Build, depth int) (*yaml.Build, error) {
newPipeline := *p
// return if max template depth has been reached
if depth == 0 {
retErr := fmt.Errorf("max template depth of %d exceeded", c.GetTemplateDepth())
return nil, retErr
}
for _, template := range p.Templates {
bytes, err := c.getTemplate(ctx, template, template.Name)
if err != nil {
return nil, err
}
format := template.Format
// set the default format to golang if the user did not define anything
if template.Format == "" {
format = constants.PipelineTypeGo
}
// initialize variable map if not parsed from config
if len(template.Variables) == 0 {
template.Variables = make(map[string]interface{})
}
// inject template name into variables
template.Variables["VELA_TEMPLATE_NAME"] = template.Name
parsed, _, err := c.Parse(bytes, format, template)
if err != nil {
return nil, err
}
// if template parsed contains a template reference, recurse with decremented depth
if len(parsed.Templates) > 0 && parsed.Metadata.RenderInline {
parsed, err = c.compileInline(ctx, parsed, depth-1)
if err != nil {
return nil, err
}
newPipeline.Templates = append(newPipeline.Templates, parsed.Templates...)
}
switch {
case len(parsed.Environment) > 0:
for key, value := range parsed.Environment {
newPipeline.Environment[key] = value
}
fallthrough
case len(parsed.Stages) > 0:
// ensure all templated steps inside stages have template prefix
for stgIndex, newStage := range parsed.Stages {
parsed.Stages[stgIndex].Name = fmt.Sprintf("%s_%s", template.Name, newStage.Name)
for index, newStep := range newStage.Steps {
parsed.Stages[stgIndex].Steps[index].Name = fmt.Sprintf("%s_%s", template.Name, newStep.Name)
}
}
newPipeline.Stages = append(newPipeline.Stages, parsed.Stages...)
fallthrough
case len(parsed.Steps) > 0:
// ensure all templated steps have template prefix
for index, newStep := range parsed.Steps {
parsed.Steps[index].Name = fmt.Sprintf("%s_%s", template.Name, newStep.Name)
}
newPipeline.Steps = append(newPipeline.Steps, parsed.Steps...)
fallthrough
case len(parsed.Services) > 0:
newPipeline.Services = append(newPipeline.Services, parsed.Services...)
fallthrough
case len(parsed.Secrets) > 0:
newPipeline.Secrets = append(newPipeline.Secrets, parsed.Secrets...)
default:
//nolint:lll // ignore long line length due to error message
return nil, fmt.Errorf("empty template %s provided: template must contain secrets, services, stages or steps", template.Name)
}
if len(newPipeline.Stages) > 0 && len(newPipeline.Steps) > 0 {
//nolint:lll // ignore long line length due to error message
return nil, fmt.Errorf("invalid template %s provided: templates cannot mix stages and steps", template.Name)
}
}
return &newPipeline, nil
}
// compileSteps executes the workflow for converting a YAML pipeline into an executable struct.
func (c *client) compileSteps(ctx context.Context, p *yaml.Build, _pipeline *api.Pipeline, tmpls map[string]*yaml.Template, r *pipeline.RuleData) (*pipeline.Build, *api.Pipeline, error) {
var err error
// check if the pipeline disabled the clone
if p.Metadata.Clone == nil || *p.Metadata.Clone {
// inject the clone step
p, err = c.CloneStep(p)
if err != nil {
return nil, _pipeline, err
}
}
// inject the init step
p, err = c.InitStep(p)
if err != nil {
return nil, _pipeline, err
}
// inject the templates into the steps
p, err = c.ExpandSteps(ctx, p, tmpls, r, c.GetTemplateDepth())
if err != nil {
return nil, _pipeline, err
}
if c.ModificationService.Endpoint != "" {
// send config to external endpoint for modification
p, err = c.modifyConfig(p, c.build, c.repo)
if err != nil {
return nil, _pipeline, err
}
}
// validate the yaml configuration
err = c.Validate(p)
if err != nil {
return nil, _pipeline, err
}
// Create some default global environment inject vars
// these are used below to overwrite to an empty
// map if they should not be injected into a container
envGlobalServices, envGlobalSecrets, envGlobalSteps := p.Environment, p.Environment, p.Environment
if !p.Metadata.HasEnvironment("services") {
envGlobalServices = make(raw.StringSliceMap)
}
if !p.Metadata.HasEnvironment("secrets") {
envGlobalSecrets = make(raw.StringSliceMap)
}
if !p.Metadata.HasEnvironment("steps") {
envGlobalSteps = make(raw.StringSliceMap)
}
// inject the environment variables into the services
p.Services, err = c.EnvironmentServices(p.Services, envGlobalServices)
if err != nil {
return nil, _pipeline, err
}
// inject the environment variables into the secrets
p.Secrets, err = c.EnvironmentSecrets(p.Secrets, envGlobalSecrets)
if err != nil {
return nil, _pipeline, err
}
// inject the environment variables into the steps
p.Steps, err = c.EnvironmentSteps(p.Steps, envGlobalSteps)
if err != nil {
return nil, _pipeline, err
}
// inject the substituted environment variables into the steps
p.Steps, err = c.SubstituteSteps(p.Steps)
if err != nil {
return nil, _pipeline, err
}
// inject the scripts into the steps
p.Steps, err = c.ScriptSteps(p.Steps)
if err != nil {
return nil, _pipeline, err
}
// create executable representation
build, err := c.TransformSteps(r, p)
if err != nil {
return nil, _pipeline, err
}
return build, _pipeline, nil
}
// compileStages executes the workflow for converting a YAML pipeline into an executable struct.
func (c *client) compileStages(ctx context.Context, p *yaml.Build, _pipeline *api.Pipeline, tmpls map[string]*yaml.Template, r *pipeline.RuleData) (*pipeline.Build, *api.Pipeline, error) {
var err error
// check if the pipeline disabled the clone
if p.Metadata.Clone == nil || *p.Metadata.Clone {
// inject the clone stage
p, err = c.CloneStage(p)
if err != nil {
return nil, _pipeline, err
}
}
// inject the init stage
p, err = c.InitStage(p)
if err != nil {
return nil, _pipeline, err
}
// inject the templates into the stages
p, err = c.ExpandStages(ctx, p, tmpls, r)
if err != nil {
return nil, _pipeline, err
}
if c.ModificationService.Endpoint != "" {
// send config to external endpoint for modification
p, err = c.modifyConfig(p, c.build, c.repo)
if err != nil {
return nil, _pipeline, err
}
}
// validate the yaml configuration
err = c.Validate(p)
if err != nil {
return nil, _pipeline, err
}
// Create some default global environment inject vars
// these are used below to overwrite to an empty
// map if they should not be injected into a container
envGlobalServices, envGlobalSecrets, envGlobalSteps := p.Environment, p.Environment, p.Environment
if !p.Metadata.HasEnvironment("services") {
envGlobalServices = make(raw.StringSliceMap)
}
if !p.Metadata.HasEnvironment("secrets") {
envGlobalSecrets = make(raw.StringSliceMap)
}
if !p.Metadata.HasEnvironment("steps") {
envGlobalSteps = make(raw.StringSliceMap)
}
// inject the environment variables into the services
p.Services, err = c.EnvironmentServices(p.Services, envGlobalServices)
if err != nil {
return nil, _pipeline, err
}
// inject the environment variables into the secrets
p.Secrets, err = c.EnvironmentSecrets(p.Secrets, envGlobalSecrets)
if err != nil {
return nil, _pipeline, err
}
// inject the environment variables into the stages
p.Stages, err = c.EnvironmentStages(p.Stages, envGlobalSteps)
if err != nil {
return nil, _pipeline, err
}
// inject the substituted environment variables into the stages
p.Stages, err = c.SubstituteStages(p.Stages)
if err != nil {
return nil, _pipeline, err
}
// inject the scripts into the stages
p.Stages, err = c.ScriptStages(p.Stages)
if err != nil {
return nil, _pipeline, err
}
// create executable representation
build, err := c.TransformStages(r, p)
if err != nil {
return nil, _pipeline, err
}
return build, _pipeline, nil
}
// errorHandler ensures the error contains the number of request attempts.
func errorHandler(resp *http.Response, err error, attempts int) (*http.Response, error) {
if err != nil {
err = fmt.Errorf("giving up connecting to modification endpoint after %d attempts due to: %w", attempts, err)
}
return resp, err
}
// modifyConfig sends the configuration to external http endpoint for modification.
func (c *client) modifyConfig(build *yaml.Build, libraryBuild *api.Build, repo *api.Repo) (*yaml.Build, error) {
// create request to send to endpoint
data, err := yml.Marshal(build)
if err != nil {
return nil, err
}
modReq := &ModifyRequest{
Pipeline: string(data),
Build: libraryBuild.GetNumber(),
Repo: repo.GetName(),
Org: repo.GetOrg(),
User: libraryBuild.GetAuthor(),
}
// marshal json to send in request
b, err := json.Marshal(modReq)
if err != nil {
return nil, fmt.Errorf("failed to marshal modify payload")
}
// setup http client
retryClient := retryablehttp.Client{
HTTPClient: cleanhttp.DefaultPooledClient(),
RetryWaitMin: 500 * time.Millisecond,
RetryWaitMax: 1 * time.Second,
RetryMax: c.ModificationService.Retries,
CheckRetry: retryablehttp.DefaultRetryPolicy,
ErrorHandler: errorHandler,
Backoff: retryablehttp.DefaultBackoff,
}
// ensure the overall request(s) do not take over the defined timeout
ctx, cancel := context.WithTimeout(context.Background(), c.ModificationService.Timeout)
defer cancel()
// create POST request
req, err := retryablehttp.NewRequestWithContext(ctx, "POST", c.ModificationService.Endpoint, bytes.NewBuffer(b))
if err != nil {
return nil, err
}
// add content-type and auth headers
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", c.ModificationService.Secret))
// send the request
resp, err := retryClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
// fail if the response code was not 200
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("modification endpoint returned status code %v", resp.StatusCode)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("failed to read payload: %w", err)
}
response := new(ModifyResponse)
// unmarshal the response into the ModifyResponse struct
err = json.Unmarshal(body, &response)
if err != nil {
return nil, fmt.Errorf("failed to unmarshal JSON modification payload: %w", err)
}
newBuild := new(yaml.Build)
// unmarshal the response into the yaml.Build struct
err = yml.Unmarshal([]byte(response.Pipeline), &newBuild)
if err != nil {
return nil, fmt.Errorf("failed to unmarshal YAML modification payload: %w", err)
}
return newBuild, nil
}