"ParamArrayIndexingInvalid"
ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is not under correct api fields feature gate -or the array is out of bound.
+ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is out of bound.
"ParameterMissing"
ReasonParameterMissing indicates that the reason for the failure status is that the diff --git a/docs/pipelines.md b/docs/pipelines.md index 3ce6e029e7f..2de52d549c0 100644 --- a/docs/pipelines.md +++ b/docs/pipelines.md @@ -1375,8 +1375,7 @@ results: For an end-to-end example, see [`Results` in a `PipelineRun`](../examples/v1/pipelineruns/pipelinerun-results.yaml). -Array result is a beta feature, -see [`Array and Object Results` in a `PipelineRun`](../examples/v1/pipelineruns/beta/pipeline-emitting-results.yaml). +In the example below, the `Pipeline` collects array and object results from `Tasks`. ```yaml results: @@ -1398,6 +1397,7 @@ see [`Array and Object Results` in a `PipelineRun`](../examples/v1/pipelineruns/ value: $(tasks.task2.results.object-results.foo) ``` +For an end-to-end example see [`Array and Object Results` in a `PipelineRun`](../examples/v1/pipelineruns/pipeline-emitting-results.yaml). A `Pipeline Result` is not emitted if any of the following are true: - A `PipelineTask` referenced by the `Pipeline Result` failed. The `PipelineRun` will also diff --git a/docs/tasks.md b/docs/tasks.md index 82e6f97278b..320db205aa2 100644 --- a/docs/tasks.md +++ b/docs/tasks.md @@ -588,13 +588,12 @@ spec: type: string ``` -Refer to the [TaskRun example](../examples/v1/taskruns/beta/object-param-result.yaml) and the [PipelineRun example](../examples/v1/pipelineruns/beta/pipeline-object-param-and-result.yaml) in which `object` parameters are demonstrated. +Refer to the [TaskRun example](../examples/v1/taskruns/object-param-result.yaml) and the [PipelineRun example](../examples/v1/pipelineruns/pipeline-object-param-and-result.yaml) in which `object` parameters are demonstrated. > NOTE: - > - `object` param is a `beta` feature and gated by the `alpha` or `beta` feature flag. > - `object` param must specify the `properties` section to define the schema i.e. what keys are available for this object param. See how to define `properties` section in the following example and the [TEP-0075](https://github.com/tektoncd/community/blob/main/teps/0075-object-param-and-result-types.md#defaulting-to-string-types-for-values). - > - When providing value for an `object` param, one may provide values for just a subset of keys in spec's `default`, and provide values for the rest of keys at runtime ([example](../examples/v1/taskruns/beta/object-param-result.yaml)). - > - When using object in variable replacement, users can only access its individual key ("child" member) of the object by its name i.e. `$(params.gitrepo.url)`. Using an entire object as a value is only allowed when the value is also an object like [this example](https://github.com/tektoncd/pipeline/blob/55665765e4de35b3a4fb541549ae8cdef0996641/examples/v1/pipelineruns/beta/pipeline-object-param-and-result.yaml#L64-L65). See more details about using object param from the [TEP-0075](https://github.com/tektoncd/community/blob/main/teps/0075-object-param-and-result-types.md#using-objects-in-variable-replacement). + > - When providing value for an `object` param, one may provide values for just a subset of keys in spec's `default`, and provide values for the rest of keys at runtime ([example](../examples/v1/taskruns/object-param-result.yaml)). + > - When using object in variable replacement, users can only access its individual key ("child" member) of the object by its name i.e. `$(params.gitrepo.url)`. Using an entire object as a value is only allowed when the value is also an object like [this example](../examples/v1/pipelineruns/pipeline-object-param-and-result.yaml). See more details about using object param from the [TEP-0075](https://github.com/tektoncd/community/blob/main/teps/0075-object-param-and-result-types.md#using-objects-in-variable-replacement). ##### `array` type diff --git a/examples/v1/pipelineruns/beta/pipelinerun-array-results-substitution.yaml b/examples/v1/pipelineruns/pipelinerun-array-results-substitution.yaml similarity index 100% rename from examples/v1/pipelineruns/beta/pipelinerun-array-results-substitution.yaml rename to examples/v1/pipelineruns/pipelinerun-array-results-substitution.yaml diff --git a/examples/v1/pipelineruns/beta/pipelinerun-param-array-indexing.yaml b/examples/v1/pipelineruns/pipelinerun-param-array-indexing.yaml similarity index 100% rename from examples/v1/pipelineruns/beta/pipelinerun-param-array-indexing.yaml rename to examples/v1/pipelineruns/pipelinerun-param-array-indexing.yaml diff --git a/pkg/apis/pipeline/v1/pipeline_validation.go b/pkg/apis/pipeline/v1/pipeline_validation.go index 9c000c673e8..4fbe3f1dfed 100644 --- a/pkg/apis/pipeline/v1/pipeline_validation.go +++ b/pkg/apis/pipeline/v1/pipeline_validation.go @@ -94,22 +94,6 @@ func (ps *PipelineSpec) Validate(ctx context.Context) (errs *apis.FieldError) { // have "enable-api-fields" set to "alpha" or "beta". func (ps *PipelineSpec) ValidateBetaFields(ctx context.Context) *apis.FieldError { var errs *apis.FieldError - // Indexing into array parameters - arrayParamIndexingRefs := ps.GetIndexingReferencesToArrayParams() - if len(arrayParamIndexingRefs) != 0 { - errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "indexing into array parameters", config.BetaAPIFields)) - } - // array and object results - for i, result := range ps.Results { - switch result.Type { - case ResultsTypeObject: - // stable feature - case ResultsTypeArray: - errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "array results", config.BetaAPIFields).ViaFieldIndex("results", i)) - case ResultsTypeString: - default: - } - } for i, pt := range ps.Tasks { errs = errs.Also(pt.validateBetaFields(ctx).ViaFieldIndex("tasks", i)) } @@ -132,8 +116,6 @@ func (pt *PipelineTask) validateBetaFields(ctx context.Context) *apis.FieldError if len(pt.TaskRef.Params) > 0 { errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "taskref.params", config.BetaAPIFields)) } - } else if pt.TaskSpec != nil { - errs = errs.Also(pt.TaskSpec.ValidateBetaFields(ctx)) } return errs } diff --git a/pkg/apis/pipeline/v1/pipeline_validation_test.go b/pkg/apis/pipeline/v1/pipeline_validation_test.go index cf7344a7b35..4ee7acc508c 100644 --- a/pkg/apis/pipeline/v1/pipeline_validation_test.go +++ b/pkg/apis/pipeline/v1/pipeline_validation_test.go @@ -4150,38 +4150,6 @@ func TestPipelineWithBetaFields(t *testing.T) { name string spec PipelineSpec }{{ - name: "array indexing in Tasks", - spec: PipelineSpec{ - Params: []ParamSpec{ - {Name: "first-param", Type: ParamTypeArray, Default: NewStructuredValues("default-value", "default-value-again")}, - }, - Tasks: []PipelineTask{{ - Name: "foo", - Params: Params{ - {Name: "first-task-first-param", Value: *NewStructuredValues("$(params.first-param[0])")}, - }, - TaskRef: &TaskRef{Name: "foo"}, - }}, - }, - }, { - name: "array indexing in Finally", - spec: PipelineSpec{ - Params: []ParamSpec{ - {Name: "first-param", Type: ParamTypeArray, Default: NewStructuredValues("default-value", "default-value-again")}, - }, - Tasks: []PipelineTask{{ - Name: "foo", - TaskRef: &TaskRef{Name: "foo"}, - }}, - Finally: []PipelineTask{{ - Name: "bar", - Params: Params{ - {Name: "first-task-first-param", Value: *NewStructuredValues("$(params.first-param[0])")}, - }, - TaskRef: &TaskRef{Name: "bar"}, - }}, - }, - }, { name: "pipeline tasks - use of resolver", spec: PipelineSpec{ Tasks: []PipelineTask{{ @@ -4221,41 +4189,6 @@ func TestPipelineWithBetaFields(t *testing.T) { TaskRef: &TaskRef{ResolverRef: ResolverRef{Resolver: "bar", Params: Params{{}}}}, }}, }, - }, { - name: "array results", - spec: PipelineSpec{ - Tasks: []PipelineTask{{ - Name: "valid-pipeline-task", - TaskRef: &TaskRef{Name: "foo-task"}, - }}, - Results: []PipelineResult{{Name: "my-array-result", Type: ResultsTypeArray, Value: *NewStructuredValues("$(tasks.valid-pipeline-task.results.foo[*])")}}, - }, - }, { - name: "array results in Tasks", - spec: PipelineSpec{ - Tasks: []PipelineTask{{ - Name: "valid-pipeline-task", - TaskSpec: &EmbeddedTask{TaskSpec: TaskSpec{ - Steps: []Step{{Image: "busybox", Script: "echo hello"}}, - Results: []TaskResult{{Name: "my-array-result", Type: ResultsTypeArray}}, - }}, - }}, - }, - }, { - name: "array results in Finally", - spec: PipelineSpec{ - Tasks: []PipelineTask{{ - Name: "valid-pipeline-task", - TaskRef: &TaskRef{Name: "foo-task"}, - }}, - Finally: []PipelineTask{{ - Name: "valid-finally-task", - TaskSpec: &EmbeddedTask{TaskSpec: TaskSpec{ - Steps: []Step{{Image: "busybox", Script: "echo hello"}}, - Results: []TaskResult{{Name: "my-array-result", Type: ResultsTypeArray}}, - }}, - }}, - }, }} for _, tt := range tts { t.Run(tt.name, func(t *testing.T) { diff --git a/pkg/apis/pipeline/v1/pipelinerun_types.go b/pkg/apis/pipeline/v1/pipelinerun_types.go index 34be57243ae..27509bd2c23 100644 --- a/pkg/apis/pipeline/v1/pipelinerun_types.go +++ b/pkg/apis/pipeline/v1/pipelinerun_types.go @@ -369,8 +369,7 @@ const ( // ReasonObjectParameterMissKeys indicates that the object param value provided from PipelineRun spec // misses some keys required for the object param declared in Pipeline spec. PipelineRunReasonObjectParameterMissKeys PipelineRunReason = "ObjectParameterMissKeys" - // ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is not under correct api fields feature gate - // or the array is out of bound. + // ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is out of bound. PipelineRunReasonParamArrayIndexingInvalid PipelineRunReason = "ParamArrayIndexingInvalid" // ReasonCouldntGetTask indicates that the reason for the failure status is that the // associated Pipeline's Tasks couldn't all be retrieved diff --git a/pkg/apis/pipeline/v1/pipelinerun_validation_test.go b/pkg/apis/pipeline/v1/pipelinerun_validation_test.go index f6862bb7357..825002d0a36 100644 --- a/pkg/apis/pipeline/v1/pipelinerun_validation_test.go +++ b/pkg/apis/pipeline/v1/pipelinerun_validation_test.go @@ -1415,38 +1415,6 @@ func TestPipelineRunSpecBetaFeatures(t *testing.T) { name string spec v1.PipelineSpec }{{ - name: "array indexing in Tasks", - spec: v1.PipelineSpec{ - Params: []v1.ParamSpec{ - {Name: "first-param", Type: v1.ParamTypeArray, Default: v1.NewStructuredValues("default-value", "default-value-again")}, - }, - Tasks: []v1.PipelineTask{{ - Name: "foo", - Params: v1.Params{ - {Name: "first-task-first-param", Value: *v1.NewStructuredValues("$(params.first-param[0])")}, - }, - TaskRef: &v1.TaskRef{Name: "foo"}, - }}, - }, - }, { - name: "array indexing in Finally", - spec: v1.PipelineSpec{ - Params: []v1.ParamSpec{ - {Name: "first-param", Type: v1.ParamTypeArray, Default: v1.NewStructuredValues("default-value", "default-value-again")}, - }, - Tasks: []v1.PipelineTask{{ - Name: "foo", - TaskRef: &v1.TaskRef{Name: "foo"}, - }}, - Finally: []v1.PipelineTask{{ - Name: "bar", - Params: v1.Params{ - {Name: "first-task-first-param", Value: *v1.NewStructuredValues("$(params.first-param[0])")}, - }, - TaskRef: &v1.TaskRef{Name: "bar"}, - }}, - }, - }, { name: "pipeline tasks - use of resolver", spec: v1.PipelineSpec{ Tasks: []v1.PipelineTask{{ @@ -1486,41 +1454,6 @@ func TestPipelineRunSpecBetaFeatures(t *testing.T) { TaskRef: &v1.TaskRef{ResolverRef: v1.ResolverRef{Resolver: "bar", Params: v1.Params{{}}}}, }}, }, - }, { - name: "array results", - spec: v1.PipelineSpec{ - Tasks: []v1.PipelineTask{{ - Name: "valid-pipeline-task", - TaskRef: &v1.TaskRef{Name: "foo-task"}, - }}, - Results: []v1.PipelineResult{{Name: "my-array-result", Type: v1.ResultsTypeArray, Value: *v1.NewStructuredValues("$(tasks.valid-pipeline-task.results.foo[*])")}}, - }, - }, { - name: "array results in Tasks", - spec: v1.PipelineSpec{ - Tasks: []v1.PipelineTask{{ - Name: "valid-pipeline-task", - TaskSpec: &v1.EmbeddedTask{TaskSpec: v1.TaskSpec{ - Steps: []v1.Step{{Image: "busybox", Script: "echo hello"}}, - Results: []v1.TaskResult{{Name: "my-array-result", Type: v1.ResultsTypeArray}}, - }}, - }}, - }, - }, { - name: "array results in Finally", - spec: v1.PipelineSpec{ - Tasks: []v1.PipelineTask{{ - Name: "valid-pipeline-task", - TaskRef: &v1.TaskRef{Name: "foo-task"}, - }}, - Finally: []v1.PipelineTask{{ - Name: "valid-finally-task", - TaskSpec: &v1.EmbeddedTask{TaskSpec: v1.TaskSpec{ - Steps: []v1.Step{{Image: "busybox", Script: "echo hello"}}, - Results: []v1.TaskResult{{Name: "my-array-result", Type: v1.ResultsTypeArray}}, - }}, - }}, - }, }} for _, tt := range tts { t.Run(tt.name, func(t *testing.T) { diff --git a/pkg/apis/pipeline/v1/task_validation.go b/pkg/apis/pipeline/v1/task_validation.go index 23f7178645e..7a6628e6f42 100644 --- a/pkg/apis/pipeline/v1/task_validation.go +++ b/pkg/apis/pipeline/v1/task_validation.go @@ -71,7 +71,6 @@ func (t *Task) Validate(ctx context.Context) *apis.FieldError { // Validate implements apis.Validatable func (ts *TaskSpec) Validate(ctx context.Context) (errs *apis.FieldError) { - errs = errs.Also(ts.ValidateBetaFields(ctx)) if len(ts.Steps) == 0 { errs = errs.Also(apis.ErrMissingField("steps")) } @@ -98,29 +97,6 @@ func (ts *TaskSpec) Validate(ctx context.Context) (errs *apis.FieldError) { return errs } -// ValidateBetaFields returns an error if the Task spec uses beta features but does not -// have "enable-api-fields" set to "alpha" or "beta". -func (ts *TaskSpec) ValidateBetaFields(ctx context.Context) *apis.FieldError { - var errs *apis.FieldError - // Indexing into array parameters - arrayIndexParamRefs := ts.GetIndexingReferencesToArrayParams() - if len(arrayIndexParamRefs) != 0 { - errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "indexing into array parameters", config.BetaAPIFields)) - } - // Array and object results - for i, result := range ts.Results { - switch result.Type { - case ResultsTypeObject: - // stable feature - case ResultsTypeArray: - errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "array results", config.BetaAPIFields).ViaFieldIndex("results", i)) - case ResultsTypeString: - default: - } - } - return errs -} - // ValidateUsageOfDeclaredParameters validates that all parameters referenced in the Task are declared by the Task. func ValidateUsageOfDeclaredParameters(ctx context.Context, steps []Step, params ParamSpecs) *apis.FieldError { var errs *apis.FieldError diff --git a/pkg/apis/pipeline/v1/task_validation_test.go b/pkg/apis/pipeline/v1/task_validation_test.go index 27a830faa54..88b8da29612 100644 --- a/pkg/apis/pipeline/v1/task_validation_test.go +++ b/pkg/apis/pipeline/v1/task_validation_test.go @@ -2002,51 +2002,6 @@ func TestIncompatibleAPIVersions(t *testing.T) { } } -func TestTaskBetaFields(t *testing.T) { - tests := []struct { - name string - spec v1.TaskSpec - }{{ - name: "array param indexing", - spec: v1.TaskSpec{ - Params: []v1.ParamSpec{{Name: "foo", Type: v1.ParamTypeArray}}, - Steps: []v1.Step{{ - Name: "my-step", - Image: "my-image", - Script: ` - #!/usr/bin/env bash - echo $(params.foo[1])`, - }}, - }, - }, { - name: "array results", - spec: v1.TaskSpec{ - Results: []v1.TaskResult{{Name: "array-result", Type: v1.ResultsTypeArray}}, - Steps: []v1.Step{{ - Name: "my-step", - Image: "my-image", - Script: ` - #!/usr/bin/env bash - echo -n "[\"hello\",\"world\"]" | tee $(results.array-result.path)`, - }}, - }, - }} - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - ctx := cfgtesting.EnableStableAPIFields(context.Background()) - task := v1.Task{ObjectMeta: metav1.ObjectMeta{Name: "foo"}, Spec: tt.spec} - if err := task.Validate(ctx); err == nil { - t.Errorf("no error when using beta field when `enable-api-fields` is stable") - } - - ctx = cfgtesting.EnableBetaAPIFields(context.Background()) - if err := task.Validate(ctx); err != nil { - t.Errorf("unexpected error when using beta field: %s", err) - } - }) - } -} - func TestTaskSpecValidateUsageOfDeclaredParams(t *testing.T) { tests := []struct { name string diff --git a/pkg/apis/pipeline/v1/taskrun_validation_test.go b/pkg/apis/pipeline/v1/taskrun_validation_test.go index 06a99b840df..e418256c042 100644 --- a/pkg/apis/pipeline/v1/taskrun_validation_test.go +++ b/pkg/apis/pipeline/v1/taskrun_validation_test.go @@ -898,50 +898,3 @@ func TestTaskRunSpec_Validate(t *testing.T) { }) } } - -func TestTaskRunBetaFields(t *testing.T) { - tests := []struct { - name string - spec v1.TaskSpec - }{{ - name: "array param indexing", - spec: v1.TaskSpec{ - Params: []v1.ParamSpec{{Name: "foo", Type: v1.ParamTypeArray}}, - Steps: []v1.Step{{ - Name: "my-step", - Image: "my-image", - Script: ` - #!/usr/bin/env bash - echo $(params.foo[1])`, - }}, - }, - }, { - name: "array results", - spec: v1.TaskSpec{ - Results: []v1.TaskResult{{Name: "array-result", Type: v1.ResultsTypeArray}}, - Steps: []v1.Step{{ - Name: "my-step", - Image: "my-image", - Script: ` - #!/usr/bin/env bash - echo -n "[\"hello\",\"world\"]" | tee $(results.array-result.path)`, - }}, - }, - }} - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - ctx := cfgtesting.EnableStableAPIFields(context.Background()) - tr := v1.TaskRun{ObjectMeta: metav1.ObjectMeta{Name: "foo"}, Spec: v1.TaskRunSpec{ - TaskSpec: &tt.spec, - }} - if err := tr.Validate(ctx); err == nil { - t.Errorf("no error when using beta field when `enable-api-fields` is stable") - } - - ctx = cfgtesting.EnableBetaAPIFields(context.Background()) - if err := tr.Validate(ctx); err != nil { - t.Errorf("unexpected error when using beta field: %s", err) - } - }) - } -} diff --git a/pkg/apis/pipeline/v1beta1/pipeline_validation.go b/pkg/apis/pipeline/v1beta1/pipeline_validation.go index 69d39e09546..7cc773928f6 100644 --- a/pkg/apis/pipeline/v1beta1/pipeline_validation.go +++ b/pkg/apis/pipeline/v1beta1/pipeline_validation.go @@ -97,29 +97,12 @@ func (ps *PipelineSpec) Validate(ctx context.Context) (errs *apis.FieldError) { // `enable-api-fields` but does not have "enable-api-fields" set to "alpha" or "beta". func (ps *PipelineSpec) ValidateBetaFields(ctx context.Context) *apis.FieldError { var errs *apis.FieldError - // Indexing into array parameters - arrayParamIndexingRefs := ps.GetIndexingReferencesToArrayParams() - if len(arrayParamIndexingRefs) != 0 { - errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "indexing into array parameters", config.BetaAPIFields)) - } - // array and object results - for i, result := range ps.Results { - switch result.Type { - case ResultsTypeObject: - // stable feature - case ResultsTypeArray: - errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "array results", config.BetaAPIFields).ViaFieldIndex("results", i)) - case ResultsTypeString: - default: - } - } for i, pt := range ps.Tasks { errs = errs.Also(pt.validateBetaFields(ctx).ViaFieldIndex("tasks", i)) } for i, pt := range ps.Finally { errs = errs.Also(pt.validateBetaFields(ctx).ViaFieldIndex("finally", i)) } - return errs } @@ -135,8 +118,6 @@ func (pt *PipelineTask) validateBetaFields(ctx context.Context) *apis.FieldError if len(pt.TaskRef.Params) > 0 { errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "taskref.params", config.BetaAPIFields)) } - } else if pt.TaskSpec != nil { - errs = errs.Also(pt.TaskSpec.ValidateBetaFields(ctx)) } return errs } diff --git a/pkg/apis/pipeline/v1beta1/pipeline_validation_test.go b/pkg/apis/pipeline/v1beta1/pipeline_validation_test.go index 01d6995f668..9f37d95586e 100644 --- a/pkg/apis/pipeline/v1beta1/pipeline_validation_test.go +++ b/pkg/apis/pipeline/v1beta1/pipeline_validation_test.go @@ -4212,38 +4212,6 @@ func TestPipelineWithBetaFields(t *testing.T) { name string spec PipelineSpec }{{ - name: "array indexing in Tasks", - spec: PipelineSpec{ - Params: []ParamSpec{ - {Name: "first-param", Type: ParamTypeArray, Default: NewStructuredValues("default-value", "default-value-again")}, - }, - Tasks: []PipelineTask{{ - Name: "foo", - Params: Params{ - {Name: "first-task-first-param", Value: *NewStructuredValues("$(params.first-param[0])")}, - }, - TaskRef: &TaskRef{Name: "foo"}, - }}, - }, - }, { - name: "array indexing in Finally", - spec: PipelineSpec{ - Params: []ParamSpec{ - {Name: "first-param", Type: ParamTypeArray, Default: NewStructuredValues("default-value", "default-value-again")}, - }, - Tasks: []PipelineTask{{ - Name: "foo", - TaskRef: &TaskRef{Name: "foo"}, - }}, - Finally: []PipelineTask{{ - Name: "bar", - Params: Params{ - {Name: "first-task-first-param", Value: *NewStructuredValues("$(params.first-param[0])")}, - }, - TaskRef: &TaskRef{Name: "bar"}, - }}, - }, - }, { name: "pipeline tasks - use of resolver", spec: PipelineSpec{ Tasks: []PipelineTask{{ @@ -4283,41 +4251,6 @@ func TestPipelineWithBetaFields(t *testing.T) { TaskRef: &TaskRef{ResolverRef: ResolverRef{Resolver: "bar", Params: Params{{}}}}, }}, }, - }, { - name: "array results", - spec: PipelineSpec{ - Tasks: []PipelineTask{{ - Name: "valid-pipeline-task", - TaskRef: &TaskRef{Name: "foo-task"}, - }}, - Results: []PipelineResult{{Name: "my-array-result", Type: ResultsTypeArray, Value: *NewStructuredValues("$(tasks.valid-pipeline-task.results.foo[*])")}}, - }, - }, { - name: "array results in Tasks", - spec: PipelineSpec{ - Tasks: []PipelineTask{{ - Name: "valid-pipeline-task", - TaskSpec: &EmbeddedTask{TaskSpec: TaskSpec{ - Steps: []Step{{Image: "busybox", Script: "echo hello"}}, - Results: []TaskResult{{Name: "my-array-result", Type: ResultsTypeArray}}, - }}, - }}, - }, - }, { - name: "array results in Finally", - spec: PipelineSpec{ - Tasks: []PipelineTask{{ - Name: "valid-pipeline-task", - TaskRef: &TaskRef{Name: "foo-task"}, - }}, - Finally: []PipelineTask{{ - Name: "valid-finally-task", - TaskSpec: &EmbeddedTask{TaskSpec: TaskSpec{ - Steps: []Step{{Image: "busybox", Script: "echo hello"}}, - Results: []TaskResult{{Name: "my-array-result", Type: ResultsTypeArray}}, - }}, - }}, - }, }} for _, tt := range tts { t.Run(tt.name, func(t *testing.T) { diff --git a/pkg/apis/pipeline/v1beta1/pipelinerun_validation_test.go b/pkg/apis/pipeline/v1beta1/pipelinerun_validation_test.go index 7b0a9794fae..61cdd7bfe47 100644 --- a/pkg/apis/pipeline/v1beta1/pipelinerun_validation_test.go +++ b/pkg/apis/pipeline/v1beta1/pipelinerun_validation_test.go @@ -1566,38 +1566,6 @@ func TestPipelineRunSpecBetaFeatures(t *testing.T) { name string spec v1beta1.PipelineSpec }{{ - name: "array indexing in Tasks", - spec: v1beta1.PipelineSpec{ - Params: []v1beta1.ParamSpec{ - {Name: "first-param", Type: v1beta1.ParamTypeArray, Default: v1beta1.NewStructuredValues("default-value", "default-value-again")}, - }, - Tasks: []v1beta1.PipelineTask{{ - Name: "foo", - Params: v1beta1.Params{ - {Name: "first-task-first-param", Value: *v1beta1.NewStructuredValues("$(params.first-param[0])")}, - }, - TaskRef: &v1beta1.TaskRef{Name: "foo"}, - }}, - }, - }, { - name: "array indexing in Finally", - spec: v1beta1.PipelineSpec{ - Params: []v1beta1.ParamSpec{ - {Name: "first-param", Type: v1beta1.ParamTypeArray, Default: v1beta1.NewStructuredValues("default-value", "default-value-again")}, - }, - Tasks: []v1beta1.PipelineTask{{ - Name: "foo", - TaskRef: &v1beta1.TaskRef{Name: "foo"}, - }}, - Finally: []v1beta1.PipelineTask{{ - Name: "bar", - Params: v1beta1.Params{ - {Name: "first-task-first-param", Value: *v1beta1.NewStructuredValues("$(params.first-param[0])")}, - }, - TaskRef: &v1beta1.TaskRef{Name: "bar"}, - }}, - }, - }, { name: "pipeline tasks - use of resolver", spec: v1beta1.PipelineSpec{ Tasks: []v1beta1.PipelineTask{{ @@ -1637,41 +1605,6 @@ func TestPipelineRunSpecBetaFeatures(t *testing.T) { TaskRef: &v1beta1.TaskRef{ResolverRef: v1beta1.ResolverRef{Resolver: "bar", Params: v1beta1.Params{{}}}}, }}, }, - }, { - name: "array results", - spec: v1beta1.PipelineSpec{ - Tasks: []v1beta1.PipelineTask{{ - Name: "valid-pipeline-task", - TaskRef: &v1beta1.TaskRef{Name: "foo-task"}, - }}, - Results: []v1beta1.PipelineResult{{Name: "my-array-result", Type: v1beta1.ResultsTypeArray, Value: *v1beta1.NewStructuredValues("$(tasks.valid-pipeline-task.results.foo[*])")}}, - }, - }, { - name: "array results in Tasks", - spec: v1beta1.PipelineSpec{ - Tasks: []v1beta1.PipelineTask{{ - Name: "valid-pipeline-task", - TaskSpec: &v1beta1.EmbeddedTask{TaskSpec: v1beta1.TaskSpec{ - Steps: []v1beta1.Step{{Image: "busybox", Script: "echo hello"}}, - Results: []v1beta1.TaskResult{{Name: "my-array-result", Type: v1beta1.ResultsTypeArray}}, - }}, - }}, - }, - }, { - name: "array results in Finally", - spec: v1beta1.PipelineSpec{ - Tasks: []v1beta1.PipelineTask{{ - Name: "valid-pipeline-task", - TaskRef: &v1beta1.TaskRef{Name: "foo-task"}, - }}, - Finally: []v1beta1.PipelineTask{{ - Name: "valid-finally-task", - TaskSpec: &v1beta1.EmbeddedTask{TaskSpec: v1beta1.TaskSpec{ - Steps: []v1beta1.Step{{Image: "busybox", Script: "echo hello"}}, - Results: []v1beta1.TaskResult{{Name: "my-array-result", Type: v1beta1.ResultsTypeArray}}, - }}, - }}, - }, }} for _, tt := range tts { t.Run(tt.name, func(t *testing.T) { diff --git a/pkg/apis/pipeline/v1beta1/task_validation.go b/pkg/apis/pipeline/v1beta1/task_validation.go index c9a5e5a9ec9..0b50d152362 100644 --- a/pkg/apis/pipeline/v1beta1/task_validation.go +++ b/pkg/apis/pipeline/v1beta1/task_validation.go @@ -71,7 +71,6 @@ func (t *Task) Validate(ctx context.Context) *apis.FieldError { // Validate implements apis.Validatable func (ts *TaskSpec) Validate(ctx context.Context) (errs *apis.FieldError) { - errs = errs.Also(ts.ValidateBetaFields(ctx)) if len(ts.Steps) == 0 { errs = errs.Also(apis.ErrMissingField("steps")) } @@ -101,29 +100,6 @@ func (ts *TaskSpec) Validate(ctx context.Context) (errs *apis.FieldError) { return errs } -// ValidateBetaFields returns an error if the TaskSpec uses beta specifications governed by -// `enable-api-fields` but does not have "enable-api-fields" set to "alpha" or "beta". -func (ts *TaskSpec) ValidateBetaFields(ctx context.Context) *apis.FieldError { - var errs *apis.FieldError - // Indexing into array parameters - arrayIndexParamRefs := ts.GetIndexingReferencesToArrayParams() - if len(arrayIndexParamRefs) != 0 { - errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "indexing into array parameters", config.BetaAPIFields)) - } - // Array and object results - for i, result := range ts.Results { - switch result.Type { - case ResultsTypeObject: - // stable feature - case ResultsTypeArray: - errs = errs.Also(config.ValidateEnabledAPIFields(ctx, "array results", config.BetaAPIFields).ViaFieldIndex("results", i)) - case ResultsTypeString: - default: - } - } - return errs -} - // ValidateUsageOfDeclaredParameters validates that all parameters referenced in the Task are declared by the Task. func ValidateUsageOfDeclaredParameters(ctx context.Context, steps []Step, params ParamSpecs) *apis.FieldError { var errs *apis.FieldError diff --git a/pkg/apis/pipeline/v1beta1/task_validation_test.go b/pkg/apis/pipeline/v1beta1/task_validation_test.go index bee77c71b69..f398e351c01 100644 --- a/pkg/apis/pipeline/v1beta1/task_validation_test.go +++ b/pkg/apis/pipeline/v1beta1/task_validation_test.go @@ -1964,51 +1964,6 @@ func TestIncompatibleAPIVersions(t *testing.T) { } } -func TestTaskBetaFields(t *testing.T) { - tests := []struct { - name string - spec v1beta1.TaskSpec - }{{ - name: "array param indexing", - spec: v1beta1.TaskSpec{ - Params: []v1beta1.ParamSpec{{Name: "foo", Type: v1beta1.ParamTypeArray}}, - Steps: []v1beta1.Step{{ - Name: "my-step", - Image: "my-image", - Script: ` - #!/usr/bin/env bash - echo $(params.foo[1])`, - }}, - }, - }, { - name: "array results", - spec: v1beta1.TaskSpec{ - Results: []v1beta1.TaskResult{{Name: "array-result", Type: v1beta1.ResultsTypeArray}}, - Steps: []v1beta1.Step{{ - Name: "my-step", - Image: "my-image", - Script: ` - #!/usr/bin/env bash - echo -n "[\"hello\",\"world\"]" | tee $(results.array-result.path)`, - }}, - }, - }} - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - ctx := cfgtesting.EnableStableAPIFields(context.Background()) - task := v1beta1.Task{ObjectMeta: metav1.ObjectMeta{Name: "foo"}, Spec: tt.spec} - if err := task.Validate(ctx); err == nil { - t.Errorf("no error when using beta field when `enable-api-fields` is stable") - } - - ctx = cfgtesting.EnableBetaAPIFields(context.Background()) - if err := task.Validate(ctx); err != nil { - t.Errorf("unexpected error when using beta field: %s", err) - } - }) - } -} - func TestGetArrayIndexParamRefs(t *testing.T) { tcs := []struct { name string diff --git a/pkg/apis/pipeline/v1beta1/taskrun_validation_test.go b/pkg/apis/pipeline/v1beta1/taskrun_validation_test.go index 4020f293ba6..6e604fb6e36 100644 --- a/pkg/apis/pipeline/v1beta1/taskrun_validation_test.go +++ b/pkg/apis/pipeline/v1beta1/taskrun_validation_test.go @@ -904,50 +904,3 @@ func TestTaskRunSpec_Validate(t *testing.T) { }) } } - -func TestTaskRunBetaFields(t *testing.T) { - tests := []struct { - name string - spec v1beta1.TaskSpec - }{{ - name: "array param indexing", - spec: v1beta1.TaskSpec{ - Params: []v1beta1.ParamSpec{{Name: "foo", Type: v1beta1.ParamTypeArray}}, - Steps: []v1beta1.Step{{ - Name: "my-step", - Image: "my-image", - Script: ` - #!/usr/bin/env bash - echo $(params.foo[1])`, - }}, - }, - }, { - name: "array results", - spec: v1beta1.TaskSpec{ - Results: []v1beta1.TaskResult{{Name: "array-result", Type: v1beta1.ResultsTypeArray}}, - Steps: []v1beta1.Step{{ - Name: "my-step", - Image: "my-image", - Script: ` - #!/usr/bin/env bash - echo -n "[\"hello\",\"world\"]" | tee $(results.array-result.path)`, - }}, - }, - }} - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - ctx := cfgtesting.EnableStableAPIFields(context.Background()) - tr := v1beta1.TaskRun{ObjectMeta: metav1.ObjectMeta{Name: "foo"}, Spec: v1beta1.TaskRunSpec{ - TaskSpec: &tt.spec, - }} - if err := tr.Validate(ctx); err == nil { - t.Errorf("no error when using beta field when `enable-api-fields` is stable") - } - - ctx = cfgtesting.EnableBetaAPIFields(context.Background()) - if err := tr.Validate(ctx); err != nil { - t.Errorf("unexpected error when using beta field: %s", err) - } - }) - } -} diff --git a/pkg/reconciler/pipelinerun/pipelinerun.go b/pkg/reconciler/pipelinerun/pipelinerun.go index 32c3254e54c..17d3ea381c1 100644 --- a/pkg/reconciler/pipelinerun/pipelinerun.go +++ b/pkg/reconciler/pipelinerun/pipelinerun.go @@ -96,8 +96,7 @@ var ( // ReasonObjectParameterMissKeys indicates that the object param value provided from PipelineRun spec // misses some keys required for the object param declared in Pipeline spec. ReasonObjectParameterMissKeys = v1.PipelineRunReasonObjectParameterMissKeys.String() - // ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is not under correct api fields feature gate - // or the array is out of bound. + // ReasonParamArrayIndexingInvalid indicates that the use of param array indexing is out of bound. ReasonParamArrayIndexingInvalid = v1.PipelineRunReasonParamArrayIndexingInvalid.String() // ReasonCouldntGetTask indicates that the reason for the failure status is that the // associated Pipeline's Tasks couldn't all be retrieved