Add option to include causes in the JCasC export, and read causes from it on import.

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

@@ -58,6 +58,7 @@
 import javax.annotation.Nonnull;
 import java.io.File;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 import java.util.logging.Level;
@@ -155,6 +156,7 @@ public class PluginImpl extends GlobalConfiguration {
     private String fallbackCategoriesAsString;
     private transient List<String> fallbackCategories;
 
+    private boolean exportCausesToJCasCEnabled;
     private transient CopyOnWriteList<FailureCause> causes;
 
     private KnowledgeBase knowledgeBase;
@@ -629,6 +631,64 @@ public void setSlackFailureCategories(String slackFailureCategories) {
         this.slackFailureCategories = slackFailureCategories;
     }
 
+    /**
+     * Get if causes from the current knowledge base should be included in the JCasC export is enabled.
+     * @return exportCausesToJCasCEnabled - on or off. null == off.
+     */
+    public boolean isExportCausesToJCasCEnabled() {
+        return exportCausesToJCasCEnabled;
+    }
+
+    /**
+     * Set if this feature is enabled or not. When on, causes will in the JCasC export.
+     *
+     * @param exportCausesToJCasCEnabled on or off. null == off.
+     */
+    @DataBoundSetter
+    public void setExportCausesToJCasCEnabled(boolean exportCausesToJCasCEnabled) {
+        this.exportCausesToJCasCEnabled = exportCausesToJCasCEnabled;
+    }
+
+    /**
+     * Save causes to the db. Assumes that the ids are kept from when the causes were fetched.
+     * Failing to do so may result in duplicate causes.
+     *
+     * @param causes value
+     */
+    @DataBoundSetter
+    public void setCauses(List<FailureCause> causes) {
+        if (knowledgeBase != null) {
+            for (FailureCause cause:causes) {
+                try {
+                    knowledgeBase.saveCause(cause);
+                } catch (Exception e) {
+                    logger.log(Level.WARNING, "Failed to save cause to the knowledge base", e);
+                }
+            }
+        }
+    }
+
+    /**
+     * Get the causes, used by JCasC to include it in the configuration export.
+     *
+     * @return the causes
+     */
+    public Collection<FailureCause> getCauses() {
+        // The Causes export can be very large so we only include it if enabled.
+        if (!isExportCausesToJCasCEnabled()) {
+            return null;
+        }
+        if (knowledgeBase != null) {
+            try {
+                return knowledgeBase.getCauses();
+            } catch (Exception e) {
+                logger.log(Level.WARNING, "Failed to get causes from the knowledge base", e);
+                return null;
+            }
+        }
+        return null;
+    }
+
     /**
      * The number of threads to have in the pool for each build. Used by the {@link BuildFailureScanner}.
      * Will return nothing less than {@link #MINIMUM_NR_OF_SCAN_THREADS}.

src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureCause.java

@@ -46,6 +46,7 @@
 import jenkins.model.Jenkins;
 import net.sf.json.JSONObject;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
 import org.kohsuke.stapler.QueryParameter;
 import org.kohsuke.stapler.Stapler;
 import org.kohsuke.stapler.StaplerRequest;
@@ -86,13 +87,26 @@ public class FailureCause implements Serializable, Action, Describable<FailureCa
      * @param id            the id.
      * @param name          the name of this FailureCause.
      * @param description   the description of this FailureCause.
+     * @param indications   the list of indications
+     */
+    @DataBoundConstructor
+    public FailureCause(String id, String name, String description, List<Indication> indications) {
+        this(id, name, description, null, null, (List<String>)null,
+                indications, null);
+    }
+
+    /**
+     * Standard constructor.
+     *
+     * @param id            the id.
+     * @param name          the name of this FailureCause.
+     * @param description   the description of this FailureCause.
      * @param comment       the comment of this FailureCause.
      * @param lastOccurred  the time at which this FailureCause last occurred.
      * @param categories    the categories of this FailureCause.
      * @param indications   the list of indications
      * @param modifications the modification history of this FailureCause.
      */
-    @DataBoundConstructor
     public FailureCause(String id, String name, String description, String comment,
                         Date lastOccurred, String categories, List<Indication> indications,
                         List<FailureCauseModification> modifications) {
@@ -401,6 +415,7 @@ public Date getAndInitiateLastOccurred() {
      *
      * @param lastOccurred the occurrence to set.
      */
+    @DataBoundSetter
     public void setLastOccurred(Date lastOccurred) {
         if (lastOccurred == null) {
             this.lastOccurred = null;
@@ -441,6 +456,26 @@ public List<String> getCategories() {
         return categories;
     }
 
+    /**
+     * Setter for the comment.
+     *
+     * @param comment the comment
+     */
+    @DataBoundSetter
+    public void setComment(String comment) {
+        this.comment = comment;
+    }
+
+    /**
+     * Setter for the FailureCauseModifications done to this FailureCause.
+     *
+     * @param modifications the modifications
+     */
+    @DataBoundSetter
+    public void setModifications(List<FailureCauseModification> modifications) {
+        this.modifications = modifications;
+    }
+
     /**
      * Returns the categories as a String, used for the view.
      *
@@ -541,6 +576,7 @@ private void loadLastOccurred() {
      *
      * @param categories the categories.
      */
+    @DataBoundSetter
     public void setCategories(List<String> categories) {
         this.categories = categories;
     }

src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/FailureCauseModification.java

@@ -25,6 +25,7 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import org.kohsuke.stapler.DataBoundConstructor;
 
 import java.io.Serializable;
 import java.util.Date;
@@ -54,6 +55,22 @@ public FailureCauseModification(@JsonProperty("user") String user, @JsonProperty
         }
     }
 
+    /**
+     * Constructor for FailureCauseModification.
+     *
+     * @param user The user who made the modification.
+     * @param time The time at which the modification was done.
+     */
+    @DataBoundConstructor
+    public FailureCauseModification(String user, String time) {
+        this.user = user;
+        if (time == null) {
+            this.time = null;
+        } else {
+            this.time = new Date(time);
+        }
+    }
+
     /**
      * Getter for the time.
      *

src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/indication/BuildLogIndication.java

@@ -43,6 +43,7 @@
 import hudson.model.Run;
 import hudson.util.FormValidation;
 import jenkins.model.Jenkins;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.QueryParameter;
 import org.kohsuke.stapler.interceptor.RequirePOST;
@@ -59,6 +60,7 @@
  */
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "@class", visible = true)
 @JsonIgnoreProperties(ignoreUnknown = true)
+@Symbol("buildLog")
 public class BuildLogIndication extends Indication {
 
     private static final long serialVersionUID = -2889792693081908532L;

src/main/java/com/sonyericsson/jenkins/plugins/bfa/model/indication/MultilineBuildLogIndication.java

@@ -31,6 +31,7 @@
 import com.sonyericsson.jenkins.plugins.bfa.model.MultilineBuildLogFailureReader;
 import hudson.Extension;
 import hudson.model.Hudson;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import java.util.regex.Pattern;
@@ -42,6 +43,7 @@
  */
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "@class", visible = true)
 @JsonIgnoreProperties(ignoreUnknown = true)
+@Symbol("multilineBuildLog")
 public class MultilineBuildLogIndication extends BuildLogIndication {
 
     private static final long serialVersionUID = 8436383594898812087L;

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

@@ -92,5 +92,8 @@
         <f:entry title="${%Max size of log file}" description="${%maxLogSize}">
             <f:textbox field="maxLogSize" />
         </f:entry>
+        <f:entry title="${%Include causes to the JCasC export}" description="${%exportCausesToJCasCEnabled}">
+            <f:checkbox field="exportCausesToJCasCEnabled" />
+        </f:entry>
     </f:advanced>
 </j:jelly>

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

@@ -1,4 +1,5 @@
 enableGerritTriggerDescription=This option allows BFA to forward the description of the found causes to the Gerrit-Trigger-plugin, ultimately allowing users to see their build issues directly inside Gerrit.
+exportCausesToJCasCEnabled=If the knowledge base is large this will make the JCasC export large.
 nrOfScanThreadsDescription=Number of threads per build to use when scanning the failed builds.
 testResultParsingEnabledDescription=Treat failed test cases (as indicated by JUnit/xUnit/... publishers) as failure causes.
 testResultCategoriesDescription=A space-separated list of categories to use for failure causes representing failed test cases.