From 4c6e8ab192b045164f5d6211589ee9ecebfbb1ef Mon Sep 17 00:00:00 2001 From: Ulli Hafner Date: Wed, 8 May 2024 19:15:55 +0200 Subject: [PATCH] Improve layout of Markdown. - Simplify warnings message. - Use the configured icon if set. --- .../hm/hafner/grading/AnalysisMarkdown.java | 6 +++--- .../edu/hm/hafner/grading/AnalysisScore.java | 4 ++-- .../edu/hm/hafner/grading/TestMarkdown.java | 4 ++-- .../hafner/grading/AnalysisMarkdownTest.java | 20 +++++++++---------- .../hm/hafner/grading/GradingReportTest.java | 16 +++++++-------- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/main/java/edu/hm/hafner/grading/AnalysisMarkdown.java b/src/main/java/edu/hm/hafner/grading/AnalysisMarkdown.java index 651dd5c..b7caf63 100644 --- a/src/main/java/edu/hm/hafner/grading/AnalysisMarkdown.java +++ b/src/main/java/edu/hm/hafner/grading/AnalysisMarkdown.java @@ -87,10 +87,10 @@ private int sum(final AnalysisScore score, final Function" diff --git a/src/main/java/edu/hm/hafner/grading/AnalysisScore.java b/src/main/java/edu/hm/hafner/grading/AnalysisScore.java index 0508f4e..eef680c 100644 --- a/src/main/java/edu/hm/hafner/grading/AnalysisScore.java +++ b/src/main/java/edu/hm/hafner/grading/AnalysisScore.java @@ -119,10 +119,10 @@ public int getTotalSize() { @Override protected String createSummary() { if (getReport().isEmpty()) { - return "No warnings found"; + return "No warnings"; } else { - return String.format("%d warning%s found (%d error%s, %d high, %d normal, %d low)", + return String.format("%d warning%s (%d error%s, %d high, %d normal, %d low)", getTotalSize(), plural(getTotalSize()), getErrorSize(), plural(getErrorSize()), getHighSeveritySize(), getNormalSeveritySize(), getLowSeveritySize()); diff --git a/src/main/java/edu/hm/hafner/grading/TestMarkdown.java b/src/main/java/edu/hm/hafner/grading/TestMarkdown.java index 2543911..b984d49 100644 --- a/src/main/java/edu/hm/hafner/grading/TestMarkdown.java +++ b/src/main/java/edu/hm/hafner/grading/TestMarkdown.java @@ -185,8 +185,8 @@ protected String createSummary(final TestScore score) { - :microscope:   Mutation Coverage: 93% mutations killed - ☑️ 99% Test strength --- -- :warning:   Style:: No warnings found -- :bug:   Bugs: No warnings found +- :warning:   Style:: No warnings +- :bug:   Bugs: No warnings
Created by [Quality Monitor](https://github.com/uhafner/quality-monitor/releases/tag/v1.6.0) v1.6.0 (#85eae94). More details are shown in the [GitHub Checks Result](https://github.com/jenkinsci/coverage-model/runs/23474192891). diff --git a/src/test/java/edu/hm/hafner/grading/AnalysisMarkdownTest.java b/src/test/java/edu/hm/hafner/grading/AnalysisMarkdownTest.java index 0e98090..231dd1b 100644 --- a/src/test/java/edu/hm/hafner/grading/AnalysisMarkdownTest.java +++ b/src/test/java/edu/hm/hafner/grading/AnalysisMarkdownTest.java @@ -58,7 +58,7 @@ void shouldShowMaximumScore() { .contains(IMPACT_CONFIGURATION); assertThat(analysisMarkdown.createSummary(score)) .contains("CheckStyle - 100 of 100") - .contains("No warnings found"); + .contains("No warnings"); } @Test @@ -87,7 +87,7 @@ void shouldShowScoreWithOneResult() { var analysisMarkdown = new AnalysisMarkdown(); assertThat(analysisMarkdown.createSummary(score)).contains( - "CS - 70 of 100: 10 warnings found (1 error, 2 high, 3 normal, 4 low)"); + "CS - 70 of 100: 10 warnings (1 error, 2 high, 3 normal, 4 low)"); assertThat(analysisMarkdown.createDetails(score)) .contains("TopLevel Warnings - 70 of 100") .contains("|CS|1|1|2|3|4|10|-30") @@ -126,8 +126,8 @@ void shouldShowScoreWithTwoSubResults() { assertThat(analysisMarkdown.createSummary(score)) .contains( - "CheckStyle - 70 of 100: 10 warnings found (1 error, 2 high, 3 normal, 4 low)", - "SpotBugs - 80 of 100: 10 warnings found (4 errors, 3 high, 2 normal, 1 low)"); + "CheckStyle - 70 of 100: 10 warnings (1 error, 2 high, 3 normal, 4 low)", + "SpotBugs - 80 of 100: 10 warnings (4 errors, 3 high, 2 normal, 1 low)"); assertThat(analysisMarkdown.createDetails(score)) .contains("CheckStyle - 50 of 100", "|CheckStyle|1|1|2|3|4|10|-30", @@ -162,8 +162,8 @@ void shouldShowNoImpactsWithTwoSubResults() { var analysisMarkdown = new AnalysisMarkdown(); assertThat(analysisMarkdown.createSummary(score)) - .contains("CheckStyle: 10 warnings found (1 error, 2 high, 3 normal, 4 low)", - "SpotBugs: 10 warnings found (4 errors, 3 high, 2 normal, 1 low)"); + .contains("CheckStyle: 10 warnings (1 error, 2 high, 3 normal, 4 low)", + "SpotBugs: 10 warnings (4 errors, 3 high, 2 normal, 1 low)"); assertThat(analysisMarkdown.createDetails(score)) .contains("CheckStyle", "|CheckStyle|1|1|2|3|4|10", @@ -217,10 +217,10 @@ void shouldShowScoreWithTwoResults() { ":moneybag:|:heavy_minus_sign:|*1*|*2*|*3*|*4*|:heavy_minus_sign:|:heavy_minus_sign:", ":moneybag:|:heavy_minus_sign:|*-11*|*-12*|*-13*|*-14*|:heavy_minus_sign:|:heavy_minus_sign:"); assertThat(analysisMarkdown.createSummary(score)) - .contains("CheckStyle 1 - 30 of 100: 10 warnings found (1 error, 2 high, 3 normal, 4 low)", - "CheckStyle 2 - 30 of 100: 10 warnings found (1 error, 2 high, 3 normal, 4 low)", - "SpotBugs 1 - 0 of 100: 10 warnings found (4 errors, 3 high, 2 normal, 1 low)", - "SpotBugs 2 - 0 of 100: 10 warnings found (4 errors, 3 high, 2 normal, 1 low)") + .contains("CheckStyle 1 - 30 of 100: 10 warnings (1 error, 2 high, 3 normal, 4 low)", + "CheckStyle 2 - 30 of 100: 10 warnings (1 error, 2 high, 3 normal, 4 low)", + "SpotBugs 1 - 0 of 100: 10 warnings (4 errors, 3 high, 2 normal, 1 low)", + "SpotBugs 2 - 0 of 100: 10 warnings (4 errors, 3 high, 2 normal, 1 low)") .doesNotContain("Total"); } diff --git a/src/test/java/edu/hm/hafner/grading/GradingReportTest.java b/src/test/java/edu/hm/hafner/grading/GradingReportTest.java index 4ad753b..b00d54a 100644 --- a/src/test/java/edu/hm/hafner/grading/GradingReportTest.java +++ b/src/test/java/edu/hm/hafner/grading/GradingReportTest.java @@ -114,8 +114,8 @@ void shouldCreateAllGradingResults() { "Line Coverage - 60 of 100", "80% (20 missed lines)", "Branch Coverage - 20 of 100", "60% (40 missed branches)", "Mutation Coverage - 20 of 100: 60% (40 survived mutations)", - "Checkstyle - 30 of 100: 10 warnings found (1 error, 2 high, 3 normal, 4 low)", - "SpotBugs - 0 of 100: 10 warnings found (4 errors, 3 high, 2 normal, 1 low)"); + "Checkstyle - 30 of 100: 10 warnings (1 error, 2 high, 3 normal, 4 low)", + "SpotBugs - 0 of 100: 10 warnings (4 errors, 3 high, 2 normal, 1 low)"); assertThat(results.getTextSummary(score)).isEqualTo( "Autograding score - 167 of 500 (33%)"); assertThat(results.getMarkdownDetails(score)).contains( @@ -142,8 +142,8 @@ void shouldCreateAllQualityResults() { "Line Coverage: 80% (20 missed lines)", "Branch Coverage: 60% (40 missed branches)", "Mutation Coverage: 60% (40 survived mutations)", - "Checkstyle: 10 warnings found (1 error, 2 high, 3 normal, 4 low)", - "SpotBugs: 10 warnings found (4 errors, 3 high, 2 normal, 1 low)"); + "Checkstyle: 10 warnings (1 error, 2 high, 3 normal, 4 low)", + "SpotBugs: 10 warnings (4 errors, 3 high, 2 normal, 1 low)"); assertThat(results.getTextSummary(score)).isEqualTo( "Autograding score"); assertThat(results.getMarkdownDetails(score)).contains( @@ -198,8 +198,8 @@ void shouldSkipScores() { aggregation.gradeAnalysis((tool, log) -> AnalysisMarkdownTest.createTwoReports(tool)); assertThat(logger.getInfoMessages()).contains( "Processing 2 static analysis configuration(s)", - "=> Style: 10 warnings found (1 error, 2 high, 3 normal, 4 low)", - "=> Bugs: 10 warnings found (4 errors, 3 high, 2 normal, 1 low)"); + "=> Style: 10 warnings (1 error, 2 high, 3 normal, 4 low)", + "=> Bugs: 10 warnings (4 errors, 3 high, 2 normal, 1 low)"); aggregation.gradeTests((tool, log) -> TestMarkdownTest.createTwoReports(tool)); assertThat(logger.getInfoMessages()).contains( @@ -229,8 +229,8 @@ void shouldSkipScores() { "Line Coverage: 80% (20 missed lines)", "Branch Coverage: 60% (40 missed branches)", "Mutation Coverage: 60% (40 survived mutations)", - "Checkstyle: 10 warnings found (1 error, 2 high, 3 normal, 4 low)", - "SpotBugs: 10 warnings found (4 errors, 3 high, 2 normal, 1 low)"); + "Checkstyle: 10 warnings (1 error, 2 high, 3 normal, 4 low)", + "SpotBugs: 10 warnings (4 errors, 3 high, 2 normal, 1 low)"); assertThat(results.getTextSummary(aggregation)).isEqualTo( "Autograding score"); assertThat(results.getTextSummary(aggregation, "Quality Summary")).isEqualTo(