Implement rcov sensor to capture overall coverage from rcov report. (Report must be located in coverage/rcov)

Author: wpgreenway

pom.xml

@@ -21,10 +21,11 @@
             <artifactId>sonar-plugin-api</artifactId>
             <version>2.10</version>
         </dependency>
-
-        <!-- add your dependencies here -->
-
-        <!-- unit tests -->
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>rubyMetrics</artifactId>
+            <version>1.5.1-SNAPSHOT</version>
+        </dependency>
         <dependency>
             <groupId>org.codehaus.sonar</groupId>
             <artifactId>sonar-testing-harness</artifactId>

src/main/java/com/pica/sonarplugins/ruby/RubyPlugin.java

@@ -3,6 +3,7 @@
 import com.pica.sonarplugins.ruby.core.Ruby;
 import com.pica.sonarplugins.ruby.core.RubySourceCodeColorizer;
 import com.pica.sonarplugins.ruby.core.RubySourceImporter;
+import com.pica.sonarplugins.ruby.rcov.RcovSensor;
 import org.sonar.api.Plugin;
 import org.sonar.api.Properties;
 
@@ -30,7 +31,8 @@ public List getExtensions() {
                 Ruby.class,
                 RubySensor.class,
                 RubySourceImporter.class,
-                RubySourceCodeColorizer.class
+                RubySourceCodeColorizer.class,
+                RcovSensor.class
         );
     }
 

src/main/java/com/pica/sonarplugins/ruby/rcov/RcovSensor.java

@@ -0,0 +1,52 @@
+package com.pica.sonarplugins.ruby.rcov;
+
+import com.pica.sonarplugins.ruby.core.RubyFile;
+import hudson.plugins.rubyMetrics.rcov.RcovParser;
+import hudson.plugins.rubyMetrics.rcov.model.RcovResult;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.sonar.api.batch.Sensor;
+import org.sonar.api.batch.SensorContext;
+import org.sonar.api.measures.CoreMetrics;
+import org.sonar.api.resources.Project;
+import org.sonar.api.resources.ProjectFileSystem;
+
+import java.io.File;
+import java.io.IOException;
+
+public class RcovSensor implements Sensor {
+
+    private static final Logger LOG = LoggerFactory.getLogger(RcovSensor.class);
+
+    public boolean shouldExecuteOnProject(Project project) {
+        return true;
+    }
+
+    public void analyse(Project project, SensorContext context) {
+        //TODO: Configure rcov location
+        File reportFile = new File("coverage/rcov/");
+        try {
+            parseReport(project.getFileSystem(), reportFile, context);
+        } catch (IOException e) {
+            LOG.error("Error analysing project.", e);
+        }
+
+    }
+
+    protected void parseReport(ProjectFileSystem fileSystem, File rootFile, final SensorContext context) throws IOException {;
+        //Coverage will be assigned to the "root" ruby file
+        RubyFile rootRubyFile = RubyFile.fromIOFile(fileSystem.getBasedir(), fileSystem.getSourceDirs());
+
+        RcovParser parser = new RcovParser(rootFile);
+        //TODO: Dynamic coverage file locations
+        File coverageFile = new File("coverage/rcov/index.html");
+        RcovResult result = parser.parse(coverageFile);
+
+        context.saveMeasure(rootRubyFile, CoreMetrics.COVERAGE, result.getCodeCoverageFloat().doubleValue());
+    }
+
+    @Override
+    public String toString() {
+        return "Ruby RcovSensor";
+    }
+}