JUnit report (#37)

* XUnit report

* updates README

* updates DOC

* adds unit tests

* more tests

* license header

* sonar.test.reportPath into sonar.rust.test.reportPath #37

* fixes a breaking test #37

Co-authored-by: tfalque.ext <[email protected]>

Author: thibaultfalque

DOC.md

@@ -69,4 +69,13 @@ e.g
 But [other coverage tools](https://vladfilippov.com/blog/rust-code-coverage-tools/) might work as well
 
 
+## Adding test measures
 
+Optionally SonarQube can also display tests measures.
+
+This Community Rust plugin doesn't run your tests or generate tests reports for you. That has to be done before analysis and provided in the form of reports.
+
+Currently, only `junit report` formats are supported :
+
+Insert a parameter `sonar.rust.test.reportPath` into you `sonar-project.properties` file. As an example, one of such tool 
+for Rust than converts `cargo test` report to `junit report` is [cargo2junit](https://crates.io/crates/cargo2junit).

README.md

@@ -20,6 +20,11 @@ It leverages [Clippy lints](https://rust-lang.github.io/rust-clippy/master/) to
 * Import it into SonarQube
 
 set analysis parameter `community.rust.clippy.reportPaths=<CLIPPY REPORT FILE>`
+
+* Optionally import tests measures (`junit` report)
+
+use `sonar.rust.test.reportPath`
+
 * Optionally import coverage measures 
 
 use either 

community-rust-plugin/src/main/java/org/elegoff/plugins/communityrust/CommunityRustPlugin.java

@@ -23,6 +23,7 @@
 import org.elegoff.plugins.communityrust.coverage.cobertura.CoberturaSensor;
 import org.elegoff.plugins.communityrust.coverage.lcov.LCOVSensor;
 import org.elegoff.plugins.communityrust.rules.RustRulesDefinition;
+import org.elegoff.plugins.communityrust.xunit.XUnitSensor;
 import org.sonar.api.Plugin;
 import org.sonar.api.config.PropertyDefinition;
 import org.elegoff.plugins.communityrust.clippy.ClippySensor;
@@ -92,5 +93,17 @@ public void define(Context context) {
         );
 
 
+        context.addExtensions(
+                PropertyDefinition.builder(XUnitSensor.REPORT_PATH_KEY)
+                        .name("Path to xunit report(s)")
+                        .description("Path to the report of test execution, relative to project's root. Ant patterns are accepted. The reports have to conform to the junitreport XML format.")
+                        .category("Rust")
+                        .subCategory("Test and Coverage")
+                        .onQualifiers(Qualifiers.PROJECT)
+                        .defaultValue(XUnitSensor.DEFAULT_REPORT_PATH)
+                        .build(),
+                XUnitSensor.class);
+
+
     }
 }

community-rust-plugin/src/main/java/org/elegoff/plugins/communityrust/xunit/StaxParser.java

@@ -0,0 +1,88 @@
+/**
+ * Community Rust Plugin
+ * Copyright (C) 2021 Eric Le Goff
+ * mailto:community-rust AT pm DOT me
+ * http://github.com/elegoff/sonar-rust
+ *
+ * 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, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.elegoff.plugins.communityrust.xunit;
+
+import org.apache.commons.lang.StringUtils;
+import org.codehaus.staxmate.SMInputFactory;
+import org.codehaus.staxmate.in.SMHierarchicCursor;
+
+import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLResolver;
+import javax.xml.stream.XMLStreamException;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+public class StaxParser {
+
+  private SMInputFactory inf;
+
+  private XmlStreamHandler streamHandler;
+
+  public StaxParser(XmlStreamHandler streamHandler) {
+    this.streamHandler = streamHandler;
+    XMLInputFactory xmlFactory = XMLInputFactory.newInstance();
+
+    inf = new SMInputFactory(xmlFactory);
+  }
+
+  public void parse(File xmlFile) throws XMLStreamException {
+    try (FileInputStream input = new FileInputStream(xmlFile)) {
+      parse(input);
+    } catch (IOException e) {
+      throw new XMLStreamException(e);
+    }
+  }
+
+  public void parse(InputStream xmlInput) throws XMLStreamException {
+    SMHierarchicCursor rootCursor = inf.rootElementCursor(xmlInput);
+    try {
+      streamHandler.stream(rootCursor);
+    } finally {
+      rootCursor.getStreamReader().closeCompletely();
+    }
+  }
+
+  private static class UndeclaredEntitiesXMLResolver implements XMLResolver {
+
+    @Override
+    public Object resolveEntity(String arg0, String arg1, String fileName, String undeclaredEntity) throws XMLStreamException {
+      String undeclared = undeclaredEntity;
+      // avoid problems with XML docs containing undeclared entities.. return the entity under its raw form if not a Unicode expression
+      if (StringUtils.startsWithIgnoreCase(undeclaredEntity, "u") && undeclaredEntity.length() == 5) {
+        int unicodeCharHexValue = Integer.parseInt(undeclaredEntity.substring(1), 16);
+        if (Character.isDefined(unicodeCharHexValue)) {
+          undeclared = new String(new char[] {(char) unicodeCharHexValue});
+        }
+      }
+      return undeclared;
+    }
+  }
+
+  /**
+   * Simple interface for handling XML stream to parse.
+   */
+  @FunctionalInterface
+  public interface XmlStreamHandler {
+    void stream(SMHierarchicCursor rootCursor) throws XMLStreamException;
+  }
+
+}

community-rust-plugin/src/main/java/org/elegoff/plugins/communityrust/xunit/TestCase.java

@@ -0,0 +1,88 @@
+/**
+ * Community Rust Plugin
+ * Copyright (C) 2021 Eric Le Goff
+ * mailto:community-rust AT pm DOT me
+ * http://github.com/elegoff/sonar-rust
+ *
+ * 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, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.elegoff.plugins.communityrust.xunit;
+
+import javax.annotation.Nullable;
+
+/**
+ * Represents a unit test case. Has a couple of data items like name, status, time etc. associated. Reports testcase details in
+ * sonar-conform XML
+ */
+public class TestCase {
+    private final String name;
+    private final TestCaseStatus status;
+    private final String stackTrace;
+    private final String errorMessage;
+    private final int time;
+    private final String file;
+    private final String testClassname;
+
+    /**
+     * Constructs a testcase instance out of following parameters
+     * @param name  The name of this testcase
+     * @param status The execution status of the testcase
+     * @param stackTrace The stack trace occurred while executing of this testcase; pass "" if the testcase passed/skipped.
+     * @param errorMessage The error message associated with this testcase of the execution was erroneous; pass "" if not.
+     * @param time The execution time in milliseconds
+     * @param file The optional file to which this test case applies.
+     * @param testClassname The classname of the test.
+     */
+    public TestCase(String name, TestCaseStatus status, String stackTrace, String errorMessage, int time, @Nullable String file, @Nullable  String testClassname) {
+        this.name = name;
+        this.status = status;
+        this.stackTrace = stackTrace;
+        this.errorMessage = errorMessage;
+        this.time = time;
+        this.file = file;
+        this.testClassname = testClassname;
+    }
+    /**
+     * Returns true if this testcase is an error, false otherwise
+     */
+    public boolean isError(){
+        return TestCaseStatus.ERROR.equals(status);
+    }
+    /**
+     * Returns true if this testcase is a failure, false otherwise
+     */
+    public boolean isFailure(){
+        return TestCaseStatus.FAILURE.equals(status);
+    }
+
+    /**
+     * Returns true if this testcase has been skipped, failure, false otherwise
+     */
+    public boolean isSkipped() {
+        return TestCaseStatus.SKIPPED.equals(status);
+    }
+
+    public int getTime() {
+        return time;
+    }
+
+    public String getFile() {
+        return file;
+    }
+
+    public String getTestClassname() {
+        return testClassname;
+    }
+}

community-rust-plugin/src/main/java/org/elegoff/plugins/communityrust/xunit/TestCaseStatus.java

@@ -0,0 +1,43 @@
+/**
+ * Community Rust Plugin
+ * Copyright (C) 2021 Eric Le Goff
+ * mailto:community-rust AT pm DOT me
+ * http://github.com/elegoff/sonar-rust
+ *
+ * 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, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.elegoff.plugins.communityrust.xunit;
+
+public enum TestCaseStatus {
+    OK("ok"),
+    ERROR("error"),
+    FAILURE("failure"),
+    SKIPPED("skipped");
+    private final String text;
+
+    TestCaseStatus(String name) {
+        this.text = name;
+    }
+
+    @Override
+    public String toString() {
+        return text;
+    }
+
+    public static TestCaseStatus getFromIgnoreCaseString(String value) {
+        return TestCaseStatus.valueOf(value.toUpperCase());
+    }
+}
+

community-rust-plugin/src/main/java/org/elegoff/plugins/communityrust/xunit/TestResult.java

@@ -0,0 +1,66 @@
+/**
+ * Community Rust Plugin
+ * Copyright (C) 2021 Eric Le Goff
+ * mailto:community-rust AT pm DOT me
+ * http://github.com/elegoff/sonar-rust
+ *
+ * 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, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.elegoff.plugins.communityrust.xunit;
+
+public class TestResult {
+    private int errors = 0;
+    private int skipped = 0;
+    private int tests = 0;
+    private int time = 0;
+    private int failures = 0;
+
+
+    public int getErrors() {
+        return errors;
+    }
+
+    public int getSkipped() {
+        return skipped;
+    }
+
+    public int getTests() {
+        return tests;
+    }
+
+    public int getExecutedTests() {
+        return tests - skipped;
+    }
+
+    public int getTime() {
+        return time;
+    }
+
+    public int getFailures() {
+        return failures;
+    }
+
+    public void addTestCase(TestCase tc) {
+        if (tc.isSkipped()) {
+            skipped++;
+        } else if (tc.isFailure()) {
+            failures++;
+        } else if (tc.isError()) {
+            errors++;
+        }
+        tests++;
+        time += tc.getTime();
+    }
+}