[JENKINS-39284] Set build description to failure cause

src/main/java/com/sonyericsson/jenkins/plugins/bfa/BuildFailureScanner.java

@@ -240,6 +240,10 @@ public static void scan(Run build, PrintStream scanLog) {
                 printDownstream(scanLog, downstreamFailureCauses);
             }
 
+            if (PluginImpl.getInstance().isBuildDescriptionEnabled() && !foundCauseList.isEmpty()) {
+              build.setDescription(generateDescriptionString(build, foundCauseList));
+            }
+
             StatisticsLogger.getInstance().log(build, foundCauseListToLog);
         } catch (Exception e) {
             logger.log(Level.SEVERE, "Could not scan build " + build, e);
@@ -534,4 +538,43 @@ private static List<FoundFailureCause> findFailedTests(final Run build, final Pr
 
         return failedTestList;
     }
+
+    /**
+     * Generate text that can be used for the build description using categories and failure causes.
+     *
+     * @param build to get current build description
+     * @param foundCauseList list of failure causes
+     * @return A String of the BFA categories and causes appended to the build's description.
+     */
+    public static String generateDescriptionString(Run build, List<FoundFailureCause> foundCauseList) {
+        String buildDescription = "<mark>";
+        // Append all of the categories.
+        if (foundCauseList.get(0) != null) {
+            for (int j = 0; j < foundCauseList.get(0).getCategories().size(); j++) {
+                buildDescription += "<b>";
+                buildDescription += foundCauseList.get(0).getCategories().get(j).toString();
+                buildDescription += "</b> ";
+            }
+            if (foundCauseList.get(0).getCategories().size() > 0) {
+                buildDescription += ": ";
+            }
+        }
+
+        // Append all failure causes.
+        for (int i = 0; i < foundCauseList.size(); i++) {
+            buildDescription = buildDescription.concat("<i>");
+            buildDescription = buildDescription.concat(foundCauseList.get(i).getDescription());
+            buildDescription = buildDescription.concat("</i>");
+            if (i < (foundCauseList.size() - 1)) {
+                buildDescription += "  ";
+            }
+        }
+        buildDescription = buildDescription.concat("</mark>");
+
+        // Append this build description to any pre-existing build description
+        if (!(build.getDescription() == null) && !build.getDescription().isEmpty()) {
+            buildDescription = build.getDescription().concat("<br>\n").concat(buildDescription);
+        }
+        return buildDescription;
+    }
 }

src/main/java/com/sonyericsson/jenkins/plugins/bfa/PluginImpl.java

