Set title for an XML report

Kotlin/kotlinx-kover#527
JetBrains · Feb 6, 2024 · 2913ce6 · 2913ce6
1 parent 0bbd4b2
commit 2913ce6
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 28 deletions.
diff --git a/java6-utils/src/com/intellij/rt/coverage/report/XMLCoverageReport.java b/java6-utils/src/com/intellij/rt/coverage/report/XMLCoverageReport.java
@@ -245,12 +245,20 @@ private String getAttribute(String attributeName) {
     return value;
   }
 
-  public void write(FileOutputStream fOut, ProjectData project) throws IOException {
+  public void write(FileOutputStream fOut, ProjectData project, String title) throws IOException {
     XMLOutputFactory factory = XMLOutputFactory.newInstance();
     try {
       myOut = factory.createXMLStreamWriter(new BufferedOutputStream(fOut));
       myFiles.clear();
+
+      myOut.writeStartDocument();
+      newLine();
+      myOut.writeStartElement(REPORT_TAG);
+      String reportName = title != null ? title : IJ_REPORT_NAME;
+      myOut.writeAttribute(NAME_TAG, reportName);
+      newLine();
       writeProject(project);
+      myOut.writeEndDocument();
     } catch (XMLStreamException e) {
       throw wrapIOException(e);
     } finally {
@@ -272,12 +280,6 @@ private void newLine() throws XMLStreamException {
   }
 
   private void writeProject(ProjectData project) throws XMLStreamException {
-    myOut.writeStartDocument();
-    newLine();
-    myOut.writeStartElement(REPORT_TAG);
-    myOut.writeAttribute(NAME_TAG, IJ_REPORT_NAME);
-    newLine();
-
     final HashMap<String, List<ClassData>> packages = mapClassesToPackages(project, true);
 
     final Counter counter = new Counter();
@@ -290,7 +292,6 @@ private void writeProject(ProjectData project) throws XMLStreamException {
     writeCounter(counter, INSTRUCTION_MASK | LINE_MASK | BRANCH_MASK | METHOD_MASK | CLASS_MASK);
     myOut.writeEndElement();
     newLine();
-    myOut.writeEndDocument();
   }
 
   private Counter writePackage(ProjectData project, String packageName, List<ClassData> classes) throws XMLStreamException {

diff --git a/reporter/resources/xml/xmlTest.xml b/reporter/resources/xml/xmlTest.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" ?>
-<report name="Intellij Coverage Report">
+<report name="TITLE">
 <package name="MyClass">
 <class name="MyClass" sourcefilename="F.java">
 <method name="foo" desc="(I)V">

diff --git a/reporter/src/com/intellij/rt/coverage/report/Reporter.java b/reporter/src/com/intellij/rt/coverage/report/Reporter.java
@@ -33,9 +33,11 @@
  */
 public class Reporter {
   private final ReportLoadStrategy myLoad;
+  private final String myTitle;
 
-  public Reporter(ReportLoadStrategy loadStrategy) {
+  public Reporter(ReportLoadStrategy loadStrategy, String title) {
     myLoad = loadStrategy;
+    myTitle = title;
   }
 
   public void createXMLReport(File xmlFile) throws IOException {
@@ -44,19 +46,19 @@ public void createXMLReport(File xmlFile) throws IOException {
     try {
       xmlFile.getParentFile().mkdirs();
       out = new FileOutputStream(xmlFile);
-      report.write(out, myLoad.getProjectData());
+      report.write(out, myLoad.getProjectData(), myTitle);
     } finally {
       CoverageIOUtil.close(out);
     }
   }
 
-  public void createHTMLReport(File htmlDir, String title, String charset) throws IOException {
+  public void createHTMLReport(File htmlDir, String charset) throws IOException {
     htmlDir.mkdirs();
     final HTMLReportBuilder builder = ReportBuilderFactory.createHTMLReportBuilderForKover();
     builder.setReportDir(htmlDir);
     if (builder instanceof HTMLReportBuilderImpl) {
-      if (title != null) {
-        ((HTMLReportBuilderImpl) builder).setReportTitle(title);
+      if (myTitle != null) {
+        ((HTMLReportBuilderImpl) builder).setReportTitle(myTitle);
       }
 
       if (charset != null) {

diff --git a/reporter/src/com/intellij/rt/coverage/report/api/ReportApi.java b/reporter/src/com/intellij/rt/coverage/report/api/ReportApi.java
@@ -32,8 +32,8 @@ private ReportApi() {
     // no-op
   }
 
-  public static void xmlReport(File xmlReportFile, List<File> reports, List<File> outputRoots, List<File> sourceRoots, Filters filters) throws IOException {
-    Reporter reporter = createReporter(reports, outputRoots, sourceRoots, filters);
+  public static void xmlReport(File xmlReportFile, String title, List<File> reports, List<File> outputRoots, List<File> sourceRoots, Filters filters) throws IOException {
+    Reporter reporter = createReporter(title, reports, outputRoots, sourceRoots, filters);
     reporter.createXMLReport(xmlReportFile);
   }
 
@@ -46,11 +46,11 @@ public static void htmlReport(
       List<File> sourceRoots,
       Filters filters
   ) throws IOException {
-    Reporter reporter = createReporter(reports, outputRoots, sourceRoots, filters);
-    reporter.createHTMLReport(htmlReportDir, title, charset);
+    Reporter reporter = createReporter(title, reports, outputRoots, sourceRoots, filters);
+    reporter.createHTMLReport(htmlReportDir, charset);
   }
 
-  private static Reporter createReporter(List<File> reports, List<File> outputRoots, List<File> sourceRoots, Filters filters) {
+  private static Reporter createReporter(String title, List<File> reports, List<File> outputRoots, List<File> sourceRoots, Filters filters) {
     List<BinaryReport> binaryReports = new ArrayList<BinaryReport>();
     for (File report : reports) {
       binaryReports.add(new BinaryReport(report, null));
@@ -59,7 +59,7 @@ private static Reporter createReporter(List<File> reports, List<File> outputRoot
     ReportLoadStrategy loadStrategy =
         new ReportLoadStrategy.RawReportLoadStrategy(binaryReports, outputRoots, sourceRoots, filters);
 
-    return new Reporter(loadStrategy);
+    return new Reporter(loadStrategy, title);
   }
 
   public static void setFreemarkerRetry(int repeatMaxCount, long repeatCooldownMs) {

diff --git a/reporter/test/com/intellij/rt/coverage/report/HTMLTest.java b/reporter/test/com/intellij/rt/coverage/report/HTMLTest.java
@@ -95,7 +95,7 @@ private File runTestAndConvertToHTML(String patterns, String className) throws T
     BinaryReport report = TestUtils.runTest(patterns, className);
     File htmlDir = createHtmlDir(report.getDataFile());
     TestUtils.clearLogFile(new File("."));
-    TestUtils.createRawReporter(report, patterns).createHTMLReport(htmlDir, DEFAULT_TITLE, DEFAULT_CHARSET);
+    TestUtils.createRawReporter(report, patterns, DEFAULT_TITLE).createHTMLReport(htmlDir, DEFAULT_CHARSET);
     TestUtils.checkLogFile(new File("."));
     return htmlDir;
   }

diff --git a/reporter/test/com/intellij/rt/coverage/report/TestUtils.kt b/reporter/test/com/intellij/rt/coverage/report/TestUtils.kt
@@ -82,20 +82,22 @@ object TestUtils {
         return File(expectedPath)
     }
 
+    @JvmOverloads
     @JvmStatic
-    fun createRawReporter(report: BinaryReport?, patterns: String): Reporter {
+    fun createRawReporter(report: BinaryReport?, patterns: String, title: String? = null): Reporter {
         val reports = if (report == null) emptyList() else listOf(report)
         val filters = getFilters(patterns)
-        return Reporter(RawReportLoadStrategy(reports, outputRoots, sourceRoots, filters))
+        return Reporter(RawReportLoadStrategy(reports, outputRoots, sourceRoots, filters), title)
     }
 
+    @JvmOverloads
     @JvmStatic
-    fun createReporter(report: BinaryReport, patterns: String): Reporter {
+    fun createReporter(report: BinaryReport, patterns: String, title: String? = null): Reporter {
         val smapFile = File(report.dataFile.absolutePath + ".sm")
         val aggregatedReport = BinaryReport(report.dataFile, smapFile)
         runAggregator(aggregatedReport, patterns)
         val reports = listOf(aggregatedReport)
-        return Reporter(AggregatedReportLoadStrategy(reports, outputRoots, sourceRoots))
+        return Reporter(AggregatedReportLoadStrategy(reports, outputRoots, sourceRoots), title)
     }
 
     @JvmStatic

diff --git a/reporter/test/com/intellij/rt/coverage/report/XMLTest.java b/reporter/test/com/intellij/rt/coverage/report/XMLTest.java
@@ -108,7 +108,7 @@ public void apiTest() throws Throwable {
 
     TestUtils.clearLogFile(new File("."));
     Filters filters = TestUtils.createFilters(Pattern.compile("testData.simple.*"));
-    ReportApi.xmlReport(xmlFile, singletonList(report.getDataFile()), singletonList(new File(TestUtils.JAVA_OUTPUT)), singletonList(new File("test")), filters);
+    ReportApi.xmlReport(xmlFile, null, singletonList(report.getDataFile()), singletonList(new File(TestUtils.JAVA_OUTPUT)), singletonList(new File("test")), filters);
 
     TestUtils.checkLogFile(new File("."));
     XMLTest.verifyXMLWithExpected(xmlFile, "xml/simple.xml");
@@ -137,7 +137,7 @@ public void basicTest() throws Throwable {
 
     File file = createXMLFile();
     TestUtils.clearLogFile(new File("."));
-    new XMLCoverageReport().write(new FileOutputStream(file), project);
+    new XMLCoverageReport().write(new FileOutputStream(file), project, "TITLE");
     TestUtils.checkLogFile(new File("."));
     verifyXMLWithExpected(file, "xml/xmlTest.xml");
   }
@@ -172,7 +172,7 @@ public void sameFileNameTest() throws Throwable {
 
     File file = createXMLFile();
     TestUtils.clearLogFile(new File("."));
-    new XMLCoverageReport().write(new FileOutputStream(file), project);
+    new XMLCoverageReport().write(new FileOutputStream(file), project, null);
     TestUtils.checkLogFile(new File("."));
     verifyXMLWithExpected(file, "xml/sameSource.xml");
   }