Add onboarding doc for smoke tests #5283
Conversation
Signed-off-by: Zelin Hao <[email protected]>
zelinh
requested review from
dblock,
peterzhuamazon,
gaiksaya,
rishabh6788,
prudhvigodithi,
Divyaasm and
tianleh
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5283 +/- ##
==========================================
- Coverage 92.06% 92.04% -0.03%
==========================================
Files 202 202
Lines 7017 7036 +19
==========================================
+ Hits 6460 6476 +16
- Misses 557 560 +3 ☔ View full report in Codecov by Sentry. |
ONBOARDING.md
Outdated
|
|
||
| 2. You will need to add a distinct YAML file for your plugin in the appropriate major version directory under [smoke_tests_spec](src/test_workflow/smoke_test/smoke_tests_spec) and reference the file name in the test manifest for the corresponding component. | ||
|
|
||
| 3. In the YAML file, specify the API path, HTTP method, request body as parameter and heading if `Content-Type` differs from the default `application/json`. Refer to an example test definition [here](src/test_workflow/smoke_test/smoke_tests_spec/2.x/opensearch.yml) for guidance. |
There was a problem hiding this comment.
Do we want to also point to api-specification repo guidelines for on-boarding?
There was a problem hiding this comment.
I believe we assume that plugins should already be onboarded to the API-spec repo and follow their own onboarding procedures. This isn't just specific to the smoke tests framework.
There was a problem hiding this comment.
@dblock is that a requirement for new plugins/components from api-specification side?
There was a problem hiding this comment.
There is an ongoing issue in api-spec repo for adding missing API specs. opensearch-project/opensearch-api-specification#168
Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: Zelin Hao <[email protected]>
Description
Add smoke tests framework onboarding guide for plugins.
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.