Skip to content

Commit ba3a605

Browse files
authored
[Docs] Adds testing requirements for PR's (opensearch-project#5950)
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
1 parent d1dd85b commit ba3a605

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

TESTING.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,17 @@ Overview
1414
- [Misc](#misc)
1515

1616
# General information
17-
OpenSearch Dashboards uses [Jest](https://jestjs.io/) for unit and integration tests, [Selenium](https://www.selenium.dev/) for functional tests, and [Cypress](https://www.cypress.io/) for backwards compatibility tests.
17+
OpenSearch Dashboards uses [Jest](https://jestjs.io/) for unit and integration tests, [Cypress](https://www.cypress.io/) for backwards compatibility tests and functional tests and [Selenium](https://www.selenium.dev/) for some legacy functional tests (Tests should no longer be written in Selenium).
1818

1919
In general, we recommend four tiers of tests:
2020
* Unit tests: Unit tests: small and modular tests that utilize mocks for external dependencies.
2121
* Integration tests: higher-level tests that verify interactions between systems (eg. HTTP APIs, OpenSearch API calls, calling other plugin).
2222
* End-to-end tests (e2e): functional tests that verify behavior in a web browser.
23-
* Backwards Compatibility tests: cypress tests that verify any changes are backwards compatible with previous versions.
23+
* Backwards Compatibility tests: tests that verify any changes are backwards compatible with previous versions.
24+
25+
> Contributors submitting pull requests (PRs) to the codebase are required to ensure that their code changes include appropriate testing coverage. This includes, but is not limited to, unit tests, integration tests, functional tests, and backwards compatibility tests where applicable.
26+
> It is the responsibility of the contributor to verify that their code changes do not introduce regressions or break existing functionality. PRs lacking sufficient testing coverage may be subject to delays in review or rejection until adequate tests are provided.
27+
2428

2529
# Requirements
2630
* Install the latest NodeJS, [NPM](https://www.npmjs.com/get-npm) and [Yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable)

0 commit comments

Comments
 (0)