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.

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

KEP template: enhance suggestions for integration and e2e tests #5077

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pohly
Copy link
Contributor

@pohly pohly commented Jan 23, 2025

The template gives the impression that both integration and e2e tests must be written. Let's be a bit more flexible and document that feature owners can opt out of that if it makes sense.

Linking to the triage tool is not sufficient. We want an empty result there, but that could also have been caused by not running the tests at all. A link to the periodic job which included the tests is more important.

To ensure more consistency, the suggested bullet list gets extended to be more realistic. Otherwise feature owners have to guess how they are meant to fill in the placeholders.

This was triggered by the discussion in #5035 (comment).

/sig testing
/cc @aojea @BenTheElder

@k8s-ci-robot k8s-ci-robot added sig/testing Categorizes an issue or PR as relevant to SIG Testing. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 23, 2025
Copy link
Member

@BenTheElder BenTheElder left a comment

Choose a reason for hiding this comment

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

Let's add a reference to the testing strategy doc in git.k8s.io/kubernetes/community ?

@pohly pohly force-pushed the kep-template-tests branch from 927d48e to f8851a6 Compare January 23, 2025 11:28
The template gives the impression that both integration and e2e tests must be
written. Let's be a bit more flexible and document that feature owners can opt
out of that if it makes sense.

Linking to the triage tool is not sufficient. We want an empty result there,
but that could also have been caused by not running the tests at all. A link to
the periodic job which included the tests is more important.

To ensure more consistency, the suggested bullet list gets extended to be more
realistic. Otherwise feature owners have to guess how they are meant to fill in
the placeholders.
@pohly pohly force-pushed the kep-template-tests branch from f8851a6 to 9f589f6 Compare January 23, 2025 14:50
@@ -308,31 +308,43 @@ Integration tests are contained in k8s.io/kubernetes/test/integration.
Integration tests allow control of the configuration parameters used to start the binaries under test.
This is different from e2e tests which do not allow configuration of parameters.
Doing this allows testing non-default options and multiple different and potentially conflicting command line options.
For more details, see https://github.com/kubernetes/community/blob/master/contributors/devel/sig-testing/testing-strategy.md
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's add a reference to the testing strategy doc in git.k8s.io/kubernetes/community ?

Added here because it already talked about integration and e2e testing.

@xing-yang
Copy link
Contributor

xing-yang commented Jan 23, 2025

Thanks @pohly for this enhancement!
/lgtm

@xing-yang
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 23, 2025
@pohly
Copy link
Contributor Author

pohly commented Jan 24, 2025

/assign @jeremyrickard

For approval.

Updating the template won't get mirrored in existing KEPs, so it will be useful to notify at least the leads of this update for consideration in future KEP graduations. Perhaps even all Kubernetes devs?

@kikisdeliveryservice kikisdeliveryservice added the area/enhancements Issues or PRs related to the Enhancements subproject label Feb 7, 2025
@kikisdeliveryservice
Copy link
Member

Since enhancements freeze is next week, let's wait until that closes to merge a change to the template - that way we have a clear start release for the change and limit confusion..

We will also highlight it again for the next release.

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 7, 2025
@kikisdeliveryservice kikisdeliveryservice self-assigned this Feb 7, 2025
@aojea
Copy link
Member

aojea commented Feb 9, 2025

LGTM

Copy link
Contributor

@soltysh soltysh left a comment

Choose a reason for hiding this comment

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

I support this change, as one of the PRR reviewers, I struggle a lot explaining authors what the expectation for links to triage boards and source code should look like. This will definitely help. Thanks Patrick!

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: pohly, soltysh
Once this PR has been reviewed and has the lgtm label, please ask for approval from jeremyrickard. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/enhancements Issues or PRs related to the Enhancements subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/testing Categorizes an issue or PR as relevant to SIG Testing. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants