Add more identifiers to gradle-check job webhook payload #12938

rishabh6788 · 2024-03-27T00:59:43Z

Description

We are adding an additional post action to gradle-check job to fetch the failed tests for each run and index those results into an OpenSearch cluster.
Based on the feedback from @peternied here, this PR adds additional env variables to add metadata related to branch and PR contributor details.

As per our current implementation following fields get indexed for each gradle-check run when there are test failures:

{
  "build_number": 35918,
  "pull_request": "12914",
  "pr_description": "backport 2x bump orgapachecommonscommonsconfiguration2 from 2100 to 2101 in pluginsrepositoryhdfs",
  "test_class": "RemoteIndexRecoveryIT",
  "test_name": "org.opensearch.remotestore.RemoteIndexRecoveryIT.testCancelRecoveryWithAutoExpandReplicas",
  "test_status": "FAILED",
  "build_result": "FAILURE",
  "test_fail_count": 1,
  "test_skipped_count": 677,
  "test_passed_count": 30892,
  "build_duration": 3028345,
  "build_start_time": 1711417450740
}

For all the gradle-check test failure that happen as part of post merge action, i.e., when a PR is merged, the pr_number field passed from the existing workflow is Null and same is reflected in the indexed document.
It would be really helpful if we can add more metadata around merged commits that help operator easily identify person associated with the commit and pull request numbers.

The new env variables introduced are:

event_name: The event pull_request_target or push that triggered the gradle-check workflow.
branch_name: This will be the base repo branch in case of pull_request action. For push this will be the branch to which the commit was merged.
pr_owner : The github id of the user who created the PR. Will be Null in case of push action.
pr_or_commit_description : The commit message that is displayed upon merge, this contains important details around pr contributor and associated pull_requests. This will be PR body description for pull_request action.

Related Issues

opensearch-project/opensearch-build#4469

Check List

~~[ ] New functionality includes testing.~~
- ~~[ ] All tests pass~~
~~[ ] New functionality has been documented.~~
- ~~[ ] New functionality has javadoc added~~
~~[ ] Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)~~
Commits are signed per the DCO using --signoff
~~[ ] Commit changes are listed out in CHANGELOG.md file (See: Changelog)~~
~~[ ] Public documentation issue/PR created~~

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.

Signed-off-by: Rishabh Singh <[email protected]>

rishabh6788 · 2024-03-27T01:00:14Z

Tagging @peternied for feedback and review.

github-actions · 2024-03-27T01:22:44Z

Compatibility status:

Checks if related components are compatible with change b12cc21

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/flow-framework.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/performance-analyzer.git]

github-actions · 2024-03-27T01:46:21Z

✅ Gradle check result for b59f9cd: SUCCESS

codecov · 2024-03-27T01:47:25Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.37%. Comparing base (b15cb0c) to head (b12cc21).
Report is 107 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #12938      +/-   ##
============================================
- Coverage     71.42%   71.37%   -0.05%     
- Complexity    59978    60359     +381     
============================================
  Files          4985     5021      +36     
  Lines        282275   284067    +1792     
  Branches      40946    41151     +205     
============================================
+ Hits         201603   202748    +1145     
- Misses        63999    64541     +542     
- Partials      16673    16778     +105

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

.github/workflows/gradle-check.yml

Co-authored-by: Peter Nied <[email protected]> Signed-off-by: Rishabh Singh <[email protected]>

github-actions · 2024-03-27T19:03:16Z

❕ Gradle check result for 0be531b: UNSTABLE

TEST FAILURES:

      1 org.opensearch.remotestore.RemoteStoreStatsIT.testNonZeroPrimaryStatsOnNewlyCreatedIndexWithZeroDocs

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

peternied

Even with the outstanding comments this change would be a good step forward if merged as is, thanks @rishabh6788

Signed-off-by: Rishabh Singh <[email protected]>

github-actions · 2024-03-29T02:54:05Z

❌ Gradle check result for 8f07f5b: FAILURE