Update README for smoke tests with usages and examples #5244
Conversation
Signed-off-by: Zelin Hao <zelinhao@amazon.com>
Signed-off-by: Zelin Hao <zelinhao@amazon.com>
zelinh
requested review from
dblock,
peterzhuamazon,
gaiksaya,
rishabh6788,
prudhvigodithi,
Divyaasm and
tianleh
as code owners
src/test_workflow/README.md
Outdated
| @@ -290,6 +315,14 @@ After the performance test completes, it will report back the test results as we | |||
|
|
|||
| The development is tracked by meta issue [#126](https://github.com/opensearch-project/opensearch-build/issues/126) | |||
|
|
|||
| #### smokeTest job | |||
|
|
|||
| It is a Jenkins job designed to run smoke tests on bundle artifacts. It retrieves the bundle artifacts using the provided manifest URL parameter and spins up a cluster with all plugins installed. The cluster is deployed using the default configuration without any customizations. Smoke tests for all components are executed sequentially, and the results are returned at the end. | |||
There was a problem hiding this comment.
| It is a Jenkins job designed to run smoke tests on bundle artifacts. It retrieves the bundle artifacts using the provided manifest URL parameter and spins up a cluster with all plugins installed. The cluster is deployed using the default configuration without any customizations. Smoke tests for all components are executed sequentially, and the results are returned at the end. | |
| It is a Jenkins job designed to run smoke tests on distribution artifacts. It retrieves the distribution artifacts using the provided manifest URL parameter and spins up a cluster with all plugins installed. The cluster is deployed using the default configuration without any customization. Smoke tests for all components are executed sequentially, and the results are returned at the end. |
There was a problem hiding this comment.
Is the cluster cleaned up after every component?
There was a problem hiding this comment.
Updated based on suggestions. Thanks.
Is the cluster cleaned up after every component?
No. We will only clean up after all components test completed.
There was a problem hiding this comment.
That might cause conflicts right?
There was a problem hiding this comment.
We have test requirements that if it causes conflicts, we shouldn't add it into the framework.
There was a problem hiding this comment.
I dont think that is feasible in the long term. Adding @prudhvigodithi @rishabh6788 @peterzhuamazon to get some more inputs.
There was a problem hiding this comment.
Our current design involves spinning up a single cluster and accommodating non-conflicting smoke test cases for multiple plugins. Perhaps we could create a separate issue to discuss this further?
There was a problem hiding this comment.
Please create an issue to discuss this. We can move forward with merge.
There was a problem hiding this comment.
Cut an enhancement issue here. We may revisit it to analyze its benefits further.
#5274
Signed-off-by: Zelin Hao <zelinhao@amazon.com>
Description
Update README for smoke tests with usages and examples
Issues Resolved
Part of #5223
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.