Support multiple source roots in report generators (issue #104)

scalac-scoverage-plugin/src/main/scala/scoverage/IOUtils.scala

@@ -80,4 +80,22 @@ object IOUtils {
     }
     acc
   }
+
+  /**
+   * Converts absolute path to relative one if any of the source directories is it's parent.
+   * If there is no parent directory, the path is returned unchanged (absolute).
+   * 
+   * @param src absolute file path in canonical form
+   * @param sourcePaths absolute source paths in canonical form WITH trailing file separators
+   */
+  def relativeSource(src: String, sourcePaths: Seq[String]): String = {
+    val sourceRoot: Option[String] = sourcePaths.find(
+      sourcePath => src.startsWith(sourcePath)
+    )
+    sourceRoot match {
+      case Some(path: String) => src.replace(path, "")
+      case _ => throw new RuntimeException(s"No source root found for '$src'"); //TODO Change exception class
+    }
+  }
+
 }

scalac-scoverage-plugin/src/main/scala/scoverage/report/CoberturaXmlWriter.scala

@@ -4,17 +4,24 @@ import java.io.File
 
 import scoverage._
 
-import scala.xml.Node
+import scala.xml.{Node, PrettyPrinter}
 
 /** @author Stephen Samuel */
-class CoberturaXmlWriter(baseDir: File, outputDir: File) {
+class CoberturaXmlWriter(sourceDirectories: Seq[File], outputDir: File) {
 
+  def this (baseDir: File, outputDir: File) {
+    this(Seq(baseDir), outputDir);
+  }
+
+  // Source paths in canonical form WITH trailing file separator
+  val formattedSourcePaths: Seq[String] = sourceDirectories filter ( _.isDirectory ) map ( _.getCanonicalPath + File.separator )
+
   def format(double: Double): String = "%.2f".format(double)
 
   def write(coverage: Coverage): Unit = {
-    IOUtils.writeToFile(new File(outputDir.getAbsolutePath + "/cobertura.xml"),
-      "<?xml version=\"1.0\"?>\n<!DOCTYPE coverage SYSTEM \"http://cobertura.sourceforge.net/xml/coverage-04.dtd\">\n" +
-        xml(coverage))
+    val file = new File(outputDir, "cobertura.xml")
+    IOUtils.writeToFile(file, "<?xml version=\"1.0\"?>\n<!DOCTYPE coverage SYSTEM \"http://cobertura.sourceforge.net/xml/coverage-04.dtd\">\n" + 
+        new PrettyPrinter(120, 4).format(xml(coverage)))
   }
 
   def method(method: MeasuredMethod): Node = {
@@ -35,12 +42,7 @@ class CoberturaXmlWriter(baseDir: File, outputDir: File) {
 
   def klass(klass: MeasuredClass): Node = {
     <class name={klass.name}
-           filename={
-            val absPath = baseDir.getAbsolutePath.last == File.separatorChar match {
-              case true => baseDir.getAbsolutePath
-              case false => baseDir.getAbsolutePath + File.separatorChar
-            }
-            klass.source.replace(absPath, "")}
+           filename={relativeSource(klass.source).replace(File.separator, "/")}
            line-rate={format(klass.statementCoverage)}
            branch-rate={format(klass.branchCoverage)}
            complexity="0">
@@ -69,6 +71,10 @@ class CoberturaXmlWriter(baseDir: File, outputDir: File) {
     </package>
   }
 
+  def source(src: File): Node = {
+    <source>{src.getCanonicalPath.replace(File.separator, "/")}</source>
+  }
+
   def xml(coverage: Coverage): Node = {
     <coverage line-rate={format(coverage.statementCoverage)}
               lines-covered={coverage.statementCount.toString}
@@ -80,11 +86,15 @@ class CoberturaXmlWriter(baseDir: File, outputDir: File) {
               version="1.0"
               timestamp={System.currentTimeMillis.toString}>
       <sources>
-        <source>/src/main/scala</source>
+        <source>--source</source>
+        {sourceDirectories.filter(_.isDirectory()).map(source)}
       </sources>
       <packages>
         {coverage.packages.map(pack)}
       </packages>
     </coverage>
   }
+
+  private def relativeSource(src: String): String = IOUtils.relativeSource(src, formattedSourcePaths)
+
 }

scalac-scoverage-plugin/src/main/scala/scoverage/report/CoverageAggregator.scala

@@ -8,6 +8,10 @@ object CoverageAggregator {
 
   def aggregate(baseDir: File, clean: Boolean): Option[Coverage] = {
     val files = IOUtils.reportFileSearch(baseDir, IOUtils.isReportFile)
+    aggregate(files, clean)
+  }
+
+  def aggregate(files: Seq[File], clean: Boolean): Option[Coverage] = {
     println(s"[info] Found ${files.size} subproject report files [${files.mkString(",")}]")
     if (files.size > 1) {
       val coverage = aggregatedCoverage(files)

scalac-scoverage-plugin/src/main/scala/scoverage/report/ScoverageHtmlWriter.scala

@@ -8,8 +8,15 @@ import scoverage._
 import scala.xml.Node
 
 /** @author Stephen Samuel */
-class ScoverageHtmlWriter(sourceDirectory: File, outputDir: File) {
+class ScoverageHtmlWriter(sourceDirectories: Seq[File], outputDir: File) {
 
+  def this (sourceDirectory: File, outputDir: File) {
+    this(Seq(sourceDirectory), outputDir);
+  }
+
+  // Source paths in canonical form WITH trailing file separator
+  val formattedSourcePaths: Seq[String] = sourceDirectories filter ( _.isDirectory ) map ( _.getCanonicalPath + File.separator )
+
   def write(coverage: Coverage): Unit = {
     val indexFile = new File(outputDir.getAbsolutePath + "/index.html")
     val packageFile = new File(outputDir.getAbsolutePath + "/packages.html")
@@ -23,8 +30,6 @@ class ScoverageHtmlWriter(sourceDirectory: File, outputDir: File) {
     coverage.packages.foreach(writePackage)
   }
 
-  private def relativeSource(src: String): String = src.replace(sourceDirectory.getCanonicalPath + File.separator, "")
-
   private def writePackage(pkg: MeasuredPackage): Unit = {
     // package overview files are written out using a filename that respects the package name
     // that means package com.example declared in a class at src/main/scala/mystuff/MyClass.scala will be written
@@ -535,5 +540,8 @@ class ScoverageHtmlWriter(sourceDirectory: File, outputDir: File) {
       </tr>
     </table>
   }
+
+  private def relativeSource(src: String): String = IOUtils.relativeSource(src, formattedSourcePaths)
+
 }
 

scalac-scoverage-plugin/src/main/scala/scoverage/report/ScoverageXmlWriter.scala

@@ -7,8 +7,15 @@ import _root_.scoverage._
 import scala.xml.{Node, PrettyPrinter}
 
 /** @author Stephen Samuel */
-class ScoverageXmlWriter(sourceDir: File, outputDir: File, debug: Boolean) {
+class ScoverageXmlWriter(sourceDirectories: Seq[File], outputDir: File, debug: Boolean) {
 
+  def this (sourceDir: File, outputDir: File, debug: Boolean) {
+    this(Seq(sourceDir), outputDir, debug);
+  }
+
+  // Source paths in canonical form WITH trailing file separator
+  val formattedSourcePaths: Seq[String] = sourceDirectories filter ( _.isDirectory ) map ( _.getCanonicalPath + File.separator )
+
   def write(coverage: Coverage): Unit = {
     val file = IOUtils.reportFile(outputDir, debug)
     IOUtils.writeToFile(file, new PrettyPrinter(120, 4).format(xml(coverage)))
@@ -74,7 +81,7 @@ class ScoverageXmlWriter(sourceDir: File, outputDir: File, debug: Boolean) {
 
   private def klass(klass: MeasuredClass): Node = {
     <class name={klass.name}
-           filename={klass.source.replace(sourceDir.getAbsolutePath, "")}
+           filename={relativeSource(klass.source)}
            statement-count={klass.statementCount.toString}
            statements-invoked={klass.invokedStatementCount.toString}
            statement-rate={klass.statementCoverageFormatted}
@@ -96,5 +103,7 @@ class ScoverageXmlWriter(sourceDir: File, outputDir: File, debug: Boolean) {
     </package>
   }
 
+  private def relativeSource(src: String): String = IOUtils.relativeSource(src, formattedSourcePaths)
+
 }