Fail taskrun when results validation fails #5198

Yongxuanzhang · 2022-07-22T15:55:16Z

Changes

This commit adds the ReasonFailedValidation into taskrun status and fail
the taskrun when results validation fails. Before this commit users can
only see error messages in logs but the taskrun are completed like no
errors happen.

/kind bug

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Has Docs included if any changes are user facing
Has Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including
functionality, content, code)
Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

tekton-robot · 2022-07-22T15:55:17Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

Yongxuanzhang · 2022-07-22T15:58:14Z

@ywluogg

tekton-robot · 2022-07-22T16:02:16Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/reconciler/taskrun/taskrun.go	80.3%	80.6%	0.3

ywluogg

/lgtm

pkg/reconciler/taskrun/taskrun_test.go

lbernick · 2022-07-25T13:19:17Z

pkg/reconciler/taskrun/taskrun_test.go

+		name:             "taskrun results type mismatched",
+		taskRun:          taskRunResultsTypeMismatched,
+		wantFailedReason: podconvert.ReasonFailedValidation,
+		expectedError:    fmt.Errorf("1 error occurred:\n\t* missmatched Types for these results, map[aResult:[array]]\n\n"),


This is a confusing error message because it's not clear which result (taskrun result or result declared in task spec) is an array and which is not, and what the type of the result that is not an array is. Can it be improved?

The current code logic will only collect the wrong results/params names and log them, and same for other parts. You're 100% correct that this can be improved! I will think about it and maybe address it in a new PR? If that is ok I will open an issue to track

pipeline/pkg/reconciler/pipelinerun/resources/validate_params.go

Lines 82 to 90 in 8a7b0cf

// ValidateObjectParamRequiredKeys validates that the required keys of all the object parameters expected by the Pipeline are provided by the PipelineRun.

func ValidateObjectParamRequiredKeys(pipelineParameters []v1beta1.ParamSpec, pipelineRunParameters []v1beta1.Param) error {

missings := taskrun.MissingKeysObjectParamNames(pipelineParameters, pipelineRunParameters)

if len(missings) != 0 {

return fmt.Errorf("PipelineRun missing object keys for parameters: %v", missings)

}

return nil

}

Sure, you can definitely change in a separate PR-- it's a small enough change I'll leave it up to you whether to create an issue or just open a follow-up PR

lbernick · 2022-07-25T13:20:41Z

pkg/reconciler/taskrun/taskrun_test.go

