#362: htmlTitle is used as title for maven report

siom79 · Sep 22, 2023 · 90ae1eb · 90ae1eb
1 parent 2997889
commit 90ae1eb
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 4 deletions.
diff --git a/japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpReport.java b/japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpReport.java
@@ -84,6 +84,14 @@ protected void executeReport(Locale locale) throws MavenReportException {
 					htmlString = htmlString.replaceAll("<title>[^<]*</title>", "");
 					htmlString = htmlString.replaceAll("<META[^>]*>", "");
 					Sink sink = getSink();
+					String htmlTitle = getHtmlTitle();
+					if (htmlTitle != null) {
+						sink.head();
+						sink.title();
+						sink.text(pluginParameters.getParameterParam().getHtmlTitle());
+						sink.title_();
+						sink.head_();
+					}
 					sink.rawText(htmlString);
 					sink.close();
 				}
@@ -119,6 +127,13 @@ private Options getOptions() {
 		}
 	}
 
+	private String getHtmlTitle() {
+		if (pluginParameters.getParameterParam() != null && pluginParameters.getParameterParam().getHtmlTitle() != null) {
+			return pluginParameters.getParameterParam().getHtmlTitle();
+		}
+		return null;
+	}
+
 	@Override
 	public String getOutputName() {
 		if (this.parameter != null && this.parameter.getReportLinkName() != null) {
@@ -150,6 +165,6 @@ public String getDescription(Locale locale) {
 
 	private boolean isPomModuleNeedingSkip() {
 		return this.pluginParameters.getParameterParam().getSkipPomModules()
-			&& "pom".equalsIgnoreCase(this.mavenProject.getArtifact().getType());
+				&& "pom".equalsIgnoreCase(this.mavenProject.getArtifact().getType());
 	}
 }
diff --git a/japicmp-testbase/japicmp-test-maven-plugin/pom.xml b/japicmp-testbase/japicmp-test-maven-plugin/pom.xml
@@ -703,6 +703,7 @@
 						<ignoreNonResolvableArtifacts>true</ignoreNonResolvableArtifacts>
 						<onlyModified>true</onlyModified>
 						<reportOnlyFilename>true</reportOnlyFilename>
+						<htmlTitle>Test-Title for Site-Report</htmlTitle>
 					</parameter>
 				</configuration>
 				<reportSets>

diff --git a/japicmp-testbase/japicmp-test-maven-plugin/src/test/java/japicmp/test/ITHtmlTitle.java b/japicmp-testbase/japicmp-test-maven-plugin/src/test/java/japicmp/test/ITHtmlTitle.java
@@ -6,26 +6,36 @@
 import org.junit.Test;
 
 import java.io.IOException;
-import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
-import static org.junit.Assert.assertThat;
 
 public class ITHtmlTitle {
 
 	@Test
 	public void testHtmlTitle() throws IOException {
 		Path htmlPath = Paths.get(System.getProperty("user.dir"), "target", "japicmp", "single-version.html");
 		assertThat(Files.exists(htmlPath), is(true));
-		Document document = Jsoup.parse(htmlPath.toFile(), Charset.forName("UTF-8").toString());
+		Document document = Jsoup.parse(htmlPath.toFile(), StandardCharsets.UTF_8.toString());
 		Elements title = document.select("title");
 		assertThat(title.isEmpty(), is(false));
 		assertThat(title.text(), is("Test-Title"));
 		Elements span = document.select("span.title");
 		assertThat(span.isEmpty(), is(false));
 		assertThat(span.text(), is("Test-Title"));
 	}
+
+	@Test
+	public void testHtmlTitleInSiteReport() throws IOException {
+		Path htmlPath = Paths.get(System.getProperty("user.dir"), "target", "site", "japicmp-test-v1_japicmp-test-v2.html");
+		assertThat(Files.exists(htmlPath), is(true));
+		Document document = Jsoup.parse(htmlPath.toFile(), StandardCharsets.UTF_8.toString());
+		Elements title = document.select("title");
+		assertThat(title.isEmpty(), is(false));
+		assertThat(title.text(), is("japicmp-test-maven-plugin – Test-Title for Site-Report"));
+	}
 }