Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor events to decouple k8s event and cloud event #5817

Merged
merged 1 commit into from
Dec 2, 2022
Merged

Refactor events to decouple k8s event and cloud event #5817

merged 1 commit into from
Dec 2, 2022

Conversation

Yongxuanzhang
Copy link
Member

@Yongxuanzhang Yongxuanzhang commented Nov 30, 2022 •
edited
Loading

Changes

This commit refactors the code in events to decouple the k8s events emit
and cloud events emit. This commit fixes #4404. This could avoid circular dependencies. The events in test is also moved to k8sevent pkg.
This also pave the path for #5770

/kind cleanup

Submitter Checklist

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

  • Has Docs included if any changes are user facing
  • 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)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot
Copy link
Collaborator

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

@tekton-robot tekton-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none Denotes a PR that doesnt merit a release note. labels Nov 30, 2022
@tekton-robot tekton-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Nov 30, 2022
@Yongxuanzhang Yongxuanzhang marked this pull request as ready for review November 30, 2022 20:26
@tekton-robot 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 Nov 30, 2022
@tekton-robot
Copy link
Collaborator

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/cloud_event_controller.go 88.7% 78.9% -9.8
pkg/reconciler/events/event.go 93.3% 100.0% 6.7
pkg/reconciler/events/k8sevent/event.go Do not exist 100.0%
pkg/reconciler/events/k8sevent/events.go Do not exist 73.9%

@tekton-robot
Copy link
Collaborator

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/cloud_event_controller.go 88.7% 78.9% -9.8
pkg/reconciler/events/event.go 93.3% 100.0% 6.7
pkg/reconciler/events/k8sevent/event.go Do not exist 100.0%
pkg/reconciler/events/k8sevent/events.go Do not exist 73.9%

@Yongxuanzhang
Copy link
Member Author

cc @lbernick

@tekton-robot
Copy link
Collaborator

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/cloud_event_controller.go 88.7% 78.9% -9.8
pkg/reconciler/events/event.go 93.3% 100.0% 6.7
pkg/reconciler/events/k8sevent/event.go Do not exist 100.0%
pkg/reconciler/events/k8sevent/events.go Do not exist 73.9%

@lbernick lbernick self-assigned this Nov 30, 2022
Yongxuanzhang
Yongxuanzhang commented Nov 30, 2022
View reviewed changes
pkg/reconciler/events/cloudevent/cloud_event_controller.go
}

// EmitCloudEventsWhenConditionChange emits CloudEvents when there is a change in condition
func EmitCloudEventsWhenConditionChange(ctx context.Context, beforeCondition *apis.Condition, afterCondition *apis.Condition, object runtime.Object) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we should merge this function with EmitCloudEvents, the only difference is to check the condition.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok to do that in a separate PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

lbernick
lbernick approved these changes Dec 1, 2022
View reviewed changes
pkg/reconciler/events/cloudevent/cloud_event_controller.go
}

// EmitCloudEventsWhenConditionChange emits CloudEvents when there is a change in condition
func EmitCloudEventsWhenConditionChange(ctx context.Context, beforeCondition *apis.Condition, afterCondition *apis.Condition, object runtime.Object) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok to do that in a separate PR.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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:

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 1, 2022
@tekton-robot
Copy link
Collaborator

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/cloud_event_controller.go 88.7% 78.9% -9.8
pkg/reconciler/events/event.go 93.3% 100.0% 6.7
pkg/reconciler/events/k8sevent/event.go Do not exist 100.0%
pkg/reconciler/events/k8sevent/events.go Do not exist 73.9%

@dibyom
Copy link
Member

dibyom commented Dec 1, 2022

@Yongxuanzhang can we add ad test for EmitCloudEventsWhenConditionChange?

@Yongxuanzhang
Copy link
Member Author

Yongxuanzhang commented Dec 1, 2022 •
edited
Loading

@Yongxuanzhang can we add ad test for EmitCloudEventsWhenConditionChange?

Sure! It is actually tested from the Emit() function, is it ok to just copy some test cases there?
I moved the cloud event test case there

@Yongxuanzhang
Refactor events to decouple k8s event and cloud event
3b1b392 
This commit refactors the code in events to decouple the k8s events emit
and cloud events emit. This commit fixes tektoncd#4404.
@tekton-robot
Copy link
Collaborator

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/cloud_event_controller.go 88.7% 88.9% 0.2
pkg/reconciler/events/event.go 93.3% 100.0% 6.7
pkg/reconciler/events/k8sevent/event.go Do not exist 100.0%
pkg/reconciler/events/k8sevent/events.go Do not exist 73.9%

@dibyom
Copy link
Member

dibyom commented Dec 2, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 2, 2022
@tekton-robot tekton-robot merged commit 09c7285 into tektoncd:main Dec 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lbernick lbernick lbernick approved these changes

@afrittoli afrittoli Awaiting requested review from afrittoli

@jerop jerop Awaiting requested review from jerop

@imjasonh imjasonh Awaiting requested review from imjasonh

Assignees

@dibyom dibyom

@lbernick lbernick

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Refactor reconciler events package to separate events and cloudevents
4 participants
@Yongxuanzhang @tekton-robot @dibyom @lbernick