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

Cross-version API Compatibility - Follow up changes on test results and additional tests #26

Merged

Conversation

mpanchajanya
Copy link
Contributor

@mpanchajanya mpanchajanya commented Mar 14, 2023

What this PR does / why we need it

Follow up PR addresses

  • Reduce verbose noise in Tests.
  • Added COMPATIBILITY_TEST_VERBOSE configurable variable to run compatibility tests.
  • Added Documentation for test results and outputs
  • Test Output in the GH workflow will display all API test suites that are run.
  • Added Context API tests involving multiple context objects.
  • Added Combination tests for Context and Server APIs.

Which issue(s) this PR fixes

Fixes #

Describe testing done for PR

  • Run Unit tests for test/compatibility
  • Build and Run compatibility tests using below command and make sure all tests pass
    make compatibility-tests

Output:
Screenshot 2023-03-22 at 19 48 07

More details on test output can be found from the Github workflow that is run on the PR https://github.com/vmware-tanzu/tanzu-plugin-runtime/actions/runs/4495795430/jobs/7909811037?pr=26

For more details on Cross-version API compatibility testing refer to https://github.com/vmware-tanzu/tanzu-plugin-runtime/blob/main/test/compatibility/docs/cross-version-api-compatibility.md

Release note


Additional information

Special notes for your reviewer

@mpanchajanya mpanchajanya marked this pull request as ready for review March 14, 2023 03:14
@mpanchajanya mpanchajanya requested a review from a team as a code owner March 14, 2023 03:14
@mpanchajanya mpanchajanya force-pushed the compatibility_tests_results branch 12 times, most recently from 0f2b32f to 51ec95e Compare March 22, 2023 23:43
Makefile Outdated
cd ./test/compatibility/framework/compatibilitytests && ${GINKGO} --keep-going --fail-fast --race -r --randomize-all --trace --output-dir ./../../../../testresults --junit-report compatibility-tests.xml; \

.PHONY: debug-compatibility-tests
debug-compatibility-tests: ## Run Compatibility tests
Copy link
Contributor

Choose a reason for hiding this comment

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

My preference, to reduce duplication, and so the developer doesn't have to deal with multiple targets, is to use a variable to control -v or not, not unlike what is used in https://github.com/vmware-tanzu/tanzu-cli/blob/main/Makefile#L198

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the scripts

@mpanchajanya mpanchajanya changed the title Cross-version API Compatibility tests results Cross-version API Compatibility - Follow up changes on test results and additional tests Mar 23, 2023
@mpanchajanya mpanchajanya requested a review from vuil March 23, 2023 00:36
Makefile Outdated
context-api-compatibility-tests: ## Run Compatibility tests
${GO} test `go list ./test/compatibility/framework/compatibilitytests/context...` -v -timeout 60m -race;\

cd ./test/compatibility/framework/compatibilitytests && ${GINKGO} --keep-going --fail-fast --race -r --randomize-all --trace --output-dir ./../../../../testresults --junit-report compatibility-tests.xml; \
Copy link
Contributor

Choose a reason for hiding this comment

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

what happened to the equivalent of debug-compatibility-tests?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added debug-compatibility-tests with ${GOTEST_VERBOSE}

Copy link
Contributor

Choose a reason for hiding this comment

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

What I meant, in an earlier comment, was to update run-compatibility-tests to take a flag that is configurable.
If that flag is not ${GOTEST_VERBOSE} because the default value does not match the default behavior, then create one for the compat tests.

Copy link
Contributor

@vuil vuil left a comment

Choose a reason for hiding this comment

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

lgtm, thanks for the updates. Just a small markdown nit.

| Client Options APIs | TBA | TBA | TBA | TBA |
| Repositories APIs | TBA | TBA | TBA | TBA |

- For the latest test results check the most recent job that is run for the workflow [Tanzu Plugin Runtime Cross-version API Compatibility Tests](https://github.com/vmware-tanzu/tanzu-plugin-runtime/actions/workflows/compatibility_tests.yaml?query=branch%3Amain)
Copy link
Contributor

Choose a reason for hiding this comment

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

let see as a followup if we can make the results more accessible. Even if I bookmark the link it takes 4 clicks just to get to what the results.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a JIRA to track this changes. https://jira.eng.vmware.com/browse/TANZUCLI-409


- For the latest test results check the most recent job that is run for the workflow [Tanzu Plugin Runtime Cross-version API Compatibility Tests](https://github.com/vmware-tanzu/tanzu-plugin-runtime/actions/workflows/compatibility_tests.yaml?query=branch%3Amain)

*TBA - to be added in future sprints
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: space after *

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added space

@mpanchajanya mpanchajanya merged commit a110e57 into vmware-tanzu:main Mar 24, 2023
@marckhouzam marckhouzam added this to the v0.90.0 milestone Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants