-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
status.go
914 lines (826 loc) · 30.9 KB
/
status.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
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
/*
Copyright 2019 The Tekton Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package pod
import (
"context"
"encoding/json"
"fmt"
"strconv"
"strings"
"time"
"github.com/hashicorp/go-multierror"
"github.com/tektoncd/pipeline/internal/sidecarlogresults"
"github.com/tektoncd/pipeline/pkg/apis/config"
"github.com/tektoncd/pipeline/pkg/apis/pipeline"
v1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
"github.com/tektoncd/pipeline/pkg/result"
"github.com/tektoncd/pipeline/pkg/termination"
"go.uber.org/zap"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"knative.dev/pkg/apis"
)
// Aliased for backwards compatibility; do not add additional TaskRun reasons here
var (
// ReasonFailedResolution indicated that the reason for failure status is
// that references within the TaskRun could not be resolved
ReasonFailedResolution = v1.TaskRunReasonFailedResolution.String()
// ReasonFailedValidation indicated that the reason for failure status is
// that taskrun failed runtime validation
ReasonFailedValidation = v1.TaskRunReasonFailedValidation.String()
// ReasonTaskFailedValidation indicated that the reason for failure status is
// that task failed runtime validation
ReasonTaskFailedValidation = v1.TaskRunReasonTaskFailedValidation.String()
// ReasonResourceVerificationFailed indicates that the task fails the trusted resource verification,
// it could be the content has changed, signature is invalid or public key is invalid
ReasonResourceVerificationFailed = v1.TaskRunReasonResourceVerificationFailed.String()
)
const (
// ReasonExceededResourceQuota indicates that the TaskRun failed to create a pod due to
// a ResourceQuota in the namespace
ReasonExceededResourceQuota = "ExceededResourceQuota"
// ReasonExceededNodeResources indicates that the TaskRun's pod has failed to start due
// to resource constraints on the node
ReasonExceededNodeResources = "ExceededNodeResources"
// ReasonPullImageFailed indicates that the TaskRun's pod failed to pull image
ReasonPullImageFailed = "PullImageFailed"
// ReasonCreateContainerConfigError indicates that the TaskRun failed to create a pod due to
// config error of container
ReasonCreateContainerConfigError = "CreateContainerConfigError"
// ReasonPodCreationFailed indicates that the reason for the current condition
// is that the creation of the pod backing the TaskRun failed
ReasonPodCreationFailed = "PodCreationFailed"
// ReasonPodAdmissionFailed indicates that the TaskRun's pod failed to pass admission validation
ReasonPodAdmissionFailed = "PodAdmissionFailed"
// ReasonPending indicates that the pod is in corev1.Pending, and the reason is not
// ReasonExceededNodeResources or isPodHitConfigError
ReasonPodPending = "Pending"
// timeFormat is RFC3339 with millisecond
timeFormat = "2006-01-02T15:04:05.000Z07:00"
)
const (
oomKilled = "OOMKilled"
evicted = "Evicted"
)
// SidecarsReady returns true if all of the Pod's sidecars are Ready or
// Terminated.
func SidecarsReady(podStatus corev1.PodStatus) bool {
if podStatus.Phase != corev1.PodRunning {
return false
}
for _, s := range podStatus.ContainerStatuses {
// If the step indicates that it's a step, skip it.
// An injected sidecar might not have the "sidecar-" prefix, so
// we can't just look for that prefix, we need to look at any
// non-step container.
if IsContainerStep(s.Name) {
continue
}
if s.State.Running != nil && s.Ready {
continue
}
if s.State.Terminated != nil {
continue
}
return false
}
return true
}
// MakeTaskRunStatus returns a TaskRunStatus based on the Pod's status.
func MakeTaskRunStatus(ctx context.Context, logger *zap.SugaredLogger, tr v1.TaskRun, pod *corev1.Pod, kubeclient kubernetes.Interface, ts *v1.TaskSpec) (v1.TaskRunStatus, error) {
trs := &tr.Status
if trs.GetCondition(apis.ConditionSucceeded) == nil || trs.GetCondition(apis.ConditionSucceeded).Status == corev1.ConditionUnknown {
// If the taskRunStatus doesn't exist yet, it's because we just started running
markStatusRunning(trs, v1.TaskRunReasonRunning.String(), "Not all Steps in the Task have finished executing")
}
sortPodContainerStatuses(pod.Status.ContainerStatuses, pod.Spec.Containers)
complete := areContainersCompleted(ctx, pod) || isPodCompleted(pod)
if complete {
onError, ok := tr.Annotations[v1.PipelineTaskOnErrorAnnotation]
if ok {
updateCompletedTaskRunStatus(logger, trs, pod, v1.PipelineTaskOnErrorType(onError))
} else {
updateCompletedTaskRunStatus(logger, trs, pod, "")
}
} else {
updateIncompleteTaskRunStatus(trs, pod)
}
trs.PodName = pod.Name
trs.Sidecars = []v1.SidecarState{}
var stepStatuses []corev1.ContainerStatus
var sidecarStatuses []corev1.ContainerStatus
for _, s := range pod.Status.ContainerStatuses {
if IsContainerStep(s.Name) {
stepStatuses = append(stepStatuses, s)
} else if IsContainerSidecar(s.Name) {
sidecarStatuses = append(sidecarStatuses, s)
}
}
for _, s := range pod.Status.InitContainerStatuses {
if IsContainerSidecar(s.Name) {
sidecarStatuses = append(sidecarStatuses, s)
}
}
var merr *multierror.Error
if err := setTaskRunStatusBasedOnStepStatus(ctx, logger, stepStatuses, &tr, pod.Status.Phase, kubeclient, ts); err != nil {
merr = multierror.Append(merr, err)
}
setTaskRunStatusBasedOnSidecarStatus(sidecarStatuses, trs)
trs.Results = removeDuplicateResults(trs.Results)
return *trs, merr.ErrorOrNil()
}
func createTaskResultsFromStepResults(stepRunRes []v1.TaskRunStepResult, neededStepResults map[string]string) []v1.TaskRunResult {
taskResults := []v1.TaskRunResult{}
for _, r := range stepRunRes {
// this result was requested by the Task
if _, ok := neededStepResults[r.Name]; ok {
taskRunResult := v1.TaskRunResult{
Name: neededStepResults[r.Name],
Type: r.Type,
Value: r.Value,
}
taskResults = append(taskResults, taskRunResult)
}
}
return taskResults
}
func setTaskRunArtifactsFromRunResult(runResults []result.RunResult, artifacts *v1.Artifacts) error {
for _, slr := range runResults {
if slr.ResultType == result.TaskRunArtifactsResultType {
return json.Unmarshal([]byte(slr.Value), artifacts)
}
}
return nil
}
func getTaskResultsFromSidecarLogs(runResults []result.RunResult) []result.RunResult {
taskResultsFromSidecarLogs := []result.RunResult{}
for _, slr := range runResults {
if slr.ResultType == result.TaskRunResultType {
taskResultsFromSidecarLogs = append(taskResultsFromSidecarLogs, slr)
}
}
return taskResultsFromSidecarLogs
}
func getStepResultsFromSidecarLogs(sidecarLogResults []result.RunResult, containerName string) ([]result.RunResult, error) {
stepResultsFromSidecarLogs := []result.RunResult{}
for _, slr := range sidecarLogResults {
if slr.ResultType == result.StepResultType {
stepName, resultName, err := sidecarlogresults.ExtractStepAndResultFromSidecarResultName(slr.Key)
if err != nil {
return []result.RunResult{}, err
}
if stepName == containerName {
slr.Key = resultName
stepResultsFromSidecarLogs = append(stepResultsFromSidecarLogs, slr)
}
}
}
return stepResultsFromSidecarLogs, nil
}
func setTaskRunStatusBasedOnStepStatus(ctx context.Context, logger *zap.SugaredLogger, stepStatuses []corev1.ContainerStatus, tr *v1.TaskRun, podPhase corev1.PodPhase, kubeclient kubernetes.Interface, ts *v1.TaskSpec) *multierror.Error {
trs := &tr.Status
var merr *multierror.Error
// collect results from taskrun spec and taskspec
specResults := []v1.TaskResult{}
if tr.Spec.TaskSpec != nil {
specResults = append(specResults, tr.Spec.TaskSpec.Results...)
}
if ts != nil {
specResults = append(specResults, ts.Results...)
}
// Extract results from sidecar logs
sidecarLogsResultsEnabled := config.FromContextOrDefaults(ctx).FeatureFlags.ResultExtractionMethod == config.ResultExtractionMethodSidecarLogs
// temporary solution to check if artifacts sidecar created in taskRun as we don't have the api for users to declare if a step/task is producing artifacts yet
artifactsSidecarCreated := artifactsPathReferenced(ts.Steps)
sidecarLogResults := []result.RunResult{}
if sidecarLogsResultsEnabled {
// extraction of results from sidecar logs
if tr.Status.TaskSpec.Results != nil || artifactsSidecarCreated {
slr, err := sidecarlogresults.GetResultsFromSidecarLogs(ctx, kubeclient, tr.Namespace, tr.Status.PodName, pipeline.ReservedResultsSidecarContainerName, podPhase)
if err != nil {
merr = multierror.Append(merr, err)
}
sidecarLogResults = append(sidecarLogResults, slr...)
}
}
// Populate Task results from sidecar logs
taskResultsFromSidecarLogs := getTaskResultsFromSidecarLogs(sidecarLogResults)
taskResults, _, _ := filterResults(taskResultsFromSidecarLogs, specResults, nil)
if tr.IsDone() {
trs.Results = append(trs.Results, taskResults...)
var tras v1.Artifacts
err := setTaskRunArtifactsFromRunResult(sidecarLogResults, &tras)
if err != nil {
logger.Errorf("Failed to set artifacts value from sidecar logs: %v", err)
merr = multierror.Append(merr, err)
} else {
trs.Artifacts = &tras
}
}
// Continue with extraction of termination messages
for _, s := range stepStatuses {
// Avoid changing the original value by modifying the pointer value.
state := s.State.DeepCopy()
taskRunStepResults := []v1.TaskRunStepResult{}
// Identify Step Results
stepResults := []v1.StepResult{}
if ts != nil {
for _, step := range ts.Steps {
if GetContainerName(step.Name) == s.Name {
stepResults = append(stepResults, step.Results...)
}
}
}
// Identify StepResults needed by the Task Results
neededStepResults, err := findStepResultsFetchedByTask(s.Name, specResults)
if err != nil {
merr = multierror.Append(merr, err)
}
// populate step results from sidecar logs
stepResultsFromSidecarLogs, err := getStepResultsFromSidecarLogs(sidecarLogResults, s.Name)
if err != nil {
merr = multierror.Append(merr, err)
}
_, stepRunRes, _ := filterResults(stepResultsFromSidecarLogs, specResults, stepResults)
if tr.IsDone() {
taskRunStepResults = append(taskRunStepResults, stepRunRes...)
// Set TaskResults from StepResults
trs.Results = append(trs.Results, createTaskResultsFromStepResults(stepRunRes, neededStepResults)...)
}
var sas v1.Artifacts
err = setStepArtifactsValueFromSidecarLogResult(sidecarLogResults, s.Name, &sas)
if err != nil {
logger.Errorf("Failed to set artifacts value from sidecar logs: %v", err)
merr = multierror.Append(merr, err)
}
// Parse termination messages
terminationReason := ""
if state.Terminated != nil && len(state.Terminated.Message) != 0 {
msg := state.Terminated.Message
results, err := termination.ParseMessage(logger, msg)
if err != nil {
logger.Errorf("termination message could not be parsed sas JSON: %v", err)
merr = multierror.Append(merr, err)
} else {
err := setStepArtifactsValueFromTerminationMessageRunResult(results, &sas)
if err != nil {
logger.Errorf("error setting step artifacts of step %q in taskrun %q: %v", s.Name, tr.Name, err)
merr = multierror.Append(merr, err)
}
time, err := extractStartedAtTimeFromResults(results)
if err != nil {
logger.Errorf("error setting the start time of step %q in taskrun %q: %v", s.Name, tr.Name, err)
merr = multierror.Append(merr, err)
}
exitCode, err := extractExitCodeFromResults(results)
if err != nil {
logger.Errorf("error extracting the exit code of step %q in taskrun %q: %v", s.Name, tr.Name, err)
merr = multierror.Append(merr, err)
}
taskResults, stepRunRes, filteredResults := filterResults(results, specResults, stepResults)
if tr.IsDone() {
taskRunStepResults = append(taskRunStepResults, stepRunRes...)
// Set TaskResults from StepResults
taskResults = append(taskResults, createTaskResultsFromStepResults(stepRunRes, neededStepResults)...)
trs.Results = append(trs.Results, taskResults...)
var tras v1.Artifacts
err := setTaskRunArtifactsFromRunResult(filteredResults, &tras)
if err != nil {
logger.Errorf("error setting step artifacts in taskrun %q: %v", tr.Name, err)
merr = multierror.Append(merr, err)
}
trs.Artifacts.Merge(&tras)
trs.Artifacts.Merge(&sas)
}
msg, err = createMessageFromResults(filteredResults)
if err != nil {
logger.Errorf("%v", err)
merr = multierror.Append(merr, err)
} else {
state.Terminated.Message = msg
}
if time != nil {
state.Terminated.StartedAt = *time
}
if exitCode != nil {
state.Terminated.ExitCode = *exitCode
}
terminationFromResults := extractTerminationReasonFromResults(results)
terminationReason = getTerminationReason(state.Terminated.Reason, terminationFromResults, exitCode)
}
}
stepState := v1.StepState{
ContainerState: *state,
Name: TrimStepPrefix(s.Name),
Container: s.Name,
ImageID: s.ImageID,
Results: taskRunStepResults,
TerminationReason: terminationReason,
Inputs: sas.Inputs,
Outputs: sas.Outputs,
}
foundStep := false
for i, ss := range trs.Steps {
if ss.Name == stepState.Name {
stepState.Provenance = ss.Provenance
trs.Steps[i] = stepState
foundStep = true
break
}
}
if !foundStep {
trs.Steps = append(trs.Steps, stepState)
}
}
return merr
}
func setStepArtifactsValueFromSidecarLogResult(results []result.RunResult, name string, artifacts *v1.Artifacts) error {
for _, r := range results {
if r.Key == name && r.ResultType == result.StepArtifactsResultType {
return json.Unmarshal([]byte(r.Value), artifacts)
}
}
return nil
}
func setStepArtifactsValueFromTerminationMessageRunResult(results []result.RunResult, artifacts *v1.Artifacts) error {
for _, r := range results {
if r.ResultType == result.StepArtifactsResultType {
return json.Unmarshal([]byte(r.Value), artifacts)
}
}
return nil
}
func setTaskRunStatusBasedOnSidecarStatus(sidecarStatuses []corev1.ContainerStatus, trs *v1.TaskRunStatus) {
for _, s := range sidecarStatuses {
trs.Sidecars = append(trs.Sidecars, v1.SidecarState{
ContainerState: *s.State.DeepCopy(),
Name: TrimSidecarPrefix(s.Name),
Container: s.Name,
ImageID: s.ImageID,
})
}
}
func createMessageFromResults(results []result.RunResult) (string, error) {
if len(results) == 0 {
return "", nil
}
bytes, err := json.Marshal(results)
if err != nil {
return "", fmt.Errorf("error marshalling remaining results back into termination message: %w", err)
}
return string(bytes), nil
}
// findStepResultsFetchedByTask fetches step results that the Task needs.
// It accepts a container name and the TaskResults as input and outputs
// a map with the name of the step result as the key and the name of the task result that is fetching it as value.
func findStepResultsFetchedByTask(containerName string, specResults []v1.TaskResult) (map[string]string, error) {
neededStepResults := map[string]string{}
for _, r := range specResults {
if r.Value != nil {
if r.Value.StringVal != "" {
sName, resultName, err := v1.ExtractStepResultName(r.Value.StringVal)
if err != nil {
return nil, err
}
// Only look at named results - referencing unnamed steps is unsupported.
if GetContainerName(sName) == containerName {
neededStepResults[resultName] = r.Name
}
}
}
}
return neededStepResults, nil
}
// filterResults filters the RunResults and TaskResults based on the results declared in the task spec.
// It returns a slice of any of the input results that are defined in the task spec, converted to TaskRunResults,
// and a slice of any of the RunResults that don't represent internal values (i.e. those that should not be displayed in the TaskRun status.
func filterResults(results []result.RunResult, specResults []v1.TaskResult, stepResults []v1.StepResult) ([]v1.TaskRunResult, []v1.TaskRunStepResult, []result.RunResult) {
var taskResults []v1.TaskRunResult
var taskRunStepResults []v1.TaskRunStepResult
var filteredResults []result.RunResult
neededTypes := make(map[string]v1.ResultsType)
neededStepTypes := make(map[string]v1.ResultsType)
for _, r := range specResults {
neededTypes[r.Name] = r.Type
}
for _, r := range stepResults {
neededStepTypes[r.Name] = r.Type
}
for _, r := range results {
switch r.ResultType {
case result.TaskRunResultType:
var taskRunResult v1.TaskRunResult
if neededTypes[r.Key] == v1.ResultsTypeString {
taskRunResult = v1.TaskRunResult{
Name: r.Key,
Type: v1.ResultsTypeString,
Value: *v1.NewStructuredValues(r.Value),
}
} else {
v := v1.ResultValue{}
err := v.UnmarshalJSON([]byte(r.Value))
if err != nil {
continue
}
taskRunResult = v1.TaskRunResult{
Name: r.Key,
Type: v1.ResultsType(v.Type),
Value: v,
}
}
taskResults = append(taskResults, taskRunResult)
filteredResults = append(filteredResults, r)
case result.StepResultType:
var taskRunStepResult v1.TaskRunStepResult
if neededStepTypes[r.Key] == v1.ResultsTypeString {
taskRunStepResult = v1.TaskRunStepResult{
Name: r.Key,
Type: v1.ResultsTypeString,
Value: *v1.NewStructuredValues(r.Value),
}
} else {
v := v1.ResultValue{}
err := v.UnmarshalJSON([]byte(r.Value))
if err != nil {
continue
}
taskRunStepResult = v1.TaskRunStepResult{
Name: r.Key,
Type: v1.ResultsType(v.Type),
Value: v,
}
}
taskRunStepResults = append(taskRunStepResults, taskRunStepResult)
filteredResults = append(filteredResults, r)
case result.StepArtifactsResultType:
filteredResults = append(filteredResults, r)
continue
case result.TaskRunArtifactsResultType:
filteredResults = append(filteredResults, r)
continue
case result.InternalTektonResultType:
// Internal messages are ignored because they're not used as external result
continue
default:
filteredResults = append(filteredResults, r)
}
}
return taskResults, taskRunStepResults, filteredResults
}
func removeDuplicateResults(taskRunResult []v1.TaskRunResult) []v1.TaskRunResult {
if len(taskRunResult) == 0 {
return nil
}
uniq := make([]v1.TaskRunResult, 0)
latest := make(map[string]v1.TaskRunResult, 0)
for _, res := range taskRunResult {
if _, seen := latest[res.Name]; !seen {
uniq = append(uniq, res)
}
latest[res.Name] = res
}
for i, res := range uniq {
uniq[i] = latest[res.Name]
}
return uniq
}
func extractStartedAtTimeFromResults(results []result.RunResult) (*metav1.Time, error) {
for _, result := range results {
if result.Key == "StartedAt" {
t, err := time.Parse(timeFormat, result.Value)
if err != nil {
return nil, fmt.Errorf("could not parse time value %q in StartedAt field: %w", result.Value, err)
}
startedAt := metav1.NewTime(t)
return &startedAt, nil
}
}
return nil, nil //nolint:nilnil // would be more ergonomic to return a sentinel error
}
func extractExitCodeFromResults(results []result.RunResult) (*int32, error) {
for _, result := range results {
if result.Key == "ExitCode" {
// We could just pass the string through but this provides extra validation
i, err := strconv.ParseInt(result.Value, 10, 32)
if err != nil {
return nil, fmt.Errorf("could not parse int value %q in ExitCode field: %w", result.Value, err)
}
exitCode := int32(i) // #nosec G115: ParseInt was called with bit size 32, so this is safe
return &exitCode, nil
}
}
return nil, nil //nolint:nilnil // would be more ergonomic to return a sentinel error
}
func extractTerminationReasonFromResults(results []result.RunResult) string {
for _, r := range results {
if r.ResultType == result.InternalTektonResultType && r.Key == "Reason" {
return r.Value
}
}
return ""
}
func getTerminationReason(terminatedStateReason string, terminationFromResults string, exitCodeFromResults *int32) string {
if terminationFromResults != "" {
return terminationFromResults
}
if exitCodeFromResults != nil {
return TerminationReasonContinued
}
return terminatedStateReason
}
func updateCompletedTaskRunStatus(logger *zap.SugaredLogger, trs *v1.TaskRunStatus, pod *corev1.Pod, onError v1.PipelineTaskOnErrorType) {
if DidTaskRunFail(pod) {
msg := getFailureMessage(logger, pod)
if onError == v1.PipelineTaskContinue {
markStatusFailure(trs, v1.TaskRunReasonFailureIgnored.String(), msg)
} else {
markStatusFailure(trs, v1.TaskRunReasonFailed.String(), msg)
}
} else {
markStatusSuccess(trs)
}
// update tr completed time
trs.CompletionTime = &metav1.Time{Time: time.Now()}
}
func updateIncompleteTaskRunStatus(trs *v1.TaskRunStatus, pod *corev1.Pod) {
switch pod.Status.Phase {
case corev1.PodRunning:
markStatusRunning(trs, v1.TaskRunReasonRunning.String(), "Not all Steps in the Task have finished executing")
case corev1.PodPending:
switch {
case IsPodExceedingNodeResources(pod):
markStatusRunning(trs, ReasonExceededNodeResources, "TaskRun Pod exceeded available resources")
case isPodHitConfigError(pod):
markStatusFailure(trs, ReasonCreateContainerConfigError, "Failed to create pod due to config error")
case isPullImageError(pod):
markStatusRunning(trs, ReasonPullImageFailed, getWaitingMessage(pod))
default:
markStatusRunning(trs, ReasonPodPending, getWaitingMessage(pod))
}
case corev1.PodSucceeded, corev1.PodFailed, corev1.PodUnknown:
// Do nothing; pod has completed or is in an unknown state.
}
}
// isPodCompleted checks if the given pod is completed.
// A pod is considered completed if its phase is either "Succeeded" or "Failed".
//
// If it is foreseeable that the pod will eventually be in a failed state,
// but it remains in a Running status for a visible period of time, it should be considered completed in advance.
//
// For example, when certain steps encounter OOM, only the pods that have timed out will change to a failed state,
// we should consider them completed in advance.
func isPodCompleted(pod *corev1.Pod) bool {
if pod.Status.Phase == corev1.PodSucceeded || pod.Status.Phase == corev1.PodFailed {
return true
}
for _, s := range pod.Status.ContainerStatuses {
if IsContainerStep(s.Name) {
if s.State.Terminated != nil {
if isOOMKilled(s) {
return true
}
}
}
}
return false
}
// DidTaskRunFail check the status of pod to decide if related taskrun is failed
func DidTaskRunFail(pod *corev1.Pod) bool {
if pod.Status.Phase == corev1.PodFailed {
return true
}
for _, s := range pod.Status.ContainerStatuses {
if IsContainerStep(s.Name) {
if s.State.Terminated != nil {
if s.State.Terminated.ExitCode != 0 || isOOMKilled(s) {
return true
}
}
}
}
return false
}
// IsPodArchived indicates if a pod is archived in the retriesStatus.
func IsPodArchived(pod *corev1.Pod, trs *v1.TaskRunStatus) bool {
for _, retryStatus := range trs.RetriesStatus {
if retryStatus.PodName == pod.GetName() {
return true
}
}
return false
}
// containerNameFilter is a function that filters container names.
type containerNameFilter func(name string) bool
// isMatchingAnyFilter returns true if the container name matches any of the filters.
func isMatchingAnyFilter(name string, filters []containerNameFilter) bool {
for _, filter := range filters {
if filter(name) {
return true
}
}
return false
}
// areContainersCompleted returns true if all related containers in the pod are completed.
func areContainersCompleted(ctx context.Context, pod *corev1.Pod) bool {
nameFilters := []containerNameFilter{IsContainerStep}
if config.FromContextOrDefaults(ctx).FeatureFlags.ResultExtractionMethod == config.ResultExtractionMethodSidecarLogs {
// If we are using sidecar logs to extract results, we need to wait for the sidecar to complete.
// Avoid failing to obtain the final result from the sidecar because the sidecar is not yet complete.
nameFilters = append(nameFilters, func(name string) bool {
return name == pipeline.ReservedResultsSidecarContainerName
})
}
return checkContainersCompleted(pod, nameFilters)
}
// checkContainersCompleted returns true if containers in the pod are completed.
func checkContainersCompleted(pod *corev1.Pod, nameFilters []containerNameFilter) bool {
if len(pod.Status.ContainerStatuses) == 0 ||
!(pod.Status.Phase == corev1.PodRunning || pod.Status.Phase == corev1.PodSucceeded) {
return false
}
for _, containerStatus := range pod.Status.ContainerStatuses {
if isMatchingAnyFilter(containerStatus.Name, nameFilters) && containerStatus.State.Terminated == nil {
// if any container is not completed, return false
return false
}
}
return true
}
func getFailureMessage(logger *zap.SugaredLogger, pod *corev1.Pod) string {
// If a pod was evicted, use the pods status message before trying to
// determine a failure message from the pod's container statuses. A
// container may have a generic exit code that contains less information,
// such as an exit code and message related to not being located.
if pod.Status.Reason == evicted {
return pod.Status.Message
}
// First, try to surface an error about the actual init container that failed.
for _, status := range pod.Status.InitContainerStatuses {
if msg := extractContainerFailureMessage(logger, status, pod.ObjectMeta); len(msg) > 0 {
return "init container failed, " + msg
}
}
// Next, try to surface an error about the actual build step that failed.
for _, status := range pod.Status.ContainerStatuses {
if msg := extractContainerFailureMessage(logger, status, pod.ObjectMeta); len(msg) > 0 {
return msg
}
}
// Next, return the Pod's status message if it has one.
if pod.Status.Message != "" {
return pod.Status.Message
}
for _, s := range pod.Status.ContainerStatuses {
if IsContainerStep(s.Name) {
if s.State.Terminated != nil {
if isOOMKilled(s) {
return oomKilled
}
}
}
}
// Lastly fall back on a generic error message.
return "build failed for unspecified reasons."
}
// extractContainerFailureMessage returns the container failure message by container status or init container status.
func extractContainerFailureMessage(logger *zap.SugaredLogger, status corev1.ContainerStatus, podMetaData metav1.ObjectMeta) string {
term := status.State.Terminated
if term != nil {
msg := status.State.Terminated.Message
r, _ := termination.ParseMessage(logger, msg)
for _, runResult := range r {
if runResult.ResultType == result.InternalTektonResultType && runResult.Key == "Reason" && runResult.Value == TerminationReasonTimeoutExceeded {
return fmt.Sprintf("%q exited because the step exceeded the specified timeout limit", status.Name)
}
}
if term.ExitCode != 0 {
return fmt.Sprintf("%q exited with code %d", status.Name, term.ExitCode)
}
}
return ""
}
// IsPodExceedingNodeResources returns true if the Pod's status indicates there
// are insufficient resources to schedule the Pod.
func IsPodExceedingNodeResources(pod *corev1.Pod) bool {
for _, podStatus := range pod.Status.Conditions {
if podStatus.Reason == corev1.PodReasonUnschedulable && strings.Contains(podStatus.Message, "Insufficient") {
return true
}
}
return false
}
// isPodHitConfigError returns true if the Pod's status undicates there are config error raised
func isPodHitConfigError(pod *corev1.Pod) bool {
for _, containerStatus := range pod.Status.ContainerStatuses {
if containerStatus.State.Waiting != nil && containerStatus.State.Waiting.Reason == ReasonCreateContainerConfigError {
return true
}
}
return false
}
// isPullImageError returns true if the Pod's status indicates there are any error when pulling image
func isPullImageError(pod *corev1.Pod) bool {
for _, containerStatus := range pod.Status.ContainerStatuses {
if containerStatus.State.Waiting != nil && isImageErrorReason(containerStatus.State.Waiting.Reason) {
return true
}
}
return false
}
func isImageErrorReason(reason string) bool {
// Reference from https://github.com/kubernetes/kubernetes/blob/a1c8e9386af844757333733714fa1757489735b3/pkg/kubelet/images/types.go#L26
imageErrorReasons := []string{
"ImagePullBackOff",
"ImageInspectError",
"ErrImagePull",
"ErrImageNeverPull",
"RegistryUnavailable",
"InvalidImageName",
}
for _, imageReason := range imageErrorReasons {
if imageReason == reason {
return true
}
}
return false
}
func getWaitingMessage(pod *corev1.Pod) string {
// First, try to surface reason for pending/unknown about the actual build step.
for _, status := range pod.Status.ContainerStatuses {
wait := status.State.Waiting
if wait != nil && wait.Message != "" {
return fmt.Sprintf("build step %q is pending with reason %q",
status.Name, wait.Message)
}
}
// Try to surface underlying reason by inspecting pod's recent status if condition is not true
for i, podStatus := range pod.Status.Conditions {
if podStatus.Status != corev1.ConditionTrue {
return fmt.Sprintf("pod status %q:%q; message: %q",
pod.Status.Conditions[i].Type,
pod.Status.Conditions[i].Status,
pod.Status.Conditions[i].Message)
}
}
// Next, return the Pod's status message if it has one.
if pod.Status.Message != "" {
return pod.Status.Message
}
// Lastly fall back on a generic pending message.
return "Pending"
}
// markStatusRunning sets taskrun status to running
func markStatusRunning(trs *v1.TaskRunStatus, reason, message string) {
trs.SetCondition(&apis.Condition{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionUnknown,
Reason: reason,
Message: message,
})
}
// markStatusFailure sets taskrun status to failure with specified reason
func markStatusFailure(trs *v1.TaskRunStatus, reason string, message string) {
trs.SetCondition(&apis.Condition{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionFalse,
Reason: reason,
Message: message,
})
}
// markStatusSuccess sets taskrun status to success
func markStatusSuccess(trs *v1.TaskRunStatus) {
trs.SetCondition(&apis.Condition{
Type: apis.ConditionSucceeded,
Status: corev1.ConditionTrue,
Reason: v1.TaskRunReasonSuccessful.String(),
Message: "All Steps have completed executing",
})
}
// sortPodContainerStatuses reorders a pod's container statuses so that
// they're in the same order as the step containers from the TaskSpec.
func sortPodContainerStatuses(podContainerStatuses []corev1.ContainerStatus, podSpecContainers []corev1.Container) {
statuses := map[string]corev1.ContainerStatus{}
for _, status := range podContainerStatuses {
statuses[status.Name] = status
}
for i, c := range podSpecContainers {
// prevent out-of-bounds panic on incorrectly formed lists
if i < len(podContainerStatuses) {
podContainerStatuses[i] = statuses[c.Name]
}
}
}
func isOOMKilled(s corev1.ContainerStatus) bool {
return s.State.Terminated.Reason == oomKilled
}