feat: PDF report

fugerit79 · fugerit79 · commit 413aada68c1f · 2025-11-27T01:52:13.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- PDF report
+
+### Changed
+
+- report generation engine with [Venus Fugerit Doc](https://github.com/fugerit-org/fj-doc)
+
 ## [1.0.2] - 2025-11-26
 
 ### Fixed
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ A simple plugin to check the presence of JUnit5 test by tags.
 
 | parameter                | type    | required | notes                                                |
 |--------------------------|---------|----------|------------------------------------------------------|
-| format                   | string  | false    | default 'text', accepts 'html', 'json', 'xml'        |
+| format                   | string  | false    | default 'text', accepts 'html', 'json', 'xml', 'pdf' |
 | outputFile               | string  | true     | path where should be produced the report             |
 | requiredTags.requiredTag | string  | true     | tag to be checked                                    |
 | failOnMissingTag         | boolean | true     | if set to 'true' the build will fail on missing tags |
diff --git a/src/main/java/org/fugerit/java/junit5/tag/check/facade/TagReportFacade.java b/src/main/java/org/fugerit/java/junit5/tag/check/facade/TagReportFacade.java
@@ -51,7 +51,8 @@ private void generateReport(Map<ExecutedTest, Set<String>> testTagMap)
                 generateXmlReport( testTagMap );
                 break;
             case DocConfig.TYPE_HTML:
-                generateHtmlReport( helper );
+            case DocConfig.TYPE_PDF:
+                generateFjDocReport( helper, format.toLowerCase() );
                 break;
             default:
                 generateTextReport(testTagMap);
@@ -190,9 +191,9 @@ private String repeatString(String s, int count) {
         return sb.toString();
     }
 
-    private void generateHtmlReport(ReportHelper reportHelper) throws IOException {
+    private void generateFjDocReport(ReportHelper reportHelper, String handlerId) throws IOException {
         try (OutputStream os = new FileOutputStream(outputFile)) {
-            DocHelper.generateReport( DocConfig.TYPE_HTML, reportHelper, os );
+            DocHelper.generateReport( handlerId, reportHelper, os );
         }
     }
 
diff --git a/src/main/resources/junit5-tag-check-maven-plugin/template/report.ftl b/src/main/resources/junit5-tag-check-maven-plugin/template/report.ftl
@@ -22,6 +22,8 @@
         <info name="doc-subject">Report</info>
         <info name="doc-author">fugerit79</info>
         <info name="doc-language">en</info>
+        <info name="page-width">29.7cm</info>
+        <info name="page-height">21cm</info>
         <info name="html-css-style">
             body { font-family: Arial, sans-serif; margin: 20px; }
             table { border-collapse: collapse; width: 100%; margin: 20px 0; }
@@ -36,9 +38,9 @@
         </info>
     </metadata>
     <body>
-    <h head-level="1">${docTitle}</h>
+    <h head-level="1" style="bold">${docTitle}</h>
 
-    <h head-level="2">Summary</h>
+    <h head-level="2" style="bold" space-before="20">Summary</h>
 
     <table columns="2" colwidths="50;50"  width="100" id="summary-table">
         <row header="true">
@@ -63,7 +65,7 @@
         </row>
     </table>
 
-    <h head-level="2">Tags Summary</h>
+    <h head-level="2" style="bold" space-before="20">Tags Summary</h>
 
     <table columns="2" colwidths="50;50"  width="100" id="tags-summary-table">
         <row header="true">
@@ -78,9 +80,9 @@
         </#list>
     </table>
 
-    <h head-level="2">All Executed Tests</h>
+    <h head-level="2" style="bold" space-before="20">All Executed Tests</h>
 
-    <table columns="4" colwidths="15;55;15;15"  width="100" id="tags-summary-table">
+    <table columns="4" colwidths="15;55;15;15"  width="100" id="all-tests-table">
         <row header="true">
             <cell border-width="${defaultTableBorderSize}"><phrase>Status</phrase></cell>
             <cell border-width="${defaultTableBorderSize}"><phrase>Test</phrase></cell>
@@ -92,7 +94,7 @@
             <#assign currentStatusIcon><#if currentTest.failed>Fail<#elseif currentTest.error>Error<#elseif currentTest.skipped>Skipped<#else>Passed</#if></#assign>
             <row>
                 <cell border-width="${defaultTableBorderSize}" ${currentClassName}><phrase>${currentStatusIcon}</phrase></cell>
-                <cell border-width="${defaultTableBorderSize}"><phrase>${currentTest.className}#${currentTest.methodName}</phrase></cell>
+                <cell border-width="${defaultTableBorderSize}"><phrase>${currentTest.className}&#8203;#${currentTest.methodName}</phrase></cell>
                 <cell border-width="${defaultTableBorderSize}"><#list currentTest.tags as currentTag><phrase class="tag">${currentTag}</phrase></#list></cell>
                 <cell border-width="${defaultTableBorderSize}"><phrase>${currentTest.time}s</phrase></cell>
             </row>

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,8 @@ private void generateReport(Map<ExecutedTest, Set<String>> testTagMap)`
`51`	`51`	`generateXmlReport( testTagMap );`
`52`	`52`	`break;`
`53`	`53`	`case DocConfig.TYPE_HTML:`
`54`		`- generateHtmlReport( helper );`
	`54`	`+ case DocConfig.TYPE_PDF:`
	`55`	`+ generateFjDocReport( helper, format.toLowerCase() );`
`55`	`56`	`break;`
`56`	`57`	`default:`
`57`	`58`	`generateTextReport(testTagMap);`
`@@ -190,9 +191,9 @@ private String repeatString(String s, int count) {`
`190`	`191`	`return sb.toString();`
`191`	`192`	`}`
`192`	`193`
`193`		`- private void generateHtmlReport(ReportHelper reportHelper) throws IOException {`
	`194`	`+ private void generateFjDocReport(ReportHelper reportHelper, String handlerId) throws IOException {`
`194`	`195`	`try (OutputStream os = new FileOutputStream(outputFile)) {`
`195`		`- DocHelper.generateReport( DocConfig.TYPE_HTML, reportHelper, os );`
	`196`	`+ DocHelper.generateReport( handlerId, reportHelper, os );`
`196`	`197`	`}`
`197`	`198`	`}`
`198`	`199`