Multiple source roots support (scoverage/scalac-scoverage-plugin#104), aggretated reports draft.

Author: gslowikowski

Diff for: pom.xml

@@ -85,7 +85,7 @@ under the License.
         <maven.version>2.2.1</maven.version>
         <maven-plugin-plugin.version>3.3</maven-plugin-plugin.version>
 
-        <scalac-scoverage-plugin.version>1.0.4</scalac-scoverage-plugin.version>
+        <scalac-scoverage-plugin.version>1.0.5-SNAPSHOT</scalac-scoverage-plugin.version>
     </properties>
 
     <dependencies>

Diff for: src/main/java/org/scoverage/plugin/SCoveragePreCompileMojo.java

@@ -17,7 +17,11 @@
 
 package org.scoverage.plugin;
 
+import java.io.BufferedWriter;
 import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Properties;
@@ -225,9 +229,9 @@ else if ( resolvedScalaVersion.startsWith( "2.11." ) )
         }
 
         File classesDirectory = new File( project.getBuild().getOutputDirectory() );
-        File scoverageClassesDirectory = new File( classesDirectory.getParentFile(), "scoverage-classes" );
+        File scoverageClassesDirectory = new File( classesDirectory.getParentFile(), "scoverage-classes" );//TODO - "scoverage-classes" -> "scoverage-" + classesDirectory.getName()? 
         project.getBuild().setOutputDirectory( scoverageClassesDirectory.getAbsolutePath() );
-        for ( MavenProject reactorProject : reactorProjects )
+        for ( MavenProject reactorProject : reactorProjects ) //TODO - is this loop required at all? check it!
         {
             if ( reactorProject != project ) // TODO - how to include only dependent reactor projects?
             {
@@ -314,6 +318,15 @@ else if ( resolvedScalaVersion.startsWith( "2.11." ) )
             throw new MojoExecutionException( "SCoverage preparation failed", e );
         }
 
+        try
+        {
+            saveCompileSourceRootsToFile();
+        }
+        catch ( IOException e)
+        {
+            throw new MojoExecutionException( "SCoverage preparation failed", e );
+        }
+
         long te = System.currentTimeMillis();
         getLog().debug( String.format( "Mojo execution time: %d ms", te - ts ) );
     }
@@ -472,4 +485,29 @@ private Artifact getResolvedArtifact( String groupId, String artifactId, String
         return artifact;
     }
 
+    private void saveCompileSourceRootsToFile()
+        throws IOException
+    {
+        if ( !dataDirectory.exists() && ! dataDirectory.mkdirs() )
+        {
+            throw new IOException( String.format( "Cannot create \"s\" directory", dataDirectory.getAbsolutePath() ) );
+        }
+        File sourceRootsFile = new File( dataDirectory, "sourceRoots" );
+        BufferedWriter bw = new BufferedWriter( new OutputStreamWriter( new FileOutputStream( sourceRootsFile ), "UTF-8" ) );
+        try
+        {
+            List<String> compileSourceRoots = project.getCompileSourceRoots();
+            for ( String path : compileSourceRoots )
+            {
+                //TEST bw.write( org.codehaus.plexus.util.PathTool.getRelativePath( project.getBasedir().getPath(), path ) );
+                bw.write( path );
+                bw.newLine();
+            }
+        }
+        finally
+        {
+            bw.close();
+        }
+    }
+
 }

Diff for: src/main/java/org/scoverage/plugin/SCoverageReportMojo.java

@@ -17,8 +17,13 @@
 
 package org.scoverage.plugin;
 
+import java.io.BufferedReader;
 import java.io.File;
-//import java.io.IOException;
+import java.io.FileInputStream;
+import java.io.InputStreamReader;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Locale;
 import java.util.ResourceBundle;
 
@@ -41,10 +46,13 @@
 import org.codehaus.plexus.util.StringUtils;
 
 import scala.Predef$;
+import scala.collection.JavaConversions;
+
 import scoverage.Coverage;
 import scoverage.IOUtils;
 import scoverage.Serializer;
 import scoverage.report.CoberturaXmlWriter;
+import scoverage.report.CoverageAggregator;
 import scoverage.report.ScoverageHtmlWriter;
 import scoverage.report.ScoverageXmlWriter;
 
@@ -87,6 +95,21 @@ public class SCoverageReportMojo
     @Parameter( defaultValue = "${project}", readonly = true, required = true )
     private MavenProject project;
 
