Add context variables for PipelineRun & TaskRun UIDs and add validation for all context variables #3017

jerop · 2020-07-27T17:55:51Z

Changes

A user may want to tag an oci image with the TaskRun or PipelineRun UIDs.
Currently, they can't do that because metadata.uid for TaskRuns and
PipelineRuns are not exposed.

In this PR, we add the UID context variable for TaskRuns and
PipelineRun. Users can now use $(context.taskRun.uid) and
$(context.pipelineRun.uid) to access and use UIDs.

In addition, we add validation for all context variables that are
supported so far -- context.task.name, context.taskRun.name,
context.taskRun.namespace, context.taskRun.uid,
context.pipeline.name, context.pipelineRun.name,
context.pipelineRun.namespace, context.pipelineRun.uid.

Partially fixes #2958

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

Includes tests (if functionality changed/added)
Includes docs (if user facing)
Commit messages follow commit message best practices
Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

If you are adding a new binary/image to the cmd dir, please update
the release Task to build and release this image.

Reviewer Notes

If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.

Release Notes

- User can access the uid of the `PipelineRun` that a `Pipeline` is running in using `context.pipelineRun.uid`.
- User can access the uid of the `TaskRun` that a `Task` is running in using `context.taskRun.uid`. 
- All context variables that are supported so far are now validated.

jerop · 2020-07-27T17:56:18Z

/kind feature

tekton-robot · 2020-07-27T17:59: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/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

pkg/reconciler/taskrun/resources/apply.go

tekton-robot · 2020-07-27T20:44:18Z

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	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T20:48:34Z

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	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T22:20:34Z

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
internal/builder/v1beta1/owner_reference.go	100.0%	80.0%	-20.0
internal/builder/v1beta1/pipeline.go	81.2%	80.2%	-0.9
internal/builder/v1beta1/task.go	75.5%	74.9%	-0.6
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T22:22:08Z

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
internal/builder/v1beta1/owner_reference.go	100.0%	80.0%	-20.0
internal/builder/v1beta1/pipeline.go	81.2%	80.2%	-0.9
internal/builder/v1beta1/task.go	75.5%	74.9%	-0.6
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T22:24:43Z

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
internal/builder/v1beta1/owner_reference.go	100.0%	80.0%	-20.0
internal/builder/v1beta1/pipeline.go	81.2%	80.2%	-0.9
internal/builder/v1beta1/task.go	75.5%	74.9%	-0.6
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T22:43:58Z

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
internal/builder/v1beta1/owner_reference.go	100.0%	80.0%	-20.0
internal/builder/v1beta1/pipeline.go	81.2%	80.2%	-0.9
internal/builder/v1beta1/task.go	75.5%	74.9%	-0.6
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T22:54: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
internal/builder/v1beta1/owner_reference.go	100.0%	80.0%	-20.0
internal/builder/v1beta1/pipeline.go	81.2%	80.2%	-0.9
internal/builder/v1beta1/task.go	75.5%	74.9%	-0.6
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T22:58:12Z

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
internal/builder/v1beta1/owner_reference.go	100.0%	80.0%	-20.0
internal/builder/v1beta1/pipeline.go	81.2%	80.2%	-0.9
internal/builder/v1beta1/task.go	75.5%	74.9%	-0.6
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T23:01:00Z

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
internal/builder/v1beta1/pipeline.go	81.2%	80.2%	-0.9
internal/builder/v1beta1/task.go	75.5%	74.9%	-0.6
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-27T23:26:55Z

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
internal/builder/v1beta1/pipeline.go	81.2%	80.2%	-0.9
internal/builder/v1beta1/task.go	75.5%	74.9%	-0.6
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	85.6%	-0.4
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	76.6%	75.9%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-28T13:50:30Z

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
internal/builder/v1beta1/pipeline.go	81.2%	81.4%	0.2
internal/builder/v1beta1/task.go	75.5%	75.7%	0.2
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	86.1%	0.1
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	77.3%	76.6%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-28T14:04:54Z

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
internal/builder/v1beta1/pipeline.go	81.2%	81.4%	0.2
internal/builder/v1beta1/task.go	75.5%	75.7%	0.2
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	86.1%	0.1
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	77.3%	76.7%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

