Coverage dashboard column #294

fo-code · 2022-02-01T16:30:26Z

Gernerally, some color utility classes have been added that can be used for visualizing coverage.
These classes are already used for visualizing the coverage within the tree map.

Also, provides a customizable dashboard column which can be used to show different coverage metrics of different coverage types of the latest completed build.
The column cell uses colors in order to highlight the coverage values.
The text can be clicked in order to open the coverage report of the latest completed build.

See #206

codecov · 2022-02-01T16:49:49Z

Codecov Report

Merging #294 (934e4c6) into master (545f0fb) will increase coverage by 2.54%.
The diff coverage is 92.98%.

@@             Coverage Diff              @@
##             master     #294      +/-   ##
============================================
+ Coverage     67.56%   70.10%   +2.54%     
- Complexity      595      689      +94     
============================================
  Files            60       73      +13     
  Lines          2454     2713     +259     
  Branches        296      313      +17     
============================================
+ Hits           1658     1902     +244     
- Misses          699      709      +10     
- Partials         97      102       +5

Impacted Files	Coverage Δ
.../model/visualization/dashboard/CoverageColumn.java	`69.81% <69.81%> (ø)`
...odel/visualization/colorization/CoverageLevel.java	`93.93% <93.93%> (ø)`
...alization/colorization/CoverageChangeTendency.java	`94.11% <94.11%> (ø)`
...ns/plugins/coverage/model/CoverageBuildAction.java	`74.00% <100.00%> (+9.41%)`	⬆️
...jenkins/plugins/coverage/model/CoverageMetric.java	`96.15% <100.00%> (+0.07%)`	⬆️
...kins/plugins/coverage/model/CoverageViewModel.java	`40.40% <100.00%> (+0.60%)`	⬆️
...s/plugins/coverage/model/TreeMapNodeConverter.java	`100.00% <100.00%> (ø)`
...plugins/coverage/model/util/FractionFormatter.java	`100.00% <100.00%> (ø)`
...rage/model/visualization/colorization/ColorId.java	`100.00% <100.00%> (ø)`
...odel/visualization/colorization/ColorProvider.java	`100.00% <100.00%> (ø)`
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 545f0fb...934e4c6. Read the comment docs.

src/main/java/io/jenkins/plugins/coverage/model/CoverageBuildAction.java

src/main/java/io/jenkins/plugins/coverage/model/util/WebUtil.java

src/main/java/io/jenkins/plugins/coverage/model/visualization/colorization/ColorUtils.java

...n/java/io/jenkins/plugins/coverage/model/visualization/colorization/CoverageChangeLevel.java

src/main/java/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumn.java

src/test/java/io/jenkins/plugins/coverage/model/visualization/colorization/ColoUtilsTest.java

...va/io/jenkins/plugins/coverage/model/visualization/colorization/CoverageChangeLevelTest.java

fo-code · 2022-02-02T16:40:07Z

Danke @hd42 für den Review!
Ich habe zu den meisten Anmerkungen Anpassungen vorgenommen. Ansonsten siehe Kommentar-Antworten.

# Conflicts: # plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageType.java # plugin/src/main/java/io/jenkins/plugins/coverage/model/TreeMapNodeConverter.java # plugin/src/main/java/io/jenkins/plugins/coverage/model/util/WebUtils.java # plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/colorization/ColorUtils.java # plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/colorization/CoverageChangeTendency.java # plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/colorization/CoverageColorizationLevel.java # plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumn.java # plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumn/column.jelly # plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumn/columnHeader.jelly # plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumn/config.jelly # plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumn/config.properties # plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageBuildActionTest.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageTypeTest.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/ResultStubs.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/TreeMapNodeConverterTest.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/testutil/CoverageStubs.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/testutil/JobStubs.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/util/WebUtilsTest.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/visualization/colorization/ColorUtilsTest.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/visualization/colorization/CoverageChangeTendencyTest.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/visualization/colorization/CoverageColorizationLevelTest.java # plugin/src/test/java/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumnTest.java

…ode-coverage-api-plugin into coverage-visualization

plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageBuildAction.java

plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageMetric.java

plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageType.java

plugin/src/main/java/io/jenkins/plugins/coverage/model/TreeMapNodeConverter.java

...n/src/main/java/io/jenkins/plugins/coverage/model/visualization/colorization/ColorUtils.java

plugin/src/main/resources/io/jenkins/plugins/coverage/model/Messages.properties

...es/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumn/column.jelly

.../main/java/io/jenkins/plugins/coverage/model/visualization/dashboard/CodeCoverageColumn.java

plugin/src/test/java/io/jenkins/plugins/coverage/model/util/FractionFormatterTest.java

plugin/src/test/java/io/jenkins/plugins/coverage/model/util/WebUtilsTest.java

uhafner

Just a few questions, we can resolve them in a followup PR if required.

uhafner · 2022-03-09T21:23:16Z

...rc/main/java/io/jenkins/plugins/coverage/model/visualization/colorization/CoverageLevel.java