+    /**
+     * All Maven projects in the reactor.
+     */
+    @Parameter( defaultValue = "${reactorProjects}", required = true, readonly = true )
+    protected List<MavenProject> reactorProjects;
+
+//    /**
+//     * Source files directory.
+//     * <br/>
+//     *
+//     * @since 1.0.5
+//     */
+//    @Parameter( property = "scoverage.sourceDirectory", defaultValue = "${project.build.sourceDirectory}", required = true, readonly = true )
+//    private File sourceDirectory;
+
     /**
      * Directory where the coverage files should be written.
      * <br/>
@@ -96,6 +119,24 @@ public class SCoverageReportMojo
     @Parameter( property = "scoverage.dataDirectory", defaultValue = "${project.build.directory}/scoverage-data", required = true, readonly = true )
     private File dataDirectory;
 
+    /**
+     * ...
+     * <br/>
+     *
+     * @since 1.0.5
+     */
+    @Parameter( property = "scoverage.aggregate", defaultValue = "false" )
+    private boolean aggregate;
+
+    /**
+     * Directory where the measurements files ("scoverage.measurements.*") should be written.
+     * <br/>
+     *
+     * @since 1.0.5
+     */
+    @Parameter( property = "scoverage.measurementsDirectory", defaultValue = "${project.build.directory}/scoverage-data", required = true, readonly = true )
+    private File measurementsDirectory;
+
     /**
      * Specifies the destination directory where SCoverage saves the generated HTML files.
      */
@@ -162,8 +203,6 @@ public void generate( Sink sink, Locale locale )
         {
             long ts = System.currentTimeMillis();
 
-            File sourceDir = new File( project.getBuild().getSourceDirectory() );
-
             mkdirs( outputDirectory );
             mkdirs( xmlOutputDirectory );
 
@@ -188,31 +227,84 @@ public void generate( Sink sink, Locale locale )
                 }
             }*/
 
-            File coverageFile = Serializer.coverageFile( dataDirectory );
-            Coverage coverage = Serializer.deserialize( coverageFile );
+            if ( !"pom".equals( project.getPackaging() ) )
+            {
+                File coverageFile = Serializer.coverageFile( dataDirectory );
+                Coverage coverage = Serializer.deserialize( coverageFile );
+
+                List<File> compileSourceRoots = loadCompileSourceRootsFromFiles( project );//TODO initialization not here
+                
+                File[] measurementFiles = IOUtils.findMeasurementFiles( measurementsDirectory );
+                scala.collection.Set<Object> measurements = IOUtils.invoked( Predef$.MODULE$
+                    .wrapRefArray( measurementFiles ) );
+                coverage.apply( measurements );
+
+                getLog().info( "[scoverage] Generating cobertura XML report..." );
+                new CoberturaXmlWriter( project.getBasedir(), xmlOutputDirectory ).write( coverage );
+
+                getLog().info( "[scoverage] Generating scoverage XML report..." );
+                new ScoverageXmlWriter( JavaConversions.asScalaBuffer( compileSourceRoots ) /*sourceDirectory*/, xmlOutputDirectory, false ).write( coverage );
+
+                if ( !aggregate )
+                {
+                    getLog().info( "[scoverage] Generating scoverage HTML report..." );
+                    new ScoverageHtmlWriter( JavaConversions.asScalaBuffer( compileSourceRoots ), outputDirectory ).write( coverage );
+                }
+            }
+            else // aggregation
+            {
+                List<File> scoverageXmlFiles = new ArrayList<File>();
+                List<File> compileSourceRoots = new ArrayList<File>();
 
-            File[] measurementFiles = IOUtils.findMeasurementFiles( dataDirectory );
-            scala.collection.Set<Object> measurements = IOUtils.invoked( Predef$.MODULE$
-                .wrapRefArray( measurementFiles ) );
-            coverage.apply( measurements );
+                // List<File> measurementFiles2 = new ArrayList<File>();
+                for ( MavenProject module: reactorProjects )
+                {
+                    if ( !module.isExecutionRoot() && !module.getPackaging().equals( "pom" ) )
+                    {
+                        File scoverageXmlFile = new File( module.getBuild().getDirectory(), "scoverage.xml" );
+                        if ( scoverageXmlFile.isFile() )
+                        {
+                            scoverageXmlFiles.add( scoverageXmlFile );
+                            compileSourceRoots.addAll( loadCompileSourceRootsFromFiles( module ) );
+                        }
+                    }
+                }
+                if ( !scoverageXmlFiles.isEmpty() )
+                {
+                    Coverage coverage = CoverageAggregator.aggregatedCoverage( JavaConversions.asScalaBuffer( scoverageXmlFiles ).toSeq() );
 
-            getLog().info( "[scoverage] Generating cobertura XML report..." );
-            new CoberturaXmlWriter( project.getBasedir(), xmlOutputDirectory ).write( coverage );
+                    /*File[] measurementFiles = IOUtils.findMeasurementFiles( dataDirectory );
+                    scala.collection.Set<Object> measurements = IOUtils.invoked( Predef$.MODULE$
+                        .wrapRefArray( measurementFiles ) );
+                    coverage.apply( measurements );*/
 
-            getLog().info( "[scoverage] Generating scoverage XML report..." );
-            new ScoverageXmlWriter( sourceDir, xmlOutputDirectory, false ).write( coverage );
+                    getLog().info( "[scoverage] Generating cobertura XML report..." );
+                    new CoberturaXmlWriter( project.getBasedir(), xmlOutputDirectory ).write( coverage );
 
-            getLog().info( "[scoverage] Generating scoverage HTML report..." );
-            new ScoverageHtmlWriter( sourceDir, outputDirectory ).write( coverage );
+                    getLog().info( "[scoverage] Generating scoverage XML report..." );
+                    new ScoverageXmlWriter( JavaConversions.asScalaBuffer( compileSourceRoots ) /*project.getBasedir()*//*TEST sourceDir*/, xmlOutputDirectory, false ).write( coverage );
+
+                    getLog().info( "[scoverage] Generating scoverage HTML report..." );
+                    new ScoverageHtmlWriter( JavaConversions.asScalaBuffer( compileSourceRoots ) /*project.getBasedir()*//*TEST sourceDir*/, outputDirectory ).write( coverage );
+                }
+            }
 
             long te = System.currentTimeMillis();
             getLog().debug( String.format( "Mojo execution time: %d ms", te - ts ) );
         }