tekton-robot · 2020-07-28T14:43:30Z

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
internal/builder/v1beta1/pipeline.go	81.2%	81.4%	0.2
internal/builder/v1beta1/task.go	75.5%	75.7%	0.2
pkg/reconciler/pipelinerun/pipelinerun.go	86.0%	86.1%	0.1
pkg/reconciler/pipelinerun/resources/validate_contexts.go	Do not exist	100.0%
pkg/reconciler/taskrun/taskrun.go	77.3%	76.7%	-0.7
pkg/reconciler/taskrun/validate_contexts.go	Do not exist	100.0%

pkg/reconciler/pipelinerun/pipelinerun.go

vdemeester · 2020-07-29T12:56:57Z

pkg/reconciler/taskrun/taskrun.go

@@ -300,6 +300,12 @@ func (c *Reconciler) prepare(ctx context.Context, tr *v1beta1.TaskRun) (*v1beta1
 		return nil, nil, controller.NewPermanentError(err)
 	}

+	if err := validateContextVariables(taskSpec, tr); err != nil {


I am having trouble seeing this one as non-exported in taskrun and the other one exported in pipelinerun/resources. Could they share code even ? (because we are "validating" the same thing, be it taskrun or other objects)

tekton-robot · 2020-08-03T12:42:14Z

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/v1beta1/pipeline_validation.go	96.2%	96.1%	-0.1
pkg/apis/pipeline/v1beta1/task_validation.go	84.0%	84.7%	0.7

tekton-robot · 2020-08-03T12:45:17Z

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/v1beta1/pipeline_validation.go	96.2%	96.1%	-0.1
pkg/apis/pipeline/v1beta1/task_validation.go	84.0%	84.7%	0.7

tekton-robot · 2020-08-03T12:50:15Z

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/v1beta1/pipeline_validation.go	96.2%	96.1%	-0.1
pkg/apis/pipeline/v1beta1/task_validation.go	84.0%	84.7%	0.7

tekton-robot · 2020-08-03T12:55:09Z

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/v1beta1/pipeline_validation.go	96.2%	96.1%	-0.2
pkg/apis/pipeline/v1beta1/task_validation.go	84.0%	84.7%	0.7

A user may want to tag an oci image with the TaskRun or PipelineRun UIDs. Currently, they can't do that because `metadata.uid` for TaskRuns and PipelineRuns are not exposed. In this PR, we add the UID context variable for TaskRuns and PipelineRun. Users can now use `$(context.taskRun.uid)` and `$(context.pipelineRun.uid)` to access and use UIDs. In addition, we add validation for all context variables that are supported so far -- `context.task.name`, `context.taskRun.name`, `context.taskRun.namespace`, `context.taskRun.uid`, `context.pipeline.name`, `context.pipelineRun.name`, `context.pipelineRun.namespace`, `context.pipelineRun.uid`. Partially fixes tektoncd#2958

tekton-robot · 2020-08-03T14:26:26Z

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/v1beta1/pipeline_validation.go	96.2%	96.1%	-0.2
pkg/apis/pipeline/v1beta1/task_validation.go	84.0%	84.7%	0.7

vdemeester

/lgtm

tekton-robot · 2020-08-03T15:07:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbwsg

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

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

tekton-robot requested review from a user and vdemeester July 27, 2020 17:56

tekton-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 27, 2020

ghost reviewed Jul 27, 2020

View reviewed changes

pkg/reconciler/taskrun/resources/apply.go Outdated Show resolved Hide resolved

jerop force-pushed the uid-and-annotation-variables branch from 80e76b1 to fd2d31e Compare July 27, 2020 20:40

jerop force-pushed the uid-and-annotation-variables branch from fd2d31e to 1623109 Compare July 27, 2020 20:45

jerop force-pushed the uid-and-annotation-variables branch 2 times, most recently from f6a20cd to f0c51cd Compare July 27, 2020 22:19

jerop force-pushed the uid-and-annotation-variables branch from f0c51cd to 607106a Compare July 27, 2020 22:21

jerop force-pushed the uid-and-annotation-variables branch from 607106a to f5867de Compare July 27, 2020 22:41

jerop force-pushed the uid-and-annotation-variables branch 2 times, most recently from bb9ac5e to 26166ab Compare July 27, 2020 22:54

jerop force-pushed the uid-and-annotation-variables branch from 26166ab to 7ce79a3 Compare July 27, 2020 22:57

jerop force-pushed the uid-and-annotation-variables branch from 7ce79a3 to e8a167d Compare July 27, 2020 23:23

jerop force-pushed the uid-and-annotation-variables branch from e8a167d to e8aa5d5 Compare July 27, 2020 23:34

jerop force-pushed the uid-and-annotation-variables branch from 293beab to 8d8db44 Compare July 28, 2020 14:01

jerop force-pushed the uid-and-annotation-variables branch from 8d8db44 to d0388c3 Compare July 28, 2020 14:40

jerop marked this pull request as ready for review July 28, 2020 15:40

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 28, 2020

vdemeester reviewed Jul 29, 2020

View reviewed changes

jerop force-pushed the uid-and-annotation-variables branch from d0388c3 to 0bd4707 Compare August 3, 2020 12:38

tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 3, 2020

jerop force-pushed the uid-and-annotation-variables branch from 0bd4707 to 658f70f Compare August 3, 2020 12:42

jerop force-pushed the uid-and-annotation-variables branch from 658f70f to a2559ec Compare August 3, 2020 12:46

jerop force-pushed the uid-and-annotation-variables branch from a2559ec to a695f09 Compare August 3, 2020 12:52

jerop force-pushed the uid-and-annotation-variables branch from a695f09 to 5c0d1b0 Compare August 3, 2020 14:24

vdemeester reviewed Aug 3, 2020

View reviewed changes

tekton-robot assigned vdemeester Aug 3, 2020

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 3, 2020

ghost approved these changes Aug 3, 2020

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 3, 2020

tekton-robot merged commit aef69cc into tektoncd:master Aug 3, 2020

jerop mentioned this pull request Aug 4, 2020

Support more context variables (uid, annotations, …) #2958

Closed

jerop deleted the uid-and-annotation-variables branch September 30, 2020 15:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add context variables for PipelineRun & TaskRun UIDs and add validation for all context variables #3017

Add context variables for PipelineRun & TaskRun UIDs and add validation for all context variables #3017

jerop commented Jul 27, 2020 •

edited

jerop commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 28, 2020

tekton-robot commented Jul 28, 2020

tekton-robot commented Jul 28, 2020

vdemeester Jul 29, 2020

tekton-robot commented Aug 3, 2020

tekton-robot commented Aug 3, 2020

tekton-robot commented Aug 3, 2020

tekton-robot commented Aug 3, 2020

tekton-robot commented Aug 3, 2020

vdemeester left a comment

tekton-robot commented Aug 3, 2020

Add context variables for PipelineRun & TaskRun UIDs and add validation for all context variables #3017

Add context variables for PipelineRun & TaskRun UIDs and add validation for all context variables #3017

Conversation

jerop commented Jul 27, 2020 • edited

Changes

Submitter Checklist

Reviewer Notes

Release Notes

jerop commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 27, 2020

tekton-robot commented Jul 28, 2020

tekton-robot commented Jul 28, 2020

tekton-robot commented Jul 28, 2020

vdemeester Jul 29, 2020

Choose a reason for hiding this comment

tekton-robot commented Aug 3, 2020

tekton-robot commented Aug 3, 2020

tekton-robot commented Aug 3, 2020

tekton-robot commented Aug 3, 2020

tekton-robot commented Aug 3, 2020

vdemeester left a comment

Choose a reason for hiding this comment

tekton-robot commented Aug 3, 2020

jerop commented Jul 27, 2020 •

edited