@@ -148,6 +148,7 @@ public class PluginImpl extends GlobalConfiguration {
 
     private int nrOfScanThreads;
     private int maxLogSize;
+    private Boolean buildDescriptionEnabled;
 
     private Boolean graphsEnabled;
 
@@ -594,6 +595,28 @@ public int getMaxLogSize() {
     }
 
 
+    /**
+     * Set option to append failure causes to job's build description.
+     *
+     * @param buildDescriptionEnabled should build description option be turned on
+     */
+    public void setBuildDescriptionEnabled(Boolean buildDescriptionEnabled) {
+      this.buildDescriptionEnabled = buildDescriptionEnabled;
+    }
+
+    /**
+     * If buildDescriptionEnabled is enabled or not. Build Descriptions will be set to a concatenated
+     * list of the failure descriptions as a convenience.
+     * @return True if enabled.
+     */
+    public boolean isBuildDescriptionEnabled() {
+      if (buildDescriptionEnabled == null) {
+        return false;
+      } else {
+        return buildDescriptionEnabled;
+      }
+    }
+
     /**
      * Checks if the build with certain result should be analyzed or not.
      *

src/main/resources/com/sonyericsson/jenkins/plugins/bfa/PluginImpl/config.jelly

@@ -87,5 +87,10 @@
         <f:entry title="${%Max size of log file}" description="${%maxLogSize}">
             <f:textbox field="maxLogSize" />
         </f:entry>
+        <f:entry title="${%Set job description to failure description}"
+             description="${%Enabling this option will set the build's description to the failure descriptions as a convenience.}">
+            <f:checkbox name="buildDescriptionEnabled" checked="${it.buildDescriptionEnabled}"
+                  default="false"/>
+        </f:entry>
     </f:advanced>
 </j:jelly>

src/test/java/com/sonyericsson/jenkins/plugins/bfa/BuildFailureScannerHudsonTest.java

@@ -104,6 +104,7 @@ public class BuildFailureScannerHudsonTest {
 
     private static final String BUILD_LOG = "ERROR: brief\n  detail\n";
     private static final String BUILD_LOG_FIRST_LINE = "ERROR: brief";
+    private static final String BUILD_DESCRIPTION = "This is a build description.";
     private static final String DESCRIPTION = "The error was: ${1,1}${2,1}";
     private static final String REGEX = "ERROR: (.*?)$";
     private static final String MULTILINE_REGEX = "ERROR: (.*?)$.*?  detail";
@@ -695,6 +696,126 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher,
         assertEquals("Amount of failure causes does not match.", 0, causeListFromAction.size());
     }
 
+    /**
+     * Test buildDescriptionEnabled = false does not append failure cause to build description.
+     *
+     * @throws Exception if a build description is appended when the setting is set to false.
+     */
+    @Test
+    public void testTestBuildDescriptionEnabledIfDisabled() throws Exception {
+      PluginImpl.getInstance().setTestResultParsingEnabled(true);
+      PluginImpl.getInstance().setBuildDescriptionEnabled(false);
+      FreeStyleProject project = jenkins.createFreeStyleProject();
+
+      project.getBuildersList().add(new PrintToLogBuilder(BUILD_LOG));
+      project.getBuildersList().add(new TestBuilder() {
+        public boolean perform(AbstractBuild<?, ?> build, Launcher launcher,
+                               BuildListener listener) throws InterruptedException, IOException {
+          build.getWorkspace().child("junit.xml").copyFrom(
+              this.getClass().getResource("junit.xml"));
+          return true;
+        }
+      });
+
+      project.getPublishersList().add(new JUnitResultArchiver("junit.xml", false, null));
+
+      Future<FreeStyleBuild> future = project.scheduleBuild2(0, new Cause.UserIdCause());
+      FreeStyleBuild build = future.get(10, TimeUnit.SECONDS);
+      jenkins.assertBuildStatus(Result.UNSTABLE, build);
+
+          FailureCauseBuildAction action = build.getAction(FailureCauseBuildAction.class);
+      assertNotNull(action);
+
+      List<FoundFailureCause> causeListFromAction = action.getFoundFailureCauses();
+      assertEquals("Amount of failure causes does not match.", 2, causeListFromAction.size());
+
+      // Start with some build description not assigned by BFA and run another scan.
+      action.getFoundFailureCauses();
+      assertEquals(build.getDescription(), null);
+    }
+
+    /**
+     * Test buildDescriptionEnabled = true does append failure cause to existing build description
+     * without categories set.
+     *
+     * @throws Exception if the build description is not appended when the setting is true.
+     */
+    @Test
+    public void testTestBuildDescriptionEnabledWithoutCategoriesIfEnabled() throws Exception {
+        PluginImpl.getInstance().setTestResultParsingEnabled(true);
+        PluginImpl.getInstance().setBuildDescriptionEnabled(true);
+        FreeStyleProject project = jenkins.createFreeStyleProject();
+
+        // Test with a preset build description
+        project.getBuildersList().add(new PrintToLogBuilder(BUILD_LOG));
+        project.getBuildersList().add(new TestBuilder() {
+            public boolean perform(AbstractBuild<?, ?> build, Launcher launcher,
+                                   BuildListener listener) throws InterruptedException, IOException {
+                build.getWorkspace().child("junit.xml").copyFrom(this.getClass().getResource("junit.xml"));
+                build.setDescription("Hello World");
+                return true;
+            }
+        });
+
+        project.getPublishersList().add(new JUnitResultArchiver("junit.xml", false, null));
+
+        Future<FreeStyleBuild> future = project.scheduleBuild2(0, new Cause.UserIdCause());
+        FreeStyleBuild build = future.get(120, TimeUnit.SECONDS);
+        jenkins.assertBuildStatus(Result.UNSTABLE, build);
+
+        FailureCauseBuildAction action = build.getAction(FailureCauseBuildAction.class);
+        assertNotNull(action);
+
+        List<FoundFailureCause> causeListFromAction = action.getFoundFailureCauses();
+        assertEquals("Amount of failure causes does not match.", 2, causeListFromAction.size());
+        String testDescription = "Hello World<br>\n"
+                + "<mark><i>Here are details of the failure...</i>  <i>More details</i></mark>";
+
+        assertEquals(testDescription, build.getDescription());
+    }
+
+  /**
+   * Test buildDescriptionEnabled = true does append failure cause to existing build description.
+   * with categories set
+   *
+   * @throws Exception if description is not appended correctly.
+   */
+  @Test
+  public void testTestBuildDescriptionEnabledWithCategoriesIfEnabled() throws Exception {
+      PluginImpl.getInstance().setTestResultParsingEnabled(true);
+      PluginImpl.getInstance().setBuildDescriptionEnabled(true);
+      String categories = "foo bar";
+      PluginImpl.getInstance().setTestResultCategories(categories);
+      FreeStyleProject project = jenkins.createFreeStyleProject();
+
+      // Test with a preset build description
+      project.getBuildersList().add(new PrintToLogBuilder(BUILD_LOG));
+      project.getBuildersList().add(new TestBuilder() {
+          public boolean perform(AbstractBuild<?, ?> build, Launcher launcher,
+                                 BuildListener listener) throws InterruptedException, IOException {
+              build.getWorkspace().child("junit.xml").copyFrom(this.getClass().getResource("junit.xml"));
+              build.setDescription("Hello World");
+              return true;
+          }
+      });
+
+      project.getPublishersList().add(new JUnitResultArchiver("junit.xml", false, null));
+
+      Future<FreeStyleBuild> future = project.scheduleBuild2(0, new Cause.UserIdCause());
+      FreeStyleBuild build = future.get(10, TimeUnit.SECONDS);
+      jenkins.assertBuildStatus(Result.UNSTABLE, build);
+
+      FailureCauseBuildAction action = build.getAction(FailureCauseBuildAction.class);
+      assertNotNull(action);
+
+      List<FoundFailureCause> causeListFromAction = action.getFoundFailureCauses();
+      assertEquals("Amount of failure causes does not match.", 2, causeListFromAction.size());
+
+      String testDescription = "Hello World<br>\n"
+              + "<mark><b>foo</b> <b>bar</b> : <i>Here are details of the failure...</i>  <i>More details</i></mark>";
+      assertEquals(build.getDescription(), testDescription);
+  }
+
     /**
      * ArgumentMatcher for a Statistics object.
      */

src/test/resources/com/sonyericsson/jenkins/plugins/bfa/jcasc/jcasc-local-expected.yml

@@ -1,3 +1,4 @@
+buildDescriptionEnabled: false
 doNotAnalyzeAbortedJob: true
 gerritTriggerEnabled: true
 globalEnabled: true

src/test/resources/com/sonyericsson/jenkins/plugins/bfa/jcasc/jcasc-mongo-expected.yml

@@ -1,3 +1,4 @@
+buildDescriptionEnabled: false
 doNotAnalyzeAbortedJob: true
 gerritTriggerEnabled: true
 globalEnabled: true