-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Surface error results from TaskRun to BuildRun
According to ship 0024, this commit adds a mechanism to surface errors from TaskRun steps. The errors are published under `status.failure` in BuildRun iff underlying TaskRun has failed. Adds `pkg/reconciler/buildrun/resources/failures.go`, `pkg/reconciler/buildrun/resources/failures_test.go` that contains logic for extracting error reason and message. Modifies `pkg/reconciler/buildrun/resources/taskrun.go` by adding two new generic results for errors. Adds error location in error results This commit extracts the login in `conditions.go` that searches for the failed pod and its container. It merges the information of the error location (pod and container) into the error results. Fix tests Added docs for failure details
- Loading branch information
Showing
11 changed files
with
354 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| # Temporary Build Files | ||
| .DS_Store | ||
| git | ||
| shipwright-build-controller | ||
| build/_output | ||
| build/_test | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| // Copyright The Shipwright Contributors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package resources | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1" | ||
| v1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "knative.dev/pkg/apis" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| buildv1alpha1 "github.com/shipwright-io/build/pkg/apis/build/v1alpha1" | ||
| ) | ||
|
|
||
| const ( | ||
| resultErrorMessage = "error-message" | ||
| resultErrorReason = "error-reason" | ||
| prefixedResultErrorReason = prefixParamsResultsVolumes + "-" + resultErrorReason | ||
| prefixedResultErrorMessage = prefixParamsResultsVolumes + "-" + resultErrorMessage | ||
| ) | ||
|
|
||
| // UpdateBuildRunUsingTaskFailures is extracting failures from taskRun steps and adding them to buildRun (mutates) | ||
| func UpdateBuildRunUsingTaskFailures(ctx context.Context, client client.Client, buildRun *buildv1alpha1.BuildRun, taskRun *v1beta1.TaskRun) { | ||
| trCondition := taskRun.Status.GetCondition(apis.ConditionSucceeded) | ||
|
|
||
| // only extract failures when failing condition is present | ||
| if trCondition != nil && v1beta1.TaskRunReason(trCondition.Reason) == v1beta1.TaskRunReasonFailed { | ||
| buildRun.Status.FailureDetails = extractFailureDetails(ctx, client, taskRun) | ||
| } | ||
| } | ||
|
|
||
| func extractFailureReasonAndMessage(taskRun *v1beta1.TaskRun) (errorReason string, errorMessage string, hasReasonAndMessage bool) { | ||
| for _, step := range taskRun.Status.Steps { | ||
| message := step.Terminated.Message | ||
| var taskRunResults []v1beta1.PipelineResourceResult | ||
|
|
||
| if err := json.Unmarshal([]byte(message), &taskRunResults); err != nil { | ||
| continue | ||
| } | ||
|
|
||
| for _, result := range taskRunResults { | ||
| if result.Key == prefixedResultErrorMessage { | ||
| errorMessage = result.Value | ||
| } | ||
|
|
||
| if result.Key == prefixedResultErrorReason { | ||
| errorReason = result.Value | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return errorReason, errorMessage, true | ||
| } | ||
|
|
||
| func extractFailedPodAndContainer(ctx context.Context, client client.Client, taskRun *v1beta1.TaskRun) (*v1.Pod, *v1.Container, error) { | ||
| var pod v1.Pod | ||
| if err := client.Get(ctx, types.NamespacedName{Namespace: taskRun.Namespace, Name: taskRun.Status.PodName}, &pod); err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| failures := make(map[string]struct{}) | ||
| // Find the names of all containers with failure status | ||
| for _, containerStatus := range pod.Status.ContainerStatuses { | ||
| if containerStatus.State.Terminated != nil && containerStatus.State.Terminated.ExitCode != 0 { | ||
| failures[containerStatus.Name] = struct{}{} | ||
| } | ||
| } | ||
|
|
||
| // Find the first container that has a failure status | ||
| var failedContainer *v1.Container | ||
| for i, container := range pod.Spec.Containers { | ||
| if _, has := failures[container.Name]; has { | ||
| failedContainer = &pod.Spec.Containers[i] | ||
| break | ||
| } | ||
| } | ||
|
|
||
| return &pod, failedContainer, nil | ||
| } | ||
|
|
||
| func extractFailureDetails(ctx context.Context, client client.Client, taskRun *v1beta1.TaskRun) (failure *buildv1alpha1.FailureDetails) { | ||
| failure = &buildv1alpha1.FailureDetails{} | ||
| failure.Location = &buildv1alpha1.FailedAt{Pod: taskRun.Status.PodName} | ||
|
|
||
| if reason, message, hasReasonAndMessage := extractFailureReasonAndMessage(taskRun); hasReasonAndMessage { | ||
| failure.Reason = reason | ||
| failure.Message = message | ||
| } | ||
|
|
||
| pod, container, _ := extractFailedPodAndContainer(ctx, client, taskRun) | ||
|
|
||
| if pod != nil && container != nil { | ||
| failure.Location.Pod = pod.Name | ||
| failure.Location.Container = container.Name | ||
| } | ||
|
|
||
| return failure | ||
| } | ||
|
|
||
| func getFailureDetailsTaskSpecResults() []v1beta1.TaskResult { | ||
| return []v1beta1.TaskResult{ | ||
| { | ||
| Name: fmt.Sprintf("%s-%s", prefixParamsResultsVolumes, resultErrorMessage), | ||
| Description: "The error description of the task run", | ||
| }, | ||
| { | ||
| Name: fmt.Sprintf("%s-%s", prefixParamsResultsVolumes, resultErrorReason), | ||
| Description: "The error reason of the task run", | ||
| }, | ||
| } | ||
| } |
Oops, something went wrong.