API deprecations removal

But still a lot to do...

Author: Gilles Grousset

commons/src/main/java/com/backelite/sonarqube/commons/MeasureUtil.java

@@ -0,0 +1,52 @@
+/**
+ * commons - Enables analysis of Swift and Objective-C projects into SonarQube.
+ * Copyright © 2015 Backelite (${email})
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.backelite.sonarqube.commons;
+
+import org.sonar.api.batch.fs.InputComponent;
+import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.measures.Metric;
+
+/**
+ * Created by gillesgrousset on 29/08/2018.
+ */
+public final class MeasureUtil {
+
+    public static void saveMeasure(SensorContext context, InputComponent component, Metric<Integer> metric, int value) {
+        context.<Integer>newMeasure()
+                .on(component)
+                .forMetric(metric)
+                .withValue(value)
+                .save();
+    }
+
+    public static void saveMeasure(SensorContext context, InputComponent component, Metric<Long> metric, long value) {
+        context.<Long>newMeasure()
+                .on(component)
+                .forMetric(metric)
+                .withValue(value)
+                .save();
+    }
+
+    public static void saveMeasure(SensorContext context, InputComponent component, Metric<Double> metric, double value) {
+        context.<Double>newMeasure()
+                .on(component)
+                .forMetric(metric)
+                .withValue(value)
+                .save();
+    }
+}

commons/src/main/java/com/backelite/sonarqube/commons/surefire/BaseSurefireParser.java renamed to commons/src/main/java/com/backelite/sonarqube/commons/surefire/SurefireParser.java

@@ -17,17 +17,18 @@
  */
 package com.backelite.sonarqube.commons.surefire;
 
+import com.backelite.sonarqube.commons.MeasureUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.sonar.api.batch.SensorContext;
 import org.sonar.api.batch.fs.FileSystem;
+import org.sonar.api.batch.fs.InputComponent;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.api.component.ResourcePerspectives;
 import org.sonar.api.measures.CoreMetrics;
 import org.sonar.api.measures.Metric;
-import org.sonar.api.resources.Resource;
 import org.sonar.api.test.MutableTestPlan;
 import org.sonar.api.test.TestCase;
-import org.sonar.api.utils.ParsingUtils;
 import org.sonar.api.utils.StaxParser;
 
 import javax.annotation.Nullable;
@@ -39,21 +40,21 @@
 /**
  * Created by gillesgrousset on 28/08/2018.
  */
