forked from argoproj/argo-workflows
-
Notifications
You must be signed in to change notification settings - Fork 0
/
get_test.go
426 lines (395 loc) · 14.4 KB
/
get_test.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
package common
import (
"bytes"
"fmt"
"testing"
"text/tabwriter"
"time"
"github.com/stretchr/testify/assert"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
wfv1 "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
"github.com/argoproj/argo-workflows/v3/workflow/util"
)
var workflowName string = "testWF"
func init() {
// these values get used as part of determining node name and would normally be set as part of
// running the application
JobStatusIconMap = map[wfv1.NodePhase]string{
wfv1.NodePending: ansiFormat("Pending", FgYellow),
wfv1.NodeRunning: ansiFormat("Running", FgCyan),
wfv1.NodeSucceeded: ansiFormat("Succeeded", FgGreen),
wfv1.NodeSkipped: ansiFormat("Skipped", FgDefault),
wfv1.NodeFailed: ansiFormat("Failed", FgRed),
wfv1.NodeError: ansiFormat("Error", FgRed),
}
NodeTypeIconMap = map[wfv1.NodeType]string{
wfv1.NodeTypeSuspend: ansiFormat("Suspend", FgCyan),
}
}
func testPrintNodeImpl(t *testing.T, expected string, node wfv1.NodeStatus, getArgs GetFlags) {
var result bytes.Buffer
w := tabwriter.NewWriter(&result, 0, 8, 1, '\t', 0)
filtered, _ := filterNode(node, getArgs)
if !filtered {
printNode(w, node, workflowName, "", getArgs, util.GetPodNameVersion())
}
err := w.Flush()
assert.NoError(t, err)
assert.Equal(t, expected, result.String())
}
// TestPrintNode
func TestPrintNode(t *testing.T) {
nodeName := "testNode"
kubernetesNodeName := "testKnodeName"
nodeTemplateName := "testTemplate"
nodeTemplateRefName := "testTemplateRef"
nodeID := "testID"
nodeMessage := "test"
getArgs := GetFlags{
Output: "",
}
timestamp := metav1.Time{
Time: time.Now(),
}
node := wfv1.NodeStatus{
Name: nodeName,
Phase: wfv1.NodeRunning,
DisplayName: nodeName,
Type: wfv1.NodeTypePod,
ID: nodeID,
StartedAt: timestamp,
FinishedAt: timestamp,
Message: nodeMessage,
TemplateName: nodeTemplateName,
}
node.HostNodeName = kubernetesNodeName
// derive expected pod name:
expectedPodName := util.GeneratePodName(workflowName, nodeName, nodeTemplateName, nodeID, util.GetPodNameVersion())
t.Log(expectedPodName)
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s\t%s\t%s\t%s\t%s\n", JobStatusIconMap[wfv1.NodeRunning], nodeName, nodeTemplateName, expectedPodName, "0s", nodeMessage, ""), node, getArgs)
// Compatibility test
getArgs.Status = "Running"
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s\t%s\t%s\t%s\t%s\n", JobStatusIconMap[wfv1.NodeRunning], nodeName, nodeTemplateName, expectedPodName, "0s", nodeMessage, ""), node, getArgs)
getArgs.Status = ""
getArgs.NodeFieldSelectorString = "phase=Running"
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s\t%s\t%s\t%s\t%s\n", JobStatusIconMap[wfv1.NodeRunning], nodeName, nodeTemplateName, expectedPodName, "0s", nodeMessage, ""), node, getArgs)
getArgs.NodeFieldSelectorString = "phase!=foobar"
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s\t%s\t%s\t%s\t%s\n", JobStatusIconMap[wfv1.NodeRunning], nodeName, nodeTemplateName, expectedPodName, "0s", nodeMessage, ""), node, getArgs)
getArgs.NodeFieldSelectorString = "phase!=Running"
testPrintNodeImpl(t, "", node, getArgs)
// Compatibility test
getArgs.NodeFieldSelectorString = ""
getArgs.Status = "foobar"
testPrintNodeImpl(t, "", node, getArgs)
getArgs.Status = ""
getArgs.NodeFieldSelectorString = "phase=foobar"
testPrintNodeImpl(t, "", node, getArgs)
getArgs = GetFlags{
Output: "",
}
node.TemplateName = nodeTemplateName
expectedPodName = util.GeneratePodName(workflowName, nodeName, nodeTemplateName, nodeID, util.GetPodNameVersion())
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s\t%s\t%s\t%s\t%s\n", JobStatusIconMap[wfv1.NodeRunning], nodeName, nodeTemplateName, expectedPodName, "0s", nodeMessage, ""), node, getArgs)
node.Type = wfv1.NodeTypeSuspend
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s\t%s\t%s\t%s\t%s\n", NodeTypeIconMap[wfv1.NodeTypeSuspend], nodeName, nodeTemplateName, "", "", nodeMessage, ""), node, getArgs)
node.TemplateRef = &wfv1.TemplateRef{
Name: nodeTemplateRefName,
Template: nodeTemplateRefName,
}
templateName := fmt.Sprintf("%s/%s", node.TemplateRef.Name, node.TemplateRef.Template)
expectedPodName = util.GeneratePodName(workflowName, nodeName, templateName, nodeID, util.GetPodNameVersion())
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s/%s\t%s\t%s\t%s\t%s\n", NodeTypeIconMap[wfv1.NodeTypeSuspend], nodeName, nodeTemplateRefName, nodeTemplateRefName, "", "", nodeMessage, ""), node, getArgs)
getArgs.Output = "wide"
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s/%s\t%s\t%s\t%s\t%s\t%s\t\n", NodeTypeIconMap[wfv1.NodeTypeSuspend], nodeName, nodeTemplateRefName, nodeTemplateRefName, "", "", getArtifactsString(node), nodeMessage, ""), node, getArgs)
node.Type = wfv1.NodeTypePod
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s/%s\t%s\t%s\t%s\t%s\t%s\t%s\n", JobStatusIconMap[wfv1.NodeRunning], nodeName, nodeTemplateRefName, nodeTemplateRefName, expectedPodName, "0s", getArtifactsString(node), nodeMessage, "", kubernetesNodeName), node, getArgs)
getArgs.Output = "short"
testPrintNodeImpl(t, fmt.Sprintf("%s %s\t%s/%s\t%s\t%s\t%s\t%s\n", JobStatusIconMap[wfv1.NodeRunning], nodeName, nodeTemplateRefName, nodeTemplateRefName, expectedPodName, "0s", nodeMessage, kubernetesNodeName), node, getArgs)
getArgs.Status = "foobar"
testPrintNodeImpl(t, "", node, getArgs)
}
func TestStatusToNodeFieldSelector(t *testing.T) {
one := statusToNodeFieldSelector("Running")
assert.Equal(t, "phase=Running", one)
}
func Test_printWorkflowHelper(t *testing.T) {
t.Run("Progress", func(t *testing.T) {
var wf wfv1.Workflow
wfv1.MustUnmarshal(`
status:
phase: Running
progress: 1/2
`, &wf)
output := PrintWorkflowHelper(&wf, GetFlags{})
assert.Regexp(t, `Progress: *1/2`, output)
})
t.Run("EstimatedDuration", func(t *testing.T) {
var wf wfv1.Workflow
wfv1.MustUnmarshal(`
status:
estimatedDuration: 1
phase: Running
`, &wf)
output := PrintWorkflowHelper(&wf, GetFlags{})
assert.Regexp(t, `EstimatedDuration: *1 second`, output)
})
t.Run("IndexOrdering", func(t *testing.T) {
var wf wfv1.Workflow
wfv1.MustUnmarshal(`apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
creationTimestamp: "2020-06-02T16:04:21Z"
generateName: many-items-
generation: 32
labels:
workflows.argoproj.io/completed: "true"
workflows.argoproj.io/phase: Succeeded
name: many-items-z26lj
namespace: argo
resourceVersion: "5102"
selfLink: /apis/argoproj.io/v1alpha1/namespaces/argo/workflows/many-items-z26lj
uid: d21f092a-f659-4300-bd69-983a9912a379
spec:
entrypoint: parallel-sleep
templates:
- name: parallel-sleep
steps:
- - name: sleep
template: sleep
withItems:
- zero
- one
- two
- three
- four
- five
- six
- seven
- eight
- nine
- ten
- eleven
- twelve
- container:
command:
- sh
- -c
- sleep 10
image: alpine:latest
name: sleep
status:
conditions:
- status: "True"
type: Completed
finishedAt: "2020-06-02T16:05:01Z"
nodes:
many-items-z26lj:
children:
- many-items-z26lj-1414877240
displayName: many-items-z26lj
finishedAt: "2020-06-02T16:05:01Z"
id: many-items-z26lj
name: many-items-z26lj
outboundNodes:
- many-items-z26lj-1939921510
- many-items-z26lj-2156977535
- many-items-z26lj-3409403178
- many-items-z26lj-1774150289
- many-items-z26lj-3491220632
- many-items-z26lj-1942531647
- many-items-z26lj-3178865096
- many-items-z26lj-3031375822
- many-items-z26lj-753834747
- many-items-z26lj-2619926859
- many-items-z26lj-1052882686
- many-items-z26lj-3011405271
- many-items-z26lj-3126938806
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: parallel-sleep
type: Steps
many-items-z26lj-753834747:
boundaryID: many-items-z26lj
displayName: sleep(8:eight)
finishedAt: "2020-06-02T16:04:42Z"
id: many-items-z26lj-753834747
name: many-items-z26lj[0].sleep(8:eight)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-1052882686:
boundaryID: many-items-z26lj
displayName: sleep(10:ten)
finishedAt: "2020-06-02T16:04:45Z"
id: many-items-z26lj-1052882686
name: many-items-z26lj[0].sleep(10:ten)
phase: Succeeded
startedAt: "2020-06-02T16:04:22Z"
templateName: sleep
type: Pod
many-items-z26lj-1414877240:
boundaryID: many-items-z26lj
children:
- many-items-z26lj-1939921510
- many-items-z26lj-2156977535
- many-items-z26lj-3409403178
- many-items-z26lj-1774150289
- many-items-z26lj-3491220632
- many-items-z26lj-1942531647
- many-items-z26lj-3178865096
- many-items-z26lj-3031375822
- many-items-z26lj-753834747
- many-items-z26lj-2619926859
- many-items-z26lj-1052882686
- many-items-z26lj-3011405271
- many-items-z26lj-3126938806
displayName: '[0]'
finishedAt: "2020-06-02T16:05:01Z"
id: many-items-z26lj-1414877240
name: many-items-z26lj[0]
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: parallel-sleep
type: StepGroup
many-items-z26lj-1774150289:
boundaryID: many-items-z26lj
displayName: sleep(3:three)
finishedAt: "2020-06-02T16:04:54Z"
id: many-items-z26lj-1774150289
name: many-items-z26lj[0].sleep(3:three)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-1939921510:
boundaryID: many-items-z26lj
displayName: sleep(0:zero)
finishedAt: "2020-06-02T16:04:48Z"
id: many-items-z26lj-1939921510
name: many-items-z26lj[0].sleep(0:zero)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-1942531647:
boundaryID: many-items-z26lj
displayName: sleep(5:five)
finishedAt: "2020-06-02T16:04:47Z"
id: many-items-z26lj-1942531647
name: many-items-z26lj[0].sleep(5:five)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-2156977535:
boundaryID: many-items-z26lj
displayName: sleep(1:one)
finishedAt: "2020-06-02T16:04:53Z"
id: many-items-z26lj-2156977535
name: many-items-z26lj[0].sleep(1:one)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-2619926859:
boundaryID: many-items-z26lj
displayName: sleep(9:nine)
finishedAt: "2020-06-02T16:04:40Z"
id: many-items-z26lj-2619926859
name: many-items-z26lj[0].sleep(9:nine)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-3011405271:
boundaryID: many-items-z26lj
displayName: sleep(11:eleven)
finishedAt: "2020-06-02T16:04:44Z"
id: many-items-z26lj-3011405271
name: many-items-z26lj[0].sleep(11:eleven)
phase: Succeeded
startedAt: "2020-06-02T16:04:22Z"
templateName: sleep
type: Pod
many-items-z26lj-3031375822:
boundaryID: many-items-z26lj
displayName: sleep(7:seven)
finishedAt: "2020-06-02T16:04:57Z"
id: many-items-z26lj-3031375822
name: many-items-z26lj[0].sleep(7:seven)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-3126938806:
boundaryID: many-items-z26lj
displayName: sleep(12:twelve)
finishedAt: "2020-06-02T16:04:59Z"
id: many-items-z26lj-3126938806
name: many-items-z26lj[0].sleep(12:twelve)
phase: Succeeded
startedAt: "2020-06-02T16:04:22Z"
templateName: sleep
type: Pod
many-items-z26lj-3178865096:
boundaryID: many-items-z26lj
displayName: sleep(6:six)
finishedAt: "2020-06-02T16:04:56Z"
id: many-items-z26lj-3178865096
name: many-items-z26lj[0].sleep(6:six)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-3409403178:
boundaryID: many-items-z26lj
displayName: sleep(2:two)
finishedAt: "2020-06-02T16:04:51Z"
id: many-items-z26lj-3409403178
name: many-items-z26lj[0].sleep(2:two)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
many-items-z26lj-3491220632:
boundaryID: many-items-z26lj
displayName: sleep(4:four)
finishedAt: "2020-06-02T16:04:50Z"
id: many-items-z26lj-3491220632
name: many-items-z26lj[0].sleep(4:four)
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
templateName: sleep
type: Pod
phase: Succeeded
startedAt: "2020-06-02T16:04:21Z"
`, &wf)
output := PrintWorkflowHelper(&wf, GetFlags{})
// derive expected pod name:
expectedPodName := util.GeneratePodName(wf.GetObjectMeta().GetName(), "many-items-z26lj[0].sleep(9:nine)", "sleep", "many-items-z26lj-2619926859", util.GetPodNameVersion())
assert.Contains(t, output, fmt.Sprintf("sleep(9:nine) sleep %s 19s", expectedPodName))
expectedPodName = util.GeneratePodName(wf.GetObjectMeta().GetName(), "many-items-z26lj[0].sleep(10:ten)", "sleep", "many-items-z26lj-1052882686", util.GetPodNameVersion())
assert.Contains(t, output, fmt.Sprintf("sleep(10:ten) sleep %s 23s", expectedPodName))
expectedPodName = util.GeneratePodName(wf.GetObjectMeta().GetName(), "many-items-z26lj[0].sleep(11:eleven)", "sleep", "many-items-z26lj-3011405271", util.GetPodNameVersion())
assert.Contains(t, output, fmt.Sprintf("sleep(11:eleven) sleep %s 22s", expectedPodName))
})
}
func Test_printWorkflowHelperNudges(t *testing.T) {
securedWf := wfv1.Workflow{
ObjectMeta: metav1.ObjectMeta{},
Spec: wfv1.WorkflowSpec{
SecurityContext: &corev1.PodSecurityContext{},
},
}
insecureWf := securedWf
insecureWf.Spec.SecurityContext = nil
securityNudges := "This workflow does not have security context set. " +
"You can run your workflow pods more securely by setting it.\n" +
"Learn more at https://argoproj.github.io/argo-workflows/workflow-pod-security-context/\n"
t.Run("SecuredWorkflow", func(t *testing.T) {
output := PrintWorkflowHelper(&securedWf, GetFlags{})
assert.NotContains(t, output, securityNudges)
})
}