/
pipeline.go
396 lines (353 loc) · 11.7 KB
/
pipeline.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
package exportentities
import (
"fmt"
"sort"
"github.com/ovh/cds/sdk"
)
// Pipeliner interface, depending on the version we will use different struct.
type Pipeliner interface {
Pipeline() (*sdk.Pipeline, error)
}
// PipelineV1 represents exported sdk.Pipeline
type PipelineV1 struct {
Version string `json:"version,omitempty" yaml:"version,omitempty" jsonschema_description:"The version for the current pipeline file (v1.0)."`
Name string `json:"name,omitempty" yaml:"name,omitempty" jsonschema_description:"The name of the pipeline."`
Description string `json:"description,omitempty" yaml:"description,omitempty" jsonschema_description:"The description of the pipeline."`
Parameters map[string]ParameterValue `json:"parameters,omitempty" yaml:"parameters,omitempty" jsonschema_description:"The list of parameters of the pipeline."`
Stages []string `json:"stages,omitempty" yaml:"stages,omitempty" jsonschema_description:"The list of stage's names for the pipeline."`
StageOptions map[string]Stage `json:"options,omitempty" yaml:"options,omitempty" jsonschema_description:"The options for stages of the pipeline."` //Here Stage.Jobs will NEVER be set
Jobs []Job `json:"jobs,omitempty" yaml:"jobs,omitempty" jsonschema_description:"The list of jobs for the pipeline."`
}
// PipelineVersion is a version
type PipelineVersion string
// There are the supported versions
const (
PipelineVersion1 = "v1.0"
)
// Stage represents exported sdk.Stage
type Stage struct {
Enabled *bool `json:"enabled,omitempty" yaml:"enabled,omitempty"`
Jobs map[string]Job `json:"jobs,omitempty" yaml:"jobs,omitempty"`
Conditions *sdk.WorkflowNodeConditions `json:"conditions,omitempty" yaml:"conditions,omitempty"`
}
// Job represents exported sdk.Job
type Job struct {
Name string `json:"job,omitempty" yaml:"job,omitempty" jsonschema_description:"The name of the job."`
Stage string `json:"stage,omitempty" yaml:"stage,omitempty" jsonschema_description:"The name of the stage for the job."`
Description string `json:"description,omitempty" yaml:"description,omitempty" jsonschema_description:"The description of the job."`
Enabled *bool `json:"enabled,omitempty" yaml:"enabled,omitempty" jsonschema_description:"Job is enabled by default, you can set this option to disable a job."`
Steps []Step `json:"steps,omitempty" yaml:"steps,omitempty" jsonschema_description:"The list of steps for the job."`
Requirements []Requirement `json:"requirements,omitempty" yaml:"requirements,omitempty" jsonschema_description:"The list of requirements for the jobs."`
Optional *bool `json:"optional,omitempty" yaml:"optional,omitempty" jsonschema_description:"Set this option to ignore job's errors."`
AlwaysExecuted *bool `json:"always_executed,omitempty" yaml:"always_executed,omitempty" jsonschema_description:"Set this option to execute the job even if a previous step failed."`
}
// Requirement represents an exported sdk.Requirement
type Requirement struct {
Binary string `json:"binary,omitempty" yaml:"binary,omitempty"`
Model string `json:"model,omitempty" yaml:"model,omitempty"`
Modelv2 string `json:"modelv2,omitempty" yaml:"modelv2,omitempty"`
Hostname string `json:"hostname,omitempty" yaml:"hostname,omitempty"`
Plugin string `json:"plugin,omitempty" yaml:"plugin,omitempty"`
Service ServiceRequirement `json:"service,omitempty" yaml:"service,omitempty"`
Memory string `json:"memory,omitempty" yaml:"memory,omitempty"`
OSArchRequirement string `json:"os-architecture,omitempty" yaml:"os-architecture,omitempty"`
RegionRequirement string `json:"region,omitempty" yaml:"region,omitempty"`
SecretRequirement string `json:"secret,omitempty" yaml:"secret,omitempty"`
}
// ServiceRequirement represents an exported sdk.Requirement of type ServiceRequirement
type ServiceRequirement struct {
Name string `json:"name,omitempty" yaml:"name,omitempty"`
Value string `json:"value,omitempty" yaml:"value,omitempty"`
}
// NewPipelineV1 creates an exportable pipeline from a sdk.Pipeline
func NewPipelineV1(pip sdk.Pipeline) (p PipelineV1) {
p.Name = pip.Name
p.Description = pip.Description
p.Version = PipelineVersion1
p.Parameters = make(map[string]ParameterValue, len(pip.Parameter))
for _, v := range pip.Parameter {
p.Parameters[v.Name] = ParameterValue{
Type: string(v.Type),
DefaultValue: v.Value,
Description: v.Description,
}
}
p.Stages, p.StageOptions = newStagesForPipelineV1(pip.Stages)
//If there is one stages and no options
if len(p.Stages) == 1 && len(p.StageOptions) == 0 {
p.Stages = nil
}
for _, s := range pip.Stages {
for _, j := range s.Jobs {
jo := newJob(j)
if len(pip.Stages) > 1 {
jo.Stage = s.Name
}
jo.Name = j.Action.Name
p.Jobs = append(p.Jobs, jo)
}
}
return
}
func newStagesForPipelineV1(stages []sdk.Stage) ([]string, map[string]Stage) {
res := make([]string, len(stages))
opts := make(map[string]Stage, len(stages))
for i := range stages {
s := &stages[i]
res[i] = s.Name
var hasOptions bool
st := Stage{}
if !s.Enabled {
st.Enabled = &s.Enabled
hasOptions = true
}
if len(s.Conditions.PlainConditions) > 0 || s.Conditions.LuaScript != "" {
st.Conditions = &s.Conditions
hasOptions = true
}
if hasOptions == true {
opts[s.Name] = st
}
}
return res, opts
}
func NewRequirements(req []sdk.Requirement) []Requirement {
if req == nil {
return nil
}
res := make([]Requirement, 0, len(req))
for _, r := range req {
switch r.Type {
case sdk.BinaryRequirement:
res = append(res, Requirement{Binary: r.Value})
case sdk.ModelRequirement:
res = append(res, Requirement{Model: r.Value})
case sdk.HostnameRequirement:
res = append(res, Requirement{Hostname: r.Value})
case sdk.PluginRequirement:
res = append(res, Requirement{Plugin: r.Value})
case sdk.ServiceRequirement:
res = append(res, Requirement{Service: ServiceRequirement{Name: r.Name, Value: r.Value}})
case sdk.OSArchRequirement:
res = append(res, Requirement{OSArchRequirement: r.Value})
case sdk.RegionRequirement:
res = append(res, Requirement{RegionRequirement: r.Value})
case sdk.MemoryRequirement:
res = append(res, Requirement{Memory: r.Value})
case sdk.SecretRequirement:
res = append(res, Requirement{SecretRequirement: r.Value})
}
}
return res
}
func newJob(j sdk.Job) Job {
jo := Job{}
if !j.Enabled {
jo.Enabled = &j.Enabled
}
jo.Steps = newSteps(j.Action)
jo.Description = j.Action.Description
jo.Requirements = NewRequirements(j.Action.Requirements)
return jo
}
func newJobs(jobs []sdk.Job) map[string]Job {
res := map[string]Job{}
for i := range jobs {
j := jobs[i]
if len(j.Action.Actions) == 0 {
continue
}
jo := newJob(j)
res[j.Action.Name] = jo
}
return res
}
func computeSteps(steps []Step) ([]sdk.Action, error) {
res := make([]sdk.Action, len(steps))
for i, s := range steps {
a, err := s.toAction()
if err != nil {
return nil, err
}
res[i] = *a
}
return res, nil
}
func computeJobRequirements(req []Requirement) []sdk.Requirement {
res := make([]sdk.Requirement, len(req))
for i, r := range req {
var name, tpe, val string
if r.Binary != "" {
name = r.Binary
val = r.Binary
tpe = sdk.BinaryRequirement
} else if r.Hostname != "" {
name = "hostname"
val = r.Hostname
tpe = sdk.HostnameRequirement
} else if r.Memory != "" {
name = "memory"
val = r.Memory
tpe = sdk.MemoryRequirement
} else if r.Model != "" {
name = "model"
val = r.Model
tpe = sdk.ModelRequirement
} else if r.OSArchRequirement != "" {
name = r.OSArchRequirement
val = r.OSArchRequirement
tpe = sdk.OSArchRequirement
} else if r.RegionRequirement != "" {
name = "region"
val = r.RegionRequirement
tpe = sdk.RegionRequirement
} else if r.Plugin != "" {
name = r.Plugin
val = r.Plugin
tpe = sdk.PluginRequirement
} else if r.Service.Name != "" {
name = r.Service.Name
val = r.Service.Value
tpe = sdk.ServiceRequirement
} else if r.SecretRequirement != "" {
name = "secret"
val = r.SecretRequirement
tpe = sdk.SecretRequirement
}
res[i] = sdk.Requirement{
Name: name,
Type: tpe,
Value: val,
}
}
return res
}
func computeJob(name string, j Job) (*sdk.Job, error) {
job := sdk.Job{
Action: sdk.Action{
Name: name,
Description: j.Description,
Type: sdk.JoinedAction,
},
}
if j.Enabled != nil {
job.Enabled = *j.Enabled
} else {
job.Enabled = true
}
job.Action.Enabled = job.Enabled
job.Action.Requirements = computeJobRequirements(j.Requirements)
//Compute steps for the jobs
children, err := computeSteps(j.Steps)
if err != nil {
return nil, err
}
job.Action.Actions = children
if err := job.Action.Requirements.IsValid(); err != nil {
return nil, err
}
return &job, nil
}
// Pipeline returns a sdk.Pipeline entity
func (p PipelineV1) Pipeline() (pip *sdk.Pipeline, err error) {
pip = new(sdk.Pipeline)
pip.Name = p.Name
pip.Description = p.Description
pip.Parameter = make([]sdk.Parameter, 0, len(p.Parameters))
//Compute parameters
for p, v := range p.Parameters {
param := sdk.Parameter{
Name: p,
Type: v.Type,
Value: v.DefaultValue,
Description: v.Description,
}
if param.Type == "" {
param.Type = sdk.StringParameter
}
pip.Parameter = append(pip.Parameter, param)
}
//Compute stage
mapStages := map[string]*sdk.Stage{}
for i, s := range p.Stages {
mapStages[s] = &sdk.Stage{
Name: s,
BuildOrder: i + 1, //Yes, buildOrder start at 1
Enabled: true,
}
}
for s, opt := range p.StageOptions {
if mapStages[s] == nil {
return nil, sdk.NewErrorFrom(sdk.ErrWrongRequest, "invalid stage option, stage %s not found", s)
}
if opt.Enabled != nil {
mapStages[s].Enabled = *opt.Enabled
} else {
mapStages[s].Enabled = true
}
if opt.Conditions != nil {
mapStages[s].Conditions = *opt.Conditions
}
}
//Compute Jobs
for _, j := range p.Jobs {
s := mapStages[j.Stage]
if s == nil { //If the stage is not found
if len(mapStages) != 1 || j.Stage != "" { // if there isn't only one stage
mapStages[j.Stage] = &sdk.Stage{
Name: j.Stage,
BuildOrder: len(mapStages) + 1,
Enabled: true,
}
s = mapStages[j.Stage]
} else {
// choose the only one stage
for _, stage := range mapStages {
s = stage
break
}
}
}
job, err := computeJob(j.Name, j)
if err != nil {
return pip, err
}
s.Jobs = append(s.Jobs, *job)
}
pip.Stages = make([]sdk.Stage, len(mapStages))
iS := 0
for _, s := range mapStages {
pip.Stages[iS] = *s
iS++
}
sort.Slice(pip.Stages, func(i, j int) bool {
return pip.Stages[i].BuildOrder < pip.Stages[j].BuildOrder
})
return pip, nil
}
// ParsePipeline returns a pipeliner from given data.
func ParsePipeline(format Format, data []byte) (Pipeliner, error) {
rawPayload := make(map[string]interface{})
if err := Unmarshal(data, format, &rawPayload); err != nil {
return nil, err
}
version := PipelineVersion1
if v, ok := rawPayload["version"]; ok {
vString := fmt.Sprintf("%v", v)
switch vString {
case PipelineVersion1:
version = PipelineVersion1
default:
return nil, sdk.NewErrorFrom(sdk.ErrWrongRequest, "invalid pipeline version")
}
}
var payload Pipeliner
switch version {
case PipelineVersion1:
payload = &PipelineV1{}
}
if err := Unmarshal(data, format, payload); err != nil {
return nil, err
}
return payload, nil
}