Notify pipeline syntax/configuration errors (#1557)

* Notify pipeline syntax/configuration errors * reword the comment
elastic · Feb 17, 2022 · c82afd2 · c82afd2
1 parent 6183147
commit c82afd2
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/resources/github-comment-markdown.template b/resources/github-comment-markdown.template
@@ -92,7 +92,8 @@ ${errorStackTrace}
 <% if (!buildStatus?.equals('ABORTED') && errorGithubPrCheckApproved) {%>
   <% stepsErrors = stepsErrors << errorGithubPrCheckApproved %>
 <%}%>
-<% if (stepsErrors?.size() != 0 && !statusSuccess) {%>
+<% if (!statusSuccess) {%>
+<% if (stepsErrors?.size() != 0) {%>
 ### Steps errors [![${stepsErrors?.size()}](https://img.shields.io/badge/${stepsErrors?.size()}%20-red)](${jobUrl}/pipeline)
   <details><summary>Expand to view the steps failures</summary>
   <p>
@@ -112,4 +113,11 @@ ${description}
   <%}%>
   </p>
   </details>
+<%} else {%>
+### Pipeline error [![1](https://img.shields.io/badge/1%20-red)](${env?.BUILD_URL}/console)
+  <p>
+  This error is likely related to the pipeline itself. Please go to the traditional console output <a href=\"${env?.BUILD_URL}/console\">here</a>"
+  You will see the error (either a wrong syntax or configuration)
+  </p>
+<%}%>
 <%}%>
diff --git a/src/test/groovy/NotificationManagerStepTests.groovy b/src/test/groovy/NotificationManagerStepTests.groovy
@@ -254,6 +254,25 @@ class NotificationManagerStepTests extends ApmBasePipelineTest {
     assertJobStatusSuccess()
   }
 
+  @Test
+  void test_notify_pr_with_failure_and_no_failed_steps() throws Exception {
+    script.notifyPR(
+      build: readJSON(file: "build-info.json"),
+      buildStatus: "FAILURE",
+      changeSet: readJSON(file: "changeSet-info.json"),
+      statsUrl: "https://ecs.example.com/app/kibana",
+      stepsErrors: [],
+      testsErrors: [],
+      testsSummary: readJSON(file: "tests-summary.json"),
+      statusSuccess: false
+    )
+    printCallStack()
+    assertTrue(assertMethodCallContainsPattern('githubPrComment', 'Build Failed'))
+    assertTrue(assertMethodCallContainsPattern('githubPrComment', 'Pipeline error'))
+    assertTrue(assertMethodCallContainsPattern('githubPrComment', 'go to the traditional console output'))
+    assertJobStatusSuccess()
+  }
+
   @Test
   void test_notify_pr_with_unstable() throws Exception {
     script.notifyPR(