Add Modified Files Coverage and Checks Publisher

plugin/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>org.jvnet.hudson.plugins</groupId>
     <artifactId>analysis-pom</artifactId>
-    <version>6.0.0</version>
+    <version>6.1.0</version>
     <relativePath />
   </parent>
 
@@ -35,11 +35,17 @@
     <job-dsl.version>1.81</job-dsl.version>
     <xmlunit.version>2.9.0</xmlunit.version>
 
-    <coverage-model.version>0.13.0</coverage-model.version>
+    <coverage-model.version>0.15.0</coverage-model.version>
     <echarts-api.version>5.4.0-2-rc759.8b_4e78286216</echarts-api.version>
     <prism-api.version>1.29.0-3-rc207.f000c20b_dea_5</prism-api.version>
-    <plugin-util-api.version>3.0.0-rc679.e40704a_a_f29f</plugin-util-api.version>
     <git-forensics.version>1.11.0</git-forensics.version>
+
+    <jquery3-api.version>3.6.3-1-rc365.70899fb_d9e1d</jquery3-api.version>
+    <plugin-util-api.version>3.0.0-rc693.c098b_871ea_49</plugin-util-api.version>
+    <bootstrap5-api.version>5.2.2-1-rc442.6631330fec41</bootstrap5-api.version>
+    <font-awesome-api.version>6.3.0-1-rc517.f6b_6e5a_dd4ef</font-awesome-api.version>
+
+    <forensics-api.version>2.0.0-rc1380.c93c627cd828</forensics-api.version>
   </properties>
 
   <developers>
@@ -139,11 +145,12 @@
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
       <artifactId>bootstrap5-api</artifactId>
-      <version>5.2.0-3</version>
+      <version>${bootstrap5-api.version}</version>
     </dependency>
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
       <artifactId>jquery3-api</artifactId>
+      <version>${jquery3-api.version}</version>
     </dependency>
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
@@ -152,7 +159,7 @@
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
       <artifactId>forensics-api</artifactId>
-      <version>2.0.0-rc1380.c93c627cd828</version>
+      <version>${forensics-api.version}</version>
     </dependency>
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
@@ -162,6 +169,7 @@
     <dependency>
       <groupId>io.jenkins.plugins</groupId>
       <artifactId>font-awesome-api</artifactId>
+      <version>${font-awesome-api.version}</version>
     </dependency>
     <dependency>
       <groupId>io.jenkins.plugins</groupId>

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/charts/TreeMapNodeConverter.java

@@ -1,5 +1,7 @@
 package io.jenkins.plugins.coverage.metrics.charts;
 
+import java.util.Optional;
+
 import edu.hm.hafner.echarts.ItemStyle;
 import edu.hm.hafner.echarts.Label;
 import edu.hm.hafner.echarts.LabeledTreeMapNode;
