Update README for distribution level BWC tests #3645
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Zelin Hao <[email protected]>
zelinh
requested review from
dblock,
peterzhuamazon,
bbarani,
gaiksaya,
rishabh6788,
jordarlu,
prudhvigodithi,
Divyaasm and
tianleh
as code owners
Codecov Report
@@ Coverage Diff @@
## main #3645 +/- ##
=======================================
Coverage 91.48% 91.48%
=======================================
Files 181 181
Lines 5381 5381
=======================================
Hits 4923 4923
Misses 458 458 |
gaiksaya
reviewed
Jun 21, 2023
src/test_workflow/README.md
Outdated
|
|
||
| The BWC tests running on distribution level are using the same framework from OpenSearch. The test cluster is spin up with the `latest` distribution bundle of provided version exclusively when the project is initialized with property `-PcustomDistributionDownloadType=bundle`. | ||
|
|
||
| The distribution bundle will be obtained with this format URL: `https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.2/latest/linux/x64/tar/dist/opensearch/opensearch-1.3.2-linux-x64.tar.gz` |
There was a problem hiding this comment.
Suggested change
| The distribution bundle will be obtained with this format URL: `https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.2/latest/linux/x64/tar/dist/opensearch/opensearch-1.3.2-linux-x64.tar.gz` | |
| The distribution bundle (for example tarball) will be obtained with this sample URL: `https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.2/latest/linux/x64/tar/dist/opensearch/opensearch-1.3.2-linux-x64.tar.gz` |
There was a problem hiding this comment.
@gaiksaya Thanks for review. However, I think our BWC distribution test are hardcoded right now to only support tarball distribution because of the framework we used from the OpenSearch repo.
There was a problem hiding this comment.
I see! Maybe then just say:
Example distribution bundle URL: https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.2/latest/linux/x64/tar/dist/opensearch/opensearch-1.3.2-linux-x64.tar.gz
src/test_workflow/README.md
Outdated
| @@ -110,6 +110,17 @@ To run OpenSearch Dashboards BWC tests. | |||
| opensearch-dashboards=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch-dashboards/1.3.5/4056/linux/x64/tar | |||
| ``` | |||
|
|
|||
| #### BWC tests on distribution bundle level | |||
|
|
|||
| The BWC tests running on distribution level are using the same framework from OpenSearch. The test cluster is spin up with the `latest` distribution bundle of provided version exclusively when the project is initialized with property `-PcustomDistributionDownloadType=bundle`. | |||
There was a problem hiding this comment.
Should this be when gradle task is run with customDistributionDownloadType property?
There was a problem hiding this comment.
There was a problem hiding this comment.
Maybe attach the mentioned script then if anyone wants to reproduce.
There was a problem hiding this comment.
Just updated. Please help take a look again. Thanks.
Signed-off-by: Zelin Hao <[email protected]>
gaiksaya
reviewed
Jun 22, 2023
src/test_workflow/README.md
Outdated
| The BWC tests running on distribution level are using the same framework from OpenSearch. The test cluster is spin up with the `latest` distribution bundle of provided version exclusively when the project is initialized with property `-PcustomDistributionDownloadType=bundle`. In this repo, the test workflow will be enable this gradle property by default.[BWC test script](https://github.com/opensearch-project/opensearch-build/blob/edffab782abf96390b3993ccc92425c63ab77884/scripts/default/bwctest.sh#L38) | ||
|
|
||
| Example distribution bundle URL: `https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.2/latest/linux/x64/tar/dist/opensearch/opensearch-1.3.2-linux-x64.tar.gz` | ||
| This URL pattern starts to be supported as far as `v1.3.2` so The distribution bundle set up in the test cluster can be all versions after version `v1.3.2`. |
There was a problem hiding this comment.
Suggested change
| This URL pattern starts to be supported as far as `v1.3.2` so The distribution bundle set up in the test cluster can be all versions after version `v1.3.2`. | |
| This feature for BWC testing is supported for distribution versions starting 1.3.2 |
Signed-off-by: Zelin Hao <[email protected]>
gaiksaya
approved these changes
Jun 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update README in our test workflow for the distribution level BWC tests
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.