Merge pull request #217 from jenkinsci/JENKINS-57312-column-types

[JENKINS-57312] Add a type configuration to columns and tokens

Author: uhafner

clean.sh

@@ -2,7 +2,7 @@
 
 JENKINS_HOME=../docker/volumes/jenkins-home
 
-mvn clean install || { echo "Build failed"; exit 1; }
+mvn clean install -Djenkins.test.timeout=1000 || { echo "Build failed"; exit 1; }
 
 echo "Installing plugin in $JENKINS_HOME"
 rm -rf $JENKINS_HOME/plugins/warnings-ng*

doc/Documentation.md

@@ -61,6 +61,7 @@ main build page. From there you can also dive into the details:
      * [Source code blames (for Git projects)](#source-code-blames-for-git-projects)
      * [Repository forensics (for Git projects)](#repository-forensics-for-git-projects)
      * [Source code view](#source-code-view)
+     * [Issues Totals Column](#issues-totals-column)
      * [Dashboard view support](#dashboard-view-support)
      * [Configuration as code support](#configuration-as-code-support)
      * [Remote API](#remote-api)
@@ -577,17 +578,34 @@ This library provides syntax highlighting for the most popular languages and ren
 
 ![source view](images/source-view.png)
 
+### Issues Totals Column
+
+You can show the total number of issues of a job in separate columns of the Jenkins jobs table. By default, the Jenkins
+main list view will show a new column that counts the total number of issues of all tools. You can add additional columns
+that can configure
+- the column name 
+- the actual tools that should be taken into account
+- the type of the totals to show (overall warnings, new warnings, specific severity, etc.).
+
+![issues column](images/column.png)
+
 ### Dashboard view support
 
-Support for Jenkins [dashboard view](https://wiki.jenkins.io/display/JENKINS/Dashboard+View) is quite limited up to now.
-Currently, only one portlet is available, that shows the number of issues for a job (separated by each tool). Moreover,
-the visualization is quite ugly, since it is more complex to use modern JS libraries on pages that are not under control
-of the warnings plugin.
- 
-The remaining portlets from the old static analysis collector plugin will be added step by step.
+Support for Jenkins [dashboard view](https://wiki.jenkins.io/display/JENKINS/Dashboard+View) is also available.
+Currently, the following portlets are available:
+
+#### Issues per tool and job table
 
+An issues table shows the total number of issues for a job (separated by each tool). 
+ 
 ![issues portlet](images/issues-portlet.png)
 
+#### Issues trend
+
+A trend chart can be added as portlet that shows an aggregation of the total number of issues of all jobs.
+
+![chart portlet](images/chart-portlet.png)
+
 ### Configuration as code support
 
 The Warnings Next Generation plugin is compatible with the 

doc/images/chart-portlet.png

@@ -19,6 +19,7 @@
 import hudson.Extension;
 import hudson.model.Job;
 import hudson.model.Run;
+import hudson.util.ListBoxModel;
 import hudson.views.ListViewColumn;
 import hudson.views.ListViewColumnDescriptor;
 
@@ -27,6 +28,7 @@
 import io.jenkins.plugins.analysis.core.model.ResultAction;
 import io.jenkins.plugins.analysis.core.model.StaticAnalysisLabelProvider;
 import io.jenkins.plugins.analysis.core.model.ToolSelection;
+import io.jenkins.plugins.analysis.core.util.IssuesStatistics.StatisticProperties;
 
 import static io.jenkins.plugins.analysis.core.model.ToolSelection.*;
 
@@ -44,6 +46,7 @@ public class IssuesTotalColumn extends ListViewColumn {
     private String name = "# Issues";
 
     private LabelProviderFactory labelProviderFactory = new LabelProviderFactory();
+    private StatisticProperties type = StatisticProperties.TOTAL;
 
     /** Creates a new instance of {@link ToolSelection}. */
     @DataBoundConstructor
@@ -52,7 +55,18 @@ public IssuesTotalColumn() {
         // empty constructor required for stapler
     }
 
-    @SuppressWarnings({"unused", "PMD.BooleanGetMethodName"}) // called by Stapler
+    /**
+     * Called after de-serialization to retain backward compatibility..
+     *
+     * @return this
+     */
+    protected Object readResolve() {
+        type = StatisticProperties.TOTAL;
+
+        return this;
+    }
+
+    @SuppressWarnings({"unused", "PMD.BooleanGetMethodName", "WeakerAccess"}) // called by Stapler
     public boolean getSelectTools() {
         return selectTools;
     }
@@ -74,6 +88,19 @@ public List<ToolSelection> getTools() {
         return tools;
     }
 
+    /**
+     * Returns the tools that should be taken into account when summing up the totals of a job.
+     *
+     * @param tools
+     *         the tools to select
+     *
+     * @see #setSelectTools(boolean)
+     */
+    @DataBoundSetter
+    public void setTools(final List<ToolSelection> tools) {
+        this.tools = tools;
+    }
+
     public String getName() {
         return name;
     }
@@ -89,17 +116,19 @@ public void setName(final String name) {
         this.name = name;
     }
 
+    public StatisticProperties getType() {
+        return type;
+    }
+
     /**
-     * Returns the tools that should be taken into account when summing up the totals of a job.
-     *
-     * @param tools
-     *         the tools to select
+     * Defines which value should be shown in the column.
      *
-     * @see #setSelectTools(boolean)
+     * @param type
+     *         the type of the values to show
      */
     @DataBoundSetter
-    public void setTools(final List<ToolSelection> tools) {
-        this.tools = tools;
+    public void setType(final StatisticProperties type) {
+        this.type = type;
     }
 
     @VisibleForTesting
@@ -129,7 +158,8 @@ public OptionalInt getTotal(final Job<?, ?> job) {
         return lastCompletedBuild.getActions(ResultAction.class).stream()
                 .filter(createToolFilter(selectTools, tools))
                 .map(ResultAction::getResult)
-                .mapToInt(AnalysisResult::getTotalSize)
+                .map(AnalysisResult::getTotals)
+                .mapToInt(totals -> type.getSizeGetter().apply(totals))
                 .reduce(Integer::sum);
     }
 
@@ -200,6 +230,21 @@ public static class IssuesTablePortletDescriptor extends ListViewColumnDescripto
         public String getDisplayName() {
             return Messages.IssuesTotalColumn_Name();
         }
+
+        /**
+         * Return the model for the select widget.
+         *
+         * @return the quality gate types
+         */
+        public ListBoxModel doFillTypeItems() {
+            ListBoxModel model = new ListBoxModel();
+
+            for (StatisticProperties qualityGateType : StatisticProperties.values()) {
+                model.add(qualityGateType.getDisplayName(), qualityGateType.name());
+            }
+
+            return model;
+        }
     }
 
     /**