+        catch ( IOException e )
+        {
+            if ( failOnError )
+            {
+                throw new MavenReportException("Error while creating scoverage report", e);
+            }
+            getLog().error( "Error while creating scoverage report: " + e.getMessage(), e );
+        }
         catch ( RuntimeException e )
         {
             if ( failOnError )
             {
-                throw e;
+                throw new MavenReportException("Error while creating scoverage report", e);
             }
             getLog().error( "Error while creating scoverage report: " + e.getMessage(), e );
         }
@@ -241,6 +333,12 @@ public boolean canGenerateReport()
             return false;
         }
 
+        // If aggregated report and we are in top-level parent pom
+        if ( aggregate && project.isExecutionRoot() && reactorProjects.size() > 1 )
+        {
+            return true;
+        }
+
         if ( "pom".equals( project.getPackaging() ) )
         {
             return false;
@@ -249,7 +347,7 @@ public boolean canGenerateReport()
         //return true;//TODO-don't generate for aggregator nodes 
 
         File coverageFile = Serializer.coverageFile( dataDirectory );
-        if ( !coverageFile.exists() || !coverageFile.isFile() )
+        if ( !coverageFile.exists() || !coverageFile.isFile() ) //TODO - check is any measurement file exists
         {
 //            getLog().warn( "[scoverage] No coverage data, report generation skipped." );
             return false;
@@ -359,4 +457,39 @@ private void mkdirs( File directory )
         }
     }
 
+    private List<File> loadCompileSourceRootsFromFiles(MavenProject mavenProject) throws IOException
+    {
+        List<String> paths = new ArrayList<String>();
+        File dataDirectory = new File( mavenProject.getBuild().getDirectory(), "scoverage-data" );//TEMP
+        File sourceRootsFile = new File( dataDirectory, "sourceRoots" );
+        if ( sourceRootsFile.isFile() && sourceRootsFile.canRead() )
+        {
+            BufferedReader br = new BufferedReader( new InputStreamReader( new FileInputStream( sourceRootsFile ), "UTF-8" ) );
+            try
+            {
+                String path = br.readLine();
+                while ( path != null )
+                {
+                    paths.add( path );
+                    path = br.readLine();
+                }
+            }
+            finally
+            {
+                br.close();
+            }
+        }
+        else
+        {
+            // add debug message
+            paths.addAll( project.getCompileSourceRoots() );
+        }
+
+        List<File> result = new ArrayList<File>( paths.size() );
+        for ( String path : paths )
+        {
+            result.add( new File( path ) );
+        }
+        return result;
+    }
 }