-public abstract class BaseSurefireParser {
+public class SurefireParser {
 
-    protected static final Logger LOGGER = LoggerFactory.getLogger(BaseSurefireParser.class);
+    protected static final Logger LOGGER = LoggerFactory.getLogger(SurefireParser.class);
 
     protected final FileSystem fileSystem;
     protected final SensorContext context;
     protected final ResourcePerspectives perspectives;
 
-    protected BaseSurefireParser(FileSystem fileSystem, ResourcePerspectives perspectives, SensorContext context) {
+    protected SurefireParser(FileSystem fileSystem, ResourcePerspectives perspectives, SensorContext context) {
         this.fileSystem = fileSystem;
         this.perspectives = perspectives;
         this.context = context;
     }
 
-    private static void parseFiles(File[] reports, UnitTestIndex index) {
+    private void parseFiles(File[] reports, UnitTestIndex index) {
         SurefireStaxHandler staxParser = new SurefireStaxHandler(index);
         StaxParser parser = new StaxParser(staxParser, false);
         for (File report : reports) {
@@ -63,16 +64,15 @@ private static void parseFiles(File[] reports, UnitTestIndex index) {
                 throw new IllegalStateException("Fail to parse the Surefire report: " + report, e);
             }
         }
+
     }
 
     public void collect(File reportsDir) {
 
 
         File[] xmlFiles = getReports(reportsDir);
 
-        if (xmlFiles.length == 0) {
-            insertZeroWhenNoReports();
-        } else {
+        if (xmlFiles.length > 0) {
             parseFiles(xmlFiles);
         }
     }
@@ -91,9 +91,6 @@ public boolean accept(File dir, String name) {
         });
     }
 
-    private void insertZeroWhenNoReports() {
-        context.saveMeasure(CoreMetrics.TESTS, 0.0);
-    }
 
     private void parseFiles(File[] reports) {
         UnitTestIndex index = new UnitTestIndex();
@@ -102,41 +99,55 @@ private void parseFiles(File[] reports) {
     }
 
     private void save(UnitTestIndex index) {
+
+
         long negativeTimeTestNumber = 0;
+        int testsCount = 0;
+        int testsSkipped = 0;
+        int testsErrors = 0;
+        int testsFailures = 0;
+        long testsTime = 0;
 
         for (Map.Entry<String, UnitTestClassReport> entry : index.getIndexByClassname().entrySet()) {
+
             UnitTestClassReport report = entry.getValue();
+
+            testsCount += report.getTests() - report.getSkipped();
+            testsSkipped += report.getSkipped();
+            testsErrors += report.getErrors();
+            testsFailures += report.getFailures();
+
             if (report.getTests() > 0) {
+
                 negativeTimeTestNumber += report.getNegativeTimeTestNumber();
-                Resource resource = getUnitTestResource(entry.getKey());
-                if (resource != null) {
-                    save(report, resource);
+                InputFile inputFile = getUnitTestResource(entry.getKey());
+                if (inputFile != null) {
+                    saveResults(inputFile, report);
                 } else {
                     LOGGER.warn("Resource not found: {}", entry.getKey());
                 }
+
             }
+
         }
+
+
         if (negativeTimeTestNumber > 0) {
             LOGGER.warn("There is {} test(s) reported with negative time by data, total duration may not be accurate.", negativeTimeTestNumber);
         }
-    }
 
-    private void save(UnitTestClassReport report, Resource resource) {
-        double testsCount = report.getTests() - report.getSkipped();
-        saveMeasure(resource, CoreMetrics.SKIPPED_TESTS, report.getSkipped());
-        saveMeasure(resource, CoreMetrics.TESTS, testsCount);
-        saveMeasure(resource, CoreMetrics.TEST_ERRORS, report.getErrors());
-        saveMeasure(resource, CoreMetrics.TEST_FAILURES, report.getFailures());
-        saveMeasure(resource, CoreMetrics.TEST_EXECUTION_TIME, report.getDurationMilliseconds());
-        double passedTests = testsCount - report.getErrors() - report.getFailures();
         if (testsCount > 0) {
-            double percentage = passedTests * 100d / testsCount;
-            saveMeasure(resource, CoreMetrics.TEST_SUCCESS_DENSITY, ParsingUtils.scaleValue(percentage));
+            InputComponent module = context.module();
+            MeasureUtil.saveMeasure(context, module, CoreMetrics.TESTS, testsCount);
+            MeasureUtil.saveMeasure(context, module, CoreMetrics.SKIPPED_TESTS, testsSkipped);
+            MeasureUtil.saveMeasure(context, module, CoreMetrics.TEST_ERRORS, testsErrors);
+            MeasureUtil.saveMeasure(context, module, CoreMetrics.TEST_FAILURES, testsFailures);
+            MeasureUtil.saveMeasure(context, module, CoreMetrics.TEST_EXECUTION_TIME, testsTime);
         }
-        saveResults(resource, report);
     }
 
-    protected void saveResults(Resource testFile, UnitTestClassReport report) {
+
+    protected void saveResults(InputFile testFile, UnitTestClassReport report) {
         for (UnitTestResult unitTestResult : report.getResults()) {
             MutableTestPlan testPlan = perspectives.as(MutableTestPlan.class, testFile);
             if (testPlan != null) {
@@ -151,11 +162,9 @@ protected void saveResults(Resource testFile, UnitTestClassReport report) {
     }
 
     @Nullable
-    public abstract Resource getUnitTestResource(String classname);
-
-    private void saveMeasure(Resource resource, Metric metric, double value) {
-        if (!Double.isNaN(value)) {
-            context.saveMeasure(resource, metric, value);
-        }
+    public  InputFile getUnitTestResource(String classname) {
+        return TestFileFinders.getInstance().getUnitTestResource(fileSystem, classname);
     }
+
+
 }

commons/src/main/java/com/backelite/sonarqube/commons/surefire/BaseSurefireSensor.java renamed to commons/src/main/java/com/backelite/sonarqube/commons/surefire/SurefireSensor.java

@@ -20,41 +20,47 @@
 import com.backelite.sonarqube.commons.Constants;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.sonar.api.batch.Sensor;
-import org.sonar.api.batch.SensorContext;
 import org.sonar.api.batch.fs.FileSystem;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.batch.sensor.Sensor;
+import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.batch.sensor.SensorDescriptor;
 import org.sonar.api.component.ResourcePerspectives;
 import org.sonar.api.config.Settings;
-import org.sonar.api.resources.Project;
 import org.sonar.api.scan.filesystem.PathResolver;
 
 import java.io.File;
 
 /**
  * Created by gillesgrousset on 28/08/2018.
  */
-public abstract class BaseSurefireSensor implements Sensor {
+public class SurefireSensor implements Sensor {
 
     public static final String REPORTS_PATH_KEY = Constants.PROPERTY_PREFIX + ".surefire.junit.reportsPath";
     public static final String DEFAULT_REPORTS_PATH = "sonar-reports/";
-    protected static final Logger LOGGER = LoggerFactory.getLogger(BaseSurefireSensor.class);
-    protected final FileSystem fileSystem;
-    protected final PathResolver pathResolver;
-    protected final ResourcePerspectives resourcePerspectives;
-    protected final Settings settings;
 
-    protected BaseSurefireSensor(FileSystem fileSystem, PathResolver pathResolver, ResourcePerspectives resourcePerspectives, Settings settings) {
+    private static final Logger LOGGER = LoggerFactory.getLogger(SurefireSensor.class);
+    private final FileSystem fileSystem;
+    private final PathResolver pathResolver;
+    private final ResourcePerspectives resourcePerspectives;
+    private final Settings settings;
+
+    public SurefireSensor(FileSystem fileSystem, PathResolver pathResolver, ResourcePerspectives resourcePerspectives, Settings settings) {
         this.fileSystem = fileSystem;
         this.pathResolver = pathResolver;
         this.resourcePerspectives = resourcePerspectives;
         this.settings = settings;
     }
 
     @Override
-    public abstract boolean shouldExecuteOnProject(Project project);
+    public void describe(SensorDescriptor descriptor) {
+        descriptor
+                .name("Surefire")
+                .onlyOnFileType(InputFile.Type.MAIN);
+    }
 
     @Override
-    public void analyse(Project project, SensorContext context) {
+    public void execute(SensorContext context) {
 
         String path = this.reportPath();
         File reportsDir = pathResolver.relativeFile(fileSystem.baseDir(), path);
@@ -69,7 +75,10 @@ public void analyse(Project project, SensorContext context) {
         collect(context, reportsDir);
     }
 
-    protected abstract void collect(SensorContext context, File reportsDir);
+    protected  void collect(SensorContext context, File reportsDir) {
+        LOGGER.info("parsing {}", reportsDir);
+        new SurefireParser(fileSystem, resourcePerspectives, context).collect(reportsDir);
+    }
 
     protected String reportPath() {
         String reportPath = settings.getString(REPORTS_PATH_KEY);

commons/src/main/java/com/backelite/sonarqube/commons/surefire/SurefireStaxHandler.java

@@ -121,7 +121,7 @@ public void stream(SMHierarchicCursor rootCursor) throws XMLStreamException {
             if (testSuiteEvent.compareTo(SMEvent.START_ELEMENT) == 0) {
                 String testSuiteClassName = testSuite.getAttrValue("name");
                 if (StringUtils.contains(testSuiteClassName, "$")) {
-                    // test suites for inner classes are ignored
+                    // Test suites for inner classes are ignored
                     return;
                 }
                 SMInputCursor testCase = testSuite.childCursor(new ElementFilter("testcase"));

commons/src/main/java/com/backelite/sonarqube/commons/surefire/TestFileFinder.java

@@ -0,0 +1,32 @@
+/**
+ * commons - Enables analysis of Swift and Objective-C projects into SonarQube.
+ * Copyright © 2015 Backelite (${email})
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.backelite.sonarqube.commons.surefire;
+
+import org.sonar.api.batch.fs.FileSystem;
+import org.sonar.api.batch.fs.InputFile;
+
+import javax.annotation.Nullable;
+
+/**
+ * Created by gillesgrousset on 28/08/2018.
+ */
+public interface TestFileFinder {
+
+    @Nullable
+    InputFile getUnitTestResource(FileSystem fileSystem, String classname);
+}

commons/src/main/java/com/backelite/sonarqube/commons/surefire/TestFileFinders.java

@@ -0,0 +1,64 @@
+/**
+ * commons - Enables analysis of Swift and Objective-C projects into SonarQube.
+ * Copyright © 2015 Backelite (${email})
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.backelite.sonarqube.commons.surefire;
+
+import org.sonar.api.batch.fs.FileSystem;
+import org.sonar.api.batch.fs.InputFile;
+
+import javax.annotation.Nullable;
+import java.util.ArrayList;
+import java.util.List;
+
+public class TestFileFinders {
+
+    private static TestFileFinders instance;
+
+
+    private final List<TestFileFinder> finders = new ArrayList<>();
+
+    private TestFileFinders() {
+
+    }
+
+    public static synchronized TestFileFinders getInstance() {
+
+        if (instance == null) {
+            instance = new TestFileFinders();
+        }
+        return instance;
+    }
+
+    public void addFinder(TestFileFinder finder) {
+        finders.add(finder);
+    }
+
+    @Nullable
+    InputFile getUnitTestResource(FileSystem fileSystem, String classname) {
+
+        for (TestFileFinder finder : finders) {
+            InputFile result = finder.getUnitTestResource(fileSystem, classname);
+            if (result != null) {
+                return result;
+            }
+        }
+
+        return null;
+    }
+
+
+}