Add Modified Files Coverage and Checks Publisher

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,13 @@
 package io.jenkins.plugins.coverage.metrics.model;
 
+import java.util.Comparator;
+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 +16,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;
 
@@ -370,6 +376,51 @@ 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()
+                // use the default comparator which uses the enum ordinal
+                .sorted()
+                .map(this::getDisplayName)
+                .collect(Collectors.toList());
+    }
+
+    /**
+     * Formats a stream of values to theis display representation by using the passed 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)
+                .sorted(Comparator.comparing(Coverage::getMetric));
+    }
+
     /**
      * 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,7 +172,7 @@ 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());
         Set<String> linesAsText = lines.stream().map(String::valueOf).collect(Collectors.toSet());

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/steps/ChangesTableModel.java

@@ -64,19 +64,19 @@ FileNode getOriginalFile() {
 
         @Override
         public DetailedCell<?> getLineCoverageDelta() {
-            return createColoredChangeCoverageDeltaColumn(Metric.LINE);
+            return createColoredModifiedLinesCoverageDeltaColumn(Metric.LINE);
         }
 
         @Override
         public DetailedCell<?> getBranchCoverageDelta() {
-            return createColoredChangeCoverageDeltaColumn(Metric.BRANCH);
+            return createColoredModifiedLinesCoverageDeltaColumn(Metric.BRANCH);
         }
 
-        DetailedCell<?> createColoredChangeCoverageDeltaColumn(final Metric metric) {
-            Coverage changeCoverage = getFile().getTypedValue(metric, Coverage.nullObject(metric));
-            if (changeCoverage.isSet()) {
+        DetailedCell<?> createColoredModifiedLinesCoverageDeltaColumn(final Metric metric) {
+            Coverage modifiedLinesCoverage = getFile().getTypedValue(metric, Coverage.nullObject(metric));
+            if (modifiedLinesCoverage.isSet()) {
                 return createColoredCoverageDeltaColumn(metric,
-                        changeCoverage.delta(originalFile.getTypedValue(metric, Coverage.nullObject(metric))));
+                        modifiedLinesCoverage.delta(originalFile.getTypedValue(metric, Coverage.nullObject(metric))));
             }
             return NO_COVERAGE;
         }

plugin/src/main/java/io/jenkins/plugins/coverage/metrics/steps/CoverageBuildAction.java

@@ -75,10 +75,16 @@ public final class CoverageBuildAction extends BuildAction<Node> implements Stap
     private final NavigableMap<Metric, Fraction> difference;
 
     /** The coverages filtered by changed lines of the associated change request. */
-    private final List<? extends Value> changeCoverage;
+    private final List<? extends Value> modifiedLinesCoverage;
 
     /** The delta of the coverages of the associated change request with respect to the reference build. */
-    private final NavigableMap<Metric, Fraction> changeCoverageDifference;
+    private final NavigableMap<Metric, Fraction> modifiedLinesCoverageDifference;
+
+    /** The coverage of the modified lines. */
+    private final List<? extends Value> modifiedFilesCoverage;
+
+    /** The coverage delta of the modified lines. */
+    private final NavigableMap<Metric, Fraction> modifiedFilesCoverageDifference;
 
     /** The indirect coverage changes of the associated change request with respect to the reference build. */
     private final List<? extends Value> indirectCoverageChanges;
@@ -87,7 +93,7 @@ public final class CoverageBuildAction extends BuildAction<Node> implements Stap
         CoverageXmlStream.registerConverters(XSTREAM2);
         XSTREAM2.registerLocalConverter(CoverageBuildAction.class, "difference",
                 new MetricFractionMapConverter());
-        XSTREAM2.registerLocalConverter(CoverageBuildAction.class, "changeCoverageDifference",
+        XSTREAM2.registerLocalConverter(CoverageBuildAction.class, "modifiedLinesCoverageDifference",
                 new MetricFractionMapConverter());
     }
 
