[TEP-0144] Validate PipelineRun for Param Enum

[QuanZhang-William]

Changes

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

This commit adds validation logic for PipelineRun against Param Enum

/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

Implement Param Enum validation for PipelineRuns. Param Enum is supported per TEP-0144

[tekton-robot]

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]

/test all

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[QuanZhang-William]

/retest

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[QuanZhang-William]

/retest

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.6%	0.1

[tekton-robot]

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

@tektoncd/core-collaborators @tektoncd/core-maintainers. Please take a look if you are interested 😃

[jerop]

I have a concern about the intersection approach when enum is specified in both tasks and pipelines, I think we should require that the enum in pipeline is a subset of the enum in task

Also, what happens currently when the param in pipeline is passed to multiple tasks with enums? do you take the intersection of the enums in all the tasks the param is passed to and the pipeline? in the example below, what is the valid value for "message" param in a pipelinerun?

apiVersion: tekton.dev/v1
kind: Task
metadata:
  name: param-enum-demo-1
spec:
  params:
  - name: message
    type: string
    enum: ["v1", "v2", "v3"]
  steps:
  - name: build
    image: bash:latest
    script: |
      echo "$(params.message)"
---
apiVersion: tekton.dev/v1
kind: Task
metadata:
  name: param-enum-demo-2
spec:
  params:
  - name: message
    type: string
    enum: ["v3", "v4"]
  steps:
  - name: build
    image: bash:latest
    script: |
      echo "$(params.message)"
---
apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: pipeline-param-enum
spec:
  params:
  - name: message
    enum: ["v1", "v3", "v4", "v5"]
  tasks:
  - name: task-1
    params:
      - name: message
        value: $(params.message)
    taskRef:
      name: param-enum-demo-1
  - name: task-2 
    params:
      - name: message
        value: $(params.message)
    taskRef:
      name: param-enum-demo-2

[jerop]

/hold

wait on tektoncd/community#1106 to be merged

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.3%	-0.2
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go	96.7%	96.4%	-0.3

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.3%	-0.2
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go	96.7%	96.4%	-0.3

[QuanZhang-William]

I have a concern about the intersection approach when enum is specified in both tasks and pipelines, I think we should require that the enum in pipeline is a subset of the enum in task

Also, what happens currently when the param in pipeline is passed to multiple tasks with enums? do you take the intersection of the enums in all the tasks the param is passed to and the pipeline? in the example below, what is the valid value for "message" param in a pipelinerun?

apiVersion: tekton.dev/v1
kind: Task
metadata:
  name: param-enum-demo-1
spec:
  params:
  - name: message
    type: string
    enum: ["v1", "v2", "v3"]
  steps:
  - name: build
    image: bash:latest
    script: |
      echo "$(params.message)"
---
apiVersion: tekton.dev/v1
kind: Task
metadata:
  name: param-enum-demo-2
spec:
  params:
  - name: message
    type: string
    enum: ["v3", "v4"]
  steps:
  - name: build
    image: bash:latest
    script: |
      echo "$(params.message)"
---
apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
  name: pipeline-param-enum
spec:
  params:
  - name: message
    enum: ["v1", "v3", "v4", "v5"]
  tasks:
  - name: task-1
    params:
      - name: message
        value: $(params.message)
    taskRef:
      name: param-enum-demo-1
  - name: task-2 
    params:
      - name: message
        value: $(params.message)
    taskRef:
      name: param-enum-demo-2

Hi Jerop. You are right about the behaviour in the previous intersection design, it essentially takes the intersection of all related enum sets. I have changed to subset design, which also essentially validates the pipeline-level is a subset of all referenced Tasks

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.3%	-0.2
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go	96.7%	96.4%	-0.3

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.3%	-0.2
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go	96.7%	96.4%	-0.3

[tekton-robot]

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/pipelinerun/pipelinerun.go	92.5%	92.3%	-0.2
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go	96.7%	96.4%	-0.3

[tekton-robot]

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/reconciler/pipelinerun/pipelinerun.go	92.5%	92.3%	-0.2
pkg/reconciler/pipelinerun/resources/pipelinerunresolution.go	96.7%	96.4%	-0.3

[jerop]

Thank you @QuanZhang-William!

/lgtm