From 599b75bce8373c77c12d0ec8b01a55627c4a472c Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Fri, 20 May 2022 17:25:30 +0200 Subject: [PATCH 01/32] Improve the layout and design of the coverage columns. --- .../coverage/model/CoverageViewModel.java | 16 +++++------ .../dashboard/CoverageColumn/column.jelly | 27 ++++++++++--------- plugin/src/main/webapp/css/column-style.css | 9 +++++++ plugin/src/main/webapp/css/custom-style.css | 16 +++++++++++ 4 files changed, 48 insertions(+), 20 deletions(-) create mode 100644 plugin/src/main/webapp/css/column-style.css diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index 1012f4217..764ec4ca7 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -582,13 +582,13 @@ protected DetailedColumnDefinition createColoredCoverageColumn(final CoveragePer double percentage = coverage.getDoubleValue(); String sort = String.valueOf(percentage); DisplayColors colors = CoverageLevel.getDisplayColorsOfCoverageLevel(percentage, COLOR_PROVIDER); - String tag = span() - .withTitle(tooltip) - .withStyle(String.format( - "color:%s; background-image: linear-gradient(90deg, %s %f%%, transparent %f%%); display:block;", + String tag = div().withClasses("coverage-column-outer").with( + div().withClasses("coverage-column-inner") + .withStyle(String.format("color:%s; background-image: linear-gradient(90deg, %s %f%%, transparent %f%%);", colors.getLineColorAsHex(), colors.getFillColorAsHex(), percentage, percentage)) - .withText(text) + .withTitle(tooltip) + .withText(text)) .render(); return new DetailedColumnDefinition(tag, sort); } @@ -610,12 +610,12 @@ protected DetailedColumnDefinition createColoredCoverageDeltaColumn( String sort = String.valueOf(coverageValue); DisplayColors colors = CoverageChangeTendency .getDisplayColorsForTendency(coverageValue, COLOR_PROVIDER); - String tag = span() - .withClasses("badge", "badge-delta") + String tag = div().withClasses("coverage-column-outer").with( + div().withClasses("coverage-column-inner") .withStyle(String.format("color:%s;background-color:%s;", colors.getLineColorAsHex(), colors.getFillColorAsHex())) .withText(coverageText) - .withTitle(tooltip) + .withTitle(tooltip)) .render(); return new DetailedColumnDefinition(tag, sort); } diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/column.jelly b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/column.jelly index 8f63fee0f..a75d7831d 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/column.jelly +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/column.jelly @@ -1,27 +1,30 @@ + + - - - - - ${coverageText} - - - ${coverageText} - - + +
+
+ + + ${coverageText} + + + ${coverageText} + + +
+
diff --git a/plugin/src/main/webapp/css/column-style.css b/plugin/src/main/webapp/css/column-style.css new file mode 100644 index 000000000..dd3bb8e44 --- /dev/null +++ b/plugin/src/main/webapp/css/column-style.css @@ -0,0 +1,9 @@ +.coverage-column-inner { + padding: 4px 7px; + border-radius: 10px +} + +.coverage-column-outer { + border: 1px solid var(--light-bg-color); + border-radius: 10px +} diff --git a/plugin/src/main/webapp/css/custom-style.css b/plugin/src/main/webapp/css/custom-style.css index 7ad5c734a..856234ae9 100644 --- a/plugin/src/main/webapp/css/custom-style.css +++ b/plugin/src/main/webapp/css/custom-style.css @@ -56,9 +56,25 @@ border-color: #b4b4b4; background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'%3e%3ccircle r='3' fill='white'/%3e%3c/svg%3e"); } + .form-switch .form-check-input:focus { box-shadow: none; background-color: #b4b4b4; border-color: #b4b4b4; background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'%3e%3ccircle r='3' fill='white'/%3e%3c/svg%3e"); } + +.coverage-column-outer { + border: 1px solid var(--light-bg-color); + border-radius: 10px; +} + +.coverage-column-inner { + padding: 1px 7px; + border-radius: 10px; + color:black +} + +#coverage-table td { + vertical-align: middle; +} From adfcb8a956202509aaa1974391840c30edac384f Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Fri, 20 May 2022 22:53:42 +0200 Subject: [PATCH 02/32] Right align number cells. --- .../plugins/coverage/model/CoverageViewModel.java | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index 764ec4ca7..486d597e5 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -470,23 +470,23 @@ public List getColumns() { // fileColumn.setWidth(2); columns.add(fileColumn); - TableColumn lineColumn = new TableColumn("Line", "lineCoverage", "number"); + TableColumn lineColumn = new TableColumn("Line", "lineCoverage", "number").setHeaderClass(ColumnCss.NUMBER); // lineColumn.setWidth(2); columns.add(lineColumn); - TableColumn lineColumnDelta = new TableColumn("Line Δ", "lineCoverageDelta", "number"); + TableColumn lineColumnDelta = new TableColumn("Line Δ", "lineCoverageDelta", "number").setHeaderClass(ColumnCss.NUMBER); // lineColumnDelta.setWidth(1); columns.add(lineColumnDelta); - TableColumn branchColumn = new TableColumn("Branch", "branchCoverage", "number"); + TableColumn branchColumn = new TableColumn("Branch", "branchCoverage", "number").setHeaderClass(ColumnCss.NUMBER); // branchColumn.setWidth(2); columns.add(branchColumn); - TableColumn branchColumnDelta = new TableColumn("Branch Δ", "branchCoverageDelta", "number"); + TableColumn branchColumnDelta = new TableColumn("Branch Δ", "branchCoverageDelta", "number").setHeaderClass(ColumnCss.NUMBER); // branchColumnDelta.setWidth(1); columns.add(branchColumnDelta); - TableColumn loc = new TableColumn("LOC", "loc", "number"); + TableColumn loc = new TableColumn("LOC", "loc", "number").setHeaderClass(ColumnCss.NUMBER); // loc.setWidth(1); columns.add(loc); @@ -699,7 +699,7 @@ static class IndirectCoverageChangesTable extends CoverageTableModel { private final CoverageNode changeRoot; /** - * Creates a indirect coverage changes table model. + * Creates an indirect coverage changes table model. * * @param root * The root of the origin coverage tree From ea30b5e12f98da11143416f9cf9015e7863f5a37 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Fri, 20 May 2022 23:17:55 +0200 Subject: [PATCH 03/32] Print n/a without rendering. --- .../coverage/model/CoverageViewModel.java | 74 ++++++++----------- 1 file changed, 30 insertions(+), 44 deletions(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index 486d597e5..5b762d22d 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -510,6 +510,8 @@ protected CoverageNode getRoot() { * UI row model for the coverage details table. */ private static class CoverageRow { + private static final String COVERAGE_COLUMN_OUTER = "coverage-column-outer"; + private static final String COVERAGE_COLUMN_INNER = "coverage-column-inner"; private final CoverageNode root; private final Locale browserLocale; @@ -532,14 +534,12 @@ public String getPackageName() { public DetailedColumnDefinition getLineCoverage() { Coverage coverage = root.getCoverage(LINE_COVERAGE); - return createColoredCoverageColumn(coverage.getCoveredPercentage(), printCoverage(coverage), - "The total line coverage of the file"); + return createColoredCoverageColumn(coverage, "The total line coverage of the file"); } public DetailedColumnDefinition getBranchCoverage() { Coverage coverage = root.getCoverage(BRANCH_COVERAGE); - return createColoredCoverageColumn(coverage.getCoveredPercentage(), printCoverage(coverage), - "The total branch coverage of the file"); + return createColoredCoverageColumn(coverage, "The total branch coverage of the file"); } public DetailedColumnDefinition getLineCoverageDelta() { @@ -558,39 +558,32 @@ public DetailedColumnDefinition getLoc() { return new DetailedColumnDefinition(Messages.Coverage_Not_Available(), "0"); } - protected String printCoverage(final Coverage coverage) { - if (coverage.isSet()) { - return coverage.formatCoveredPercentage(browserLocale); - } - return Messages.Coverage_Not_Available(); - } - /** * Creates a table cell which colorizes the shown coverage dependent on the coverage percentage. * * @param coverage - * The coverage as percentage - * @param text - * The text to be shown which represents the coverage + * the coverage of the element * @param tooltip - * The tooltip which describes the value + * the tooltip which describes the value * * @return the create {@link DetailedColumnDefinition} */ - protected DetailedColumnDefinition createColoredCoverageColumn(final CoveragePercentage coverage, - final String text, final String tooltip) { - double percentage = coverage.getDoubleValue(); - String sort = String.valueOf(percentage); - DisplayColors colors = CoverageLevel.getDisplayColorsOfCoverageLevel(percentage, COLOR_PROVIDER); - String tag = div().withClasses("coverage-column-outer").with( - div().withClasses("coverage-column-inner") - .withStyle(String.format("color:%s; background-image: linear-gradient(90deg, %s %f%%, transparent %f%%);", - colors.getLineColorAsHex(), colors.getFillColorAsHex(), - percentage, percentage)) - .withTitle(tooltip) - .withText(text)) - .render(); - return new DetailedColumnDefinition(tag, sort); + protected DetailedColumnDefinition createColoredCoverageColumn(final Coverage coverage, final String tooltip) { + double percentage = coverage.getCoveredPercentage().getDoubleValue(); + if (coverage.isSet()) { + DisplayColors colors = CoverageLevel.getDisplayColorsOfCoverageLevel(percentage, COLOR_PROVIDER); + String cell = div().withClasses(COVERAGE_COLUMN_OUTER).with( + div().withClasses(COVERAGE_COLUMN_INNER) + .withStyle(String.format( + "color:%s; background-image: linear-gradient(90deg, %s %f%%, transparent %f%%);", + colors.getLineColorAsHex(), colors.getFillColorAsHex(), + percentage, percentage)) + .withTitle(tooltip) + .withText(coverage.formatCoveredPercentage(browserLocale))) + .render(); + return new DetailedColumnDefinition(cell, String.valueOf(percentage)); + } + return new DetailedColumnDefinition(Messages.Coverage_Not_Available(), "-"); } /** @@ -608,16 +601,15 @@ protected DetailedColumnDefinition createColoredCoverageDeltaColumn( double coverageValue = coveragePercentage.getDoubleValue(); String coverageText = coveragePercentage.formatDeltaPercentage(browserLocale); String sort = String.valueOf(coverageValue); - DisplayColors colors = CoverageChangeTendency - .getDisplayColorsForTendency(coverageValue, COLOR_PROVIDER); - String tag = div().withClasses("coverage-column-outer").with( - div().withClasses("coverage-column-inner") + DisplayColors colors = CoverageChangeTendency.getDisplayColorsForTendency(coverageValue, COLOR_PROVIDER); + String cell = div().withClasses(COVERAGE_COLUMN_OUTER).with( + div().withClasses(COVERAGE_COLUMN_INNER) .withStyle(String.format("color:%s;background-color:%s;", colors.getLineColorAsHex(), colors.getFillColorAsHex())) .withText(coverageText) .withTitle(tooltip)) .render(); - return new DetailedColumnDefinition(tag, sort); + return new DetailedColumnDefinition(cell, sort); } protected CoverageNode getRoot() { @@ -654,7 +646,6 @@ private DetailedColumnDefinition createColoredFileCoverageDeltaColumn(final Cove * @since 3.0.0 */ static class ChangeCoverageTable extends CoverageTableModel { - private final CoverageNode changeRoot; /** @@ -758,15 +749,13 @@ private static class ChangeCoverageRow extends CoverageRow { @Override public DetailedColumnDefinition getLineCoverage() { Coverage coverage = changedFileNode.getCoverage(LINE_COVERAGE); - return createColoredCoverageColumn(coverage.getCoveredPercentage(), printCoverage(coverage), - "The line change coverage"); + return createColoredCoverageColumn(coverage, "The line change coverage"); } @Override public DetailedColumnDefinition getBranchCoverage() { Coverage coverage = changedFileNode.getCoverage(BRANCH_COVERAGE); - return createColoredCoverageColumn(coverage.getCoveredPercentage(), printCoverage(coverage), - "The branch change coverage"); + return createColoredCoverageColumn(coverage, "The branch change coverage"); } @Override @@ -805,7 +794,6 @@ private DetailedColumnDefinition createColoredChangeCoverageDeltaColumn(final Co * @since 3.0.0 */ private static class IndirectCoverageChangesRow extends CoverageRow { - private final FileCoverageNode changedFileNode; /** @@ -827,15 +815,13 @@ private static class IndirectCoverageChangesRow extends CoverageRow { @Override public DetailedColumnDefinition getLineCoverage() { Coverage coverage = changedFileNode.getCoverage(LINE_COVERAGE); - return createColoredCoverageColumn(coverage.getCoveredPercentage(), printCoverage(coverage), - "The indirect line coverage changes"); + return createColoredCoverageColumn(coverage, "The indirect line coverage changes"); } @Override public DetailedColumnDefinition getBranchCoverage() { Coverage coverage = changedFileNode.getCoverage(BRANCH_COVERAGE); - return createColoredCoverageColumn(coverage.getCoveredPercentage(), printCoverage(coverage), - "The indirect branch coverage changes"); + return createColoredCoverageColumn(coverage, "The indirect branch coverage changes"); } @Override From d529feb19ed109a71d4e0c3f92442e7652c8fe22 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Fri, 20 May 2022 23:27:18 +0200 Subject: [PATCH 04/32] Use `--medium-grey` for column border. --- plugin/src/main/webapp/css/column-style.css | 2 +- plugin/src/main/webapp/css/custom-style.css | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/plugin/src/main/webapp/css/column-style.css b/plugin/src/main/webapp/css/column-style.css index dd3bb8e44..f31034495 100644 --- a/plugin/src/main/webapp/css/column-style.css +++ b/plugin/src/main/webapp/css/column-style.css @@ -4,6 +4,6 @@ } .coverage-column-outer { - border: 1px solid var(--light-bg-color); + border: 1px solid var(--medium-grey); border-radius: 10px } diff --git a/plugin/src/main/webapp/css/custom-style.css b/plugin/src/main/webapp/css/custom-style.css index 856234ae9..fb2fbdd4b 100644 --- a/plugin/src/main/webapp/css/custom-style.css +++ b/plugin/src/main/webapp/css/custom-style.css @@ -65,7 +65,7 @@ } .coverage-column-outer { - border: 1px solid var(--light-bg-color); + border: 1px solid var(--medium-grey); border-radius: 10px; } From cec7f4d2da5e51cdc3d28e46c74312df87759cd5 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Mon, 23 May 2022 00:47:25 +0200 Subject: [PATCH 05/32] Tweak layout for dark mode. --- .../plugins/coverage/model/CoverageViewModel.java | 9 ++++----- .../dashboard/CoverageColumn/column.jelly | 8 ++++---- plugin/src/main/webapp/css/column-style.css | 11 ++++++++--- plugin/src/main/webapp/css/custom-style.css | 5 +++-- 4 files changed, 19 insertions(+), 14 deletions(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index 5b762d22d..83b232a8d 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -510,7 +510,7 @@ protected CoverageNode getRoot() { * UI row model for the coverage details table. */ private static class CoverageRow { - private static final String COVERAGE_COLUMN_OUTER = "coverage-column-outer"; + private static final String COVERAGE_COLUMN_OUTER = "coverage-column-outer float-end"; private static final String COVERAGE_COLUMN_INNER = "coverage-column-inner"; private final CoverageNode root; private final Locale browserLocale; @@ -575,8 +575,8 @@ protected DetailedColumnDefinition createColoredCoverageColumn(final Coverage co String cell = div().withClasses(COVERAGE_COLUMN_OUTER).with( div().withClasses(COVERAGE_COLUMN_INNER) .withStyle(String.format( - "color:%s; background-image: linear-gradient(90deg, %s %f%%, transparent %f%%);", - colors.getLineColorAsHex(), colors.getFillColorAsHex(), + "background-image: linear-gradient(90deg, %s %f%%, transparent %f%%);", + colors.getFillColorAsHex(), percentage, percentage)) .withTitle(tooltip) .withText(coverage.formatCoveredPercentage(browserLocale))) @@ -604,8 +604,7 @@ protected DetailedColumnDefinition createColoredCoverageDeltaColumn( DisplayColors colors = CoverageChangeTendency.getDisplayColorsForTendency(coverageValue, COLOR_PROVIDER); String cell = div().withClasses(COVERAGE_COLUMN_OUTER).with( div().withClasses(COVERAGE_COLUMN_INNER) - .withStyle(String.format("color:%s;background-color:%s;", - colors.getLineColorAsHex(), colors.getFillColorAsHex())) + .withStyle(String.format("background-color:%s;", colors.getFillColorAsHex())) .withText(coverageText) .withTitle(tooltip)) .render(); diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/column.jelly b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/column.jelly index a75d7831d..1c593f5c1 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/column.jelly +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/column.jelly @@ -12,15 +12,15 @@ - -
+ +
${coverageText} - ${coverageText} + ${coverageText}
@@ -28,7 +28,7 @@ - + ${coverageText} diff --git a/plugin/src/main/webapp/css/column-style.css b/plugin/src/main/webapp/css/column-style.css index f31034495..231a36a67 100644 --- a/plugin/src/main/webapp/css/column-style.css +++ b/plugin/src/main/webapp/css/column-style.css @@ -1,9 +1,14 @@ +.coverage-column-outer { + border: 1px solid var(--medium-grey); + border-radius: 10px; +} + .coverage-column-inner { padding: 4px 7px; border-radius: 10px } -.coverage-column-outer { - border: 1px solid var(--medium-grey); - border-radius: 10px +.coverage-column-link:hover { + text-decoration: none; } + diff --git a/plugin/src/main/webapp/css/custom-style.css b/plugin/src/main/webapp/css/custom-style.css index fb2fbdd4b..e1b9229aa 100644 --- a/plugin/src/main/webapp/css/custom-style.css +++ b/plugin/src/main/webapp/css/custom-style.css @@ -67,12 +67,13 @@ .coverage-column-outer { border: 1px solid var(--medium-grey); border-radius: 10px; + width: 5em; } .coverage-column-inner { - padding: 1px 7px; + padding: 3px 7px; border-radius: 10px; - color:black + color:var(--text-color); } #coverage-table td { From 599f467731ad60c6470d8afa3c985b5f2b2aca34 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Mon, 23 May 2022 10:51:53 +0200 Subject: [PATCH 06/32] Right align column header as well. --- .../visualization/dashboard/CoverageColumn/columnHeader.jelly | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/columnHeader.jelly b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/columnHeader.jelly index 18b1fe617..a7db87cb5 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/columnHeader.jelly +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/visualization/dashboard/CoverageColumn/columnHeader.jelly @@ -1,4 +1,4 @@ - ${it.columnName} + ${it.columnName} From 537c9428ab44674204e6e77a1f4d8dd74796ad24 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Mon, 23 May 2022 14:08:19 +0200 Subject: [PATCH 07/32] Decrease vertical padding. --- plugin/src/main/webapp/css/custom-style.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin/src/main/webapp/css/custom-style.css b/plugin/src/main/webapp/css/custom-style.css index e1b9229aa..c3a6cddc7 100644 --- a/plugin/src/main/webapp/css/custom-style.css +++ b/plugin/src/main/webapp/css/custom-style.css @@ -71,7 +71,7 @@ } .coverage-column-inner { - padding: 3px 7px; + padding: 1px 7px; border-radius: 10px; color:var(--text-color); } From 01f4f300dca12d9a26dceb750ec89b2d256f4ed9 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Mon, 23 May 2022 17:14:50 +0200 Subject: [PATCH 08/32] Add `noopener` and `norefferer` to `message.properties`. --- .../resources/io/jenkins/plugins/coverage/Messages.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/Messages.properties b/plugin/src/main/resources/io/jenkins/plugins/coverage/Messages.properties index c6f074922..33adc3609 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/Messages.properties +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/Messages.properties @@ -6,4 +6,4 @@ CoverageColumn.Caption=Line Coverage CoverageColumn.ColumnName=Code Coverage CoverageColumn.CoverageEmpty=none FieldValidator.Error.DefaultEncoding=Encoding must be a supported encoding of the Java platform, see: \ - java.nio.charset.Charset + java.nio.charset.Charset From fbebc6f1171ce63e1b1743719a021caa3dce19f1 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Thu, 9 Jun 2022 16:53:44 +0200 Subject: [PATCH 09/32] Fall back to default serialization if old format is used for `Coverage`. --- .../coverage/model/CoverageXmlStream.java | 21 +++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageXmlStream.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageXmlStream.java index 3e9092b85..ed5147010 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageXmlStream.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageXmlStream.java @@ -58,7 +58,7 @@ protected void configureXStream(final XStream2 xStream) { xStream.addImmutableType(Coverage.class, false); xStream.addImmutableType(CoveragePercentageConverter.class, false); xStream.registerConverter(new CoverageMetricConverter()); - xStream.registerConverter(new CoverageConverter()); + xStream.registerConverter(new CoverageConverter(xStream)); xStream.registerConverter(new CoveragePercentageConverter()); xStream.registerLocalConverter(FileCoverageNode.class, "coveragePerLine", new LineMapConverter()); xStream.registerLocalConverter(FileCoverageNode.class, "fileCoverageDelta", new MetricPercentageMapConverter()); @@ -99,7 +99,11 @@ public boolean canConvert(final Class type) { * {@link Converter} for {@link Coverage} instances so that only the values will be serialized. After reading the * values back from the stream, the string representation will be converted to an actual instance again. */ - private static final class CoverageConverter implements Converter { + private static final class CoverageConverter extends XStream2.PassthruConverter { + CoverageConverter(final XStream2 xStream) { + super(xStream); + } + @SuppressWarnings("PMD.NullAssignment") @Override public void marshal(final Object source, final HierarchicalStreamWriter writer, @@ -108,8 +112,17 @@ public void marshal(final Object source, final HierarchicalStreamWriter writer, } @Override - public Coverage unmarshal(final HierarchicalStreamReader reader, final UnmarshallingContext context) { - return Coverage.valueOf(reader.getValue()); + public Object unmarshal(final HierarchicalStreamReader reader, final UnmarshallingContext context) { + String value = reader.getValue(); + if (StringUtils.contains(value, '/')) { + return Coverage.valueOf(value); + } + return super.unmarshal(reader, context); // old versions before 3.0.0 + } + + @Override + protected void callback(final Coverage obj, final UnmarshallingContext context) { + // nothing to do } @Override From 7ee1cde602d4d4b018bcc3a39f4ba3476e18d7a7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 10 Jun 2022 13:23:05 +0000 Subject: [PATCH 10/32] Bump analysis-pom from 5.26.0 to 5.28.0 Bumps [analysis-pom](https://github.com/jenkinsci/analysis-pom-plugin) from 5.26.0 to 5.28.0. - [Release notes](https://github.com/jenkinsci/analysis-pom-plugin/releases) - [Changelog](https://github.com/jenkinsci/analysis-pom-plugin/blob/master/CHANGELOG.md) - [Commits](https://github.com/jenkinsci/analysis-pom-plugin/compare/v5.26.0...v5.28.0) --- updated-dependencies: - dependency-name: org.jvnet.hudson.plugins:analysis-pom dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- plugin/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin/pom.xml b/plugin/pom.xml index 02499788f..267de25cc 100644 --- a/plugin/pom.xml +++ b/plugin/pom.xml @@ -5,7 +5,7 @@ org.jvnet.hudson.plugins analysis-pom - 5.26.0 + 5.28.0 From e435dd5a659f7616e2ff1e3f568c01a6110c8a5d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 10 Jun 2022 13:23:11 +0000 Subject: [PATCH 11/32] Bump codingstyle-pom from 2.27.0 to 2.28.0 Bumps [codingstyle-pom](https://github.com/uhafner/codingstyle-pom) from 2.27.0 to 2.28.0. - [Release notes](https://github.com/uhafner/codingstyle-pom/releases) - [Changelog](https://github.com/uhafner/codingstyle-pom/blob/main/CHANGELOG.md) - [Commits](https://github.com/uhafner/codingstyle-pom/compare/v2.27.0...v2.28.0) --- updated-dependencies: - dependency-name: edu.hm.hafner:codingstyle-pom dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- ui-tests/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ui-tests/pom.xml b/ui-tests/pom.xml index 341087473..52ca4889e 100644 --- a/ui-tests/pom.xml +++ b/ui-tests/pom.xml @@ -5,7 +5,7 @@ edu.hm.hafner codingstyle-pom - 2.27.0 + 2.28.0 From 4f87c0b595972e8f70e33b6ab28746dbd7ecb317 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Fri, 17 Jun 2022 23:14:48 +0200 Subject: [PATCH 12/32] Replace button navigation with tabs. Make the UI views responsive so that the source code is shown on the same page when possible. --- plugin/pom.xml | 1 + .../model/ChangeCoverageTableModel.java | 137 +++++ .../coverage/model/CoverageTableModel.java | 306 ++++++++++ .../coverage/model/CoverageViewModel.java | 523 +++--------------- .../model/IndirectCoverageChangesTable.java | 129 +++++ .../coverage/model/SourceViewModel.java | 52 ++ .../model/CoverageViewModel/index.jelly | 272 ++++----- .../coverage/model/Messages.properties | 12 +- .../model/SourceViewModel/index.jelly | 46 ++ .../model/SourceViewModel/index.properties | 11 + plugin/src/main/webapp/css/custom-style.css | 13 +- plugin/src/main/webapp/js/charts.js | 377 +++---------- .../coverage/model/CoverageViewModelTest.java | 2 +- 13 files changed, 938 insertions(+), 943 deletions(-) create mode 100644 plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java create mode 100644 plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java create mode 100644 plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java create mode 100644 plugin/src/main/java/io/jenkins/plugins/coverage/model/SourceViewModel.java create mode 100644 plugin/src/main/resources/io/jenkins/plugins/coverage/model/SourceViewModel/index.jelly create mode 100644 plugin/src/main/resources/io/jenkins/plugins/coverage/model/SourceViewModel/index.properties diff --git a/plugin/pom.xml b/plugin/pom.xml index 02499788f..bba9ab789 100644 --- a/plugin/pom.xml +++ b/plugin/pom.xml @@ -123,6 +123,7 @@ io.jenkins.plugins data-tables-api + 1.12.1-1-SNAPSHOT io.jenkins.plugins diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java new file mode 100644 index 000000000..12f74c95e --- /dev/null +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java @@ -0,0 +1,137 @@ +package io.jenkins.plugins.coverage.model; + +import java.io.File; +import java.util.List; +import java.util.Locale; +import java.util.Optional; +import java.util.stream.Collectors; + +import org.apache.commons.lang3.math.Fraction; + +import hudson.Functions; + +import io.jenkins.plugins.datatables.DetailedCell; +import io.jenkins.plugins.datatables.TableConfiguration; +import io.jenkins.plugins.datatables.TableConfiguration.SelectStyle; + +/** + * {@link CoverageTableModel} implementation for visualizing the change coverage. + * + * @since 3.0.0 + */ +class ChangeCoverageTableModel extends CoverageTableModel { + private final CoverageNode changeRoot; + + /** + * Creates a change coverage table model. + * + * @param id + * The ID of the table + * @param root + * The root of the origin coverage tree + * @param changeRoot + * The root of the change coverage tree + * @param buildFolder + * the build folder to store the source code files + * @param resultsId + * the ID of the results as prefix for the source code files in the build folder + */ + ChangeCoverageTableModel(final String id, final CoverageNode root, final CoverageNode changeRoot, + final File buildFolder, final String resultsId) { + super(id, root, buildFolder, resultsId); + + this.changeRoot = changeRoot; + } + + @Override + public TableConfiguration getTableConfiguration() { + return super.getTableConfiguration().select(SelectStyle.SINGLE); + } + + @Override + public List getRows() { + Locale browserLocale = Functions.getCurrentLocale(); + return changeRoot.getAllFileCoverageNodes().stream() + .map(file -> new ChangeCoverageRow(getOriginalNode(file), file, getBuildFolder(), getResultsId(), + browserLocale)) + .collect(Collectors.toList()); + } + + private FileCoverageNode getOriginalNode(final FileCoverageNode fileNode) { + Optional reference = getRoot().getAllFileCoverageNodes().stream() + .filter(node -> node.getPath().equals(fileNode.getPath()) + && node.getName().equals(fileNode.getName())) + .findFirst(); + return reference.orElse(fileNode); // return this as fallback to prevent exceptions + } + + /** + * UI row model for the change coverage details table. + * + * @since 3.0.0 + */ + private static class ChangeCoverageRow extends CoverageRow { + private final FileCoverageNode changedFileNode; + + /** + * Creates a table row for visualizing the change coverage of a file. + * + * @param root + * The unfiltered node which represents the coverage of the whole file + * @param changedFileNode + * The filtered node which represents the change coverage only + * @param buildFolder + * the build folder to store the source code files + * @param resultsId + * the ID of the results as prefix for the source code files in the build folder + * @param browserLocale + * The locale + */ + ChangeCoverageRow(final FileCoverageNode root, final FileCoverageNode changedFileNode, + final File buildFolder, final String resultsId, final Locale browserLocale) { + super(root, buildFolder, resultsId, browserLocale); + + this.changedFileNode = changedFileNode; + } + + @Override + public DetailedCell getLineCoverage() { + Coverage coverage = changedFileNode.getCoverage(CoverageMetric.LINE); + return createColoredCoverageColumn(coverage, "The line change coverage"); + } + + @Override + public DetailedCell getBranchCoverage() { + Coverage coverage = changedFileNode.getCoverage(CoverageMetric.BRANCH); + return createColoredCoverageColumn(coverage, "The branch change coverage"); + } + + @Override + public DetailedCell getLineCoverageDelta() { + return createColoredChangeCoverageDeltaColumn(CoverageMetric.LINE); + } + + @Override + public DetailedCell getBranchCoverageDelta() { + return createColoredChangeCoverageDeltaColumn(CoverageMetric.BRANCH); + } + + @Override + public int getLoc() { + return (int) changedFileNode.getChangedCodeLines().stream() + .filter(line -> changedFileNode.getCoveragePerLine().containsKey(line)) + .count(); + } + + private DetailedCell createColoredChangeCoverageDeltaColumn(final CoverageMetric coverageMetric) { + Coverage changeCoverage = changedFileNode.getCoverage(coverageMetric); + if (changeCoverage.isSet()) { + Fraction delta = changeCoverage.getCoveredFraction() + .subtract(getRoot().getCoverage(coverageMetric).getCoveredFraction()); + return createColoredCoverageDeltaColumn(CoveragePercentage.valueOf(delta), + "The change coverage within the file against the total file coverage"); + } + return NO_COVERAGE; + } + } +} diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java new file mode 100644 index 000000000..54ad34deb --- /dev/null +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java @@ -0,0 +1,306 @@ +package io.jenkins.plugins.coverage.model; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.stream.Collectors; + +import hudson.Functions; + +import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProvider; +import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProvider.DisplayColors; +import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProviderFactory; +import io.jenkins.plugins.coverage.model.visualization.colorization.CoverageChangeTendency; +import io.jenkins.plugins.coverage.model.visualization.colorization.CoverageLevel; +import io.jenkins.plugins.datatables.DetailedCell; +import io.jenkins.plugins.datatables.TableColumn; +import io.jenkins.plugins.datatables.TableColumn.ColumnBuilder; +import io.jenkins.plugins.datatables.TableColumn.ColumnCss; +import io.jenkins.plugins.datatables.TableConfiguration; +import io.jenkins.plugins.datatables.TableConfiguration.SelectStyle; +import io.jenkins.plugins.datatables.TableModel; + +import static j2html.TagCreator.*; + +/** + * UI table model for the coverage details table. + */ +class CoverageTableModel extends TableModel { + private static final ColorProvider COLOR_PROVIDER = ColorProviderFactory.createColorProvider(); + private static final int NO_COVERAGE_SORT = -1000; + static final DetailedCell NO_COVERAGE = new DetailedCell<>(Messages.Coverage_Not_Available(), + NO_COVERAGE_SORT); + private final CoverageNode root; + private final File buildFolder; + private final String id; + private final String resultsId; + private final boolean isInline; + + /** + * Creates an indirect coverage changes table model. + * + * @param id + * The ID of the table + * @param root + * The root of the origin coverage tree + * @param buildFolder + * the build folder to store the source code files + * @param resultsId + * the ID of the results as prefix for the source code files in the build folder + */ + CoverageTableModel(final String id, final CoverageNode root, final File buildFolder, final String resultsId) { + this(id, root, buildFolder, resultsId, false); + } + + public CoverageTableModel(final String id, final CoverageNode root, final File buildFolder, final String resultsId, final boolean isInline) { + super(); + + this.root = root; + this.buildFolder = buildFolder; + this.id = id; + this.resultsId = resultsId; + this.isInline = isInline; + } + + String getResultsId() { + return resultsId; + } + + File getBuildFolder() { + return buildFolder; + } + + @Override + public String getId() { + return id; + } + + @Override + public TableConfiguration getTableConfiguration() { + TableConfiguration tableConfiguration = new TableConfiguration(); + tableConfiguration.responsive(); + if (isInline) { + tableConfiguration.select(SelectStyle.SINGLE); + } + return tableConfiguration; + } + + @Override + public List getColumns() { + List columns = new ArrayList<>(); + + TableColumn fileHash = new ColumnBuilder().withHeaderLabel("Hash") + .withDataPropertyKey("fileHash") + .withHeaderClass(ColumnCss.HIDDEN) + .build(); + columns.add(fileHash); + TableColumn fileName = new ColumnBuilder().withHeaderLabel(Messages.Column_File()) + .withDataPropertyKey("fileName") + .withResponsivePriority(1) + .build(); + columns.add(fileName); + TableColumn packageName = new ColumnBuilder().withHeaderLabel(Messages.Column_Package()) + .withDataPropertyKey("packageName") + .withResponsivePriority(50000) + .build(); + columns.add(packageName); + TableColumn lineCoverage = new ColumnBuilder().withHeaderLabel(Messages.Column_LineCoverage()) + .withDataPropertyKey("lineCoverage") + .withDetailedCell() + .withType("number") + .withHeaderClass(ColumnCss.NUMBER) + .withResponsivePriority(1) + .build(); + columns.add(lineCoverage); + TableColumn lineCoverageDelta = new ColumnBuilder().withHeaderLabel(Messages.Column_DeltaLineCoverage("Δ")) + .withDataPropertyKey("lineCoverageDelta") + .withDetailedCell() + .withType("number") + .withHeaderClass(ColumnCss.NUMBER) + .withResponsivePriority(2) + .build(); + columns.add(lineCoverageDelta); + TableColumn branchCoverage = new ColumnBuilder().withHeaderLabel(Messages.Column_BranchCoverage()) + .withDataPropertyKey("branchCoverage") + .withDetailedCell() + .withType("number") + .withHeaderClass(ColumnCss.NUMBER) + .withResponsivePriority(1) + .build(); + columns.add(branchCoverage); + TableColumn branchCoverageDelta = new ColumnBuilder().withHeaderLabel(Messages.Column_DeltaLineCoverage("Δ")) + .withDataPropertyKey("branchCoverageDelta") + .withDetailedCell() + .withType("number") + .withHeaderClass(ColumnCss.NUMBER) + .withResponsivePriority(2) + .build(); + columns.add(branchCoverageDelta); + TableColumn loc = new ColumnBuilder().withHeaderLabel(Messages.Column_LinesOfCode()) + .withDataPropertyKey("loc") + .withResponsivePriority(200) + .withHeaderClass(ColumnCss.NUMBER) + .build(); + columns.add(loc); + + return columns; + } + + @Override + public List getRows() { + Locale browserLocale = Functions.getCurrentLocale(); + return root.getAll(CoverageMetric.FILE).stream() + .map(file -> new CoverageRow(file, buildFolder, getResultsId(), browserLocale, isInline)) + .collect(Collectors.toList()); + } + + protected CoverageNode getRoot() { + return root; + } + + /** + * UI row model for the coverage details table. + */ + static class CoverageRow { + private static final String COVERAGE_COLUMN_OUTER = "coverage-column-outer float-end"; + private static final String COVERAGE_COLUMN_INNER = "coverage-column-inner"; + private final CoverageNode root; + private final File buildFolder; + private final String resultsId; + private final Locale browserLocale; + private boolean isInline; + + CoverageRow(final CoverageNode root, final File buildFolder, final String resultsId, final Locale browserLocale) { + this(root, buildFolder, resultsId, browserLocale, false); + } + + CoverageRow(final CoverageNode root, final File buildFolder, final String resultsId, final Locale browserLocale, final boolean isInline) { + this.root = root; + this.buildFolder = buildFolder; + this.resultsId = resultsId; + this.browserLocale = browserLocale; + this.isInline = isInline; + } + + public String getFileHash() { + return String.valueOf(root.getName().hashCode()); + } + + public String getFileName() { + String fileName = root.getName(); + if (!isInline && CoverageViewModel.isSourceFileInNewFormatAvailable(buildFolder, resultsId, root.getPath()) + || CoverageViewModel.isSourceFileInOldFormatAvailable(buildFolder, fileName)) { + return a().withHref(String.valueOf(fileName.hashCode())).withText(fileName).render(); + } + return fileName; + } + + public String getPackageName() { + return root.getParentName(); + } + + public DetailedCell getLineCoverage() { + Coverage coverage = root.getCoverage(CoverageMetric.LINE); + return createColoredCoverageColumn(coverage, "The total line coverage of the file"); + } + + public DetailedCell getBranchCoverage() { + Coverage coverage = root.getCoverage(CoverageMetric.BRANCH); + return createColoredCoverageColumn(coverage, "The total branch coverage of the file"); + } + + public DetailedCell getLineCoverageDelta() { + return createColoredFileCoverageDeltaColumn(CoverageMetric.LINE); + } + + public DetailedCell getBranchCoverageDelta() { + return createColoredFileCoverageDeltaColumn(CoverageMetric.BRANCH); + } + + public int getLoc() { + if (root instanceof FileCoverageNode) { // FIXME: Move LOC up in the hierarchy + return ((FileCoverageNode) root).getCoveragePerLine().size(); + } + return 0; + } + + /** + * Creates a table cell which colorizes the shown coverage dependent on the coverage percentage. + * + * @param coverage + * the coverage of the element + * @param tooltip + * the tooltip which describes the value + * + * @return the new {@link DetailedCell} + */ + protected DetailedCell createColoredCoverageColumn(final Coverage coverage, final String tooltip) { + if (coverage.isSet()) { + double percentage = coverage.getCoveredPercentage().getDoubleValue(); + DisplayColors colors = CoverageLevel.getDisplayColorsOfCoverageLevel(percentage, COLOR_PROVIDER); + String cell = div().withClasses(COVERAGE_COLUMN_OUTER).with( + div().withClasses(COVERAGE_COLUMN_INNER) + .withStyle(String.format( + "background-image: linear-gradient(90deg, %s %f%%, transparent %f%%);", + colors.getFillColorAsHex(), + percentage, percentage)) + .withTitle(tooltip) + .withText(coverage.formatCoveredPercentage(browserLocale))) + .render(); + return new DetailedCell<>(cell, percentage); + } + return NO_COVERAGE; + } + + /** + * Creates a table cell which colorizes the tendency of the shown coverage delta. + * + * @param coveragePercentage + * The coverage delta as percentage + * @param tooltip + * The tooltip which describes the value + * + * @return the created {@link DetailedCell} + */ + protected DetailedCell createColoredCoverageDeltaColumn( + final CoveragePercentage coveragePercentage, final String tooltip) { + double coverageValue = coveragePercentage.getDoubleValue(); + DisplayColors colors = CoverageChangeTendency.getDisplayColorsForTendency(coverageValue, COLOR_PROVIDER); + String cell = div().withClasses(COVERAGE_COLUMN_OUTER).with( + div().withClasses(COVERAGE_COLUMN_INNER) + .withStyle(String.format("background-color:%s;", colors.getFillColorAsHex())) + .withText(coveragePercentage.formatDeltaPercentage(browserLocale)) + .withTitle(tooltip)) + .render(); + return new DetailedCell<>(cell, coverageValue); + } + + protected CoverageNode getRoot() { + return root; + } + + /** + * Creates a colored column for visualizing the file coverage delta against a reference for the passed + * {@link CoverageMetric}. + * + * @param coverageMetric + * The coverage metric + * + * @return the created {@link DetailedCell} + * @since 3.0.0 + */ + private DetailedCell createColoredFileCoverageDeltaColumn(final CoverageMetric coverageMetric) { + // this is only available for versions later than 3.0.0 which introduced FileCoverageNode + if (root instanceof FileCoverageNode) { + FileCoverageNode fileNode = (FileCoverageNode) root; + if (fileNode.hasFileCoverageDelta(coverageMetric)) { + CoveragePercentage delta = fileNode.getFileCoverageDeltaForMetric(coverageMetric); + return createColoredCoverageDeltaColumn(delta, + "The total file coverage delta against the reference build"); + } + } + return NO_COVERAGE; + } + } +} diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index 83b232a8d..e4d5e53ca 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -2,9 +2,7 @@ import java.io.File; import java.io.IOException; -import java.util.ArrayList; import java.util.List; -import java.util.Locale; import java.util.Optional; import java.util.SortedMap; import java.util.stream.Collectors; @@ -14,32 +12,26 @@ import org.apache.commons.lang3.exception.ExceptionUtils; import org.apache.commons.lang3.math.Fraction; +import edu.hm.hafner.echarts.JacksonFacade; +import edu.hm.hafner.echarts.LinesChartModel; import edu.hm.hafner.echarts.TreeMapNode; +import edu.umd.cs.findbugs.annotations.CheckForNull; +import org.kohsuke.stapler.StaplerRequest; +import org.kohsuke.stapler.StaplerResponse; import org.kohsuke.stapler.bind.JavaScriptMethod; -import hudson.Functions; import hudson.model.ModelObject; import hudson.model.Run; import hudson.util.TextFile; import io.jenkins.plugins.coverage.model.visualization.code.SourceCodeFacade; import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProvider; -import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProvider.DisplayColors; import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProviderFactory; -import io.jenkins.plugins.coverage.model.visualization.colorization.CoverageChangeTendency; -import io.jenkins.plugins.coverage.model.visualization.colorization.CoverageLevel; import io.jenkins.plugins.coverage.model.visualization.tree.TreeMapNodeConverter; import io.jenkins.plugins.datatables.DefaultAsyncTableContentProvider; -import io.jenkins.plugins.datatables.TableColumn; -import io.jenkins.plugins.datatables.TableColumn.ColumnCss; -import io.jenkins.plugins.datatables.TableConfiguration; import io.jenkins.plugins.datatables.TableModel; -import io.jenkins.plugins.datatables.TableModel.DetailedColumnDefinition; -import io.jenkins.plugins.datatables.options.SelectStyle; import io.jenkins.plugins.util.BuildResultNavigator; -import static j2html.TagCreator.*; - /** * Server side model that provides the data for the details view of the coverage results. The layout of the associated * view is defined corresponding jelly view 'index.jelly'. @@ -49,8 +41,7 @@ */ @SuppressWarnings("PMD.ExcessivePublicCount") public class CoverageViewModel extends DefaultAsyncTableContentProvider implements ModelObject { - private static final CoverageMetric LINE_COVERAGE = CoverageMetric.LINE; - private static final CoverageMetric BRANCH_COVERAGE = CoverageMetric.BRANCH; + private static final JacksonFacade JACKSON_FACADE = new JacksonFacade(); private static final ColorProvider COLOR_PROVIDER = ColorProviderFactory.createColorProvider(); private static final TreeMapNodeConverter TREE_MAP_NODE_CONVERTER = new TreeMapNodeConverter(COLOR_PROVIDER); private static final BuildResultNavigator NAVIGATOR = new BuildResultNavigator(); @@ -113,6 +104,32 @@ public CoverageOverview getChangeCoverageOverview() { return new CoverageOverview(changeCoverageTreeRoot.filterPackageStructure()); } + /** + * Returns the trend chart configuration. + * + * @param configuration + * JSON object to configure optional properties for the trend chart + * + * @return the trend chart model (converted to a JSON string) + */ + @JavaScriptMethod + @SuppressWarnings("unused") + public String getTrendChart(final String configuration) { + return JACKSON_FACADE.toJson(createTrendChart(configuration)); + } + + private LinesChartModel createTrendChart(final String configuration) { + Optional latestAction = getLatestAction(); + if (latestAction.isPresent()) { + return latestAction.get().createProjectAction().createChartModel(configuration); + } + return new LinesChartModel(); + } + + private Optional getLatestAction() { + return Optional.ofNullable(getOwner().getAction(CoverageBuildAction.class)); + } + /** * Returns the root of the tree of nodes for the ECharts treemap. This tree is used as model for the chart on the * client side. The tree is available for line and branch coverage. @@ -167,6 +184,7 @@ public TreeMapNode getCoverageChangesTree(final String coverageMetric) { * * @param text * The coverage metric as String + * * @return the coverage metric */ private CoverageMetric getCoverageMetricFromText(final String text) { @@ -188,13 +206,17 @@ private CoverageMetric getCoverageMetricFromText(final String text) { @Override public TableModel getTableModel(final String tableId) { CoverageNode root = getNode(); - if (CHANGE_COVERAGE_TABLE_ID.equals(tableId)) { - return new ChangeCoverageTable(root, changeCoverageTreeRoot, tableId); + File rootDir = getOwner().getRootDir(); + if ("coverage-table-inline".equals(tableId)) { + return new CoverageTableModel(tableId, root, rootDir, getId(), true); + } + else if (CHANGE_COVERAGE_TABLE_ID.equals(tableId)) { + return new ChangeCoverageTableModel(tableId, root, changeCoverageTreeRoot, rootDir, getId()); } else if (COVERAGE_CHANGES_TABLE_ID.equals(tableId)) { - return new IndirectCoverageChangesTable(root, indirectCoverageChangesTreeRoot, tableId); + return new IndirectCoverageChangesTable(tableId, root, indirectCoverageChangesTreeRoot, rootDir, getId()); } - return new CoverageTableModel(root, tableId); + return new CoverageTableModel(tableId, root, rootDir, getId()); } /** @@ -210,9 +232,8 @@ else if (COVERAGE_CHANGES_TABLE_ID.equals(tableId)) { */ @JavaScriptMethod public String getUrlForBuild(final String selectedBuildDisplayName, final String currentUrl) { - return NAVIGATOR.getSameUrlForOtherBuild(owner, - currentUrl, CoverageBuildAction.DETAILS_URL, selectedBuildDisplayName) - .orElse(StringUtils.EMPTY); + return NAVIGATOR.getSameUrlForOtherBuild(owner, currentUrl, CoverageBuildAction.DETAILS_URL, + selectedBuildDisplayName).orElse(StringUtils.EMPTY); } /** @@ -377,6 +398,36 @@ static boolean isSourceFileInNewFormatAvailable(final File rootDir, final String return SOURCE_CODE_FACADE.createFileInBuildFolder(rootDir, id, nodePath).canRead(); } + /** + * Returns a new sub-page for the selected link. + * + * @param link + * the link to identify the sub-page to show + * @param request + * Stapler request + * @param response + * Stapler response + * + * @return the new sub-page + */ + @SuppressWarnings("unused") // Called by jelly view + @CheckForNull + public SourceViewModel getDynamic(final String link, final StaplerRequest request, final StaplerResponse response) { + if (StringUtils.isNotEmpty(link)) { + try { + Optional targetResult + = getNode().findByHashCode(CoverageMetric.FILE, Integer.parseInt(link)); + if (targetResult.isPresent()) { + return new SourceViewModel(getOwner(), targetResult.get()); + } + } + catch (NumberFormatException exception) { + // ignore + } + } + return null; // fallback on broken URLs + } + /** * UI model for the coverage overview bar chart. Shows the coverage results for the different coverage metrics. */ @@ -423,432 +474,4 @@ private SortedMap getMetricsDistribution() { } } - /** - * UI table model for the coverage details table. - */ - static class CoverageTableModel extends TableModel { - private final CoverageNode root; - private final String id; - - CoverageTableModel(final CoverageNode root, final String id) { - super(); - - this.root = root; - this.id = id; - } - - @Override - public String getId() { - return id; - } - - @Override - public TableConfiguration getTableConfiguration() { - TableConfiguration tableConfiguration = new TableConfiguration(); - tableConfiguration.select(SelectStyle.SINGLE); - return tableConfiguration; - } - - @Override - public List getColumns() { - List columns = new ArrayList<>(); - - // TODO: DataTables API sets options wrong in case of invisible columns (columnDef and number not matching) - // TODO: DataTables API requires more granular width options - - // this column is hidden, but used to access the file hash from the frontend - TableColumn fileHashColumn = new TableColumn("Hash", "fileHash"); - fileHashColumn.setHeaderClass(ColumnCss.HIDDEN); - // fileHashColumn.setWidth(0); - columns.add(fileHashColumn); - - TableColumn packageColumn = new TableColumn("Package", "packageName"); - // packageColumn.setWidth(2); - columns.add(packageColumn); - - TableColumn fileColumn = new TableColumn("File", "fileName"); - // fileColumn.setWidth(2); - columns.add(fileColumn); - - TableColumn lineColumn = new TableColumn("Line", "lineCoverage", "number").setHeaderClass(ColumnCss.NUMBER); - // lineColumn.setWidth(2); - columns.add(lineColumn); - - TableColumn lineColumnDelta = new TableColumn("Line Δ", "lineCoverageDelta", "number").setHeaderClass(ColumnCss.NUMBER); - // lineColumnDelta.setWidth(1); - columns.add(lineColumnDelta); - - TableColumn branchColumn = new TableColumn("Branch", "branchCoverage", "number").setHeaderClass(ColumnCss.NUMBER); - // branchColumn.setWidth(2); - columns.add(branchColumn); - - TableColumn branchColumnDelta = new TableColumn("Branch Δ", "branchCoverageDelta", "number").setHeaderClass(ColumnCss.NUMBER); - // branchColumnDelta.setWidth(1); - columns.add(branchColumnDelta); - - TableColumn loc = new TableColumn("LOC", "loc", "number").setHeaderClass(ColumnCss.NUMBER); - // loc.setWidth(1); - columns.add(loc); - - return columns; - } - - @Override - public List getRows() { - Locale browserLocale = Functions.getCurrentLocale(); - return root.getAll(CoverageMetric.FILE).stream() - .map(file -> new CoverageRow(file, browserLocale)) - .collect(Collectors.toList()); - } - - protected CoverageNode getRoot() { - return root; - } - } - - /** - * UI row model for the coverage details table. - */ - private static class CoverageRow { - private static final String COVERAGE_COLUMN_OUTER = "coverage-column-outer float-end"; - private static final String COVERAGE_COLUMN_INNER = "coverage-column-inner"; - private final CoverageNode root; - private final Locale browserLocale; - - CoverageRow(final CoverageNode root, final Locale browserLocale) { - this.root = root; - this.browserLocale = browserLocale; - } - - public String getFileHash() { - return String.valueOf(root.getName().hashCode()); - } - - public String getFileName() { - return root.getName(); - } - - public String getPackageName() { - return root.getParentName(); - } - - public DetailedColumnDefinition getLineCoverage() { - Coverage coverage = root.getCoverage(LINE_COVERAGE); - return createColoredCoverageColumn(coverage, "The total line coverage of the file"); - } - - public DetailedColumnDefinition getBranchCoverage() { - Coverage coverage = root.getCoverage(BRANCH_COVERAGE); - return createColoredCoverageColumn(coverage, "The total branch coverage of the file"); - } - - public DetailedColumnDefinition getLineCoverageDelta() { - return createColoredFileCoverageDeltaColumn(LINE_COVERAGE); - } - - public DetailedColumnDefinition getBranchCoverageDelta() { - return createColoredFileCoverageDeltaColumn(BRANCH_COVERAGE); - } - - public DetailedColumnDefinition getLoc() { - if (root instanceof FileCoverageNode) { - String value = String.valueOf(((FileCoverageNode) root).getCoveragePerLine().size()); - return new DetailedColumnDefinition(value, value); - } - return new DetailedColumnDefinition(Messages.Coverage_Not_Available(), "0"); - } - - /** - * Creates a table cell which colorizes the shown coverage dependent on the coverage percentage. - * - * @param coverage - * the coverage of the element - * @param tooltip - * the tooltip which describes the value - * - * @return the create {@link DetailedColumnDefinition} - */ - protected DetailedColumnDefinition createColoredCoverageColumn(final Coverage coverage, final String tooltip) { - double percentage = coverage.getCoveredPercentage().getDoubleValue(); - if (coverage.isSet()) { - DisplayColors colors = CoverageLevel.getDisplayColorsOfCoverageLevel(percentage, COLOR_PROVIDER); - String cell = div().withClasses(COVERAGE_COLUMN_OUTER).with( - div().withClasses(COVERAGE_COLUMN_INNER) - .withStyle(String.format( - "background-image: linear-gradient(90deg, %s %f%%, transparent %f%%);", - colors.getFillColorAsHex(), - percentage, percentage)) - .withTitle(tooltip) - .withText(coverage.formatCoveredPercentage(browserLocale))) - .render(); - return new DetailedColumnDefinition(cell, String.valueOf(percentage)); - } - return new DetailedColumnDefinition(Messages.Coverage_Not_Available(), "-"); - } - - /** - * Creates a table cell which colorizes the tendency of the shown coverage delta. - * - * @param coveragePercentage - * The coverage delta as percentage - * @param tooltip - * The tooltip which describes the value - * - * @return the create {@link DetailedColumnDefinition} - */ - protected DetailedColumnDefinition createColoredCoverageDeltaColumn( - final CoveragePercentage coveragePercentage, final String tooltip) { - double coverageValue = coveragePercentage.getDoubleValue(); - String coverageText = coveragePercentage.formatDeltaPercentage(browserLocale); - String sort = String.valueOf(coverageValue); - DisplayColors colors = CoverageChangeTendency.getDisplayColorsForTendency(coverageValue, COLOR_PROVIDER); - String cell = div().withClasses(COVERAGE_COLUMN_OUTER).with( - div().withClasses(COVERAGE_COLUMN_INNER) - .withStyle(String.format("background-color:%s;", colors.getFillColorAsHex())) - .withText(coverageText) - .withTitle(tooltip)) - .render(); - return new DetailedColumnDefinition(cell, sort); - } - - protected CoverageNode getRoot() { - return root; - } - - /** - * Creates a colored column for visualizing the file coverage delta against a reference for the passed {@link - * CoverageMetric}. - * - * @param coverageMetric - * The coverage metric - * - * @return the {@link DetailedColumnDefinition} - * @since 3.0.0 - */ - private DetailedColumnDefinition createColoredFileCoverageDeltaColumn(final CoverageMetric coverageMetric) { - // this is only available for versions later then 3.0.0 which introduced FileCoverageNode - if (root instanceof FileCoverageNode) { - FileCoverageNode fileNode = (FileCoverageNode) root; - if (fileNode.hasFileCoverageDelta(coverageMetric)) { - CoveragePercentage delta = fileNode.getFileCoverageDeltaForMetric(coverageMetric); - return createColoredCoverageDeltaColumn(delta, - "The total file coverage delta against the reference build"); - } - } - return new DetailedColumnDefinition(Messages.Coverage_Not_Available(), "-101"); - } - } - - /** - * {@link CoverageTableModel} implementation for visualizing the change coverage. - * - * @since 3.0.0 - */ - static class ChangeCoverageTable extends CoverageTableModel { - private final CoverageNode changeRoot; - - /** - * Creates a change coverage table model. - * - * @param root - * The root of the origin coverage tree - * @param changeRoot - * The root of the change coverage tree - * @param id - * The ID of the table - */ - ChangeCoverageTable(final CoverageNode root, final CoverageNode changeRoot, final String id) { - super(root, id); - this.changeRoot = changeRoot; - } - - @Override - public List getRows() { - Locale browserLocale = Functions.getCurrentLocale(); - return changeRoot.getAllFileCoverageNodes().stream() - .map(file -> new ChangeCoverageRow(getOriginalNode(file), file, browserLocale)) - .collect(Collectors.toList()); - } - - private FileCoverageNode getOriginalNode(final FileCoverageNode fileNode) { - Optional reference = getRoot().getAllFileCoverageNodes().stream() - .filter(node -> node.getPath().equals(fileNode.getPath()) - && node.getName().equals(fileNode.getName())) - .findFirst(); - return reference.orElse(fileNode); // return this as fallback to prevent exceptions - } - } - - /** - * {@link CoverageTableModel} implementation for visualizing the indirect coverage changes. - * - * @since 3.0.0 - */ - static class IndirectCoverageChangesTable extends CoverageTableModel { - - private final CoverageNode changeRoot; - - /** - * Creates an indirect coverage changes table model. - * - * @param root - * The root of the origin coverage tree - * @param changeRoot - * The root of the indirect coverage changes tree - * @param id - * The ID of the table - */ - IndirectCoverageChangesTable(final CoverageNode root, final CoverageNode changeRoot, final String id) { - super(root, id); - this.changeRoot = changeRoot; - } - - @Override - public List getRows() { - Locale browserLocale = Functions.getCurrentLocale(); - return changeRoot.getAllFileCoverageNodes().stream() - .map(file -> new IndirectCoverageChangesRow(getOriginalNode(file), file, browserLocale)) - .collect(Collectors.toList()); - } - - private FileCoverageNode getOriginalNode(final FileCoverageNode fileNode) { - Optional reference = getRoot().getAllFileCoverageNodes().stream() - .filter(node -> node.getPath().equals(fileNode.getPath()) - && node.getName().equals(fileNode.getName())) - .findFirst(); - return reference.orElse(fileNode); // return this as fallback to prevent exceptions - } - } - - /** - * UI row model for the change coverage details table. - * - * @since 3.0.0 - */ - private static class ChangeCoverageRow extends CoverageRow { - - private final FileCoverageNode changedFileNode; - - /** - * Creates a table row for visualizing the change coverage of a file. - * - * @param root - * The unfiltered node which represents the coverage of the whole file - * @param changedFileNode - * The filtered node which represents the change coverage only - * @param browserLocale - * The locale - */ - ChangeCoverageRow(final FileCoverageNode root, final FileCoverageNode changedFileNode, - final Locale browserLocale) { - super(root, browserLocale); - this.changedFileNode = changedFileNode; - } - - @Override - public DetailedColumnDefinition getLineCoverage() { - Coverage coverage = changedFileNode.getCoverage(LINE_COVERAGE); - return createColoredCoverageColumn(coverage, "The line change coverage"); - } - - @Override - public DetailedColumnDefinition getBranchCoverage() { - Coverage coverage = changedFileNode.getCoverage(BRANCH_COVERAGE); - return createColoredCoverageColumn(coverage, "The branch change coverage"); - } - - @Override - public DetailedColumnDefinition getLineCoverageDelta() { - return createColoredChangeCoverageDeltaColumn(LINE_COVERAGE); - } - - @Override - public DetailedColumnDefinition getBranchCoverageDelta() { - return createColoredChangeCoverageDeltaColumn(BRANCH_COVERAGE); - } - - @Override - public DetailedColumnDefinition getLoc() { - String value = String.valueOf(changedFileNode.getChangedCodeLines().stream() - .filter(line -> changedFileNode.getCoveragePerLine().containsKey(line)) - .count()); - return new DetailedColumnDefinition(value, value); - } - - private DetailedColumnDefinition createColoredChangeCoverageDeltaColumn(final CoverageMetric coverageMetric) { - Coverage changeCoverage = changedFileNode.getCoverage(coverageMetric); - if (changeCoverage.isSet()) { - Fraction delta = changeCoverage.getCoveredFraction() - .subtract(getRoot().getCoverage(coverageMetric).getCoveredFraction()); - return createColoredCoverageDeltaColumn(CoveragePercentage.valueOf(delta), - "The change coverage within the file against the total file coverage"); - } - return new DetailedColumnDefinition(Messages.Coverage_Not_Available(), "-101"); - } - } - - /** - * UI row model for the indirect coverage changes details table. - * - * @since 3.0.0 - */ - private static class IndirectCoverageChangesRow extends CoverageRow { - private final FileCoverageNode changedFileNode; - - /** - * Creates a table row for visualizing the indirect coverage changes of a file. - * - * @param root - * The unfiltered node which represents the coverage of the whole file - * @param changedFileNode - * The filtered node which represents the indirect coverage changes only - * @param browserLocale - * The locale - */ - IndirectCoverageChangesRow(final FileCoverageNode root, final FileCoverageNode changedFileNode, - final Locale browserLocale) { - super(root, browserLocale); - this.changedFileNode = changedFileNode; - } - - @Override - public DetailedColumnDefinition getLineCoverage() { - Coverage coverage = changedFileNode.getCoverage(LINE_COVERAGE); - return createColoredCoverageColumn(coverage, "The indirect line coverage changes"); - } - - @Override - public DetailedColumnDefinition getBranchCoverage() { - Coverage coverage = changedFileNode.getCoverage(BRANCH_COVERAGE); - return createColoredCoverageColumn(coverage, "The indirect branch coverage changes"); - } - - @Override - public DetailedColumnDefinition getLineCoverageDelta() { - return createColoredChangeCoverageDeltaColumn(LINE_COVERAGE); - } - - @Override - public DetailedColumnDefinition getBranchCoverageDelta() { - return createColoredChangeCoverageDeltaColumn(BRANCH_COVERAGE); - } - - @Override - public DetailedColumnDefinition getLoc() { - String value = String.valueOf(changedFileNode.getIndirectCoverageChanges().size()); - return new DetailedColumnDefinition(value, value); - } - - private DetailedColumnDefinition createColoredChangeCoverageDeltaColumn( - final CoverageMetric coverageMetric) { - Coverage changeCoverage = changedFileNode.getCoverage(coverageMetric); - if (changeCoverage.isSet()) { - Fraction delta = changeCoverage.getCoveredFraction() - .subtract(getRoot().getCoverage(coverageMetric).getCoveredFraction()); - return createColoredCoverageDeltaColumn(CoveragePercentage.valueOf(delta), - "The indirect coverage changes within the file against the total file coverage"); - } - return new DetailedColumnDefinition(Messages.Coverage_Not_Available(), "-101"); - } - } } diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java new file mode 100644 index 000000000..cf20f888c --- /dev/null +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java @@ -0,0 +1,129 @@ +package io.jenkins.plugins.coverage.model; + +import java.io.File; +import java.util.List; +import java.util.Locale; +import java.util.Optional; +import java.util.stream.Collectors; + +import org.apache.commons.lang3.math.Fraction; + +import hudson.Functions; + +import io.jenkins.plugins.datatables.DetailedCell; + +/** + * {@link CoverageTableModel} implementation for visualizing the indirect coverage changes. + * + * @since 3.0.0 + */ +class IndirectCoverageChangesTable extends CoverageTableModel { + private final CoverageNode changeRoot; + + /** + * Creates an indirect coverage changes table model. + * + * @param id + * The ID of the table + * @param root + * The root of the origin coverage tree + * @param changeRoot + * The root of the indirect coverage changes tree + * @param buildFolder + * the build folder to store the source code files + * @param resultsId + * the ID of the results as prefix for the source code files in the build folder + */ + IndirectCoverageChangesTable(final String id, final CoverageNode root, final CoverageNode changeRoot, final File buildFolder, + final String resultsId) { + super(id, root, buildFolder, resultsId); + + this.changeRoot = changeRoot; + } + + @Override + public List getRows() { + Locale browserLocale = Functions.getCurrentLocale(); + return changeRoot.getAllFileCoverageNodes().stream() + .map(file -> new IndirectCoverageChangesRow(getOriginalNode(file), file, getBuildFolder(), getResultsId(), + browserLocale)) + .collect(Collectors.toList()); + } + + private FileCoverageNode getOriginalNode(final FileCoverageNode fileNode) { + Optional reference = getRoot().getAllFileCoverageNodes().stream() + .filter(node -> node.getPath().equals(fileNode.getPath()) + && node.getName().equals(fileNode.getName())) + .findFirst(); + return reference.orElse(fileNode); // return this as fallback to prevent exceptions + } + + /** + * UI row model for the indirect coverage changes details table. + * + * @since 3.0.0 + */ + private static class IndirectCoverageChangesRow extends CoverageRow { + private final FileCoverageNode changedFileNode; + + /** + * Creates a table row for visualizing the indirect coverage changes of a file. + * + * @param root + * The unfiltered node which represents the coverage of the whole file + * @param changedFileNode + * The filtered node which represents the indirect coverage changes only + * @param buildFolder + * the build folder to store the source code files + * @param resultsId + * the ID of the results as prefix for the source code files in the build folder + * @param browserLocale + * The locale + */ + IndirectCoverageChangesRow(final FileCoverageNode root, final FileCoverageNode changedFileNode, + final File buildFolder, final String resultsId, final Locale browserLocale) { + super(root, buildFolder, resultsId, browserLocale); + + this.changedFileNode = changedFileNode; + } + + @Override + public DetailedCell getLineCoverage() { + Coverage coverage = changedFileNode.getCoverage(CoverageMetric.LINE); + return createColoredCoverageColumn(coverage, "The indirect line coverage changes"); + } + + @Override + public DetailedCell getBranchCoverage() { + Coverage coverage = changedFileNode.getCoverage(CoverageMetric.BRANCH); + return createColoredCoverageColumn(coverage, "The indirect branch coverage changes"); + } + + @Override + public DetailedCell getLineCoverageDelta() { + return createColoredChangeCoverageDeltaColumn(CoverageMetric.LINE); + } + + @Override + public DetailedCell getBranchCoverageDelta() { + return createColoredChangeCoverageDeltaColumn(CoverageMetric.BRANCH); + } + + @Override + public int getLoc() { + return changedFileNode.getIndirectCoverageChanges().size(); + } + + private DetailedCell createColoredChangeCoverageDeltaColumn( + final CoverageMetric coverageMetric) { + Coverage changeCoverage = changedFileNode.getCoverage(coverageMetric); + if (changeCoverage.isSet()) { + Fraction delta = changeCoverage.getCoveredFraction() + .subtract(getRoot().getCoverage(coverageMetric).getCoveredFraction()); + return createColoredCoverageDeltaColumn(CoveragePercentage.valueOf(delta), + "The indirect coverage changes within the file against the total file coverage"); + } + return NO_COVERAGE; + } + } +} diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/SourceViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/SourceViewModel.java new file mode 100644 index 000000000..6cc868db6 --- /dev/null +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/SourceViewModel.java @@ -0,0 +1,52 @@ +package io.jenkins.plugins.coverage.model; + +import java.io.File; +import java.io.IOException; + +import org.apache.commons.lang3.exception.ExceptionUtils; + +import hudson.model.Run; +import hudson.util.TextFile; + +import io.jenkins.plugins.coverage.model.visualization.code.SourceCodeFacade; + +/** + * Server side model that provides the data for the source code view of the coverage results. The layout of the + * associated view is defined corresponding jelly view 'index.jelly'. + * + * @author Ullrich Hafner + */ +public class SourceViewModel extends CoverageViewModel { + /** + * Creates a new source view model instance. + * + * @param owner + * the owner of this view + * @param fileNode + * the selected file node of the coverage tree + */ + public SourceViewModel(final Run owner, final CoverageNode fileNode) { + super(owner, fileNode); + } + + /** + * Returns the source file rendered in HTML. + * + * @return {@code true} if the source file is available, {@code false} otherwise + */ + public String getSourceFileContent() { + try { + File rootDir = getOwner().getRootDir(); + if (isSourceFileInNewFormatAvailable(getNode())) { + return new SourceCodeFacade().read(rootDir, getId(), getNode().getPath()); + } + if (isSourceFileInOldFormatAvailable(getNode())) { + return new TextFile(getFileForBuildsWithOldVersion(rootDir, getNode().getName())).read(); // fallback with sources persisted using the < 2.1.0 serialization + } + return Messages.Coverage_Not_Available(); + } + catch (IOException | InterruptedException exception) { + return ExceptionUtils.getStackTrace(exception); + } + } +} diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly index 8a6384114..7c3017d55 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly @@ -3,7 +3,7 @@ - + @@ -17,197 +17,121 @@ -
-
-

${it.displayName}

-
-
- - - - -
- + -
-
-
- -
- -
-
- - - -
- - -
- - - - - -
- No code changes found. -
-
- - - -
-
+
+ +
+
-
- -
- - +
+ +
+
- -
-
-
-
- -
-
-
- - -
-
-
- + +
+ +
+
+ +
+
+ +
+ +
-
-
-
- - -
-
- -
- -
- -
- - -
- -
- -
+
+ +
- -
- -
-
+ +
+
+
+ + + +
+
+ + + +
+
+ +
-
-
-

- ${%Source code is unavailable.} -

- ${%Some possible reasons are:} -

    -
  • ${%reason.1}
    • -
  • ${%reason.2}
    • -
  • ${%reason.3}
    • -
-

-

-
-
-

- ${%No source code is selected.} -

-
+ +
+
+
+ + +
+ + + +
+ + +
+ +
+
+
+ xxxl + xxl + xl + lg + md + sm + xs +
+
+ diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/Messages.properties b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/Messages.properties index ca18e9f35..d37256021 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/Messages.properties +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/Messages.properties @@ -1,13 +1,17 @@ Coverage.Not.Available=n/a Coverage.Link.Name=Coverage Report Coverage.Title=Coverage of ''{0}'' -Table_Column_Package=Package -Table_Column_File=File -Table_Column_Line=Line Coverage -Table_Column_Branch=Branch Coverage Coverage_Column=Coverage Project_Coverage_Type=Project Coverage Project_Coverage_Delta_Type=Project Coverage Delta Change_Coverage_Type=Change Coverage Change_Coverage_Delta_Type=Change Coverage Delta Indirect_Coverage_Changes_Type=Indirect Coverage Changes + +Column.File=File +Column.Package=Package +Column.LineCoverage=Line +Column.DeltaLineCoverage=Line {0} +Column.BranchCoverage=Branch +Column.DeltaBranchCoverage=Branch {0} +Column.LinesOfCode=LOC diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/SourceViewModel/index.jelly b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/SourceViewModel/index.jelly new file mode 100644 index 000000000..3023dea7c --- /dev/null +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/SourceViewModel/index.jelly @@ -0,0 +1,46 @@ + + + + + + + + + +
+ +
+
+ + + +
+ + +
+
+ + +

+ ${%Source code is unavailable.} + ${%Some possible reasons are:} +

    +
  • ${%reason.1}
    • +
  • ${%reason.2}
    • +
  • ${%reason.3}
    • +
+

+ + + + +
+
+ +
+ + + + + + diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/SourceViewModel/index.properties b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/SourceViewModel/index.properties new file mode 100644 index 000000000..be06b04d5 --- /dev/null +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/SourceViewModel/index.properties @@ -0,0 +1,11 @@ +reason.1=\ + You did not enable storing of source files (see parameter 'sourceFiles'). + +reason.2=\ + Code Coverage API plugin did not find the source files. + +reason.3=\ + You do not have sufficient permissions to view source files. + + + diff --git a/plugin/src/main/webapp/css/custom-style.css b/plugin/src/main/webapp/css/custom-style.css index c3a6cddc7..8777fb828 100644 --- a/plugin/src/main/webapp/css/custom-style.css +++ b/plugin/src/main/webapp/css/custom-style.css @@ -1,7 +1,14 @@ -.details-chart { +.overview-chart { width: 100%; - min-height: 512px; - min-width: 256px; + min-height: 40vh; + display: block; + margin-left: auto; + margin-right: auto; +} + +.tree-chart { + width: 100%; + min-height: 40vh; display: block; margin-left: auto; margin-right: auto; diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index 87293df5d..c9405c8d8 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -1,4 +1,5 @@ /* global jQuery3, viewProxy, echartsJenkinsApi, bootstrap5 */ + const CoverageChartGenerator = function ($) { function printPercentage(value) { return Number(value).toLocaleString(undefined, {style: 'percent', minimumFractionDigits: 2}); @@ -301,6 +302,8 @@ const CoverageChartGenerator = function ($) { ] }; treeChart.setOption(option); + + // TODO: there will be two events right now? window.addEventListener('resize', function () { treeChart.resize(); }); @@ -311,171 +314,38 @@ const CoverageChartGenerator = function ($) { treeChart.resize(); } - this.populateDetailsCharts = function () { - generateView(); - } - - /** - * Generates the coverage report view. - */ - function generateView() { - initializeReportView(); + function redrawCharts() { + // TODO: render only the active ones + const configuration = JSON.stringify(echartsJenkinsApi.readFromLocalStorage('jenkins-echarts-chart-configuration-coverage-history')); + viewProxy.getTrendChart(configuration, function (t) { + echartsJenkinsApi.renderConfigurableZoomableTrendChart('coverage-trend', t.responseJSON, 'chart-configuration-coverage-history', openBuild); + }); viewProxy.getOverview(function (t) { createOverview(t.responseObject(), 'coverage-overview'); - $('#coverage-trend').height($('#coverage-overview').height()); }); - // only required when the change-coverage div is visible - if (document.getElementById('change-coverage')) { - viewProxy.getChangeCoverageOverview(function (t) { - createOverview(t.responseObject(), 'change-coverage-overview'); - $('#change-coverage-overview').height($('#coverage-overview').height()); - }); - } - - loadCoverageTrees(); - - viewProxy.hasStoredSourceCode(function (t) { - if (t.responseObject()) { - initializeDataTables(); - } + viewProxy.getCoverageTree('Line', function (t) { + createFilesTreeMap(t.responseObject(), 'project-line-coverage', 'Line'); }); - } - /** - * Loads the coverage tree data. - */ - function loadCoverageTrees() { - let coverageMetric = 'Line'; - if (document.getElementById('coverage-map-metrics').checked) { - coverageMetric = 'Branch'; - } - - viewProxy.getCoverageTree(coverageMetric, function (t) { - createFilesTreeMap(t.responseObject(), 'project-coverage', coverageMetric); + viewProxy.getCoverageTree('Branch', function (t) { + createFilesTreeMap(t.responseObject(), 'project-branch-coverage', 'Branch'); }); - // only required when the change-coverage div is visible - if (document.getElementById('change-coverage')) { - viewProxy.getChangeCoverageTree(coverageMetric, function (t) { - createFilesTreeMap(t.responseObject(), 'change-coverage', coverageMetric); - }); - } - // only required when the coverage-changes div is visible - if (document.getElementById('coverage-changes')) { - viewProxy.getCoverageChangesTree(coverageMetric, function (t) { - createFilesTreeMap(t.responseObject(), 'coverage-changes', coverageMetric); - }); - } - } - - -/////////////////////////////////////////////////////////////////////// -// Report view initialization -/////////////////////////////////////////////////////////////////////// - - function initializeReportView() { - $('#report-overview a[data-bs-toggle="tab"]').on('show.bs.tab', function (e) { - window.location.hash = e.target.hash; - const activeTab = $(e.target).attr('href'); - localStorage.setItem('activeTabOverview', activeTab); - }); - - $('#report-details a[data-bs-toggle="tab"]').on('show.bs.tab', function (e) { - window.location.hash = e.target.hash; - const activeTab = $(e.target).attr('href'); - localStorage.setItem('activeTabDetails', activeTab); - }); - - const url = document.location.toString(); - // prefer loading the report by a set anchor - if (url.match('#')) { - const tabName = url.split('#')[1]; - const loaded = loadView('#' + tabName); - if (!loaded) { - // the default - loadView('#coverageTree'); - } - } - else { - let activeTab; - let defaultTab; - const view = localStorage.getItem("activeReport"); - if (view === "report-overview") { - activeTab = localStorage.getItem('activeTabOverview'); - defaultTab = '#coverageTree'; - } - else if (view === "report-details") { - activeTab = localStorage.getItem('activeTabDetails'); - defaultTab = '#coverageTable'; - } - else { - if (document.getElementById("report-overview").classList.contains("d-none")) { - activeTab = localStorage.getItem('activeTabDetails'); - defaultTab = '#coverageTable'; - } - else { - activeTab = localStorage.getItem('activeTabOverview'); - defaultTab = '#coverageTree'; - } - } - if (!loadView(activeTab)) { - loadView(defaultTab); - } - } - - initializeCoverageMapMetric(); - initializeOverviewColumnVisibility(); } /** - * Initializes the coverage metric selection of the coverage map. - */ - function initializeCoverageMapMetric() { - const coverageMapToggle = $('#coverage-map-metrics'); - const showBranch = localStorage.getItem('coverage-map-toggle-state'); - if (showBranch) { - const show = showBranch === 'true'; - coverageMapToggle.prop('checked', show).change(); - } - else { - localStorage.setItem('coverage-map-toggle-state', 'false'); - coverageMapToggle.prop('checked', false).change(); - } - setCoverageMapToggleText(); - - coverageMapToggle.on('change', function (e) { - setCoverageMapToggleText(); - localStorage.setItem('coverage-map-toggle-state', e.target.checked); - loadCoverageTrees(); - fireResizeEvent(); - }); - } - - /** - * Sets the name of the coverage metric which is currently shown in the coverage tree. + * Activates the specified tab. + * + * @param {String} selector - selector of the tab */ - function setCoverageMapToggleText() { - let coverageMetric = 'Line Coverage'; - if (document.getElementById('coverage-map-metrics').checked) { - coverageMetric = 'Branch Coverage'; - } - $("#coverage-map-metrics-label").text(coverageMetric); - } + function selectTab (selector) { + const detailsTabs = $('#tab-details'); + const selectedTab = detailsTabs.find(selector); - /** - * Initializes the visibility of the #overview-column. - */ - function initializeOverviewColumnVisibility() { - const showCharts = localStorage.getItem('showOverviewColumn'); - if (showCharts) { - const show = showCharts === 'true'; - setOverviewColumnVisibility(show); - $('#showOverviewChartsToggle').prop('checked', show); - } - else { - setOverviewColumnVisibility(true); - $('#showOverviewChartsToggle').prop('checked', true); + if (selectedTab.length !== 0) { + const tab = new bootstrap5.Tab(selectedTab[0]); + tab.show(); } } @@ -484,9 +354,7 @@ const CoverageChartGenerator = function ($) { */ function initializeDataTables() { $(document).ready(function () { - initializeSourceCodeSelection($('#coverage-table').DataTable(), 'coverage-table'); - initializeSourceCodeSelection($('#change-coverage-table').DataTable(), 'change-coverage-table'); - initializeSourceCodeSelection($('#coverage-changes-table').DataTable(), 'coverage-changes-table'); + initializeSourceCodeSelection($('#coverage-table-inline').DataTable(), 'coverage-table-inline'); }); } @@ -497,6 +365,13 @@ const CoverageChartGenerator = function ($) { * @param {String} id The ID of the DataTable */ function initializeSourceCodeSelection(datatable, id) { + /** + * Clears the source code view within #source-file. + */ + function clearSourceCode() { + $('#source-file').html('No file selected'); + } + datatable.on('select', function (e, dt, type, indexes) { if (type === 'row') { $('#source-file').html('Loading...'); @@ -504,16 +379,10 @@ const CoverageChartGenerator = function ($) { viewProxy.getSourceCode(rowData[0].fileHash, id, function (t) { const sourceCode = t.responseObject(); if (sourceCode === "n/a") { - $('#source-file').html(""); - document.getElementById('source-file-unselected').classList.add("d-none"); - document.getElementById('source-file-content').classList.add("d-none"); - document.getElementById('source-file-unavailable').classList.remove("d-none"); + $('#source-file').html('No source code available'); } else { $('#source-file').html(sourceCode); - document.getElementById('source-file-unselected').classList.add("d-none"); - document.getElementById('source-file-unavailable').classList.add("d-none"); - document.getElementById('source-file-content').classList.remove("d-none"); } }); } @@ -526,165 +395,51 @@ const CoverageChartGenerator = function ($) { }); } -/////////////////////////////////////////////////////////////////////// -// Report view management -/////////////////////////////////////////////////////////////////////// - - /** - * Loads a report view by its ID, selected by the user. - * - * @param {String} id The report view ID - */ - this.loadReportViewById = function (id) { - let loadedSuccessfully = false; - if (id === 'report-overview') { - const active = localStorage.getItem('activeTabOverview'); - if (active) { - loadedSuccessfully = loadView(active); - } - if (!loadedSuccessfully) { - loadView('#coverageTree'); - } - } - else if (id === 'report-details') { - const active = localStorage.getItem('activeTabDetails'); - if (active) { - loadedSuccessfully = loadView(active); + this.populateDetailsCharts = function () { + /** + * Activate the tab that has been visited the last time. If there is no such tab, highlight the first one. + * If the user selects the tab using an #anchor prefer this tab. + */ + function registerTabStatePersistence() { + const selectedTabID = 'jenkins-coverage-activeTab'; + + // TODO: check if a tab has been selected + selectTab('li:first-child a'); // fallback if all other options fail + const url = document.location.toString(); + if (url.match('#')) { + const tabName = url.split('#')[1]; + selectTab('a[href="#' + tabName + '"]'); } - if (!loadedSuccessfully) { - loadView('#coverageTable'); + else { + const activeTab = localStorage.getItem(selectedTabID); + if (activeTab) { + selectTab('a[href="' + activeTab + '"]'); + } } - } - } - - /** - * Loads the report view with the passed id. - * - * @param {String} id The id of the report view - */ - function loadView(id) { - const selector = 'a[href="' + id + '"]'; - let detailsTabs = $('#tab-tree'); - let selectedTab = detailsTabs.find(selector); - if (selectedTab.length !== 0) { - showReportView("report-overview"); - selectTab(selectedTab); - location.href = id; - return true; - } - detailsTabs = $('#tab-details'); - selectedTab = detailsTabs.find(selector); - if (selectedTab.length !== 0) { - showReportView("report-details"); - selectTab(selectedTab); - location.href = id; - return true; - } - return false; - } - /** - * Selects the passed Bootstrap tab. - * - * @param selectedTab The selected tab - */ - function selectTab(selectedTab) { - const tab = new bootstrap5.Tab(selectedTab[0]); - tab.show(function () { - fireResizeEvent(); - }); - } - - /** - * Makes the report view with the passed id visible. - * - * @param {String} id The ID of the report div to be shown - */ - function showReportView(id) { - const overview = document.getElementById("report-overview"); - const details = document.getElementById("report-details"); - const hideOverviewButton = document.getElementById("hide-button"); - const menuSeparator = document.getElementById("menu-separator"); - - if (id === overview.id) { - details.classList.add("d-none"); - overview.classList.remove("d-none"); - menuSeparator.style.display = 'block'; - hideOverviewButton.style.display = 'block'; - $(document).ready(function () { - $('#overviewToggle').prop('checked', true); - $('#detailToggle').prop('checked', false); - localStorage.setItem("activeReport", overview.id); + $('a[data-bs-toggle="tab"]').on('show.bs.tab', function (e) { + window.location.hash = e.target.hash; + const activeTab = $(e.target).attr('href'); + localStorage.setItem(selectedTabID, activeTab); + redrawCharts(); }); } - else if (id === details.id) { - menuSeparator.style.display = 'none'; - hideOverviewButton.style.display = 'none'; - overview.classList.add("d-none"); - details.classList.remove("d-none"); - $(document).ready(function () { - $('#detailToggle').prop('checked', true); - $('#overviewToggle').prop('checked', false); - localStorage.setItem("activeReport", details.id); + + function registerTrendChartConfiguration() { + const trendConfigurationDialogId = 'chart-configuration-coverage-history'; + $('#' + trendConfigurationDialogId).on('hidden.bs.modal', function () { + redrawCharts(); }); } - fireResizeEvent(); - } + registerTrendChartConfiguration(); + registerTabStatePersistence(); + redrawCharts(); - /** - * Toggles the visibility of the #overview-column, triggered by the user. - */ - this.toggleOverviewColumn = function () { - const overview = document.getElementById("overview-column"); - setOverviewColumnVisibility(overview.style.display === "none"); - } + initializeDataTables(); - /** - * Sets the visibility of the #overview-column which contains the overview charts. - * - * @param {boolean} show true whether the column should be shown - */ - function setOverviewColumnVisibility(show) { - const div = document.getElementById("overview-column"); - const divTree = document.getElementById("tree-column"); - if (show) { - div.style.display = "block"; - divTree.classList.add("ms-3"); - } - else { - div.style.display = "none"; - divTree.classList.remove("ms-3"); - } - localStorage.setItem('showOverviewColumn', '' + show); - fireResizeEvent(); - $(document).ready(function () { - $('#showOverviewChartsToggle').prop('checked', show); + window.addEventListener('resize', function () { + redrawCharts(); }); } - - /** - * Clears the source code view within #source-file. - */ - function clearSourceCode() { - $('#source-file').html(''); - document.getElementById('source-file-content').classList.add("d-none"); - document.getElementById('source-file-unselected').classList.remove("d-none"); - } - - /** - * Manually fires a resize event which is useful for adjusting canvas sizes with resize listeners. - */ - function fireResizeEvent() { - if (typeof (Event) === 'function') { - // for modern browsers - window.dispatchEvent(new Event('resize')); - } - else { - // for IE and other old browsers - const event = window.document.createEvent('UIEvents'); - event.initUIEvent('resize', true, false, window, 0); - window.dispatchEvent(event); - } - } }; diff --git a/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java b/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java index f03f5e81e..3ac76a677 100644 --- a/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java +++ b/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java @@ -81,7 +81,7 @@ void shouldProvideIndirectCoverageChanges() { @Test void shouldProvideRightTableModelById() { CoverageViewModel model = createModel(); - assertThat(model.getTableModel(CHANGE_COVERAGE_TABLE_ID)).isInstanceOf(ChangeCoverageTable.class); + assertThat(model.getTableModel(CHANGE_COVERAGE_TABLE_ID)).isInstanceOf(ChangeCoverageTableModel.class); assertThat(model.getTableModel(COVERAGE_CHANGES_TABLE_ID)).isInstanceOf(CoverageTableModel.class); assertThat(model.getTableModel("")).isInstanceOf(CoverageTableModel.class); } From cfb96ad85a48e45fe140bbda96c504b29801f525 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sat, 18 Jun 2022 13:01:21 +0200 Subject: [PATCH 13/32] Activate source code rendering via table selection. --- .../model/ChangeCoverageTableModel.java | 4 +- .../coverage/model/CoverageTableModel.java | 4 -- .../coverage/model/CoverageViewModel.java | 48 ++++++++++++------- .../model/IndirectCoverageChangesTable.java | 4 +- .../resources/coverage/coverage-table.jelly | 36 ++++++++++++++ plugin/src/main/resources/coverage/taglib | 0 .../model/CoverageViewModel/index.jelly | 38 ++------------- plugin/src/main/webapp/js/charts.js | 22 ++++----- .../coverage/model/CoverageViewModelTest.java | 2 +- 9 files changed, 85 insertions(+), 73 deletions(-) create mode 100644 plugin/src/main/resources/coverage/coverage-table.jelly create mode 100644 plugin/src/main/resources/coverage/taglib diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java index 12f74c95e..f461d7713 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java @@ -37,8 +37,8 @@ class ChangeCoverageTableModel extends CoverageTableModel { * the ID of the results as prefix for the source code files in the build folder */ ChangeCoverageTableModel(final String id, final CoverageNode root, final CoverageNode changeRoot, - final File buildFolder, final String resultsId) { - super(id, root, buildFolder, resultsId); + final File buildFolder, final String resultsId, final boolean isInline) { + super(id, root, buildFolder, resultsId, isInline); this.changeRoot = changeRoot; } diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java index 54ad34deb..eaeec73c0 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java @@ -49,10 +49,6 @@ class CoverageTableModel extends TableModel { * @param resultsId * the ID of the results as prefix for the source code files in the build folder */ - CoverageTableModel(final String id, final CoverageNode root, final File buildFolder, final String resultsId) { - this(id, root, buildFolder, resultsId, false); - } - public CoverageTableModel(final String id, final CoverageNode root, final File buildFolder, final String resultsId, final boolean isInline) { super(); diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index e4d5e53ca..da42cbbf4 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -47,8 +47,9 @@ public class CoverageViewModel extends DefaultAsyncTableContentProvider implemen private static final BuildResultNavigator NAVIGATOR = new BuildResultNavigator(); private static final SourceCodeFacade SOURCE_CODE_FACADE = new SourceCodeFacade(); + private static final String ABSOLUTE_COVERAGE_TABLE_ID = "absolute-coverage-table"; static final String CHANGE_COVERAGE_TABLE_ID = "change-coverage-table"; - static final String COVERAGE_CHANGES_TABLE_ID = "coverage-changes-table"; + static final String INDIRECT_COVERAGE_TABLE_ID = "indirect-coverage-table"; private final Run owner; private final CoverageNode node; @@ -207,16 +208,26 @@ private CoverageMetric getCoverageMetricFromText(final String text) { public TableModel getTableModel(final String tableId) { CoverageNode root = getNode(); File rootDir = getOwner().getRootDir(); - if ("coverage-table-inline".equals(tableId)) { + if ((ABSOLUTE_COVERAGE_TABLE_ID + "-inline").equals(tableId)) { return new CoverageTableModel(tableId, root, rootDir, getId(), true); } + else if (ABSOLUTE_COVERAGE_TABLE_ID.equals(tableId)) { + return new CoverageTableModel(tableId, root, rootDir, getId(), false); + } else if (CHANGE_COVERAGE_TABLE_ID.equals(tableId)) { - return new ChangeCoverageTableModel(tableId, root, changeCoverageTreeRoot, rootDir, getId()); + return new ChangeCoverageTableModel(tableId, root, changeCoverageTreeRoot, rootDir, getId(), false); + } + else if ((CHANGE_COVERAGE_TABLE_ID + "-inline").equals(tableId)) { + return new ChangeCoverageTableModel(tableId, root, changeCoverageTreeRoot, rootDir, getId(), true); + } + else if (INDIRECT_COVERAGE_TABLE_ID.equals(tableId)) { + return new IndirectCoverageChangesTable(tableId, root, indirectCoverageChangesTreeRoot, rootDir, getId(), false); } - else if (COVERAGE_CHANGES_TABLE_ID.equals(tableId)) { - return new IndirectCoverageChangesTable(tableId, root, indirectCoverageChangesTreeRoot, rootDir, getId()); + else if ((INDIRECT_COVERAGE_TABLE_ID + "-inline").equals(tableId)) { + return new IndirectCoverageChangesTable(tableId, root, indirectCoverageChangesTreeRoot, rootDir, getId(), true); } - return new CoverageTableModel(tableId, root, rootDir, getId()); + + throw new IllegalArgumentException("No such table with id " + id); } /** @@ -268,7 +279,7 @@ public String getSourceCode(final String fileHash, final String tableId) { * Reads the sourcecode corresponding to the passed {@link CoverageNode node} and filters the code dependent on the * table ID. * - * @param fileNode + * @param node * The node * @param tableId * The table ID @@ -279,24 +290,25 @@ public String getSourceCode(final String fileHash, final String tableId) { * @throws InterruptedException * if reading failed */ - private String readSourceCode(final CoverageNode fileNode, final String tableId) + private String readSourceCode(final CoverageNode node, final String tableId) throws IOException, InterruptedException { String content = ""; File rootDir = getOwner().getRootDir(); - if (isSourceFileInNewFormatAvailable(fileNode)) { - content = SOURCE_CODE_FACADE.read(rootDir, getId(), fileNode.getPath()); + if (isSourceFileInNewFormatAvailable(node)) { + content = SOURCE_CODE_FACADE.read(rootDir, getId(), node.getPath()); } - if (isSourceFileInOldFormatAvailable(fileNode)) { + if (isSourceFileInOldFormatAvailable(node)) { content = new TextFile(getFileForBuildsWithOldVersion(rootDir, - fileNode.getName())).read(); // fallback with sources persisted using the < 2.1.0 serialization + node.getName())).read(); // fallback with sources persisted using the < 2.1.0 serialization } - if (!content.isEmpty() && fileNode instanceof FileCoverageNode) { - if (CHANGE_COVERAGE_TABLE_ID.equals(tableId)) { - return SOURCE_CODE_FACADE.calculateChangeCoverageSourceCode(content, (FileCoverageNode) fileNode); + if (!content.isEmpty() && node instanceof FileCoverageNode) { + String cleanTableId = StringUtils.removeEnd(tableId, "-inline"); + FileCoverageNode fileNode = (FileCoverageNode) node; + if (CHANGE_COVERAGE_TABLE_ID.equals(cleanTableId)) { + return SOURCE_CODE_FACADE.calculateChangeCoverageSourceCode(content, fileNode); } - else if (COVERAGE_CHANGES_TABLE_ID.equals(tableId)) { - return SOURCE_CODE_FACADE.calculateIndirectCoverageChangesSourceCode(content, - (FileCoverageNode) fileNode); + else if (INDIRECT_COVERAGE_TABLE_ID.equals(cleanTableId)) { + return SOURCE_CODE_FACADE.calculateIndirectCoverageChangesSourceCode(content, fileNode); } else { return content; diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java index cf20f888c..1942a97ab 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java @@ -35,8 +35,8 @@ class IndirectCoverageChangesTable extends CoverageTableModel { * the ID of the results as prefix for the source code files in the build folder */ IndirectCoverageChangesTable(final String id, final CoverageNode root, final CoverageNode changeRoot, final File buildFolder, - final String resultsId) { - super(id, root, buildFolder, resultsId); + final String resultsId, final boolean isInline) { + super(id, root, buildFolder, resultsId, isInline); this.changeRoot = changeRoot; } diff --git a/plugin/src/main/resources/coverage/coverage-table.jelly b/plugin/src/main/resources/coverage/coverage-table.jelly new file mode 100644 index 000000000..a2ce36320 --- /dev/null +++ b/plugin/src/main/resources/coverage/coverage-table.jelly @@ -0,0 +1,36 @@ + + + + + Provides a table to render the file coverage nodes and the source code view. + + The ID of the table. + + + +
+
+ + + +
+
+ + + +
+
+ +
+ +
+
+ +
+
+ + diff --git a/plugin/src/main/resources/coverage/taglib b/plugin/src/main/resources/coverage/taglib new file mode 100644 index 000000000..e69de29bb diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly index 7c3017d55..96f28c130 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly @@ -1,5 +1,5 @@ - + @@ -75,46 +75,18 @@
-
-
- - - -
-
- - - -
-
- -
- -
-
- -
-
+
- - - +
+
- - - +
diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index c9405c8d8..690479a9c 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -354,7 +354,9 @@ const CoverageChartGenerator = function ($) { */ function initializeDataTables() { $(document).ready(function () { - initializeSourceCodeSelection($('#coverage-table-inline').DataTable(), 'coverage-table-inline'); + initializeSourceCodeSelection($('#absolute-coverage-table-inline').DataTable(), 'absolute-coverage-table-inline'); + initializeSourceCodeSelection($('#change-coverage-table-inline').DataTable(), 'change-coverage-table-inline'); + initializeSourceCodeSelection($('#indirect-coverage-table-inline').DataTable(), 'indirect-coverage-table-inline'); }); } @@ -365,33 +367,27 @@ const CoverageChartGenerator = function ($) { * @param {String} id The ID of the DataTable */ function initializeSourceCodeSelection(datatable, id) { - /** - * Clears the source code view within #source-file. - */ - function clearSourceCode() { - $('#source-file').html('No file selected'); - } - + const sourceView = $('#' + id + '-source-file'); datatable.on('select', function (e, dt, type, indexes) { if (type === 'row') { - $('#source-file').html('Loading...'); + sourceView.html('Loading...'); const rowData = datatable.rows(indexes).data().toArray(); viewProxy.getSourceCode(rowData[0].fileHash, id, function (t) { const sourceCode = t.responseObject(); if (sourceCode === "n/a") { - $('#source-file').html('No source code available'); + sourceView.html('No source code available'); } else { - $('#source-file').html(sourceCode); + sourceView.html(sourceCode); } }); } else { - clearSourceCode(); + sourceView.html('No file selected'); } }) datatable.on('deselect', function () { - clearSourceCode(); + sourceView.html('No file selected'); }); } diff --git a/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java b/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java index 3ac76a677..86eb05318 100644 --- a/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java +++ b/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java @@ -82,7 +82,7 @@ void shouldProvideIndirectCoverageChanges() { void shouldProvideRightTableModelById() { CoverageViewModel model = createModel(); assertThat(model.getTableModel(CHANGE_COVERAGE_TABLE_ID)).isInstanceOf(ChangeCoverageTableModel.class); - assertThat(model.getTableModel(COVERAGE_CHANGES_TABLE_ID)).isInstanceOf(CoverageTableModel.class); + assertThat(model.getTableModel(INDIRECT_COVERAGE_TABLE_ID)).isInstanceOf(CoverageTableModel.class); assertThat(model.getTableModel("")).isInstanceOf(CoverageTableModel.class); } From 6f0bfbe3bab19af7ac183a3001ecf835f522a9a2 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sat, 18 Jun 2022 14:33:10 +0200 Subject: [PATCH 14/32] Use new enum as column type. --- plugin/pom.xml | 2 +- .../coverage/model/CoverageTableModel.java | 15 ++++++--------- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/plugin/pom.xml b/plugin/pom.xml index bba9ab789..a635a54e7 100644 --- a/plugin/pom.xml +++ b/plugin/pom.xml @@ -123,7 +123,7 @@ io.jenkins.plugins data-tables-api - 1.12.1-1-SNAPSHOT + 1.12.1-1-rc700.c12cd9a7969a io.jenkins.plugins diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java index eaeec73c0..ed893e5f6 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java @@ -17,6 +17,7 @@ import io.jenkins.plugins.datatables.TableColumn; import io.jenkins.plugins.datatables.TableColumn.ColumnBuilder; import io.jenkins.plugins.datatables.TableColumn.ColumnCss; +import io.jenkins.plugins.datatables.TableColumn.ColumnType; import io.jenkins.plugins.datatables.TableConfiguration; import io.jenkins.plugins.datatables.TableConfiguration.SelectStyle; import io.jenkins.plugins.datatables.TableModel; @@ -104,39 +105,35 @@ public List getColumns() { TableColumn lineCoverage = new ColumnBuilder().withHeaderLabel(Messages.Column_LineCoverage()) .withDataPropertyKey("lineCoverage") .withDetailedCell() - .withType("number") - .withHeaderClass(ColumnCss.NUMBER) + .withType(ColumnType.NUMBER) .withResponsivePriority(1) .build(); columns.add(lineCoverage); TableColumn lineCoverageDelta = new ColumnBuilder().withHeaderLabel(Messages.Column_DeltaLineCoverage("Δ")) .withDataPropertyKey("lineCoverageDelta") .withDetailedCell() - .withType("number") - .withHeaderClass(ColumnCss.NUMBER) + .withType(ColumnType.NUMBER) .withResponsivePriority(2) .build(); columns.add(lineCoverageDelta); TableColumn branchCoverage = new ColumnBuilder().withHeaderLabel(Messages.Column_BranchCoverage()) .withDataPropertyKey("branchCoverage") .withDetailedCell() - .withType("number") - .withHeaderClass(ColumnCss.NUMBER) + .withType(ColumnType.NUMBER) .withResponsivePriority(1) .build(); columns.add(branchCoverage); TableColumn branchCoverageDelta = new ColumnBuilder().withHeaderLabel(Messages.Column_DeltaLineCoverage("Δ")) .withDataPropertyKey("branchCoverageDelta") .withDetailedCell() - .withType("number") - .withHeaderClass(ColumnCss.NUMBER) + .withType(ColumnType.NUMBER) .withResponsivePriority(2) .build(); columns.add(branchCoverageDelta); TableColumn loc = new ColumnBuilder().withHeaderLabel(Messages.Column_LinesOfCode()) .withDataPropertyKey("loc") .withResponsivePriority(200) - .withHeaderClass(ColumnCss.NUMBER) + .withType(ColumnType.NUMBER) .build(); columns.add(loc); From 9b2091af2e205c45e4ddc5920eb09a9937bfb36f Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sat, 18 Jun 2022 15:01:46 +0200 Subject: [PATCH 15/32] Update unit test with new table IDs. --- .github/workflows/ui-tests.yml | 89 ------------------- .../coverage/model/CoverageViewModel.java | 23 ++--- .../coverage/model/CoverageViewModelTest.java | 15 ++-- ui-tests/pom.xml | 1 + 4 files changed, 22 insertions(+), 106 deletions(-) delete mode 100644 .github/workflows/ui-tests.yml diff --git a/.github/workflows/ui-tests.yml b/.github/workflows/ui-tests.yml deleted file mode 100644 index c3c0d3600..000000000 --- a/.github/workflows/ui-tests.yml +++ /dev/null @@ -1,89 +0,0 @@ -name: 'Run UI tests' - -on: - push: - branches: - - master - pull_request: - -jobs: - coverage-publisher: - runs-on: [ubuntu-latest] - name: Coverage Publisher UI tests - - steps: - - uses: actions/checkout@v1 - - name: Set up JDK 11 - uses: actions/setup-java@v3 - with: - distribution: 'temurin' - java-version: '11' - check-latest: true - cache: 'maven' - - name: Build code-coverage plugin and download dependencies - run: mvn -V -ntp verify -Pskip --file plugin/pom.xml -Dgpg.skip - - name: Run UI tests for the coverage publisher - env: - BROWSER: firefox-container - run: mvn -V -ntp test --file ui-tests/pom.xml -Dtest=CoveragePublisherTest -Dgpg.skip -Dsurefire.rerunFailingTestsCount=1 - - coverage-report: - runs-on: [ubuntu-latest] - name: Coverage report UI tests - - steps: - - uses: actions/checkout@v1 - - name: Set up JDK 11 - uses: actions/setup-java@v3 - with: - distribution: 'temurin' - java-version: '11' - check-latest: true - cache: 'maven' - - name: Build code-coverage plugin and download dependencies - run: mvn -V -ntp verify -Pskip --file plugin/pom.xml -Dgpg.skip - - name: Run UI tests for the coverage report - env: - BROWSER: firefox-container - run: mvn -V -ntp test --file ui-tests/pom.xml -Dtest=CoverageReportTest -Dgpg.skip -Dsurefire.rerunFailingTestsCount=1 - - coverage-summary: - runs-on: [ubuntu-latest] - name: Coverage summary UI tests - - steps: - - uses: actions/checkout@v1 - - name: Set up JDK 11 - uses: actions/setup-java@v3 - with: - distribution: 'temurin' - java-version: '11' - check-latest: true - cache: 'maven' - - name: Build code-coverage plugin and download dependencies - run: mvn -V -ntp verify -Pskip --file plugin/pom.xml -Dgpg.skip - - name: Run UI tests for the coverage summary - env: - BROWSER: firefox-container - run: mvn -V -ntp test --file ui-tests/pom.xml -Dtest=CoverageSummaryTest -Dgpg.skip -Dsurefire.rerunFailingTestsCount=1 - - coverage-panel: - runs-on: [ubuntu-latest] - name: Coverage main panel UI tests - - steps: - - uses: actions/checkout@v1 - - name: Set up JDK 11 - uses: actions/setup-java@v3 - with: - distribution: 'temurin' - java-version: '11' - check-latest: true - cache: 'maven' - - name: Build code-coverage plugin and download dependencies - run: mvn -V -ntp verify -Pskip --file plugin/pom.xml -Dgpg.skip - - name: Run UI tests for the coverage main panel - env: - BROWSER: firefox-container - run: mvn -V -ntp test --file ui-tests/pom.xml -Dtest=MainPanelTest -Dgpg.skip -Dsurefire.rerunFailingTestsCount=1 - diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index da42cbbf4..6f8546cf4 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -3,6 +3,7 @@ import java.io.File; import java.io.IOException; import java.util.List; +import java.util.NoSuchElementException; import java.util.Optional; import java.util.SortedMap; import java.util.stream.Collectors; @@ -39,7 +40,7 @@ * @author Ullrich Hafner * @author Florian Orendi */ -@SuppressWarnings("PMD.ExcessivePublicCount") +@SuppressWarnings({"PMD.ExcessivePublicCount", "checkstyle:ClassDataAbstractionCoupling", "checkstyle:ClassFanOutComplexity"}) public class CoverageViewModel extends DefaultAsyncTableContentProvider implements ModelObject { private static final JacksonFacade JACKSON_FACADE = new JacksonFacade(); private static final ColorProvider COLOR_PROVIDER = ColorProviderFactory.createColorProvider(); @@ -47,7 +48,7 @@ public class CoverageViewModel extends DefaultAsyncTableContentProvider implemen private static final BuildResultNavigator NAVIGATOR = new BuildResultNavigator(); private static final SourceCodeFacade SOURCE_CODE_FACADE = new SourceCodeFacade(); - private static final String ABSOLUTE_COVERAGE_TABLE_ID = "absolute-coverage-table"; + static final String ABSOLUTE_COVERAGE_TABLE_ID = "absolute-coverage-table"; static final String CHANGE_COVERAGE_TABLE_ID = "change-coverage-table"; static final String INDIRECT_COVERAGE_TABLE_ID = "indirect-coverage-table"; @@ -227,7 +228,7 @@ else if ((INDIRECT_COVERAGE_TABLE_ID + "-inline").equals(tableId)) { return new IndirectCoverageChangesTable(tableId, root, indirectCoverageChangesTreeRoot, rootDir, getId(), true); } - throw new IllegalArgumentException("No such table with id " + id); + throw new NoSuchElementException("No such table with id " + id); } /** @@ -279,7 +280,7 @@ public String getSourceCode(final String fileHash, final String tableId) { * Reads the sourcecode corresponding to the passed {@link CoverageNode node} and filters the code dependent on the * table ID. * - * @param node + * @param sourceNode * The node * @param tableId * The table ID @@ -290,20 +291,20 @@ public String getSourceCode(final String fileHash, final String tableId) { * @throws InterruptedException * if reading failed */ - private String readSourceCode(final CoverageNode node, final String tableId) + private String readSourceCode(final CoverageNode sourceNode, final String tableId) throws IOException, InterruptedException { String content = ""; File rootDir = getOwner().getRootDir(); - if (isSourceFileInNewFormatAvailable(node)) { - content = SOURCE_CODE_FACADE.read(rootDir, getId(), node.getPath()); + if (isSourceFileInNewFormatAvailable(sourceNode)) { + content = SOURCE_CODE_FACADE.read(rootDir, getId(), sourceNode.getPath()); } - if (isSourceFileInOldFormatAvailable(node)) { + if (isSourceFileInOldFormatAvailable(sourceNode)) { content = new TextFile(getFileForBuildsWithOldVersion(rootDir, - node.getName())).read(); // fallback with sources persisted using the < 2.1.0 serialization + sourceNode.getName())).read(); // fallback with sources persisted using the < 2.1.0 serialization } - if (!content.isEmpty() && node instanceof FileCoverageNode) { + if (!content.isEmpty() && sourceNode instanceof FileCoverageNode) { String cleanTableId = StringUtils.removeEnd(tableId, "-inline"); - FileCoverageNode fileNode = (FileCoverageNode) node; + FileCoverageNode fileNode = (FileCoverageNode) sourceNode; if (CHANGE_COVERAGE_TABLE_ID.equals(cleanTableId)) { return SOURCE_CODE_FACADE.calculateChangeCoverageSourceCode(content, fileNode); } diff --git a/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java b/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java index 86eb05318..e41c1e333 100644 --- a/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java +++ b/plugin/src/test/java/io/jenkins/plugins/coverage/model/CoverageViewModelTest.java @@ -1,5 +1,6 @@ package io.jenkins.plugins.coverage.model; +import java.util.NoSuchElementException; import java.util.SortedMap; import java.util.TreeMap; @@ -30,9 +31,9 @@ void shouldReturnEmptySourceViewForExistingLinkButMissingSourceFile() { CoverageViewModel model = createModel(); String hash = String.valueOf("PathUtil.java".hashCode()); - assertThat(model.getSourceCode(hash, "coverage-table")).isEqualTo("n/a"); - assertThat(model.getSourceCode(hash, "change-coverage-table")).isEqualTo("n/a"); - assertThat(model.getSourceCode(hash, "coverage-changes-table")).isEqualTo("n/a"); + assertThat(model.getSourceCode(hash, ABSOLUTE_COVERAGE_TABLE_ID)).isEqualTo("n/a"); + assertThat(model.getSourceCode(hash, CHANGE_COVERAGE_TABLE_ID)).isEqualTo("n/a"); + assertThat(model.getSourceCode(hash, INDIRECT_COVERAGE_TABLE_ID)).isEqualTo("n/a"); } @Test @@ -83,12 +84,14 @@ void shouldProvideRightTableModelById() { CoverageViewModel model = createModel(); assertThat(model.getTableModel(CHANGE_COVERAGE_TABLE_ID)).isInstanceOf(ChangeCoverageTableModel.class); assertThat(model.getTableModel(INDIRECT_COVERAGE_TABLE_ID)).isInstanceOf(CoverageTableModel.class); - assertThat(model.getTableModel("")).isInstanceOf(CoverageTableModel.class); + assertThat(model.getTableModel(ABSOLUTE_COVERAGE_TABLE_ID)).isInstanceOf(CoverageTableModel.class); + + assertThatExceptionOfType(NoSuchElementException.class) + .isThrownBy(() -> model.getTableModel("wrong-id")); } private CoverageViewModel createModel() { - return new CoverageViewModel(mock(Run.class), - readNode("jacoco-codingstyle.xml")); + return new CoverageViewModel(mock(Run.class), readNode("jacoco-codingstyle.xml")); } /** diff --git a/ui-tests/pom.xml b/ui-tests/pom.xml index 341087473..1a01d9a3d 100644 --- a/ui-tests/pom.xml +++ b/ui-tests/pom.xml @@ -186,6 +186,7 @@ org.apache.maven.plugins maven-surefire-plugin + true false false From b13e804738e1cbfdcba92aa3592109c57452e6dd Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sat, 18 Jun 2022 15:21:57 +0200 Subject: [PATCH 16/32] Bump version of data-tables to 1.12.1-1. --- plugin/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin/pom.xml b/plugin/pom.xml index a635a54e7..7bf60c19d 100644 --- a/plugin/pom.xml +++ b/plugin/pom.xml @@ -123,7 +123,7 @@ io.jenkins.plugins data-tables-api - 1.12.1-1-rc700.c12cd9a7969a + 1.12.1-1 io.jenkins.plugins From 68706adb40d85c4de3812e2bb911e52675cf6df0 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sun, 19 Jun 2022 16:38:45 +0200 Subject: [PATCH 17/32] Extract rendering of file cells into a strategy. --- .../model/ChangeCoverageTableModel.java | 33 ++---- .../coverage/model/CoverageTableModel.java | 106 +++++++++++------- .../coverage/model/CoverageViewModel.java | 45 ++++---- .../model/IndirectCoverageChangesTable.java | 35 ++---- 4 files changed, 106 insertions(+), 113 deletions(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java index f461d7713..975408ae4 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/ChangeCoverageTableModel.java @@ -1,6 +1,5 @@ package io.jenkins.plugins.coverage.model; -import java.io.File; import java.util.List; import java.util.Locale; import java.util.Optional; @@ -31,14 +30,12 @@ class ChangeCoverageTableModel extends CoverageTableModel { * The root of the origin coverage tree * @param changeRoot * The root of the change coverage tree - * @param buildFolder - * the build folder to store the source code files - * @param resultsId - * the ID of the results as prefix for the source code files in the build folder + * @param renderer + * the renderer to use for the file names */ ChangeCoverageTableModel(final String id, final CoverageNode root, final CoverageNode changeRoot, - final File buildFolder, final String resultsId, final boolean isInline) { - super(id, root, buildFolder, resultsId, isInline); + final RowRenderer renderer) { + super(id, root, renderer); this.changeRoot = changeRoot; } @@ -52,8 +49,8 @@ public TableConfiguration getTableConfiguration() { public List getRows() { Locale browserLocale = Functions.getCurrentLocale(); return changeRoot.getAllFileCoverageNodes().stream() - .map(file -> new ChangeCoverageRow(getOriginalNode(file), file, getBuildFolder(), getResultsId(), - browserLocale)) + .map(file -> new ChangeCoverageRow( + getOriginalNode(file), file, browserLocale, getRenderer())) .collect(Collectors.toList()); } @@ -73,23 +70,9 @@ private FileCoverageNode getOriginalNode(final FileCoverageNode fileNode) { private static class ChangeCoverageRow extends CoverageRow { private final FileCoverageNode changedFileNode; - /** - * Creates a table row for visualizing the change coverage of a file. - * - * @param root - * The unfiltered node which represents the coverage of the whole file - * @param changedFileNode - * The filtered node which represents the change coverage only - * @param buildFolder - * the build folder to store the source code files - * @param resultsId - * the ID of the results as prefix for the source code files in the build folder - * @param browserLocale - * The locale - */ ChangeCoverageRow(final FileCoverageNode root, final FileCoverageNode changedFileNode, - final File buildFolder, final String resultsId, final Locale browserLocale) { - super(root, buildFolder, resultsId, browserLocale); + final Locale browserLocale, final RowRenderer renderer) { + super(root, browserLocale, renderer); this.changedFileNode = changedFileNode; } diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java index ed893e5f6..eea636bd6 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java @@ -33,10 +33,8 @@ class CoverageTableModel extends TableModel { static final DetailedCell NO_COVERAGE = new DetailedCell<>(Messages.Coverage_Not_Available(), NO_COVERAGE_SORT); private final CoverageNode root; - private final File buildFolder; + private final RowRenderer renderer; private final String id; - private final String resultsId; - private final boolean isInline; /** * Creates an indirect coverage changes table model. @@ -44,28 +42,20 @@ class CoverageTableModel extends TableModel { * @param id * The ID of the table * @param root - * The root of the origin coverage tree - * @param buildFolder - * the build folder to store the source code files - * @param resultsId - * the ID of the results as prefix for the source code files in the build folder + * The root of the coverage tree + * @param renderer + * the renderer to use for the file names */ - public CoverageTableModel(final String id, final CoverageNode root, final File buildFolder, final String resultsId, final boolean isInline) { + CoverageTableModel(final String id, final CoverageNode root, final RowRenderer renderer) { super(); - this.root = root; - this.buildFolder = buildFolder; this.id = id; - this.resultsId = resultsId; - this.isInline = isInline; - } - - String getResultsId() { - return resultsId; + this.root = root; + this.renderer = renderer; } - File getBuildFolder() { - return buildFolder; + RowRenderer getRenderer() { + return renderer; } @Override @@ -77,9 +67,7 @@ public String getId() { public TableConfiguration getTableConfiguration() { TableConfiguration tableConfiguration = new TableConfiguration(); tableConfiguration.responsive(); - if (isInline) { - tableConfiguration.select(SelectStyle.SINGLE); - } + renderer.configureTable(tableConfiguration); return tableConfiguration; } @@ -144,7 +132,7 @@ public List getColumns() { public List getRows() { Locale browserLocale = Functions.getCurrentLocale(); return root.getAll(CoverageMetric.FILE).stream() - .map(file -> new CoverageRow(file, buildFolder, getResultsId(), browserLocale, isInline)) + .map(file -> new CoverageRow(file, browserLocale, renderer)) .collect(Collectors.toList()); } @@ -159,21 +147,13 @@ static class CoverageRow { private static final String COVERAGE_COLUMN_OUTER = "coverage-column-outer float-end"; private static final String COVERAGE_COLUMN_INNER = "coverage-column-inner"; private final CoverageNode root; - private final File buildFolder; - private final String resultsId; private final Locale browserLocale; - private boolean isInline; + private final RowRenderer renderer; - CoverageRow(final CoverageNode root, final File buildFolder, final String resultsId, final Locale browserLocale) { - this(root, buildFolder, resultsId, browserLocale, false); - } - - CoverageRow(final CoverageNode root, final File buildFolder, final String resultsId, final Locale browserLocale, final boolean isInline) { + CoverageRow(final CoverageNode root, final Locale browserLocale, final RowRenderer renderer) { this.root = root; - this.buildFolder = buildFolder; - this.resultsId = resultsId; this.browserLocale = browserLocale; - this.isInline = isInline; + this.renderer = renderer; } public String getFileHash() { @@ -181,12 +161,7 @@ public String getFileHash() { } public String getFileName() { - String fileName = root.getName(); - if (!isInline && CoverageViewModel.isSourceFileInNewFormatAvailable(buildFolder, resultsId, root.getPath()) - || CoverageViewModel.isSourceFileInOldFormatAvailable(buildFolder, fileName)) { - return a().withHref(String.valueOf(fileName.hashCode())).withText(fileName).render(); - } - return fileName; + return renderer.renderFileName(root.getName(), root.getPath()); } public String getPackageName() { @@ -296,4 +271,55 @@ private DetailedCell createColoredFileCoverageDeltaColumn(final CoverageMetri return NO_COVERAGE; } } + + /** + * Renders filenames with links. Selection will be handled by opening a new page using the provided link. + */ + static class LinkedRowRenderer implements RowRenderer { + private File buildFolder; + private String resultsId; + + LinkedRowRenderer(final File buildFolder, final String resultsId) { + this.buildFolder = buildFolder; + this.resultsId = resultsId; + } + + @Override + public void configureTable(final TableConfiguration tableConfiguration) { + // nothing required + } + + @Override + public String renderFileName(final String fileName, final String path) { + if (CoverageViewModel.isSourceFileInNewFormatAvailable(buildFolder, resultsId, path) + || CoverageViewModel.isSourceFileInOldFormatAvailable(buildFolder, fileName)) { + return a().withHref(String.valueOf(fileName.hashCode())).withText(fileName).render(); + } + return fileName; + } + } + + /** + * Renders filenames without links. Selection will be handled using the table select events. + */ + static class InlineRowRenderer implements RowRenderer { + @Override + public void configureTable(final TableConfiguration tableConfiguration) { + tableConfiguration.select(SelectStyle.SINGLE); + } + + @Override + public String renderFileName(final String fileName, final String path) { + return fileName; + } + } + + /** + * Renders filenames in table cells. + */ + interface RowRenderer { + void configureTable(TableConfiguration tableConfiguration); + + String renderFileName(String fileName, String path); + } } diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index 6f8546cf4..2b17beb38 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -25,6 +25,8 @@ import hudson.model.Run; import hudson.util.TextFile; +import io.jenkins.plugins.coverage.model.CoverageTableModel.InlineRowRenderer; +import io.jenkins.plugins.coverage.model.CoverageTableModel.LinkedRowRenderer; import io.jenkins.plugins.coverage.model.visualization.code.SourceCodeFacade; import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProvider; import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProviderFactory; @@ -51,6 +53,7 @@ public class CoverageViewModel extends DefaultAsyncTableContentProvider implemen static final String ABSOLUTE_COVERAGE_TABLE_ID = "absolute-coverage-table"; static final String CHANGE_COVERAGE_TABLE_ID = "change-coverage-table"; static final String INDIRECT_COVERAGE_TABLE_ID = "indirect-coverage-table"; + private static final String INLINE_SUFFIX = "-inline"; private final Run owner; private final CoverageNode node; @@ -207,28 +210,27 @@ private CoverageMetric getCoverageMetricFromText(final String text) { */ @Override public TableModel getTableModel(final String tableId) { - CoverageNode root = getNode(); - File rootDir = getOwner().getRootDir(); - if ((ABSOLUTE_COVERAGE_TABLE_ID + "-inline").equals(tableId)) { - return new CoverageTableModel(tableId, root, rootDir, getId(), true); - } - else if (ABSOLUTE_COVERAGE_TABLE_ID.equals(tableId)) { - return new CoverageTableModel(tableId, root, rootDir, getId(), false); - } - else if (CHANGE_COVERAGE_TABLE_ID.equals(tableId)) { - return new ChangeCoverageTableModel(tableId, root, changeCoverageTreeRoot, rootDir, getId(), false); - } - else if ((CHANGE_COVERAGE_TABLE_ID + "-inline").equals(tableId)) { - return new ChangeCoverageTableModel(tableId, root, changeCoverageTreeRoot, rootDir, getId(), true); + CoverageTableModel.RowRenderer renderer; + String actualId; + if (tableId.endsWith(INLINE_SUFFIX)) { + renderer = new InlineRowRenderer(); + actualId = tableId.replace(INLINE_SUFFIX, StringUtils.EMPTY); } - else if (INDIRECT_COVERAGE_TABLE_ID.equals(tableId)) { - return new IndirectCoverageChangesTable(tableId, root, indirectCoverageChangesTreeRoot, rootDir, getId(), false); - } - else if ((INDIRECT_COVERAGE_TABLE_ID + "-inline").equals(tableId)) { - return new IndirectCoverageChangesTable(tableId, root, indirectCoverageChangesTreeRoot, rootDir, getId(), true); + else { + renderer = new LinkedRowRenderer(getOwner().getRootDir(), getId()); + actualId = tableId; } - throw new NoSuchElementException("No such table with id " + id); + switch (actualId) { + case ABSOLUTE_COVERAGE_TABLE_ID: + return new CoverageTableModel(tableId, getNode(), renderer); + case CHANGE_COVERAGE_TABLE_ID: + return new ChangeCoverageTableModel(tableId, getNode(), changeCoverageTreeRoot, renderer); + case INDIRECT_COVERAGE_TABLE_ID: + return new IndirectCoverageChangesTable(tableId, getNode(), indirectCoverageChangesTreeRoot, renderer); + default: + throw new NoSuchElementException("No such table with id " + id); + } } /** @@ -245,7 +247,7 @@ else if ((INDIRECT_COVERAGE_TABLE_ID + "-inline").equals(tableId)) { @JavaScriptMethod public String getUrlForBuild(final String selectedBuildDisplayName, final String currentUrl) { return NAVIGATOR.getSameUrlForOtherBuild(owner, currentUrl, CoverageBuildAction.DETAILS_URL, - selectedBuildDisplayName).orElse(StringUtils.EMPTY); + selectedBuildDisplayName).orElse(StringUtils.EMPTY); } /** @@ -303,7 +305,7 @@ private String readSourceCode(final CoverageNode sourceNode, final String tableI sourceNode.getName())).read(); // fallback with sources persisted using the < 2.1.0 serialization } if (!content.isEmpty() && sourceNode instanceof FileCoverageNode) { - String cleanTableId = StringUtils.removeEnd(tableId, "-inline"); + String cleanTableId = StringUtils.removeEnd(tableId, INLINE_SUFFIX); FileCoverageNode fileNode = (FileCoverageNode) sourceNode; if (CHANGE_COVERAGE_TABLE_ID.equals(cleanTableId)) { return SOURCE_CODE_FACADE.calculateChangeCoverageSourceCode(content, fileNode); @@ -486,5 +488,4 @@ private SortedMap getMetricsDistribution() { return coverage.getMetricsDistribution(); } } - } diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java index 1942a97ab..55b3978c9 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/IndirectCoverageChangesTable.java @@ -1,6 +1,5 @@ package io.jenkins.plugins.coverage.model; -import java.io.File; import java.util.List; import java.util.Locale; import java.util.Optional; @@ -29,14 +28,12 @@ class IndirectCoverageChangesTable extends CoverageTableModel { * The root of the origin coverage tree * @param changeRoot * The root of the indirect coverage changes tree - * @param buildFolder - * the build folder to store the source code files - * @param resultsId - * the ID of the results as prefix for the source code files in the build folder + * @param renderer + * the renderer to use for the file names */ - IndirectCoverageChangesTable(final String id, final CoverageNode root, final CoverageNode changeRoot, final File buildFolder, - final String resultsId, final boolean isInline) { - super(id, root, buildFolder, resultsId, isInline); + IndirectCoverageChangesTable(final String id, final CoverageNode root, final CoverageNode changeRoot, + final RowRenderer renderer) { + super(id, root, renderer); this.changeRoot = changeRoot; } @@ -45,8 +42,8 @@ class IndirectCoverageChangesTable extends CoverageTableModel { public List getRows() { Locale browserLocale = Functions.getCurrentLocale(); return changeRoot.getAllFileCoverageNodes().stream() - .map(file -> new IndirectCoverageChangesRow(getOriginalNode(file), file, getBuildFolder(), getResultsId(), - browserLocale)) + .map(file -> new IndirectCoverageChangesRow( + getOriginalNode(file), file, browserLocale, getRenderer())) .collect(Collectors.toList()); } @@ -66,23 +63,9 @@ private FileCoverageNode getOriginalNode(final FileCoverageNode fileNode) { private static class IndirectCoverageChangesRow extends CoverageRow { private final FileCoverageNode changedFileNode; - /** - * Creates a table row for visualizing the indirect coverage changes of a file. - * - * @param root - * The unfiltered node which represents the coverage of the whole file - * @param changedFileNode - * The filtered node which represents the indirect coverage changes only - * @param buildFolder - * the build folder to store the source code files - * @param resultsId - * the ID of the results as prefix for the source code files in the build folder - * @param browserLocale - * The locale - */ IndirectCoverageChangesRow(final FileCoverageNode root, final FileCoverageNode changedFileNode, - final File buildFolder, final String resultsId, final Locale browserLocale) { - super(root, buildFolder, resultsId, browserLocale); + final Locale browserLocale, final RowRenderer renderer) { + super(root, browserLocale, renderer); this.changedFileNode = changedFileNode; } From ffc59c929f6f97eccf12e76f5f4a7741d5b0a699 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sun, 19 Jun 2022 16:39:15 +0200 Subject: [PATCH 18/32] Make fields final. --- .../io/jenkins/plugins/coverage/model/CoverageTableModel.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java index eea636bd6..1e4475085 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java @@ -276,8 +276,8 @@ private DetailedCell createColoredFileCoverageDeltaColumn(final CoverageMetri * Renders filenames with links. Selection will be handled by opening a new page using the provided link. */ static class LinkedRowRenderer implements RowRenderer { - private File buildFolder; - private String resultsId; + private final File buildFolder; + private final String resultsId; LinkedRowRenderer(final File buildFolder, final String resultsId) { this.buildFolder = buildFolder; From c44b9388dafeb4d532a0b3e863641646e87cfc5f Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sun, 19 Jun 2022 17:59:30 +0200 Subject: [PATCH 19/32] Select the first tab only if no other tab is selected. --- plugin/src/main/webapp/js/charts.js | 49 ++++++++++++++++------------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index 690479a9c..00b9850e9 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -334,21 +334,6 @@ const CoverageChartGenerator = function ($) { }); } - /** - * Activates the specified tab. - * - * @param {String} selector - selector of the tab - */ - function selectTab (selector) { - const detailsTabs = $('#tab-details'); - const selectedTab = detailsTabs.find(selector); - - if (selectedTab.length !== 0) { - const tab = new bootstrap5.Tab(selectedTab[0]); - tab.show(); - } - } - /** * Initializes the datatables. */ @@ -396,15 +381,34 @@ const CoverageChartGenerator = function ($) { * Activate the tab that has been visited the last time. If there is no such tab, highlight the first one. * If the user selects the tab using an #anchor prefer this tab. */ - function registerTabStatePersistence() { - const selectedTabID = 'jenkins-coverage-activeTab'; + function registerTabEvents() { + /** + * Activates the specified tab. + * + * @param {String} selector - selector of the tab + * @return true if the tab has been selected + */ + function selectTab (selector) { + const detailsTabs = $('#tab-details'); + const selectedTab = detailsTabs.find(selector); + + if (selectedTab.length !== 0) { + const tab = new bootstrap5.Tab(selectedTab[0]); + tab.show(); + + return true; + } + return false + } - // TODO: check if a tab has been selected - selectTab('li:first-child a'); // fallback if all other options fail + const selectedTabID = 'jenkins-coverage-activeTab'; const url = document.location.toString(); if (url.match('#')) { const tabName = url.split('#')[1]; - selectTab('a[href="#' + tabName + '"]'); + if (selectTab('a[href="#' + tabName + '"]')) { + localStorage.setItem(selectedTabID, '#' + tabName); + } + } else { const activeTab = localStorage.getItem(selectedTabID); @@ -412,6 +416,9 @@ const CoverageChartGenerator = function ($) { selectTab('a[href="' + activeTab + '"]'); } } + if ($('#tab-details a.active').length === 0) { + selectTab('li:first-child a'); // fallback if all other options fail + } $('a[data-bs-toggle="tab"]').on('show.bs.tab', function (e) { window.location.hash = e.target.hash; @@ -429,7 +436,7 @@ const CoverageChartGenerator = function ($) { } registerTrendChartConfiguration(); - registerTabStatePersistence(); + registerTabEvents(); redrawCharts(); initializeDataTables(); From 60ca274b994ce5f0b9cd25cd5032e8372f2fd358 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sun, 19 Jun 2022 18:07:20 +0200 Subject: [PATCH 20/32] Simplify registration of selection events. --- plugin/src/main/webapp/js/charts.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index 00b9850e9..e74a321be 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -339,25 +339,25 @@ const CoverageChartGenerator = function ($) { */ function initializeDataTables() { $(document).ready(function () { - initializeSourceCodeSelection($('#absolute-coverage-table-inline').DataTable(), 'absolute-coverage-table-inline'); - initializeSourceCodeSelection($('#change-coverage-table-inline').DataTable(), 'change-coverage-table-inline'); - initializeSourceCodeSelection($('#indirect-coverage-table-inline').DataTable(), 'indirect-coverage-table-inline'); + initializeSourceCodeSelection('absolute-coverage-table-inline'); + initializeSourceCodeSelection('change-coverage-table-inline'); + initializeSourceCodeSelection('indirect-coverage-table-inline'); }); } /** * Initializes a selection listener for a datatable which loads the selected source code. * - * @param {DataTable} datatable The DataTable - * @param {String} id The ID of the DataTable + * @param {String} tableId The ID of the DataTable */ - function initializeSourceCodeSelection(datatable, id) { - const sourceView = $('#' + id + '-source-file'); + function initializeSourceCodeSelection(tableId) { + const datatable = $('#' + tableId).DataTable(); + const sourceView = $('#' + tableId + '-source-file'); datatable.on('select', function (e, dt, type, indexes) { if (type === 'row') { sourceView.html('Loading...'); const rowData = datatable.rows(indexes).data().toArray(); - viewProxy.getSourceCode(rowData[0].fileHash, id, function (t) { + viewProxy.getSourceCode(rowData[0].fileHash, tableId, function (t) { const sourceCode = t.responseObject(); if (sourceCode === "n/a") { sourceView.html('No source code available'); From ed3932f6c6c4bbeae1ca337e77973970aad48fa9 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sun, 19 Jun 2022 23:32:35 +0200 Subject: [PATCH 21/32] Fix warnings. --- .../io/jenkins/plugins/coverage/model/CoverageTableModel.java | 4 ++-- .../io/jenkins/plugins/coverage/model/CoverageViewModel.java | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java index 1e4475085..5d3311fe6 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageTableModel.java @@ -29,7 +29,7 @@ */ class CoverageTableModel extends TableModel { private static final ColorProvider COLOR_PROVIDER = ColorProviderFactory.createColorProvider(); - private static final int NO_COVERAGE_SORT = -1000; + private static final int NO_COVERAGE_SORT = -1_000; static final DetailedCell NO_COVERAGE = new DetailedCell<>(Messages.Coverage_Not_Available(), NO_COVERAGE_SORT); private final CoverageNode root; @@ -87,7 +87,7 @@ public List getColumns() { columns.add(fileName); TableColumn packageName = new ColumnBuilder().withHeaderLabel(Messages.Column_Package()) .withDataPropertyKey("packageName") - .withResponsivePriority(50000) + .withResponsivePriority(50_000) .build(); columns.add(packageName); TableColumn lineCoverage = new ColumnBuilder().withHeaderLabel(Messages.Column_LineCoverage()) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index 2b17beb38..c910b2b93 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -42,7 +42,7 @@ * @author Ullrich Hafner * @author Florian Orendi */ -@SuppressWarnings({"PMD.ExcessivePublicCount", "checkstyle:ClassDataAbstractionCoupling", "checkstyle:ClassFanOutComplexity"}) +@SuppressWarnings({"PMD.GodClass", "PMD.ExcessivePublicCount", "checkstyle:ClassDataAbstractionCoupling", "checkstyle:ClassFanOutComplexity"}) public class CoverageViewModel extends DefaultAsyncTableContentProvider implements ModelObject { private static final JacksonFacade JACKSON_FACADE = new JacksonFacade(); private static final ColorProvider COLOR_PROVIDER = ColorProviderFactory.createColorProvider(); From 61c174b65165d2a82fb51c9299fc317a7fa5f4d0 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sun, 19 Jun 2022 23:38:11 +0200 Subject: [PATCH 22/32] Improve handling of redraw events for charts. --- plugin/src/main/webapp/js/charts.js | 156 ++++++++++++++-------------- 1 file changed, 77 insertions(+), 79 deletions(-) diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index e74a321be..420eae27b 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -148,11 +148,8 @@ const CoverageChartGenerator = function ($) { ] }; summaryChart.setOption(summaryOption); - - window.addEventListener('resize', function () { - summaryChart.resize(); - }); - } + summaryChart.resize(); + } function createFilesTreeMap(coverageTree, id, coverageMetric) { function getLevelOption() { @@ -302,80 +299,9 @@ const CoverageChartGenerator = function ($) { ] }; treeChart.setOption(option); - - // TODO: there will be two events right now? - window.addEventListener('resize', function () { - treeChart.resize(); - }); - $('a[data-bs-toggle="tab"]').on('shown.bs.tab', function () { - treeChart.resize(); - }); - treeChart.resize(); } - function redrawCharts() { - // TODO: render only the active ones - const configuration = JSON.stringify(echartsJenkinsApi.readFromLocalStorage('jenkins-echarts-chart-configuration-coverage-history')); - viewProxy.getTrendChart(configuration, function (t) { - echartsJenkinsApi.renderConfigurableZoomableTrendChart('coverage-trend', t.responseJSON, 'chart-configuration-coverage-history', openBuild); - }); - - viewProxy.getOverview(function (t) { - createOverview(t.responseObject(), 'coverage-overview'); - }); - - viewProxy.getCoverageTree('Line', function (t) { - createFilesTreeMap(t.responseObject(), 'project-line-coverage', 'Line'); - }); - - viewProxy.getCoverageTree('Branch', function (t) { - createFilesTreeMap(t.responseObject(), 'project-branch-coverage', 'Branch'); - }); - } - - /** - * Initializes the datatables. - */ - function initializeDataTables() { - $(document).ready(function () { - initializeSourceCodeSelection('absolute-coverage-table-inline'); - initializeSourceCodeSelection('change-coverage-table-inline'); - initializeSourceCodeSelection('indirect-coverage-table-inline'); - }); - } - - /** - * Initializes a selection listener for a datatable which loads the selected source code. - * - * @param {String} tableId The ID of the DataTable - */ - function initializeSourceCodeSelection(tableId) { - const datatable = $('#' + tableId).DataTable(); - const sourceView = $('#' + tableId + '-source-file'); - datatable.on('select', function (e, dt, type, indexes) { - if (type === 'row') { - sourceView.html('Loading...'); - const rowData = datatable.rows(indexes).data().toArray(); - viewProxy.getSourceCode(rowData[0].fileHash, tableId, function (t) { - const sourceCode = t.responseObject(); - if (sourceCode === "n/a") { - sourceView.html('No source code available'); - } - else { - sourceView.html(sourceCode); - } - }); - } - else { - sourceView.html('No file selected'); - } - }) - datatable.on('deselect', function () { - sourceView.html('No file selected'); - }); - } - this.populateDetailsCharts = function () { /** * Activate the tab that has been visited the last time. If there is no such tab, highlight the first one. @@ -420,7 +346,7 @@ const CoverageChartGenerator = function ($) { selectTab('li:first-child a'); // fallback if all other options fail } - $('a[data-bs-toggle="tab"]').on('show.bs.tab', function (e) { + $('a[data-bs-toggle="tab"]').on('shown.bs.tab', function (e) { window.location.hash = e.target.hash; const activeTab = $(e.target).attr('href'); localStorage.setItem(selectedTabID, activeTab); @@ -428,6 +354,42 @@ const CoverageChartGenerator = function ($) { }); } + /** + * Loads all chart JSON models via AJAX calls from the server and renders the corresponding echarts. + */ + function initializeCharts() { + viewProxy.getOverview(function (t) { + createOverview(t.responseObject(), 'coverage-overview'); + }); + + viewProxy.getCoverageTree('Line', function (t) { + createFilesTreeMap(t.responseObject(), 'project-line-coverage', 'Line'); + }); + + viewProxy.getCoverageTree('Branch', function (t) { + createFilesTreeMap(t.responseObject(), 'project-branch-coverage', 'Branch'); + }); + } + + /** + * Event handler to resizes all charts. + */ + function redrawCharts() { + function resizeChartOf(selector) { + $(selector)[0].echart.resize(); + } + + const configuration = JSON.stringify(echartsJenkinsApi.readFromLocalStorage('jenkins-echarts-chart-configuration-coverage-history')); + viewProxy.getTrendChart(configuration, function (t) { + echartsJenkinsApi.renderConfigurableZoomableTrendChart('coverage-trend', t.responseJSON, 'chart-configuration-coverage-history', openBuild); + resizeChartOf('#coverage-trend'); + }); + + resizeChartOf('#coverage-overview'); + resizeChartOf('#project-line-coverage'); + resizeChartOf('#project-branch-coverage'); + } + function registerTrendChartConfiguration() { const trendConfigurationDialogId = 'chart-configuration-coverage-history'; $('#' + trendConfigurationDialogId).on('hidden.bs.modal', function () { @@ -435,14 +397,50 @@ const CoverageChartGenerator = function ($) { }); } + /** + * Initializes a selection listener for a datatable which loads the selected source code. + * + * @param {String} tableId The ID of the DataTable + */ + function initializeSourceCodeSelection(tableId) { + const datatable = $('#' + tableId).DataTable(); + const sourceView = $('#' + tableId + '-source-file'); + datatable.on('select', function (e, dt, type, indexes) { + if (type === 'row') { + sourceView.html('Loading...'); + const rowData = datatable.rows(indexes).data().toArray(); + viewProxy.getSourceCode(rowData[0].fileHash, tableId, function (t) { + const sourceCode = t.responseObject(); + if (sourceCode === "n/a") { + sourceView.html('No source code available'); + } + else { + sourceView.html(sourceCode); + } + }); + } + else { + sourceView.html('No file selected'); + } + }) + datatable.on('deselect', function () { + sourceView.html('No file selected'); + }); + } + registerTrendChartConfiguration(); registerTabEvents(); - redrawCharts(); - initializeDataTables(); + initializeCharts(); window.addEventListener('resize', function () { redrawCharts(); }); + + $(document).ready(function () { + initializeSourceCodeSelection('absolute-coverage-table-inline'); + initializeSourceCodeSelection('change-coverage-table-inline'); + initializeSourceCodeSelection('indirect-coverage-table-inline'); + }); } }; From ab738bc6fe4f9a21939ede25200043c5bf6b933f Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Sun, 19 Jun 2022 23:47:21 +0200 Subject: [PATCH 23/32] Cleanup versions of dependencies. --- plugin/pom.xml | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/plugin/pom.xml b/plugin/pom.xml index 95002033e..3a56329eb 100644 --- a/plugin/pom.xml +++ b/plugin/pom.xml @@ -26,14 +26,13 @@ 3.0.3 11.3 - 2.16.0 - 1.13.0 + 1.15.1 1.7.8 2.35.0 0.8.1 2.9.0 1.15.1 - 1.26.0-2 + 1.28.0-2 1.11 1.17.2 @@ -159,9 +158,8 @@ io.jenkins.plugins plugin-util-api - ${plugin-util-api.version} + tests test - test-jar @@ -240,7 +238,7 @@ io.jenkins.plugins git-forensics - 1.8.0 + 1.9.0 test From 97805f9e1cd6b6b57f8e63aea1ec06c8a3409339 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Mon, 20 Jun 2022 10:24:52 +0200 Subject: [PATCH 24/32] Add TODOs and FIXMEs. --- .../io/jenkins/plugins/coverage/model/CoverageViewModel.java | 1 + plugin/src/main/webapp/js/charts.js | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index c910b2b93..5b79436ce 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -104,6 +104,7 @@ public CoverageOverview getOverview() { return new CoverageOverview(getNode().filterPackageStructure()); } + // FIXME: currently not in use anymore @JavaScriptMethod public CoverageOverview getChangeCoverageOverview() { return new CoverageOverview(changeCoverageTreeRoot.filterPackageStructure()); diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index 420eae27b..2ef470c23 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -357,6 +357,7 @@ const CoverageChartGenerator = function ($) { /** * Loads all chart JSON models via AJAX calls from the server and renders the corresponding echarts. */ + // TODO: maybe it would make sense to render only visible charts function initializeCharts() { viewProxy.getOverview(function (t) { createOverview(t.responseObject(), 'coverage-overview'); @@ -428,7 +429,7 @@ const CoverageChartGenerator = function ($) { }); } - registerTrendChartConfiguration(); + registerTrendCmvnnhartConfiguration(); registerTabEvents(); initializeCharts(); From 818650e86f6050d72a9c0a041c77f1c296b08798 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Mon, 20 Jun 2022 10:25:42 +0200 Subject: [PATCH 25/32] Ignore RevApi right now as we are creating a new major version anyway. --- plugin/pom.xml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/plugin/pom.xml b/plugin/pom.xml index 3a56329eb..f340f7910 100644 --- a/plugin/pom.xml +++ b/plugin/pom.xml @@ -292,6 +292,13 @@ io.jenkins.plugins.coverage.model + + org.revapi + revapi-maven-plugin + + true + + From 05ea0f25e117ac701fafabebc8d8fd48b0dd1071 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Mon, 20 Jun 2022 10:58:43 +0200 Subject: [PATCH 26/32] Ignore RevApi for UI tests. --- ui-tests/pom.xml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/ui-tests/pom.xml b/ui-tests/pom.xml index 76a54212f..8f1e6fa75 100644 --- a/ui-tests/pom.xml +++ b/ui-tests/pom.xml @@ -225,6 +225,13 @@ + + org.revapi + revapi-maven-plugin + + true + + From d0e8593897aa252df08d2f5f44aac03f6f40cdb3 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Tue, 21 Jun 2022 10:17:31 +0200 Subject: [PATCH 27/32] Fix typo. --- plugin/src/main/webapp/js/charts.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index 2ef470c23..0dbaaa63c 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -429,7 +429,7 @@ const CoverageChartGenerator = function ($) { }); } - registerTrendCmvnnhartConfiguration(); + registerTrendChartConfiguration(); registerTabEvents(); initializeCharts(); From 5a3a4fe074360e99189a055970a29930715ab757 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Tue, 21 Jun 2022 10:19:11 +0200 Subject: [PATCH 28/32] Add support for builds without source code. --- .../coverage/model/CoverageViewModel.java | 13 +++-- .../coverage-table-and-source-code.jelly | 34 ++++++++++++ .../resources/coverage/coverage-table.jelly | 54 +++++++++++-------- .../model/CoverageViewModel/index.jelly | 2 +- 4 files changed, 73 insertions(+), 30 deletions(-) create mode 100644 plugin/src/main/resources/coverage/coverage-table-and-source-code.jelly diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index 5b79436ce..eec6a5722 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -213,14 +213,13 @@ private CoverageMetric getCoverageMetricFromText(final String text) { public TableModel getTableModel(final String tableId) { CoverageTableModel.RowRenderer renderer; String actualId; - if (tableId.endsWith(INLINE_SUFFIX)) { + if (tableId.endsWith(INLINE_SUFFIX) && isSourceFileAvailable(getNode())) { renderer = new InlineRowRenderer(); - actualId = tableId.replace(INLINE_SUFFIX, StringUtils.EMPTY); } else { renderer = new LinkedRowRenderer(getOwner().getRootDir(), getId()); - actualId = tableId; } + actualId = tableId.replace(INLINE_SUFFIX, StringUtils.EMPTY); switch (actualId) { case ABSOLUTE_COVERAGE_TABLE_ID: @@ -230,7 +229,7 @@ public TableModel getTableModel(final String tableId) { case INDIRECT_COVERAGE_TABLE_ID: return new IndirectCoverageChangesTable(tableId, getNode(), indirectCoverageChangesTreeRoot, renderer); default: - throw new NoSuchElementException("No such table with id " + id); + throw new NoSuchElementException("No such table with id " + actualId); } } @@ -322,13 +321,13 @@ else if (INDIRECT_COVERAGE_TABLE_ID.equals(cleanTableId)) { } /** - * Checks whether there are stored source files. + * Checks whether source files are stored. * - * @return {@code true} whether there are stored source files, else {@code false} + * @return {@code true} when source files are stored, {@code false} otherwise * @since 3.0.0 */ @JavaScriptMethod - public boolean hasStoredSourceCode() { + public boolean hasSourceCode() { return SOURCE_CODE_FACADE.hasStoredSourceCode(getOwner().getRootDir(), id); } diff --git a/plugin/src/main/resources/coverage/coverage-table-and-source-code.jelly b/plugin/src/main/resources/coverage/coverage-table-and-source-code.jelly new file mode 100644 index 000000000..ef767b56f --- /dev/null +++ b/plugin/src/main/resources/coverage/coverage-table-and-source-code.jelly @@ -0,0 +1,34 @@ + + + + + Provides a table to render the file coverage nodes and the source code view. + + The ID of the table. + + + +
+
+ + + +
+
+ + + +
+
+ +
+ +
+
+ +
+
+ + diff --git a/plugin/src/main/resources/coverage/coverage-table.jelly b/plugin/src/main/resources/coverage/coverage-table.jelly index a2ce36320..f182a624b 100644 --- a/plugin/src/main/resources/coverage/coverage-table.jelly +++ b/plugin/src/main/resources/coverage/coverage-table.jelly @@ -2,35 +2,45 @@ - Provides a table to render the file coverage nodes and the source code view. + Provides a table to render the file coverage nodes without the source code. The ID of the table.
-
- - - -
-
- - - -
-
- -
- -
+ + +
+ + +
- -
+
+ + + +
+
+ +
+ +
+
+ +
+ + +
+ + + +
+ + +
diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly index 96f28c130..58f2e6722 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly @@ -75,7 +75,7 @@
- +
From 78023f15fe053a329689d3d492b502ec2389b934 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Tue, 21 Jun 2022 11:06:09 +0200 Subject: [PATCH 29/32] Check overall source code folder. --- .../io/jenkins/plugins/coverage/model/CoverageViewModel.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java index eec6a5722..ae2eafbe0 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java @@ -213,7 +213,7 @@ private CoverageMetric getCoverageMetricFromText(final String text) { public TableModel getTableModel(final String tableId) { CoverageTableModel.RowRenderer renderer; String actualId; - if (tableId.endsWith(INLINE_SUFFIX) && isSourceFileAvailable(getNode())) { + if (tableId.endsWith(INLINE_SUFFIX) && hasSourceCode()) { renderer = new InlineRowRenderer(); } else { From a3d41db2341fba110d92160189fe961e9a21bb97 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Tue, 21 Jun 2022 11:15:28 +0200 Subject: [PATCH 30/32] Always show the no-source-code table view. --- plugin/src/main/resources/coverage/coverage-table.jelly | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin/src/main/resources/coverage/coverage-table.jelly b/plugin/src/main/resources/coverage/coverage-table.jelly index f182a624b..3c11864e0 100644 --- a/plugin/src/main/resources/coverage/coverage-table.jelly +++ b/plugin/src/main/resources/coverage/coverage-table.jelly @@ -33,7 +33,7 @@ -
+
From b91bab3f9a96bd561e3293f9599ea150a8a2bdf2 Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Wed, 22 Jun 2022 00:39:00 +0200 Subject: [PATCH 31/32] Improve layout for not selected source code. --- .../resources/coverage/coverage-table.jelly | 20 ++++++++- plugin/src/main/webapp/css/custom-style.css | 7 +++ plugin/src/main/webapp/js/charts.js | 43 ++++++++++++++----- 3 files changed, 58 insertions(+), 12 deletions(-) diff --git a/plugin/src/main/resources/coverage/coverage-table.jelly b/plugin/src/main/resources/coverage/coverage-table.jelly index 3c11864e0..2b4aba2f9 100644 --- a/plugin/src/main/resources/coverage/coverage-table.jelly +++ b/plugin/src/main/resources/coverage/coverage-table.jelly @@ -1,5 +1,5 @@ - + Provides a table to render the file coverage nodes without the source code. @@ -26,9 +26,25 @@
- +
+
+
+ +
+
+
${%Please select a file in the table to open the source code}
+
+
+
+
+ +
+
+
${%No source code available for this file}
+
+
diff --git a/plugin/src/main/webapp/css/custom-style.css b/plugin/src/main/webapp/css/custom-style.css index 8777fb828..4060948ee 100644 --- a/plugin/src/main/webapp/css/custom-style.css +++ b/plugin/src/main/webapp/css/custom-style.css @@ -1,3 +1,10 @@ +.no-selection-banner { + padding: 30px; + fill: var(--text-color); + height: 200px; + width: 200px; +} + .overview-chart { width: 100%; min-height: 40vh; diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index 0dbaaa63c..4da2e2636 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -149,7 +149,7 @@ const CoverageChartGenerator = function ($) { }; summaryChart.setOption(summaryOption); summaryChart.resize(); - } + } function createFilesTreeMap(coverageTree, id, coverageMetric) { function getLevelOption() { @@ -314,7 +314,7 @@ const CoverageChartGenerator = function ($) { * @param {String} selector - selector of the tab * @return true if the tab has been selected */ - function selectTab (selector) { + function selectTab(selector) { const detailsTabs = $('#tab-details'); const selectedTab = detailsTabs.find(selector); @@ -404,16 +404,39 @@ const CoverageChartGenerator = function ($) { * @param {String} tableId The ID of the DataTable */ function initializeSourceCodeSelection(tableId) { - const datatable = $('#' + tableId).DataTable(); + const datatable = $('#' + tableId + '-table-inline').DataTable(); const sourceView = $('#' + tableId + '-source-file'); + const noFileSelectedBanner = $('#' + tableId + '-no-selection'); + const noSourceAvailableBanner = $('#' + tableId + '-no-source'); + + function showNoSelection() { + sourceView.hide(); + noSourceAvailableBanner.hide(); + noFileSelectedBanner.show(); + } + + function showNoSourceCode() { + sourceView.hide(); + noFileSelectedBanner.hide(); + noSourceAvailableBanner.show(); + } + + function showSourceCode() { + noFileSelectedBanner.hide(); + noSourceAvailableBanner.hide(); + sourceView.show(); + } + + showNoSelection(); datatable.on('select', function (e, dt, type, indexes) { if (type === 'row') { + showSourceCode(); sourceView.html('Loading...'); const rowData = datatable.rows(indexes).data().toArray(); - viewProxy.getSourceCode(rowData[0].fileHash, tableId, function (t) { + viewProxy.getSourceCode(rowData[0].fileHash, tableId + '-table', function (t) { const sourceCode = t.responseObject(); if (sourceCode === "n/a") { - sourceView.html('No source code available'); + showNoSourceCode(); } else { sourceView.html(sourceCode); @@ -421,11 +444,11 @@ const CoverageChartGenerator = function ($) { }); } else { - sourceView.html('No file selected'); + showNoSelection(); } }) datatable.on('deselect', function () { - sourceView.html('No file selected'); + showNoSelection(); }); } @@ -439,9 +462,9 @@ const CoverageChartGenerator = function ($) { }); $(document).ready(function () { - initializeSourceCodeSelection('absolute-coverage-table-inline'); - initializeSourceCodeSelection('change-coverage-table-inline'); - initializeSourceCodeSelection('indirect-coverage-table-inline'); + initializeSourceCodeSelection('absolute-coverage'); + initializeSourceCodeSelection('change-coverage'); + initializeSourceCodeSelection('indirect-coverage'); }); } }; From bf5075441764c389f47e5213be2a9b4b07b41fda Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Wed, 22 Jun 2022 12:44:18 +0200 Subject: [PATCH 32/32] Cleanup. --- .../visualization/code/SourceCodeFacade.java | 3 +-- .../resources/coverage/coverage-table.jelly | 2 +- .../model/CoverageViewModel/index.jelly | 18 +++-------------- plugin/src/main/webapp/js/charts.js | 20 ++++++++++++------- 4 files changed, 18 insertions(+), 25 deletions(-) diff --git a/plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/code/SourceCodeFacade.java b/plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/code/SourceCodeFacade.java index 9fd7d0392..9f1036e32 100644 --- a/plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/code/SourceCodeFacade.java +++ b/plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/code/SourceCodeFacade.java @@ -367,8 +367,7 @@ private static String sanitizeFilename(final String inputName) { } @Override - public FilteredLog invoke(final File workspaceFile, final VirtualChannel channel) - throws IOException, InterruptedException { + public FilteredLog invoke(final File workspaceFile, final VirtualChannel channel) { FilteredLog log = new FilteredLog("Errors during source code painting:"); Set sourceDirectories = filterSourceDirectories(workspaceFile, log); if (sourceDirectories.isEmpty()) { diff --git a/plugin/src/main/resources/coverage/coverage-table.jelly b/plugin/src/main/resources/coverage/coverage-table.jelly index 2b4aba2f9..6daa52698 100644 --- a/plugin/src/main/resources/coverage/coverage-table.jelly +++ b/plugin/src/main/resources/coverage/coverage-table.jelly @@ -50,7 +50,7 @@
- +
diff --git a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly index 58f2e6722..ed3cd6d31 100644 --- a/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly +++ b/plugin/src/main/resources/io/jenkins/plugins/coverage/model/CoverageViewModel/index.jelly @@ -68,9 +68,9 @@
-
- -
+
+ +
@@ -92,18 +92,6 @@
-
-
- xxxl - xxl - xl - lg - md - sm - xs -
-
- diff --git a/plugin/src/main/webapp/js/charts.js b/plugin/src/main/webapp/js/charts.js index 4da2e2636..ff0a35277 100644 --- a/plugin/src/main/webapp/js/charts.js +++ b/plugin/src/main/webapp/js/charts.js @@ -359,6 +359,8 @@ const CoverageChartGenerator = function ($) { */ // TODO: maybe it would make sense to render only visible charts function initializeCharts() { + renderTrendChart(); + viewProxy.getOverview(function (t) { createOverview(t.responseObject(), 'coverage-overview'); }); @@ -372,19 +374,23 @@ const CoverageChartGenerator = function ($) { }); } - /** - * Event handler to resizes all charts. - */ - function redrawCharts() { - function resizeChartOf(selector) { - $(selector)[0].echart.resize(); - } + function resizeChartOf(selector) { + $(selector)[0].echart.resize(); + } + function renderTrendChart() { const configuration = JSON.stringify(echartsJenkinsApi.readFromLocalStorage('jenkins-echarts-chart-configuration-coverage-history')); viewProxy.getTrendChart(configuration, function (t) { echartsJenkinsApi.renderConfigurableZoomableTrendChart('coverage-trend', t.responseJSON, 'chart-configuration-coverage-history', openBuild); resizeChartOf('#coverage-trend'); }); + } + + /** + * Event handler to resizes all charts. + */ + function redrawCharts() { + renderTrendChart(); // rerender since the configuration might have changed resizeChartOf('#coverage-overview'); resizeChartOf('#project-line-coverage');