@@ -112,7 +118,7 @@ public final class CoverageBuildAction extends BuildAction<Node> implements Stap
     public CoverageBuildAction(final Run<?, ?> owner, final String id, final String optionalName, final String icon,
             final Node result, final QualityGateResult qualityGateResult, final FilteredLog log) {
         this(owner, id, optionalName, icon, result, qualityGateResult, log, NO_REFERENCE_BUILD,
-                new TreeMap<>(), List.of(), new TreeMap<>(), List.of());
+                new TreeMap<>(), List.of(), new TreeMap<>(), List.of(), new TreeMap<>(), List.of());
     }
 
     /**
@@ -136,9 +142,9 @@ public CoverageBuildAction(final Run<?, ?> owner, final String id, final String
      *         the ID of the reference build
      * @param delta
      *         delta of this build's coverages with respect to the reference build
-     * @param changeCoverage
+     * @param modifiedLinesCoverage
      *         the coverages filtered by changed lines of the associated change request
-     * @param changeCoverageDifference
+     * @param modifiedLinesCoverageDifference
      *         the delta of the coverages of the associated change request with respect to the reference build
      * @param indirectCoverageChanges
      *         the indirect coverage changes of the associated change request with respect to the reference build
@@ -148,11 +154,16 @@ public CoverageBuildAction(final Run<?, ?> owner, final String id, final String
             final Node result, final QualityGateResult qualityGateResult, final FilteredLog log,
             final String referenceBuildId,
             final NavigableMap<Metric, Fraction> delta,
-            final List<? extends Value> changeCoverage,
-            final NavigableMap<Metric, Fraction> changeCoverageDifference,
+            final List<? extends Value> modifiedLinesCoverage,
+            final NavigableMap<Metric, Fraction> modifiedLinesCoverageDifference,
+            final List<? extends Value> modifiedFilesCoverage,
+            final NavigableMap<Metric, Fraction> modifiedFilesCoverageDifference,
             final List<? extends Value> indirectCoverageChanges) {
-        this(owner, id, optionalName, icon, result, qualityGateResult, log, referenceBuildId, delta, changeCoverage,
-                changeCoverageDifference, indirectCoverageChanges, true);
+        this(owner, id, optionalName, icon, result, qualityGateResult, log, referenceBuildId, delta,
+                modifiedLinesCoverage,
+                modifiedLinesCoverageDifference, modifiedFilesCoverage, modifiedFilesCoverageDifference,
+                indirectCoverageChanges,
+                true);
     }
 
     @VisibleForTesting
@@ -161,8 +172,10 @@ public CoverageBuildAction(final Run<?, ?> owner, final String id, final String
             final Node result, final QualityGateResult qualityGateResult, final FilteredLog log,
             final String referenceBuildId,
             final NavigableMap<Metric, Fraction> delta,
-            final List<? extends Value> changeCoverage,
-            final NavigableMap<Metric, Fraction> changeCoverageDifference,
+            final List<? extends Value> modifiedLinesCoverage,
+            final NavigableMap<Metric, Fraction> modifiedLinesCoverageDifference,
+            final List<? extends Value> modifiedFilesCoverage,
+            final NavigableMap<Metric, Fraction> modifiedFilesCoverageDifference,
             final List<? extends Value> indirectCoverageChanges,
             final boolean canSerialize) {
         super(owner, result, false);
@@ -175,8 +188,10 @@ public CoverageBuildAction(final Run<?, ?> owner, final String id, final String
         projectValues = result.aggregateValues();
         this.qualityGateResult = qualityGateResult;
         difference = delta;
-        this.changeCoverage = new ArrayList<>(changeCoverage);
-        this.changeCoverageDifference = changeCoverageDifference;
+        this.modifiedLinesCoverage = new ArrayList<>(modifiedLinesCoverage);
+        this.modifiedLinesCoverageDifference = modifiedLinesCoverageDifference;
+        this.modifiedFilesCoverage = new ArrayList<>(modifiedFilesCoverage);
+        this.modifiedFilesCoverageDifference = modifiedFilesCoverageDifference;
         this.indirectCoverageChanges = new ArrayList<>(indirectCoverageChanges);
         this.referenceBuildId = referenceBuildId;
 
@@ -207,8 +222,8 @@ public ElementFormatter getFormatter() {
     }
 
     public CoverageStatistics getStatistics() {
-        return new CoverageStatistics(projectValues, difference, changeCoverage, changeCoverageDifference,
-                List.of(), new TreeMap<>());
+        return new CoverageStatistics(projectValues, difference, modifiedLinesCoverage, modifiedLinesCoverageDifference,
+                modifiedFilesCoverage, modifiedFilesCoverageDifference);
     }
 
     /**
@@ -218,7 +233,7 @@ public CoverageStatistics getStatistics() {
      */
     @SuppressWarnings("unused") // Called by jelly view
     public List<Baseline> getBaselines() {
-        return List.of(Baseline.PROJECT, Baseline.MODIFIED_LINES, Baseline.INDIRECT);
+        return List.of(Baseline.PROJECT, Baseline.MODIFIED_FILES, Baseline.MODIFIED_LINES, Baseline.INDIRECT);
     }
 
     /**
@@ -273,6 +288,19 @@ public List<Value> getAllValues(final Baseline baseline) {
         return getValueStream(baseline).collect(Collectors.toList());
     }
 
+    public NavigableMap<Metric, Fraction> getAllDeltas(final Baseline deltaBaseline) {
+        if (deltaBaseline == Baseline.PROJECT_DELTA) {
+            return difference;
+        }
+        else if (deltaBaseline == Baseline.MODIFIED_LINES_DELTA) {
+            return modifiedLinesCoverageDifference;
+        }
+        else if (deltaBaseline == Baseline.MODIFIED_FILES_DELTA) {
+            return modifiedFilesCoverageDifference;
+        }
+        throw new NoSuchElementException("No delta baseline: " + deltaBaseline);
+    }
+
     /**
      * Returns all important values for the specified baseline.
      *
@@ -288,6 +316,12 @@ public List<Value> getValues(final Baseline baseline) {
         return filterImportantMetrics(getValueStream(baseline));
     }
 
+    public Optional<Value> getValueForMetric(final Baseline baseline, final Metric metric) {
+        return getAllValues(baseline).stream()
+                .filter(value -> value.getMetric() == metric)
+                .findFirst();
+    }
+
     private List<Value> filterImportantMetrics(final Stream<? extends Value> values) {
         return values.filter(v -> getMetricsForSummary().contains(v.getMetric()))
                 .collect(Collectors.toList());
@@ -298,7 +332,10 @@ private Stream<? extends Value> getValueStream(final Baseline baseline) {
             return projectValues.stream();
         }
         if (baseline == Baseline.MODIFIED_LINES) {
-            return changeCoverage.stream();
+            return modifiedLinesCoverage.stream();
+        }
+        if (baseline == Baseline.MODIFIED_FILES) {
+            return modifiedFilesCoverage.stream();
         }
         if (baseline == Baseline.INDIRECT) {
             return indirectCoverageChanges.stream();
@@ -316,7 +353,8 @@ private Stream<? extends Value> getValueStream(final Baseline baseline) {
      */
     @SuppressWarnings("unused") // Called by jelly view
     public boolean hasDelta(final Baseline baseline) {
-        return baseline == Baseline.PROJECT || baseline == Baseline.MODIFIED_LINES;
+        return baseline == Baseline.PROJECT || baseline == Baseline.MODIFIED_LINES
+                || baseline == Baseline.MODIFIED_FILES;
     }
 
     /**
@@ -334,7 +372,11 @@ public boolean hasDelta(final Baseline baseline, final Metric metric) {
             return difference.containsKey(metric);
         }
         if (baseline == Baseline.MODIFIED_LINES) {
-            return changeCoverageDifference.containsKey(metric)
+            return modifiedLinesCoverageDifference.containsKey(metric)
+                    && Set.of(Metric.BRANCH, Metric.LINE).contains(metric);
+        }
+        if (baseline == Baseline.MODIFIED_FILES) {
+            return modifiedFilesCoverageDifference.containsKey(metric)
                     && Set.of(Metric.BRANCH, Metric.LINE).contains(metric);
         }
         if (baseline == Baseline.INDIRECT) {
@@ -343,6 +385,39 @@ public boolean hasDelta(final Baseline baseline, final Metric metric) {
         throw new NoSuchElementException("No such baseline: " + baseline);
     }
 
+    /**
+     * Returns whether a value for the specified metric exists.
+     *
+     * @param baseline
+     *         the baseline to use
+     * @param metric
+     *         the metric to check
+     *
+     * @return {@code true} if a value is available for the specified metric, {@code false} otherwise
+     */
+    public boolean hasValue(final Baseline baseline, final Metric metric) {
+        return getAllValues(baseline).stream()
+                .anyMatch(v -> v.getMetric() == metric);
+    }
+
+    /**
+     * Returns a formatted and localized String representation of the value for the specified metric (with respect to
+     * the given baseline).
+     *
+     * @param baseline
+     *         the baseline to use
+     * @param metric
+     *         the metric to get the delta for
+     *
+     * @return the formatted value
+     */
+    public String formatValue(final Baseline baseline, final Metric metric) {
+        var value = getAllValues(baseline).stream()
+                .filter(v -> v.getMetric() == metric)
+                .findFirst();
+        return value.isPresent() ? FORMATTER.formatValue(value.get()) : Messages.Coverage_Not_Available();
+    }
+
     /**
      * Returns a formatted and localized String representation of the delta for the specified metric (with respect to
      * the given baseline).
@@ -364,7 +439,13 @@ public String formatDelta(final Baseline baseline, final Metric metric) {
         }
         if (baseline == Baseline.MODIFIED_LINES) {
             if (hasDelta(baseline, metric)) {
-                return FORMATTER.formatDelta(changeCoverageDifference.get(metric), metric,
+                return FORMATTER.formatDelta(modifiedLinesCoverageDifference.get(metric), metric,
+                        Functions.getCurrentLocale());
+            }
+        }
+        if (baseline == Baseline.MODIFIED_FILES) {
+            if (hasDelta(baseline, metric)) {
+                return FORMATTER.formatDelta(modifiedFilesCoverageDifference.get(metric), metric,
                         Functions.getCurrentLocale());
             }
         }