@@ -38,7 +40,8 @@ public class TreeMapNodeConverter {
      */
     public LabeledTreeMapNode toTreeChartModel(final Node node, final Metric metric, final ColorProvider colorProvider) {
         var tree = mergePackages(node);
-        LabeledTreeMapNode root = toTreeMapNode(tree, metric, colorProvider);
+        LabeledTreeMapNode root = toTreeMapNode(tree, metric, colorProvider).orElse(
+                new LabeledTreeMapNode(node.getPath(), node.getName()));
         for (LabeledTreeMapNode child : root.getChildren()) {
             child.collapseEmptyPackages();
         }
@@ -55,18 +58,18 @@ private Node mergePackages(final Node node) {
         return node;
     }
 
-    private LabeledTreeMapNode toTreeMapNode(final Node node, final Metric metric,
+    private Optional<LabeledTreeMapNode> toTreeMapNode(final Node node, final Metric metric,
             final ColorProvider colorProvider) {
         var value = node.getValue(metric);
         if (value.isPresent()) {
             var rootValue = value.get();
             if (rootValue instanceof Coverage) {
-                return createCoverageTree((Coverage) rootValue, colorProvider, node, metric);
+                return Optional.of(createCoverageTree((Coverage) rootValue, colorProvider, node, metric));
             }
             // TODO: does it make sense to render the other metrics?
         }
 
-        return new LabeledTreeMapNode(node.getPath(), node.getName());
+        return Optional.empty();
     }
 
     private LabeledTreeMapNode createCoverageTree(final Coverage coverage, final ColorProvider colorProvider, final Node node,
@@ -91,6 +94,7 @@ private LabeledTreeMapNode createCoverageTree(final Coverage coverage, final Col
 
         node.getChildren().stream()
                 .map(n -> toTreeMapNode(n, metric, colorProvider))
+                .flatMap(Optional::stream)
                 .forEach(treeNode::insertNode);
 
         return treeNode;

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/model/Baseline.java

@@ -27,23 +27,23 @@ public enum Baseline {
      * Coverage of the modified lines (e.g., within the modified lines of a pull or merge request) will focus on new or
      * modified code only.
      */
-    MODIFIED_LINES(Messages._Baseline_MODIFIED_LINES(), "changeCoverage", CoverageLevel::getDisplayColorsOfCoverageLevel),
+    MODIFIED_LINES(Messages._Baseline_MODIFIED_LINES(), "modifiedLinesCoverage", CoverageLevel::getDisplayColorsOfCoverageLevel),
     /**
      * Difference between the project coverage and the modified lines coverage of the current build. Teams can use this delta
      * value to ensure that the coverage of pull requests is better than the whole project coverage.
      */
-    MODIFIED_LINES_DELTA(Messages._Baseline_MODIFIED_LINES_DELTA(), "changeCoverage",
+    MODIFIED_LINES_DELTA(Messages._Baseline_MODIFIED_LINES_DELTA(), "modifiedLinesCoverage",
             CoverageChangeTendency::getDisplayColorsForTendency),
     /**
      * Coverage of the modified files (e.g., within the files that have been touched in a pull or merge request) will
      * focus on new or modified code only.
      */
-    MODIFIED_FILES(Messages._Baseline_MODIFIED_FILES(), "fileCoverage", CoverageLevel::getDisplayColorsOfCoverageLevel),
+    MODIFIED_FILES(Messages._Baseline_MODIFIED_FILES(), "modifiedFilesCoverage", CoverageLevel::getDisplayColorsOfCoverageLevel),
     /**
      * Difference between the project coverage and the modified file coverage of the current build. Teams can use this delta
      * value to ensure that the coverage of pull requests is better than the whole project coverage.
      */
-    MODIFIED_FILES_DELTA(Messages._Baseline_MODIFIED_FILES_DELTA(), "fileCoverage", CoverageChangeTendency::getDisplayColorsForTendency),
+    MODIFIED_FILES_DELTA(Messages._Baseline_MODIFIED_FILES_DELTA(), "modifiedFilesCoverage", CoverageChangeTendency::getDisplayColorsForTendency),
     /**
      * Indirect changes of the overall code coverage that are not part of the changed code. These changes might occur,
      * if new tests will be added without touching the underlying code under test.

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/model/ElementFormatter.java

@@ -1,8 +1,12 @@
 package io.jenkins.plugins.coverage.metrics.model;
 
+import java.util.List;
 import java.util.Locale;
 import java.util.NoSuchElementException;
+import java.util.Optional;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.math.Fraction;
@@ -11,6 +15,7 @@
 import edu.hm.hafner.metric.FractionValue;
 import edu.hm.hafner.metric.IntegerValue;
 import edu.hm.hafner.metric.Metric;
+import edu.hm.hafner.metric.Node;
 import edu.hm.hafner.metric.Percentage;
 import edu.hm.hafner.metric.Value;
 
@@ -134,6 +139,7 @@ public String formatDetails(final Value value, final Locale locale) {
      *
      * @param value
      *         the value to format
+     *
      * @return the formatted value as plain text
      */
     public String formatAdditionalInformation(final Value value) {
@@ -184,10 +190,11 @@ public boolean showColors(final Value value) {
     public DisplayColors getDisplayColors(final Baseline baseline, final Value value) {
         var defaultColorProvider = ColorProviderFactory.createDefaultColorProvider();
         if (value instanceof Coverage) {
-            return baseline.getDisplayColors(((Coverage)value).getCoveredPercentage().toDouble(), defaultColorProvider);
+            return baseline.getDisplayColors(((Coverage) value).getCoveredPercentage().toDouble(),
+                    defaultColorProvider);
         }
         else if (value instanceof FractionValue) {
-            return baseline.getDisplayColors(((FractionValue)value).getFraction().doubleValue(), defaultColorProvider);
+            return baseline.getDisplayColors(((FractionValue) value).getFraction().doubleValue(), defaultColorProvider);
         }
         return ColorProvider.DEFAULT_COLOR;
     }
@@ -370,6 +377,48 @@ public String getDisplayName(final Metric metric) {
         }
     }
 
+    /**
+     * Gets the display names of the existing {@link Metric coverage metrics}, sorted by the metrics ordinal.
+     *
+     * @return the sorted metric display names
+     */
+    public List<String> getSortedCoverageDisplayNames() {
+        return Metric.getCoverageMetrics().stream()
+                .map(this::getDisplayName)
+                .collect(Collectors.toList());
+    }
+
+    /**
+     * Formats a stream of values to their display representation by using the given locale.
+     *
+     * @param values
+     *         The values to be formatted
+     * @param locale
+     *         The locale to be used for formatting
+     *
+     * @return the formatted values in the origin order of the stream
+     */
+    public List<String> getFormattedValues(final Stream<? extends Value> values, final Locale locale) {
+        return values.map(value -> formatDetails(value, locale)).collect(Collectors.toList());
+    }
+
+    /**
+     * Returns a stream of {@link Coverage} values for the given root node sorted by the metric ordinal.
+     *
+     * @param coverage
+     *         The coverage root node
+     *
+     * @return a stream containing the existent coverage values
+     */
+    public Stream<Coverage> getSortedCoverageValues(final Node coverage) {
+        return Metric.getCoverageMetrics()
+                .stream()
+                .map(m -> m.getValueFor(coverage))
+                .flatMap(Optional::stream)
+                .filter(value -> value instanceof Coverage)
+                .map(Coverage.class::cast);
+    }
+
     /**
      * Returns a localized human-readable label for the specified metric.
      *

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/source/SourceCodeFacade.java

@@ -163,7 +163,7 @@ File createFileInBuildFolder(final File buildResults, final String id, final Str
     }
 
     /**
-     * Filters the sourcecode coverage highlighting for analyzing the change coverage only.
+     * Filters the sourcecode coverage highlighting for analyzing the modified lines coverage only.
      *
      * @param content
      *         The original HTML content
@@ -172,9 +172,9 @@ File createFileInBuildFolder(final File buildResults, final String id, final Str
      *
      * @return the filtered HTML sourcecode view
      */
-    public String calculateChangeCoverageSourceCode(final String content, final FileNode fileNode) {
+    public String calculateModifiedLinesCoverageSourceCode(final String content, final FileNode fileNode) {
         Set<Integer> lines = fileNode.getLinesWithCoverage();
-        lines.retainAll(fileNode.getChangedLines());
+        lines.retainAll(fileNode.getModifiedLines());
         Set<String> linesAsText = lines.stream().map(String::valueOf).collect(Collectors.toSet());
         Document doc = Jsoup.parse(content, Parser.xmlParser());
         int maxLine = Integer.parseInt(Objects.requireNonNull(

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/source/SourceCodePainter.java

@@ -18,7 +18,7 @@
 import org.apache.commons.io.FileUtils;
 
 import edu.hm.hafner.metric.FileNode;
-import edu.hm.hafner.metric.Metric;
+import edu.hm.hafner.metric.Mutation;
 import edu.hm.hafner.util.FilteredLog;
 import edu.umd.cs.findbugs.annotations.NonNull;
 
@@ -328,29 +328,33 @@ private enum Type {
         private final int[] linesToPaint;
         private final int[] coveredPerLine;
         private final int[] missedPerLine;
-        private final Type type;
+        private final int[] survivedPerLine;
+        private final int[] killedPerLine;
 
         PaintedNode(final FileNode file) {
             path = file.getPath();
+
             linesToPaint = file.getLinesWithCoverage().stream().mapToInt(i -> i).toArray();
             coveredPerLine = file.getCoveredCounters();
             missedPerLine = file.getMissedCounters();
-            if (file.containsMetric(Metric.MUTATION)) { // FIXME: this needs to be generalized
-                type = Type.MUTATION;
-            }
-            else {
-                type = Type.COVERAGE;
+
+            survivedPerLine = new int[linesToPaint.length];
+            killedPerLine = new int[linesToPaint.length];
+
+            for (Mutation mutation : file.getMutations()) { // FIXME: this needs to be generalized
+                if (mutation.hasSurvived()) {
+                    survivedPerLine[findLine(mutation.getLine())]++;
+                }
+                else if (mutation.isKilled()) {
+                    killedPerLine[findLine(mutation.getLine())]++;
+                }
             }
         }
 
         public String getPath() {
             return path;
         }
 
-        public boolean isMutation() {
-            return type == Type.MUTATION;
-        }
-
         public boolean isPainted(final int line) {
             return findLine(line) >= 0;
         }
@@ -367,6 +371,14 @@ public int getMissed(final int line) {
             return getCounter(line, missedPerLine);
         }
 
+        public int getSurvived(final int line) {
+            return getCounter(line, survivedPerLine);
+        }
+
+        public int getKilled(final int line) {
+            return getCounter(line, killedPerLine);
+        }
+
         private int getCounter(final int line, final int[] counters) {
             var index = findLine(line);
             if (index >= 0) {