Skip to content

Commit 2a55a2a

Browse files
Update DEVELOPER_GUIDE.md to add gradle-check-flaky-test-detector automation information (opensearch-project#14417)
Signed-off-by: Prudhvi Godithi <pgodithi@amazon.com>
1 parent 3a0c0c0 commit 2a55a2a

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

DEVELOPER_GUIDE.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -651,16 +651,18 @@ Note that these snapshots do not follow the Maven [naming convention](https://ma
651651

652652
### Flaky Tests
653653

654-
OpenSearch has a very large test suite with long running, often failing (flaky), integration tests. Such individual tests are labelled as [Flaky Random Test Failure](https://github.com/opensearch-project/OpenSearch/issues?q=is%3Aopen+is%3Aissue+label%3A%22flaky-test%22). Your help is wanted fixing these!
654+
If you encounter a test failure locally or in CI that is seemingly unrelated to the change in your pull request, it may be a known flaky test or a new test failure. OpenSearch has a very large test suite with long running, often failing (flaky), integration tests. Such individual tests are labelled as [Flaky Random Test Failure](https://github.com/opensearch-project/OpenSearch/issues?q=is%3Aopen+is%3Aissue+label%3A%22flaky-test%22). Your help is wanted fixing these!
655655

656-
If you encounter a build/test failure in CI that is unrelated to the change in your pull request, it may be a known flaky test, or a new test failure.
656+
The automation [gradle-check-flaky-test-detector](https://build.ci.opensearch.org/job/gradle-check-flaky-test-detector/), which runs in OpenSearch public Jenkins, identifies failing flaky issues that are part of post-merge actions. Once a flaky test is identified, the automation creates an issue with detailed report that includes links to all relevant commits, the Gradle check build log, the test report, and pull requests that are impacted with the flaky test failures. This automation leverages data from the [OpenSearch Metrics Project](https://github.com/opensearch-project/opensearch-metrics) to establish a baseline for creating the issue and updating the flaky test report. For all flaky test issues created by automation, visit this [link](https://github.com/opensearch-project/OpenSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%3Etest-failure+author%3Aopensearch-ci-bot).
657+
658+
If you still see a failing test that is not part of the post merge actions, please do:
659+
660+
* Follow failed CI links, and locate the failing test(s) or use the [Gradle Check Metrics Dashboard](#gradle-check-metrics-dashboard).
661+
* Copy-paste the failure into a comment of your PR.
662+
* Search through issues using the name of the failed test for whether this is a known flaky test.
663+
* If no existing issue is found, open one.
664+
* Retry CI via the GitHub UX or by pushing an update to your PR.
657665

658-
1. Follow failed CI links, and locate the failing test(s).
659-
2. Copy-paste the failure into a comment of your PR.
660-
3. Search through [issues](https://github.com/opensearch-project/OpenSearch/issues?q=is%3Aopen+is%3Aissue+label%3A%22flaky-test%22) using the name of the failed test for whether this is a known flaky test.
661-
4. If an existing issue is found, paste a link to the known issue in a comment to your PR.
662-
5. If no existing issue is found, open one.
663-
6. Retry CI via the GitHub UX or by pushing an update to your PR.
664666

665667
### Gradle Check Metrics Dashboard
666668

0 commit comments

Comments
 (0)