Publish failed gradle test results (#397)

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

build.gradle

@@ -121,7 +121,7 @@ jacocoTestReport {
     }
 }
 
-String version = '6.3.3'
+String version = '6.4.0'
 
 task updateVersion {
     doLast {

vars/publishGradleCheckTestResults.groovy

@@ -0,0 +1,134 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Library to fetch failing tests at the end of gradle-check run and index the results in an OpenSearch cluster.
+ *
+ * @param Map args = [:] args A map of the following parameters
+ * @param args.prNumber <required> - The pull_request number that triggered the gradle-check run. If Null then use post_merge_action string.
+ * @param args.prDescription <required> - The subject of the pull_request. If prNumber is null then it signifies push action on branch.
+ */
+
+import hudson.tasks.test.AbstractTestResultAction
+import groovy.json.JsonOutput
+import java.text.SimpleDateFormat
+import java.util.Date
+
+void call(Map args = [:]) {
+    def lib = library(identifier: 'jenkins@main', retriever: legacySCM(scm))
+    def finalJsonDoc = ""
+    def buildNumber = currentBuild.number
+    def buildDescription = currentBuild.description
+    def buildDuration = currentBuild.duration
+    def buildResult = currentBuild.result
+    def buildStartTime = currentBuild.startTimeInMillis
+    def prString = isNullOrEmpty(args.prNumber.toString()) ? "post_merge_action" : "${args.prNumber}"
+    def prDescription = args.prDescription.toString()
+    def currentDate = new Date()
+    def formattedDate = new SimpleDateFormat("MM-yyyy").format(currentDate)
+
+    def indexName = "gradle-check-${formattedDate}"
+
+    def test_docs = getFailedTestRecords(buildNumber, prString, prDescription, buildResult, buildDuration, buildStartTime)
+
+    if (test_docs) {
+        for (doc in test_docs) {
+            def jsonDoc = JsonOutput.toJson(doc)
+            finalJsonDoc += "{\"index\": {\"_index\": \"${indexName}\"}}\n" + "${jsonDoc}\n"
+        }
+        writeFile file: "failed-test-records.json", text: finalJsonDoc
+
+        def fileContents = readFile(file: "failed-test-records.json").trim()
+        println("File Content is:\n${fileContents}")
+        indexFailedTestData()
+    }
+}
+
+List<Map<String, String>> getFailedTestRecords(buildNumber, prString, prDescription, buildResult, buildDuration, buildStartTime) {
+    def testResults = []
+    AbstractTestResultAction testResultAction = currentBuild.rawBuild.getAction(AbstractTestResultAction.class)
+    if (testResultAction != null) {
+        def testsTotal = testResultAction.totalCount
+        def testsFailed = testResultAction.failCount
+        def testsSkipped = testResultAction.skipCount
+        def testsPassed = testsTotal - testsFailed - testsSkipped
+        def failedTests = testResultAction.getFailedTests()
+
+        if (failedTests){
+            for (test in failedTests) {
+                def failDocument = ['build_number': buildNumber, 'pull_request': prString, 'pr_description': prDescription, 'test_class': test.getParent().getName(), 'test_name': test.fullName, 'test_status': 'FAILED', 'build_result': buildResult, 'test_fail_count': testsFailed, 'test_skipped_count': testsSkipped, 'test_passed_count': testsPassed, 'build_duration': buildDuration, 'build_start_time': buildStartTime]
+                testResults.add(failDocument)
+            }
+        } else {
+            println("No test failed.")
+        }
+    }
+    return testResults
+}
+
+void indexFailedTestData() {
+
+    withCredentials([
+            string(credentialsId: 'jenkins-health-metrics-account-number', variable: 'METRICS_HOST_ACCOUNT'),
+            string(credentialsId: 'jenkins-health-metrics-cluster-endpoint', variable: 'METRICS_HOST_URL')
+    ]) {
+        withAWS(role: 'OpenSearchJenkinsAccessRole', roleAccount: "${METRICS_HOST_ACCOUNT}", duration: 900, roleSessionName: 'jenkins-session') {
+            def awsAccessKey = env.AWS_ACCESS_KEY_ID
+            def awsSecretKey = env.AWS_SECRET_ACCESS_KEY
+            def awsSessionToken = env.AWS_SESSION_TOKEN
+
+            sh """
+                set +e
+                set +x
+        
+                MONTH_YEAR=\$(date +"%m-%Y")
+                INDEX_NAME="gradle-check-\$MONTH_YEAR"
+                INDEX_MAPPING='{
+                        "mappings": {
+                            "properties": {
+                              "build_number": { "type": "integer" },
+                              "pull_request": { "type": "keyword" },
+                              "pr_description": { "type": "text" },
+                              "test_class": { "type": "keyword" },
+                              "test_name": { "type": "keyword" },
+                              "test_status": { "type": "keyword" },
+                              "build_result": { "type": "keyword" },
+                              "test_fail_count": { "type": "integer" },
+                              "test_skipped_count": { "type": "integer" },
+                              "test_passed_count": { "type": "integer" },
+                              "build_duration": { "type": "float" },
+                              "build_start_time": { "type": "date" }
+                            }
+                        }
+                }'
+                echo "INDEX NAME IS \$INDEX_NAME"
+                curl -I "${METRICS_HOST_URL}/\$INDEX_NAME" --aws-sigv4 \"aws:amz:us-east-1:es\" --user \"${awsAccessKey}:${awsSecretKey}\" -H \"x-amz-security-token:${awsSessionToken}\" | grep -E 'HTTP\\/[0-9]+(\\.[0-9]+)? [0-9]+'
+                if [ \$? -eq 0 ]; then
+                    echo "Index already exists. Indexing Results"
+                else
+                    echo "Index does not exist. Creating..."
+                    create_index_response=\$(curl -s -XPUT "${METRICS_HOST_URL}/\${INDEX_NAME}" --aws-sigv4 \"aws:amz:us-east-1:es\" --user \"${awsAccessKey}:${awsSecretKey}\" -H \"x-amz-security-token:${awsSessionToken}\" -H 'Content-Type: application/json' -d "\${INDEX_MAPPING}")
+                    if [[ \$create_index_response == *'"acknowledged":true'* ]]; then
+                        echo "Index created successfully."
+                    else
+                        echo "Failed to create index. Error message: \$create_index_response"
+                        exit 1
+                    fi
+                fi
+                if [ -s failed-test-records.json ]; then
+                    echo "File Exists, indexing results."
+                    curl -XPOST "${METRICS_HOST_URL}/\$INDEX_NAME/_bulk" --aws-sigv4 \"aws:amz:us-east-1:es\" --user \"${awsAccessKey}:${awsSecretKey}\" -H \"x-amz-security-token:${awsSessionToken}\" -H "Content-Type: application/x-ndjson" --data-binary "@failed-test-records.json"
+                else
+                    echo "File Does not exist. No failing test records to process."
+                fi
+        """
+        }
+    }
+}
+
+boolean isNullOrEmpty(String str) { return (str == 'Null' || str == null || str.allWhitespace || str.isEmpty()) }