From 79112ff8d023f1884948badafcaf16496b231541 Mon Sep 17 00:00:00 2001 From: Valery Yatsynovich Date: Sun, 15 Sep 2024 21:15:16 +0300 Subject: [PATCH] [allure-adaptor] Add ability to define custom report title --- docs/modules/configuration/pages/reporting.adoc | 7 ++++++- .../vividus/report/allure/AllureReportGenerator.java | 10 +++++++--- .../resources/org/vividus/report/allure/spring.xml | 1 + .../report/allure/AllureReportGeneratorTests.java | 7 ++++--- .../resources/properties/defaults/default.properties | 1 + 5 files changed, 19 insertions(+), 7 deletions(-) diff --git a/docs/modules/configuration/pages/reporting.adoc b/docs/modules/configuration/pages/reporting.adoc index 6bca2bce9c..179e9a1daa 100644 --- a/docs/modules/configuration/pages/reporting.adoc +++ b/docs/modules/configuration/pages/reporting.adoc @@ -2,13 +2,18 @@ == Configure report layout -[cols="3,1,1,3", options="header"] +[cols="3,2,1,3", options="header"] |=== |Property Name |Acceptable values |Default |Description +|`report.title` +|Any short description of the report. +|`VIVIDUS Report` +|The provided title is displayed on *Summary* widget of *Overview* tab. Also it is used as HTML title of the document. + |`report.show-parameters-section` a|`true` + `false` diff --git a/vividus-allure-adaptor/src/main/java/org/vividus/report/allure/AllureReportGenerator.java b/vividus-allure-adaptor/src/main/java/org/vividus/report/allure/AllureReportGenerator.java index eb310a5f1f..1aa47401fd 100644 --- a/vividus-allure-adaptor/src/main/java/org/vividus/report/allure/AllureReportGenerator.java +++ b/vividus-allure-adaptor/src/main/java/org/vividus/report/allure/AllureReportGenerator.java @@ -93,6 +93,8 @@ public class AllureReportGenerator implements IAllureReportGenerator private final File resultsDirectory = new File((String) PropertiesUtils.loadAllureProperties().get("allure.results.directory")); + private final String reportTitle; + private final IPropertyMapper propertyMapper; private final ResourcePatternResolver resourcePatternResolver; private final AllurePluginsProvider allurePluginsProvider; @@ -102,9 +104,11 @@ public class AllureReportGenerator implements IAllureReportGenerator private boolean started; - public AllureReportGenerator(IPropertyMapper propertyMapper, ResourcePatternResolver resourcePatternResolver, - AllurePluginsProvider allurePluginsProvider, NotificationsSender notificationsSender) + public AllureReportGenerator(String reportTitle, IPropertyMapper propertyMapper, + ResourcePatternResolver resourcePatternResolver, AllurePluginsProvider allurePluginsProvider, + NotificationsSender notificationsSender) { + this.reportTitle = reportTitle; this.propertyMapper = propertyMapper; this.resourcePatternResolver = resourcePatternResolver; this.allurePluginsProvider = allurePluginsProvider; @@ -267,7 +271,7 @@ public Template getTemplate(String name) new Allure2Plugin() ); Configuration configuration = new ConfigurationBuilder() - .withReportName("VIVIDUS Report") + .withReportName(reportTitle) .withReportLanguage("en") .withExtensions(extensions) .withPlugins(allurePluginsProvider.getPlugins()) diff --git a/vividus-allure-adaptor/src/main/resources/org/vividus/report/allure/spring.xml b/vividus-allure-adaptor/src/main/resources/org/vividus/report/allure/spring.xml index 6540d4a775..961dd6b239 100644 --- a/vividus-allure-adaptor/src/main/resources/org/vividus/report/allure/spring.xml +++ b/vividus-allure-adaptor/src/main/resources/org/vividus/report/allure/spring.xml @@ -60,6 +60,7 @@ + diff --git a/vividus-allure-adaptor/src/test/java/org/vividus/report/allure/AllureReportGeneratorTests.java b/vividus-allure-adaptor/src/test/java/org/vividus/report/allure/AllureReportGeneratorTests.java index 41e931a2f8..991cfff984 100644 --- a/vividus-allure-adaptor/src/test/java/org/vividus/report/allure/AllureReportGeneratorTests.java +++ b/vividus-allure-adaptor/src/test/java/org/vividus/report/allure/AllureReportGeneratorTests.java @@ -87,6 +87,7 @@ class AllureReportGeneratorTests private static final String EXECUTOR_JSON = "executor.json"; private static final String ALLURE_EXECUTOR_PROPERTY_PREFIX = "allure.executor."; private static final String INDEX_HTML = "index.html"; + private static final String VIVIDUS_REPORT = "VIVIDUS Report"; private final TestLogger logger = TestLoggerFactory.getTestLogger(AllureReportGenerator.class); @@ -108,7 +109,7 @@ void beforeEach(@TempDir Path tempDir) throws IOException resultsDirectory = tempDir.resolve("allure-results"); Files.createDirectories(resultsDirectory); System.setProperty(ALLURE_RESULTS_DIRECTORY_PROPERTY, resultsDirectory.toAbsolutePath().toString()); - allureReportGenerator = new AllureReportGenerator(propertyMapper, resourcePatternResolver, + allureReportGenerator = new AllureReportGenerator(VIVIDUS_REPORT, propertyMapper, resourcePatternResolver, allurePluginsProvider, notificationsSender); } @@ -187,7 +188,7 @@ void testEndWhenResultsDirectoryDoesNotExist() throws IOException File reportDirectory = tempDir.toFile(); resultsDirectory = tempDir.resolve("allure-results-to-be-created"); System.setProperty(ALLURE_RESULTS_DIRECTORY_PROPERTY, resultsDirectory.toAbsolutePath().toString()); - allureReportGenerator = new AllureReportGenerator(propertyMapper, resourcePatternResolver, + allureReportGenerator = new AllureReportGenerator(VIVIDUS_REPORT, propertyMapper, resourcePatternResolver, allurePluginsProvider, notificationsSender); when(propertyMapper.readValue(ALLURE_EXECUTOR_PROPERTY_PREFIX, ExecutorInfo.class)).thenReturn( Optional.empty()); @@ -294,7 +295,7 @@ private void assertIndexHtml(Path reportDirectory) throws IOException private void assertSummaryJson(Path reportDirectory) throws IOException { assertFile(reportDirectory, "widgets/summary.json", - "{\"reportName\":\"VIVIDUS Report\"," + "{\"reportName\":\"" + VIVIDUS_REPORT + "\"," + "\"testRuns\":[]," + "\"statistic\":{\"failed\":0,\"broken\":0,\"skipped\":0,\"passed\":0,\"unknown\":0,\"total\":0}," + "\"time\":{}" diff --git a/vividus/src/main/resources/properties/defaults/default.properties b/vividus/src/main/resources/properties/defaults/default.properties index b80a78eea4..1c0c174ddb 100644 --- a/vividus/src/main/resources/properties/defaults/default.properties +++ b/vividus/src/main/resources/properties/defaults/default.properties @@ -91,3 +91,4 @@ statistics.print-failures=false report.show-parameters-section=true report.text-length-diff-threshold=100 +report.title=VIVIDUS Report