Add CloudEvents for Run definitions #4659

afrittoli · 2022-03-10T11:39:35Z

Changes

Add CloudEvents for Run definitions

Add the definitions for new CloudEvents for Runs.
The events are not sent yet. The event types are documented and
the cloudevent package supports creating events for Runs.

Partially addresses #3862
Depends-on: #4658

/kind feature

Submitter Checklist

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

Docs included if any changes are user facing
Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including
functionality, content, code)
Release notes block below has been filled in or deleted (only if no user facing changes)

Release Notes

CloudEvents for Run have been defined, but they are not sent yet.

tekton-robot · 2022-03-10T11:41: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/apis/pipeline/v1alpha1/run_types.go	61.5%	59.3%	-2.3
pkg/reconciler/events/cloudevent/cloudevent.go	91.2%	91.0%	-0.2

tekton-robot · 2022-03-10T11:52:37Z

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/v1alpha1/run_types.go	61.5%	59.3%	-2.3
pkg/reconciler/events/cloudevent/cloudevent.go	91.2%	91.0%	-0.2

afrittoli · 2022-03-10T12:18:08Z

/test pull-tekton-pipeline-integration-tests

tekton-robot · 2022-03-11T00:19: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
pkg/reconciler/events/cloudevent/cloudevent.go	91.2%	91.0%	-0.2

tekton-robot · 2022-03-11T10:29:55Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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

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

afrittoli · 2022-03-11T11:15:37Z

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

afrittoli · 2022-03-11T11:53:28Z

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

lbernick · 2022-03-11T15:15:54Z

docs/events.md

@@ -6,11 +6,12 @@ weight: 700
 -->
 # Events in Tekton

-Tekton's task controller emits [Kubernetes events](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#event-v1-core)


just some grammar nits: controllers emits -> controllers emit and the underlying TaskRun do -> the underlying TaskRuns do

Nice catch, thank you!

lbernick · 2022-03-11T15:16:57Z

docs/events.md

@@ -68,6 +69,12 @@ Resource      |Event    |Event Type
 `PipelineRun` | `Condition Change while Running` | `dev.tekton.event.pipelinerun.unknown.v1`
 `PipelineRun` | `Succeed` | `dev.tekton.event.pipelinerun.successful.v1`
 `PipelineRun` | `Failed`  | `dev.tekton.event.pipelinerun.failed.v1`
+`Run`         | `Started` | `dev.tekton.event.run.started.v1`


what's the reason not to send a condition change while running event? is this because we don't know what the run's previous status was, and can't make assumptions based on what it currently is? Is this a feature users might want?

We cannot make assumptions about the Run and it will use its Conditions beyond what we specify in the custom task interface. So we can see that the resource has been created (start), we can see that an initial condition was set (running) and we can see when it's finished (successfully or not).

lbernick · 2022-03-11T15:17:58Z

pkg/reconciler/events/cloudevent/cloudevent_test.go

+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      runName,
+			Namespace: "marshmallow",


pkg/reconciler/events/cloudevent/cloudevent_test.go

pkg/reconciler/events/cloudevent/cloudevent.go

lbernick · 2022-03-11T15:25:27Z

pkg/reconciler/events/cloudevent/cloudevent_test.go

+
+	for _, c := range runTests {
+		t.Run(c.desc, func(t *testing.T) {
+			names.TestingSeed()


I see names.TestingSeed a lot in our tests-- what's the reason it's needed here, just out of curiosity?

Copy paste? I wondered the same but I lazy :P I will try to find out

its there for a reason, I have been wondering about it as well since I started writing unit tests.

It was introduced to use fixed seed for the generated names as part of PR #491. This PR fixed the issue where it was reported the resource names were too long #481.

@afrittoli some of these might no longer be needed since now we have fixed names for some of the resources as your implemented in #4361.

I generally comment out one line at a time to see if its breaking my test if I am not sure what that code is doing 😄 Or add the same call twice 🙃 to understand the impact.

Thanks @pritidesai - good idea :)

names.TestingSeed is used to initialise the random generator used in names, so that you can get know what name to expect to validate results in tests. As @pritidesai mentioned, the need for this is probably reduced now that children resources have a more predictable name.

CloudEvent tests only match event types, so the name seed is not strictly required. It does cost anything or do any harm either, but I'll remove it as it's not needed.

Add the definitions for new CloudEvents for Runs. The events are not sent yet. The event types are documented and the cloudevent package supports creating events for Runs. Partially addresses tektoncd#3862 Signed-off-by: Andrea Frittoli <andrea.frittoli@uk.ibm.com>

tekton-robot · 2022-03-14T11:13: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/reconciler/events/cloudevent/cloudevent.go	91.2%	91.0%	-0.2

afrittoli · 2022-03-14T11:37:36Z

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

lbernick · 2022-03-14T13:33:06Z

/lgtm

tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. labels Mar 10, 2022

tekton-robot requested review from dibyom and jerop March 10, 2022 11:39

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

afrittoli changed the title ~~Run events~~ Add CloudEvents for Run definitions Mar 10, 2022

afrittoli added this to the Pipelines v0.34 milestone Mar 10, 2022

afrittoli force-pushed the run_events branch from 055165a to c929aa8 Compare March 10, 2022 11:50

afrittoli force-pushed the run_events branch from c929aa8 to bfa77be Compare March 11, 2022 00:16

This was referenced Mar 11, 2022

Cloud Events for Runs #3862

Closed

Implement CloudEvents for Runs #4663

Merged

vdemeester approved these changes Mar 11, 2022

View reviewed changes

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

lbernick reviewed Mar 11, 2022

View reviewed changes

afrittoli force-pushed the run_events branch from bfa77be to 222d2eb Compare March 14, 2022 11:10

afrittoli force-pushed the run_events branch from 222d2eb to 6fea418 Compare March 14, 2022 11:11

tekton-robot assigned lbernick Mar 14, 2022

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

tekton-robot merged commit e4ce133 into tektoncd:main Mar 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CloudEvents for Run definitions #4659

Add CloudEvents for Run definitions #4659

afrittoli commented Mar 10, 2022 •

edited

tekton-robot commented Mar 10, 2022

tekton-robot commented Mar 10, 2022

afrittoli commented Mar 10, 2022

tekton-robot commented Mar 11, 2022

tekton-robot commented Mar 11, 2022

afrittoli commented Mar 11, 2022

afrittoli commented Mar 11, 2022

lbernick Mar 11, 2022

afrittoli Mar 11, 2022

lbernick Mar 11, 2022 •

edited

afrittoli Mar 11, 2022

lbernick Mar 11, 2022

lbernick Mar 11, 2022

afrittoli Mar 11, 2022

pritidesai Mar 11, 2022

afrittoli Mar 14, 2022

tekton-robot commented Mar 14, 2022

afrittoli commented Mar 14, 2022

lbernick commented Mar 14, 2022

Add CloudEvents for Run definitions #4659

Add CloudEvents for Run definitions #4659

Conversation

afrittoli commented Mar 10, 2022 • edited

Changes

Submitter Checklist

Release Notes

tekton-robot commented Mar 10, 2022

tekton-robot commented Mar 10, 2022

afrittoli commented Mar 10, 2022

tekton-robot commented Mar 11, 2022

tekton-robot commented Mar 11, 2022

afrittoli commented Mar 11, 2022

afrittoli commented Mar 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lbernick Mar 11, 2022 • edited

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 Mar 14, 2022

afrittoli commented Mar 14, 2022

lbernick commented Mar 14, 2022

afrittoli commented Mar 10, 2022 •

edited

lbernick Mar 11, 2022 •

edited