JENKINS-54439 Jcasc compatibility

pom.xml

@@ -20,6 +20,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <powermock.version>1.6.6</powermock.version>
         <checkstyle.version>3.1.0</checkstyle.version>
+        <configuration-as-code.version>1.20</configuration-as-code.version>
     </properties>
 
     <licenses>
@@ -166,6 +167,20 @@
             <version>3.6</version>
         </dependency>
 
+        <dependency>
+            <groupId>io.jenkins</groupId>
+            <artifactId>configuration-as-code</artifactId>
+            <version>${configuration-as-code.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.jenkins</groupId>
+            <artifactId>configuration-as-code</artifactId>
+            <version>${configuration-as-code.version}</version>
+            <classifier>tests</classifier>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.jenkins-ci.plugins</groupId>
             <artifactId>structs</artifactId>

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

@@ -31,33 +31,39 @@
 import com.sonyericsson.jenkins.plugins.bfa.model.ScannerJobProperty;
 import com.sonyericsson.jenkins.plugins.bfa.sod.ScanOnDemandQueue;
 import com.sonyericsson.jenkins.plugins.bfa.sod.ScanOnDemandVariables;
+import hudson.Extension;
 import hudson.ExtensionList;
-import hudson.Plugin;
-import hudson.PluginManager;
-import hudson.PluginWrapper;
-import hudson.model.Descriptor;
+import hudson.XmlFile;
+import hudson.init.InitMilestone;
+import hudson.init.Initializer;
+import hudson.init.Terminator;
 import hudson.model.Hudson;
 import hudson.model.Job;
 import hudson.model.Result;
 import hudson.model.Run;
 import hudson.security.Permission;
 import hudson.security.PermissionGroup;
 import hudson.util.CopyOnWriteList;
+import java.io.File;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import javax.annotation.Nonnull;
+import jenkins.model.GlobalConfiguration;
 import jenkins.model.Jenkins;
 import net.sf.json.JSONObject;
+import org.jenkinsci.Symbol;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
 import org.kohsuke.stapler.StaplerRequest;
 
-import javax.annotation.Nonnull;
-import java.io.IOException;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
 /**
  * The main thing.
  *
  * @author Robert Sandell <robert.sandell@sonyericsson.com>
  */
-public class PluginImpl extends Plugin {
+@Extension
+@Symbol("buildFailureAnalyzer")
+public class PluginImpl extends GlobalConfiguration {
 
     private static final Logger logger = Logger.getLogger(PluginImpl.class.getName());
 
@@ -113,8 +119,6 @@ public class PluginImpl extends Plugin {
     private static final String DEFAULT_NO_CAUSES_MESSAGE = "No problems were identified. "
             + "If you know why this problem occurred, please add a suitable Cause for it.";
 
-    private static String staticResourcesBase = null;
-
     /**
      * Minimum allowed value for {@link #nrOfScanThreads}.
      */
@@ -142,13 +146,41 @@ public class PluginImpl extends Plugin {
     /**
      * ScanOnDemandVariable instance.
      */
-    private ScanOnDemandVariables sodVariables;
+    private ScanOnDemandVariables sodVariables = new ScanOnDemandVariables();
+
+    /**
+     * Default constructor.
+     */
+    @DataBoundConstructor
+    public PluginImpl() {
+        load();
+    }
+
+    protected Object readResolve() {
+        if (sodVariables == null) {
+            this.sodVariables = new ScanOnDemandVariables();
+        }
 
+        return this;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
     @Override
-    public void start() throws Exception {
-        super.start();
+    public XmlFile getConfigFile() {
+        return new XmlFile(
+                Jenkins.XSTREAM,
+                new File(Jenkins.getInstance().getRootDir(), "build-failure-analyzer.xml")
+        ); // for backward compatibility
+    }
+
+    /**
+     * Starts the knowledge base.
+     */
+    @Initializer(after = InitMilestone.EXTENSIONS_AUGMENTED)
+    public void start() {
         logger.finer("[BFA] Starting...");
-        load();
         if (noCausesMessage == null) {
             noCausesMessage = DEFAULT_NO_CAUSES_MESSAGE;
         }
@@ -158,27 +190,6 @@ public void start() throws Exception {
         if (nrOfScanThreads < 1) {
             nrOfScanThreads = DEFAULT_NR_OF_SCAN_THREADS;
         }
-        sodVariables = new ScanOnDemandVariables();
-        if (sodVariables.getMinimumSodWorkerThreads() < 1) {
-            sodVariables.setMinimumSodWorkerThreads(ScanOnDemandVariables.
-                    DEFAULT_MINIMUM_SOD_WORKER_THREADS);
-        }
-        if (sodVariables.getMaximumSodWorkerThreads() < 1) {
-            sodVariables.setMaximumSodWorkerThreads(ScanOnDemandVariables.
-                    DEFAULT_MAXIMUM_SOD_WORKER_THREADS);
-        }
-        if (sodVariables.getSodThreadKeepAliveTime() < 1) {
-            sodVariables.setSodThreadKeepAliveTime(ScanOnDemandVariables.
-                    DEFAULT_SOD_THREADS_KEEP_ALIVE_TIME);
-        }
-        if (sodVariables.getSodWaitForJobShutdownTimeout() < 1) {
-            sodVariables.setSodWaitForJobShutdownTimeout(ScanOnDemandVariables.
-                    DEFAULT_SOD_WAIT_FOR_JOBS_SHUTDOWN_TIMEOUT);
-        }
-        if (sodVariables.getSodCorePoolNumberOfThreads() < 1) {
-            sodVariables.setSodCorePoolNumberOfThreads(ScanOnDemandVariables.
-                    DEFAULT_SOD_COREPOOL_THREADS);
-        }
 
         if (knowledgeBase == null) {
             if (causes == null) {
@@ -199,9 +210,11 @@ public void start() throws Exception {
         }
     }
 
-    @Override
-    public void stop() throws Exception {
-        super.stop();
+    /**
+     * Run on Jenkins shutdown.
+     */
+    @Terminator
+    public void stop() {
         ScanOnDemandQueue.shutdown();
         knowledgeBase.stop();
     }
@@ -212,22 +225,7 @@ public void stop() throws Exception {
      * @return the base URI.
      */
     public static String getStaticResourcesBase() {
-        if (staticResourcesBase == null) {
-            PluginManager pluginManager = Jenkins.getInstance().getPluginManager();
-            if (pluginManager != null) {
-                PluginWrapper wrapper = pluginManager.getPlugin(PluginImpl.class);
-                if (wrapper != null) {
-                    staticResourcesBase = "/plugin/" + wrapper.getShortName();
-                }
-            }
-            //Did we really find it?
-            if (staticResourcesBase == null) {
-                //This is not the preferred way since the module name could change,
-                //But in some unit test cases we cannot reach the plug-in info.
-                return "/plugin/build-failure-analyzer";
-            }
-        }
-        return staticResourcesBase;
+        return "/plugin/build-failure-analyzer";
     }
 
     /**
@@ -303,16 +301,7 @@ public static String getDefaultIcon() {
      */
     @Nonnull
     public static PluginImpl getInstance() {
-        Jenkins jenkins = Jenkins.getInstance();
-        if (jenkins == null) {
-            throw new AssertionError("Jenkins is not here yet.");
-        }
-        PluginImpl plugin = jenkins.getPlugin(PluginImpl.class);
-        if (plugin == null) {
-            throw new AssertionError("Not here yet.");
-        } else {
-            return plugin;
-        }
+        return ExtensionList.lookup(PluginImpl.class).get(0);
     }
 
     /**
@@ -359,6 +348,42 @@ public boolean isGraphsEnabled() {
         }
     }
 
+    /**
+     * Sets if graphs are enabled.
+     * @param graphsEnabled the graph flag
+     */
+    @DataBoundSetter
+    public void setGraphsEnabled(Boolean graphsEnabled) {
+        this.graphsEnabled = graphsEnabled;
+    }
+
+    /**
+     * Sets the no causes message.
+     * @param noCausesMessage the no causes message
+     */
+    @DataBoundSetter
+    public void setNoCausesMessage(String noCausesMessage) {
+        this.noCausesMessage = noCausesMessage;
+    }
+
+    /**
+     * Sets the knowledge base.
+     * @param knowledgeBase the knowledge base
+     */
+    @DataBoundSetter
+    public void setKnowledgeBase(KnowledgeBase knowledgeBase) {
+        this.knowledgeBase = knowledgeBase;
+    }
+
+    /**
+     * Sets the scan on demand variables.
+     * @param sodVariables the variables
+     */
+    @DataBoundSetter
+    public void setSodVariables(ScanOnDemandVariables sodVariables) {
+        this.sodVariables = sodVariables;
+    }
+
     /**
      * If failed test cases should be represented as failure causes.
      *
@@ -481,6 +506,10 @@ public void setMaxLogSize(int maxLogSize) {
      * @return value
      */
     public int getMaxLogSize() {
+        if (maxLogSize < 0) {
+            return DEFAULT_MAX_LOG_SIZE;
+        }
+
         return maxLogSize;
     }
 
@@ -576,83 +605,23 @@ public KnowledgeBase.KnowledgeBaseDescriptor getKnowledgeBaseDescriptor(String d
 
 
     @Override
-    public void configure(StaplerRequest req, JSONObject o) throws Descriptor.FormException, IOException {
-        noCausesMessage = o.getString("noCausesMessage");
-        globalEnabled = o.getBoolean("globalEnabled");
-        doNotAnalyzeAbortedJob = o.optBoolean("doNotAnalyzeAbortedJob", false);
-        gerritTriggerEnabled = o.getBoolean("gerritTriggerEnabled");
-        graphsEnabled = o.getBoolean("graphsEnabled");
-        testResultParsingEnabled = o.getBoolean("testResultParsingEnabled");
-        testResultCategories = o.getString("testResultCategories");
-        maxLogSize = o.optInt("maxLogSize");
-        int scanThreads = o.getInt("nrOfScanThreads");
-        int minSodWorkerThreads = o.getInt("minimumNumberOfWorkerThreads");
-        int maxSodWorkerThreads = o.getInt("maximumNumberOfWorkerThreads");
-        int thrkeepAliveTime = o.getInt("threadKeepAliveTime");
-        int jobShutdownTimeWait = o.getInt("waitForJobShutdownTime");
-        int corePoolNumberOfThreads = o.getInt("corePoolNumberOfThreads");
-        if (scanThreads < MINIMUM_NR_OF_SCAN_THREADS) {
-            nrOfScanThreads = DEFAULT_NR_OF_SCAN_THREADS;
-        } else {
-            nrOfScanThreads = scanThreads;
-        }
-
-        if (maxLogSize < 0) {
-            maxLogSize = DEFAULT_MAX_LOG_SIZE;
-        }
+    public boolean configure(StaplerRequest req, JSONObject o) {
+        KnowledgeBase existingKb = this.knowledgeBase;
+        req.bindJSON(this, o);
 
-        if (corePoolNumberOfThreads < ScanOnDemandVariables.DEFAULT_SOD_COREPOOL_THREADS) {
-            sodVariables.setSodCorePoolNumberOfThreads(ScanOnDemandVariables.DEFAULT_SOD_COREPOOL_THREADS);
-        } else {
-            sodVariables.setSodCorePoolNumberOfThreads(corePoolNumberOfThreads);
-        }
-
-        if (jobShutdownTimeWait < ScanOnDemandVariables.DEFAULT_SOD_WAIT_FOR_JOBS_SHUTDOWN_TIMEOUT) {
-            sodVariables.setSodWaitForJobShutdownTimeout(ScanOnDemandVariables.
-                    DEFAULT_SOD_WAIT_FOR_JOBS_SHUTDOWN_TIMEOUT);
-        } else {
-            sodVariables.setSodWaitForJobShutdownTimeout(jobShutdownTimeWait);
-        }
-        if (thrkeepAliveTime < ScanOnDemandVariables.DEFAULT_SOD_THREADS_KEEP_ALIVE_TIME) {
-            sodVariables.setSodThreadKeepAliveTime(ScanOnDemandVariables.DEFAULT_SOD_THREADS_KEEP_ALIVE_TIME);
-        } else {
-            sodVariables.setSodThreadKeepAliveTime(thrkeepAliveTime);
-        }
-        if (minSodWorkerThreads < ScanOnDemandVariables.DEFAULT_MINIMUM_SOD_WORKER_THREADS) {
-            sodVariables.setMinimumSodWorkerThreads(ScanOnDemandVariables.DEFAULT_MINIMUM_SOD_WORKER_THREADS);
-        } else {
-            sodVariables.setMinimumSodWorkerThreads(minSodWorkerThreads);
-        }
-        if (maxSodWorkerThreads < ScanOnDemandVariables.DEFAULT_MAXIMUM_SOD_WORKER_THREADS) {
-            sodVariables.setMaximumSodWorkerThreads(ScanOnDemandVariables.DEFAULT_MAXIMUM_SOD_WORKER_THREADS);
-        } else {
-            sodVariables.setMaximumSodWorkerThreads(maxSodWorkerThreads);
-        }
-        if (maxSodWorkerThreads < ScanOnDemandVariables.DEFAULT_MAXIMUM_SOD_WORKER_THREADS) {
-            sodVariables.setMaximumSodWorkerThreads(ScanOnDemandVariables.DEFAULT_MAXIMUM_SOD_WORKER_THREADS);
-        } else {
-            sodVariables.setMaximumSodWorkerThreads(maxSodWorkerThreads);
-        }
-        KnowledgeBase base = req.bindJSON(KnowledgeBase.class, o.getJSONObject("knowledgeBase"));
-        if (base != null && !knowledgeBase.equals(base)) {
-            try {
-                base.start();
-            } catch (Exception e) {
-                logger.log(Level.SEVERE, "Could not start new knowledge base, reverting ", e);
-                save();
-                return;
-            }
+        if (existingKb != null && !existingKb.equals(knowledgeBase)) {
             if (o.getBoolean("convertOldKb")) {
                 try {
-                    base.convertFrom(knowledgeBase);
+                    knowledgeBase.start();
+                    knowledgeBase.convertFrom(existingKb);
                 } catch (Exception e) {
                     logger.log(Level.SEVERE, "Could not convert knowledge base ", e);
                 }
+                knowledgeBase.stop();
             }
-            knowledgeBase.stop();
-            knowledgeBase = base;
         }
 
         save();
+        return true;
     }
 }