+			},
+		}},
+	}
+	for _, tc := range []struct {


could you add a test case for success if there isn't one already in taskrun_test.go?

sure! just added one test for success

It looks like you might have accidentally just copied the failure test case?

oh yes, sorry about that. >_< I only updated the yaml name. Should be correct now!

tekton-robot · 2022-07-26T14:58:21Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/reconciler/taskrun/taskrun.go	80.3%	80.6%	0.3

tekton-robot · 2022-07-26T15:17:38Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/reconciler/taskrun/taskrun.go	80.3%	80.6%	0.3

Yongxuanzhang · 2022-07-26T15:29:09Z

/retest

Yongxuanzhang · 2022-07-26T15:47:34Z

/retest

Yongxuanzhang · 2022-07-26T16:28:50Z

/test

tekton-robot · 2022-07-26T16:28:52Z

@Yongxuanzhang: The /test command needs one or more targets.
The following commands are available to trigger required jobs:

/test pull-tekton-pipeline-alpha-integration-tests
/test pull-tekton-pipeline-build-tests
/test pull-tekton-pipeline-integration-tests
/test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

/test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Yongxuanzhang · 2022-07-26T16:32:31Z

/test

tekton-robot · 2022-07-26T16:32:33Z

@Yongxuanzhang: The /test command needs one or more targets.
The following commands are available to trigger required jobs:

/test pull-tekton-pipeline-alpha-integration-tests
/test pull-tekton-pipeline-build-tests
/test pull-tekton-pipeline-integration-tests
/test tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

/test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Yongxuanzhang · 2022-07-26T16:45:31Z

/retest

lbernick · 2022-07-27T15:26:07Z

pkg/reconciler/taskrun/taskrun_test.go

+		name:    "taskrun results type mismatched",
+		taskRun: taskRunResultsTypeMismatched,
+	}, {
+		name:    "taskrun results object miss key",
+		taskRun: taskRunResultsObjectMissKey,


could you please rename these test cases and variables so it's clear what's being tested?

This commit adds the ReasonFailedValidation into taskrun status and fail the taskrun when results validation fails. Before this commit users can only see error messages in logs but the taskrun are completed like no errors happen.

tekton-robot · 2022-07-27T18:35:57Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/reconciler/taskrun/taskrun.go	80.3%	80.6%	0.3

Yongxuanzhang · 2022-07-27T19:58:18Z

/retest

tekton-robot · 2022-07-27T20:02:30Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [lbernick]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ywluogg · 2022-07-27T23:14:41Z

/lgtm

tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/bug Categorizes issue or PR as related to a bug. labels Jul 22, 2022

tekton-robot requested review from jerop and vdemeester July 22, 2022 15:55

tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 22, 2022

Yongxuanzhang force-pushed the add-validation-fail branch from 5ba9896 to 2dec008 Compare July 22, 2022 15:57

Yongxuanzhang marked this pull request as ready for review July 22, 2022 15:58

tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 22, 2022

tekton-robot requested review from imjasonh and pritidesai July 22, 2022 15:58

ywluogg reviewed Jul 22, 2022

View reviewed changes

tekton-robot assigned ywluogg Jul 22, 2022

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 22, 2022

lbernick reviewed Jul 25, 2022

View reviewed changes

Yongxuanzhang force-pushed the add-validation-fail branch from 2dec008 to 0994c48 Compare July 26, 2022 14:51

tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 26, 2022

Yongxuanzhang force-pushed the add-validation-fail branch from 0994c48 to 7712256 Compare July 26, 2022 15:07

Yongxuanzhang requested a review from lbernick July 26, 2022 20:26

lbernick reviewed Jul 27, 2022

View reviewed changes

Fail taskrun when results validation fails

bfeec8f

This commit adds the ReasonFailedValidation into taskrun status and fail the taskrun when results validation fails. Before this commit users can only see error messages in logs but the taskrun are completed like no errors happen.

Yongxuanzhang force-pushed the add-validation-fail branch from 7712256 to bfeec8f Compare July 27, 2022 18:31

Yongxuanzhang requested a review from lbernick July 27, 2022 18:55

lbernick approved these changes Jul 27, 2022

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 27, 2022

Yongxuanzhang requested a review from ywluogg July 27, 2022 20:15

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 27, 2022

tekton-robot merged commit c1d4702 into tektoncd:main Jul 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fail taskrun when results validation fails #5198

Fail taskrun when results validation fails #5198

Yongxuanzhang commented Jul 22, 2022 •

edited

Loading

tekton-robot commented Jul 22, 2022

Yongxuanzhang commented Jul 22, 2022 •

edited

Loading

tekton-robot commented Jul 22, 2022

ywluogg left a comment

lbernick Jul 25, 2022

Yongxuanzhang Jul 26, 2022

lbernick Jul 26, 2022

lbernick Jul 25, 2022

Yongxuanzhang Jul 26, 2022

lbernick Jul 26, 2022

Yongxuanzhang Jul 27, 2022

tekton-robot commented Jul 26, 2022

tekton-robot commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

tekton-robot commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

tekton-robot commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

lbernick Jul 27, 2022

Yongxuanzhang Jul 27, 2022

tekton-robot commented Jul 27, 2022

Yongxuanzhang commented Jul 27, 2022

tekton-robot commented Jul 27, 2022

ywluogg commented Jul 27, 2022

	// ValidateObjectParamRequiredKeys validates that the required keys of all the object parameters expected by the Pipeline are provided by the PipelineRun.
	func ValidateObjectParamRequiredKeys(pipelineParameters []v1beta1.ParamSpec, pipelineRunParameters []v1beta1.Param) error {
	missings := taskrun.MissingKeysObjectParamNames(pipelineParameters, pipelineRunParameters)
	if len(missings) != 0 {
	return fmt.Errorf("PipelineRun missing object keys for parameters: %v", missings)
	}

	return nil
	}

Fail taskrun when results validation fails #5198

Fail taskrun when results validation fails #5198

Conversation

Yongxuanzhang commented Jul 22, 2022 • edited Loading

Changes

Submitter Checklist

Release Notes

tekton-robot commented Jul 22, 2022

Yongxuanzhang commented Jul 22, 2022 • edited Loading

tekton-robot commented Jul 22, 2022

ywluogg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tekton-robot commented Jul 26, 2022

tekton-robot commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

tekton-robot commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

tekton-robot commented Jul 26, 2022

Yongxuanzhang commented Jul 26, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tekton-robot commented Jul 27, 2022

Yongxuanzhang commented Jul 27, 2022

tekton-robot commented Jul 27, 2022

ywluogg commented Jul 27, 2022

Yongxuanzhang commented Jul 22, 2022 •

edited

Loading

Yongxuanzhang commented Jul 22, 2022 •

edited

Loading