-
Notifications
You must be signed in to change notification settings - Fork 149
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
Onboard OpenSearch plugins to Smoke tests framework #3541
Comments
@zelinh is there a timeline we are targeting for onboarding? |
Sounds a good way to automate our manual sanity test |
We are targeting this to be onboarded by 3.0.0 release. |
Hi @mingshl can you please assign this to me. |
@mingshl @dhrubo-os, can we close this issue. |
Thanks @rithin-pullela-aws for taking this up! closed this issue and marked as done |
Sub-issue from opensearch-project/opensearch-build#5317
Background
With the smoke test framework (#5223) now established, we have successfully onboarded multiple OpenSearch plugins—including Index Management, Security, SQL, and K-NN—to the framework (PR #5255).
To maximize the effectiveness of smoke testing, we aim to onboard all OpenSearch plugins into the framework. This effort will enhance overall testing coverage, ensuring greater reliability and functionality validation for OpenSearch and its plugins.
Overview of Smoke Tests
Smoke tests verify the basic functionality of an OpenSearch distribution bundle with all plugins installed. Each plugin has its own test specification YAML file, stored in the OpenSearch Build repository and organized by major version.
These YAML files list API test cases, which the smoke test workflow executes. The results are then validated against the OpenSearch API Specification to ensure API correctness and expected behavior.
How to Onboard a Plugin
To onboard your plugin to the smoke test framework, follow the Onboarding Guide.
Steps to Onboard:
Add a YAML test file
Define API tests in the YAML file
Content-Type
header if different fromapplication/json
.Ensure the APIs are onboarded to the OpenSearch API Specification repository
Reference the test file in the test manifest
Collaboration with Plugin Owners:
We are reaching out to all OpenSearch plugin owners to facilitate onboarding. We will provide:
✅ Documentation and guidelines for onboarding.
✅ Support in setting up test cases.
✅ Assistance in troubleshooting issues.
Expected Outcome:
📢 Plugin owners: We encourage you to onboard your plugin to the smoke test framework! If you have any questions or need assistance, feel free to comment on this issue or reach out to EE team.
Let’s work together to strengthen OpenSearch’s testing and release process! 🚀
The text was updated successfully, but these errors were encountered: