Ability to run Code Coverage locally with Gradle

[prudhvigodithi]

Description

• Ability to run code coverage locally.
• Run code coverage for integrationTest, test and javaRestTest (coming from this Fips smoke test #18376 looks like javaRestTest is not added)
• Run for specific Gradle module.
• Run for specific test class and method.

Related Issues

While I'm working on this PR #18358, I noticed that GitHub reports code coverage only after the Gradle Check workflow passes. Being able to run coverage reports locally using Gradle can help test and improve coverage earlier in the development cycle. Although IntelliJ provides some insights, using Gradle with the JaCoCo plugin ensures consistency with the coverage reported by GitHub.

Check List

• Functionality includes testing.
• API changes companion pull request created, if applicable.
• Public documentation issue/PR created, if applicable.

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.

[prudhvigodithi]

Adding @andrross @reta @cwperks @getsaurabh02

[cwperks]

Run code coverage for integrationTest, test and javaRestTest (coming from this #18376 looks like javaRestTest is not added)

🙌 Thank you Prudvhi! CC: @beanuwave

[prudhvigodithi]

Coming from https://github.com/opensearch-project/opensearch-build/blob/main/jenkins/gradle/gradle-check.jenkinsfile#L154 I'm also testing locally to see if ./gradlew check -Dtests.coverage=true continue to give the consolidated reports including javaRestTest.

[cwperks]

Can we add a CHANGELOG entry? Even if this is a developer centric PR I think its worth noting in the release notes that jacoco reports can now be produced locally.

[prudhvigodithi]

Can we add a CHANGELOG entry? Even if this is a developer centric PR I think its worth noting in the release notes that jacoco reports can now be produced locally.

Sure let me do that

[github-actions]

❌ Gradle check result for 22bc43d: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❌ Gradle check result for 22bc43d: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❌ Gradle check result for 1903747: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❌ Gradle check result for 1903747: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❌ Gradle check result for 3b58396: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

❌ Gradle check result for 3b58396: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

[github-actions]

✅ Gradle check result for 3b58396: SUCCESS

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.80%. Comparing base (3078649) to head (3b58396).
Report is 16 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #18509      +/-   ##
============================================
+ Coverage     72.64%   72.80%   +0.16%     
- Complexity    68070    68171     +101     
============================================
  Files          5537     5537              
  Lines        313404   313404              
  Branches      45476    45476              
============================================
+ Hits         227658   228165     +507     
+ Misses        67241    66728     -513     
- Partials      18505    18511       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[prudhvigodithi]

Coming from https://app.codecov.io/gh/opensearch-project/OpenSearch/tree/main/qa%2Fdie-with-dignity%2Fsrc%2Fmain%2Fjava%2Forg%2Fopensearch I can no see some coverage of yamlRestTest for :qa:die-with-dignity. CC @cwperks