+    LVL_95(95.0, ColorId.OUTSTANDING),
+    LVL_90(90.0, ColorId.EXCELLENT),
+    LVL_85(85.0, ColorId.VERY_GOOD),
+    LVL_80(80.0, ColorId.GOOD),
+    LVL_75(75.0, ColorId.ABOVE_AVERAGE),
+    LVL_70(70.0, ColorId.AVERAGE),
+    LVL_65(65.0, ColorId.BELOW_AVERAGE),
+    LVL_60(60.0, ColorId.BAD),
+    LVL_50(50.0, ColorId.VERY_BAD),
+    LVL_0(0.0, ColorId.INSUFFICIENT),
+    NA(-1.0, ColorId.WHITE);


Wouldn't it make sense to use a class here so that we make the percentage user configurable?

Yes, I also think the colorization should be project specific.

This enum - in long terms - is meant as a fallback colorization when no thresholds have been defined.
For further enhancements, I would suggest another color enum which is used to colorize coverage dependent on the set thresholds (maybe CoverageChangeLevel could be used directly after a rename).
This should act in a similar way, but without any further definitions but the thresholds required.

For example, if the general coverage threshold is 60% and the coverage is 65%, the color should be green for 'good' instead red for 'bad', as provided here.

...rc/main/java/io/jenkins/plugins/coverage/model/visualization/colorization/CoverageLevel.java

.../src/main/java/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn.java

plugin/src/test/java/io/jenkins/plugins/coverage/model/util/WebUtilsTest.java

…used. (If a localized messsage is stored in a static field then the wrong locale will be used.)

reitzmichnicht · 2022-06-27T07:56:40Z

Just upgraded to latest jenkins LTS with the newest release of code-coverage plugin and now can not create any views with the coveragecolumn by job-dsl

09:36:23 ERROR: Found multiple extensions which provide method coverageColumn with arguments []: [io.jenkins.plugins.coverage.CoverageColumn, io.jenkins.plugins.coverage.model.visualization.dashboard.CoverageColumn]

  listView("foo") {
    jobs {
      regex("^bar")
    }
    recurse(true)
    columns {
      status()
      weather()
      name()
      lastSuccess()
      lastFailure()
      lastDuration()
      issuesTotalColumn {
        name("# Issues")
      }
      testResult(1)
      coverageColumn()
      buildButton()
    }
  }
}

uhafner · 2022-06-27T08:40:24Z

Can you please create a bug report? Seems that we forgot to delete the old column. Is there a way to specify the class that should be used in JobDSL? The new column is: io.jenkins.plugins.coverage.model.visualization.dashboard.CoverageColumn

fo-code and others added 3 commits February 1, 2022 17:13

Added customizable coverage dashboard column and advanced color utility

80600eb

Merge branch 'jenkinsci:master' into coverage-visualization

b54b15e

Fixed import

87b8025

fo-code added 3 commits February 1, 2022 18:41

Fixed warnings

8fc810e

Fixed warnings

4b32a0c

Fixed import

46c44b8

hd42 suggested changes Feb 2, 2022

View reviewed changes

Adjusted colorization levels

52e4a39

fo-code changed the title ~~Coverage visualization~~ Coverage dashboard column Feb 5, 2022

fo-code and others added 6 commits February 14, 2022 18:17

Resolved merge conflicts

39b1b2b

Merge branch 'jenkinsci:master' into coverage-visualization

efa0c9e

Fixed test errors

13a059a

Merge branch 'coverage-visualization' of https://github.com/fo-code/c…

b9427fb

…ode-coverage-api-plugin into coverage-visualization

Fixed test errors

dacd36c

uhafner suggested changes Feb 18, 2022

View reviewed changes

Merge branch 'master' into coverage-visualization

e3c6dda

uhafner added the feature New features label Feb 21, 2022

fo-code added 8 commits February 22, 2022 08:57

Adjusted dependencies

9707cef

Rework and advanced color handling

9bedd54

Merge branch 'master' into coverage-visualization

2f65f01

Fixed tests

402ede9

Added tests and javadoc

79a6f32

Style fixes

3aa8b5f

Style fixes

bf75d1e

Adjusted color IDs

dd13b4a

fo-code marked this pull request as ready for review March 9, 2022 09:13

fo-code requested a review from uhafner March 9, 2022 09:18

uhafner approved these changes Mar 9, 2022

View reviewed changes

fo-code added 2 commits March 10, 2022 14:37

Merge branch 'master' into coverage-visualization

d6d5e85

Style fixes

f2959d1

fo-code requested a review from uhafner March 10, 2022 14:57

Dynamically compute localized text so that the client locale will be …

934e4c6

…used. (If a localized messsage is stored in a static field then the wrong locale will be used.)

uhafner approved these changes Mar 10, 2022

View reviewed changes

uhafner merged commit 31447e6 into jenkinsci:master Mar 10, 2022

Coverage dashboard column #294

Coverage dashboard column #294

Uh oh!

Conversation

fo-code commented Feb 1, 2022 • edited by uhafner Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Feb 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fo-code commented Feb 2, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

uhafner left a comment

Choose a reason for hiding this comment

Uh oh!

uhafner Mar 9, 2022

Choose a reason for hiding this comment

Uh oh!

fo-code Mar 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

reitzmichnicht commented Jun 27, 2022

Uh oh!

uhafner commented Jun 27, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fo-code commented Feb 1, 2022 •

edited by uhafner

Loading

codecov bot commented Feb 1, 2022 •

edited

Loading

fo-code Mar 10, 2022 •

edited

Loading