NO-JIRA: Add docs about places running e2e tests#1312
NO-JIRA: Add docs about places running e2e tests#1312hongkailiu wants to merge 1 commit intoopenshift:mainfrom
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@hongkailiu: This pull request explicitly references no jira issue. DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
WalkthroughAdds a new documentation section to the cluster-version-operator README explaining how to run tests together with payload testing by combining CVO conformance suites as extensions and provides guidance for handling different cluster types like MicroShift and HyperShift. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hongkailiu The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@cmd/cluster-version-operator-tests/README.md`:
- Line 78: Typo: change the product name "MiscroShift" to "MicroShift" in the
README; locate the misspelling in the README text and replace the single-word
typo, then scan for and correct any other occurrences project-wide (e.g., README
and docs). Make the change where the sentence referencing utility functions
appears and ensure surrounding grammar is preserved; as a sanity check, run a
quick grep for "MiscroShift" and verify the correct spelling is used everywhere
(you can cross-check with the utility functions referenced in test/cvo/cvo.go to
confirm the intended product name).
🧹 Nitpick comments (1)
cmd/cluster-version-operator-tests/README.md (1)
77-77: Use descriptive link text for better accessibility and readability.The paragraph uses "here" as link text twice, which is not descriptive. Screen readers and users scanning the document benefit from link text that describes the destination or purpose.
Consider replacing with more descriptive text such as:
- "by joining CVO's test suite... as children (see implementation)"
- "and register them as extension (see registration)"
| ## Run together with payload testing | ||
|
|
||
| By joining CVO's test suite `openshift/cluster-version-operator/conformance/parallel` and `openshift/cluster-version-operator/conformance/serial` as children [here](https://github.com/openshift/cluster-version-operator/blob/f25054a5800a34e3fd596b5d9a2c6c1bb5f5f628/cmd/cluster-version-operator-tests/main.go#L23-L38) and register them as extension [here](https://github.com/openshift/origin/blob/e3f443af6b2fd61a33ed8d060eb9083333ef426b/pkg/test/extensions/binary.go#L258-L261), the e2e testcases developed here in this repo will be executed in more tests than the ones defined in Presubmits for CVO's CI. For example, they will be running with [payload testing](https://docs.ci.openshift.org/docs/release-oversight/payload-testing/). | ||
| In order to avoid breaking the OpenShift release, it is suggested to start with skipping new testcases on MiscroShift, HyperShift unless they are verified. We may add them in as needed later. There are [utility functions](https://github.com/openshift/cluster-version-operator/blob/f25054a5800a34e3fd596b5d9a2c6c1bb5f5f628/test/cvo/cvo.go#L62-L66) that help determine the cluster type. |
There was a problem hiding this comment.
Fix typo: "MiscroShift" → "MicroShift".
The product name is misspelled as "MiscroShift" when it should be "MicroShift".
📝 Proposed fix
-In order to avoid breaking the OpenShift release, it is suggested to start with skipping new testcases on MiscroShift, HyperShift unless they are verified. We may add them in as needed later. There are [utility functions](https://github.com/openshift/cluster-version-operator/blob/f25054a5800a34e3fd596b5d9a2c6c1bb5f5f628/test/cvo/cvo.go#L62-L66) that help determine the cluster type.
+In order to avoid breaking the OpenShift release, it is suggested to start with skipping new testcases on MicroShift, HyperShift unless they are verified. We may add them in as needed later. There are [utility functions](https://github.com/openshift/cluster-version-operator/blob/f25054a5800a34e3fd596b5d9a2c6c1bb5f5f628/test/cvo/cvo.go#L62-L66) that help determine the cluster type.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| In order to avoid breaking the OpenShift release, it is suggested to start with skipping new testcases on MiscroShift, HyperShift unless they are verified. We may add them in as needed later. There are [utility functions](https://github.com/openshift/cluster-version-operator/blob/f25054a5800a34e3fd596b5d9a2c6c1bb5f5f628/test/cvo/cvo.go#L62-L66) that help determine the cluster type. | |
| In order to avoid breaking the OpenShift release, it is suggested to start with skipping new testcases on MicroShift, HyperShift unless they are verified. We may add them in as needed later. There are [utility functions](https://github.com/openshift/cluster-version-operator/blob/f25054a5800a34e3fd596b5d9a2c6c1bb5f5f628/test/cvo/cvo.go#L62-L66) that help determine the cluster type. |
🧰 Tools
🪛 LanguageTool
[grammar] ~78-~78: Ensure spelling is correct
Context: ...to start with skipping new testcases on MiscroShift, HyperShift unless they are verified. We...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In `@cmd/cluster-version-operator-tests/README.md` at line 78, Typo: change the
product name "MiscroShift" to "MicroShift" in the README; locate the misspelling
in the README text and replace the single-word typo, then scan for and correct
any other occurrences project-wide (e.g., README and docs). Make the change
where the sentence referencing utility functions appears and ensure surrounding
grammar is preserved; as a sanity check, run a quick grep for "MiscroShift" and
verify the correct spelling is used everywhere (you can cross-check with the
utility functions referenced in test/cvo/cvo.go to confirm the intended product
name).
|
@hongkailiu: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
/cc @JianLi-RH We talked about this in our meeting today. PTAL. |
|
|
||
| ## Run together with payload testing | ||
|
|
||
| By joining CVO's test suite `openshift/cluster-version-operator/conformance/parallel` and `openshift/cluster-version-operator/conformance/serial` as children [here](https://github.com/openshift/cluster-version-operator/blob/f25054a5800a34e3fd596b5d9a2c6c1bb5f5f628/cmd/cluster-version-operator-tests/main.go#L23-L38) and register them as extension [here](https://github.com/openshift/origin/blob/e3f443af6b2fd61a33ed8d060eb9083333ef426b/pkg/test/extensions/binary.go#L258-L261), the e2e testcases developed here in this repo will be executed in more tests than the ones defined in Presubmits for CVO's CI. For example, they will be running with [payload testing](https://docs.ci.openshift.org/docs/release-oversight/payload-testing/). |
There was a problem hiding this comment.
@hongkailiu Could you let me know what does the e2e testcases developed here in this repo will be executed in more tests than the ones defined in Presubmits for CVO's CI mean?
more tests means more test places/tools?
3 participants
No description provided.