[TEP-0144] Add enum API field #7289

QuanZhang-William · 2023-10-26T18:39:56Z

Changes

Part of #7270. In TEP-0144 we proposed a new enum field to support built-in param input validation.

This commit adds the Enum api field, validation and conversion logic.

/kind feature

Submitter Checklist

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

Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
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). See some examples of good release notes.
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

[WIP] Add `Enum` API field

tekton-robot · 2023-10-26T18:39:59Z

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

QuanZhang-William · 2023-10-26T18:40:12Z

/test all

QuanZhang-William · 2023-10-26T18:41:21Z

/hold until #7279 is merged.

QuanZhang-William · 2023-10-26T18:48:45Z

/test all

tekton-robot · 2023-10-26T18:55:25Z

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/apis/config/feature_flags.go	94.1%	94.2%	0.1
pkg/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	97.3%	97.3%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	97.3%	97.3%	0.0

tekton-robot · 2023-10-26T18:56:00Z

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

File	Old Coverage	New Coverage	Delta
pkg/apis/config/feature_flags.go	94.1%	94.2%	0.1
pkg/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	97.3%	97.3%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	97.3%	97.3%	0.0

QuanZhang-William · 2023-10-26T19:34:53Z

/test pull-tekton-pipeline-build-tests

tekton-robot · 2023-10-26T19:44:22Z

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

File	Old Coverage	New Coverage	Delta
pkg/apis/config/feature_flags.go	94.1%	94.2%	0.1
pkg/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	97.3%	97.3%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	97.3%	97.3%	0.0

tekton-robot · 2023-10-26T19:44:46Z

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

File	Old Coverage	New Coverage	Delta
pkg/apis/config/feature_flags.go	94.1%	94.2%	0.1
pkg/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	97.3%	97.3%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	97.3%	97.3%	0.0

tekton-robot · 2023-10-27T20:46:32Z

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

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	98.1%	98.2%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	98.2%	98.2%	0.0

QuanZhang-William · 2023-10-27T20:59:43Z

/hold cancel
#7279 is merged.

tekton-robot · 2023-10-30T14:18:52Z

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

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	98.1%	98.2%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	98.2%	98.2%	0.0

Yongxuanzhang · 2023-10-30T15:52:04Z

/assign

pkg/apis/pipeline/v1/pipeline_validation.go

chitrangpatel · 2023-10-31T15:12:56Z

pkg/apis/pipeline/v1/param_types.go

+			continue
+		}
+		if !config.FromContextOrDefaults(ctx).FeatureFlags.EnableParamEnum {
+			errs = errs.Also(errs, apis.ErrGeneric(fmt.Sprintf("feature flag `%s` should be set to true to use Enum", config.EnableParamEnum), "").ViaFieldKey("params", p.Name))


Instead of adding ViaFieldKey("params", ...) for every check here, why not just do

ViaFieldKey(p.Name) and where you call validateParamEnums call
errs = errs.Also(params.validateParamEnums(ctx).ViaField("params"))?

chitrangpatel · 2023-10-31T15:13:32Z

pkg/apis/pipeline/v1/pipeline_validation.go

 func ValidatePipelineParameterVariables(ctx context.Context, tasks []PipelineTask, params ParamSpecs) (errs *apis.FieldError) {
 	// validates all the types within a slice of ParamSpecs
 	errs = errs.Also(ValidateParameterTypes(ctx, params).ViaField("params"))
 	errs = errs.Also(params.validateNoDuplicateNames())
+	errs = errs.Also(params.validateParamEnums(ctx))


errs = errs.Also(params.validateParamEnums(ctx).ViaField("params"))? And in the checks there, call ViaFieldKey(p.Name)

Thanks! Updated (and for all comments below), PTAL!

chitrangpatel · 2023-10-31T15:15:07Z

pkg/apis/pipeline/v1/task_validation.go

@@ -435,6 +435,7 @@ func (p ParamSpec) ValidateObjectType(ctx context.Context) *apis.FieldError {
 func ValidateParameterVariables(ctx context.Context, steps []Step, params ParamSpecs) *apis.FieldError {
 	var errs *apis.FieldError
 	errs = errs.Also(params.validateNoDuplicateNames())
+	errs = errs.Also(params.validateParamEnums(ctx))


same comment as above related to ViaField.

chitrangpatel · 2023-10-31T15:15:52Z

pkg/apis/pipeline/v1beta1/param_types.go

+		}
+		if !config.FromContextOrDefaults(ctx).FeatureFlags.EnableParamEnum {
+			errs = errs.Also(errs, apis.ErrGeneric(fmt.Sprintf("feature flag `%s` should be set to true to use Enum", config.EnableParamEnum), "").ViaFieldKey("params", p.Name))
+		}


Same comment related to ViaFieldKey

chitrangpatel · 2023-10-31T15:16:10Z

pkg/apis/pipeline/v1beta1/pipeline_validation.go

 func ValidatePipelineParameterVariables(ctx context.Context, tasks []PipelineTask, params ParamSpecs) (errs *apis.FieldError) {
 	// validates all the types within a slice of ParamSpecs
 	errs = errs.Also(ValidateParameterTypes(ctx, params).ViaField("params"))
 	errs = errs.Also(params.validateNoDuplicateNames())
+	errs = errs.Also(params.validateParamEnums(ctx))


Same comment related to ViaField

chitrangpatel · 2023-10-31T15:16:35Z

pkg/apis/pipeline/v1beta1/task_validation.go

@@ -441,6 +441,7 @@ func (p ParamSpec) ValidateObjectType(ctx context.Context) *apis.FieldError {
 func ValidateParameterVariables(ctx context.Context, steps []Step, params ParamSpecs) *apis.FieldError {
 	var errs *apis.FieldError
 	errs = errs.Also(params.validateNoDuplicateNames())
+	errs = errs.Also(params.validateParamEnums(ctx))


Same comment related to ViaField

chitrangpatel

Left some comments. Otherwise lgtm!

tekton-robot · 2023-11-01T14:21:35Z

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/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	98.1%	98.2%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	98.2%	98.2%	0.0

tekton-robot · 2023-11-01T14:22:41Z

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

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	98.1%	98.2%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	98.2%	98.2%	0.0

QuanZhang-William · 2023-11-01T14:28:02Z

/assign

Thanks @Yongxuanzhang! Could you please take a look when you get a chance 🙏 ?

Yongxuanzhang

looks the test cases are duplicate in pipeline and task, could be a followup cleanup to merge the tests? I'm not sure 😄

Yongxuanzhang · 2023-11-01T21:03:23Z

pkg/apis/pipeline/v1/task_validation_test.go

@@ -2254,3 +2254,86 @@ func TestGetArrayIndexParamRefs(t *testing.T) {
 		})
 	}
 }
+
+func TestParamEnum(t *testing.T) {


better separate this to success and failure like tests in pipeline validation

I've splitted the tests, PTAL!

tekton-robot · 2023-11-01T21:04:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Yongxuanzhang

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~~ [Yongxuanzhang]

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

QuanZhang-William · 2023-11-01T21:17:12Z

looks the test cases are duplicate in pipeline and task, could be a followup cleanup to merge the tests? I'm not sure 😄

Yeah I see the confusion. I think it "looks like a duplicate" is because pipeline_validaiton.go and task_validation.go have their own exported ValidatePipelineParameterVariables() function (and they look similar, but they are testing different things). And accordingly to our policy, I think I do need to cover changes in both exported functions.

Part of [tektoncd#7270][tektoncd#7270]. In [TEP-0144][tep-0144] we proposed a new `enum` field to support built-in param input validation. This commit adds the `Enum` api field, validation and conversion logic. /kind feature [tektoncd#7270]: tektoncd#7270 [tep-0144]: https://github.com/tektoncd/community/blob/main/teps/0144-param-enum.md

tekton-robot · 2023-11-01T21:32:22Z

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/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	98.1%	98.2%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	98.2%	98.2%	0.0

tekton-robot · 2023-11-01T21:34:36Z

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

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1/param_types.go	98.4%	98.5%	0.1
pkg/apis/pipeline/v1/pipeline_validation.go	99.2%	99.2%	0.0
pkg/apis/pipeline/v1/task_validation.go	98.1%	98.2%	0.0
pkg/apis/pipeline/v1beta1/param_types.go	98.7%	98.8%	0.1
pkg/apis/pipeline/v1beta1/pipeline_validation.go	99.0%	99.0%	0.0
pkg/apis/pipeline/v1beta1/task_validation.go	98.2%	98.2%	0.0

QuanZhang-William · 2023-11-02T13:55:34Z

/retest

chitrangpatel · 2023-11-02T14:32:42Z

Thanks @QuanZhang-William
/lgtm

tekton-robot requested review from afrittoli and vdemeester October 26, 2023 18:40

tekton-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 26, 2023

tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 26, 2023

QuanZhang-William force-pushed the tep-0144-enum-field branch from 22ef994 to 3e6b9e3 Compare October 26, 2023 18:48

tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 26, 2023

QuanZhang-William force-pushed the tep-0144-enum-field branch from 3e6b9e3 to 8c15157 Compare October 26, 2023 19:34

QuanZhang-William force-pushed the tep-0144-enum-field branch from 8c15157 to c68093e Compare October 26, 2023 19:35

QuanZhang-William force-pushed the tep-0144-enum-field branch from c68093e to 40dcb05 Compare October 27, 2023 20:37

QuanZhang-William force-pushed the tep-0144-enum-field branch from 40dcb05 to 484e4ea Compare October 27, 2023 20:58

QuanZhang-William marked this pull request as ready for review October 27, 2023 20:59

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 Oct 27, 2023

tekton-robot requested review from bobcatfish and jerop October 27, 2023 20:59

tekton-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 27, 2023

QuanZhang-William mentioned this pull request Oct 30, 2023

[TEP-0144] Param Enum - Implementation #7270

Closed

4 tasks

tekton-robot assigned Yongxuanzhang Oct 30, 2023

chitrangpatel reviewed Oct 31, 2023

View reviewed changes

pkg/apis/pipeline/v1/pipeline_validation.go Outdated Show resolved Hide resolved

chitrangpatel reviewed Oct 31, 2023

View reviewed changes

chitrangpatel requested changes Oct 31, 2023

View reviewed changes

QuanZhang-William force-pushed the tep-0144-enum-field branch from 56018ca to c25d02a Compare November 1, 2023 14:13

QuanZhang-William requested a review from chitrangpatel November 1, 2023 14:26

Yongxuanzhang approved these changes Nov 1, 2023

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 1, 2023

QuanZhang-William force-pushed the tep-0144-enum-field branch from c25d02a to 9eadaf3 Compare November 1, 2023 21:25

tekton-robot assigned chitrangpatel Nov 2, 2023

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 2, 2023

tekton-robot merged commit 8fd372f into tektoncd:main Nov 2, 2023
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TEP-0144] Add enum API field #7289

[TEP-0144] Add enum API field #7289

QuanZhang-William commented Oct 26, 2023 •

edited

tekton-robot commented Oct 26, 2023

QuanZhang-William commented Oct 26, 2023

QuanZhang-William commented Oct 26, 2023 •

edited

QuanZhang-William commented Oct 26, 2023

tekton-robot commented Oct 26, 2023

tekton-robot commented Oct 26, 2023

QuanZhang-William commented Oct 26, 2023

tekton-robot commented Oct 26, 2023

tekton-robot commented Oct 26, 2023

tekton-robot commented Oct 27, 2023

QuanZhang-William commented Oct 27, 2023

tekton-robot commented Oct 30, 2023

Yongxuanzhang commented Oct 30, 2023

chitrangpatel Oct 31, 2023

chitrangpatel Oct 31, 2023

QuanZhang-William Nov 1, 2023

chitrangpatel Oct 31, 2023

chitrangpatel Oct 31, 2023

chitrangpatel Oct 31, 2023

chitrangpatel Oct 31, 2023

chitrangpatel left a comment

tekton-robot commented Nov 1, 2023

tekton-robot commented Nov 1, 2023

QuanZhang-William commented Nov 1, 2023

Yongxuanzhang left a comment

Yongxuanzhang Nov 1, 2023

QuanZhang-William Nov 1, 2023

tekton-robot commented Nov 1, 2023

QuanZhang-William commented Nov 1, 2023

tekton-robot commented Nov 1, 2023

tekton-robot commented Nov 1, 2023

QuanZhang-William commented Nov 2, 2023

chitrangpatel commented Nov 2, 2023

[TEP-0144] Add enum API field #7289

[TEP-0144] Add enum API field #7289

Conversation

QuanZhang-William commented Oct 26, 2023 • edited

Changes

Submitter Checklist

Release Notes

tekton-robot commented Oct 26, 2023

QuanZhang-William commented Oct 26, 2023

QuanZhang-William commented Oct 26, 2023 • edited

QuanZhang-William commented Oct 26, 2023

tekton-robot commented Oct 26, 2023

tekton-robot commented Oct 26, 2023

QuanZhang-William commented Oct 26, 2023

tekton-robot commented Oct 26, 2023

tekton-robot commented Oct 26, 2023

tekton-robot commented Oct 27, 2023

QuanZhang-William commented Oct 27, 2023

tekton-robot commented Oct 30, 2023

Yongxuanzhang commented Oct 30, 2023

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

chitrangpatel left a comment

Choose a reason for hiding this comment

tekton-robot commented Nov 1, 2023

tekton-robot commented Nov 1, 2023

QuanZhang-William commented Nov 1, 2023

Yongxuanzhang left a 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 Nov 1, 2023

QuanZhang-William commented Nov 1, 2023

tekton-robot commented Nov 1, 2023

tekton-robot commented Nov 1, 2023

QuanZhang-William commented Nov 2, 2023

chitrangpatel commented Nov 2, 2023

QuanZhang-William commented Oct 26, 2023 •

edited

QuanZhang-William commented Oct 26, 2023 •

edited