Better parsing of result files to avoid errors + UT

Author: louisjdmartin

src/main/java/fr/cnes/sonar/plugins/icode/converter/AnalysisConverter.java

@@ -0,0 +1,48 @@
+package fr.cnes.sonar.plugins.icode.converter;
+
+import com.thoughtworks.xstream.converters.ConverterLookup;
+import com.thoughtworks.xstream.converters.UnmarshallingContext;
+import com.thoughtworks.xstream.converters.extended.ToAttributedValueConverter;
+import com.thoughtworks.xstream.converters.reflection.ReflectionProvider;
+import com.thoughtworks.xstream.io.HierarchicalStreamReader;
+import com.thoughtworks.xstream.mapper.Mapper;
+import fr.cnes.sonar.plugins.icode.model.AnalysisRule;
+import fr.cnes.sonar.plugins.icode.model.Result;
+
+public class AnalysisConverter extends ToAttributedValueConverter {
+
+    public AnalysisConverter(Class type, Mapper mapper, ReflectionProvider reflectionProvider, ConverterLookup lookup) {
+        super(type, mapper, reflectionProvider, lookup);
+    }
+
+    public AnalysisConverter(Class type, Mapper mapper, ReflectionProvider reflectionProvider, ConverterLookup lookup, String valueFieldName) {
+        super(type, mapper, reflectionProvider, lookup, valueFieldName);
+    }
+
+    public AnalysisConverter(Class type, Mapper mapper, ReflectionProvider reflectionProvider, ConverterLookup lookup, String valueFieldName, Class valueDefinedIn) {
+        super(type, mapper, reflectionProvider, lookup, valueFieldName, valueDefinedIn);
+    }
+
+    @Override
+    public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext unmarshallingContext) {
+        Object r = super.unmarshal(reader, unmarshallingContext);
+        if (r.getClass() == AnalysisRule.class) {
+            Result result = new Result();
+            reader.moveDown();
+            result.setFileName(reader.getAttribute("fileName"));
+            result.setResultLine(reader.getAttribute("resultLine"));
+            result.setResultTypePlace(reader.getAttribute("resultTypePlace"));
+            result.setResultValue(reader.getAttribute("resultValue"));
+            if(reader.hasMoreChildren()) {
+                reader.moveDown();
+                result.setResultMessage(reader.getValue());
+                reader.moveUp();
+            }
+            reader.moveUp();
+            ((AnalysisRule) r).setResult(result);
+        }
+        else r = super.unmarshal(reader, unmarshallingContext);
+
+        return r;
+    }
+}

src/main/java/fr/cnes/sonar/plugins/icode/model/AnalysisFile.java

@@ -17,13 +17,17 @@
 package fr.cnes.sonar.plugins.icode.model;
 
 
+import com.thoughtworks.xstream.annotations.XStreamConverter;
+import com.thoughtworks.xstream.converters.extended.ToAttributedValueConverter;
+
 /**
  * Class used to unmarshal i-Code xml file.
  *
  * It contains an analyzed file.
  *
  * @author lequal
  */
+@XStreamConverter(value = ToAttributedValueConverter.class)
 public class AnalysisFile {
     private String language;
     private String fileName;

src/main/java/fr/cnes/sonar/plugins/icode/model/AnalysisInformations.java

@@ -17,13 +17,17 @@
 package fr.cnes.sonar.plugins.icode.model;
 
 
+import com.thoughtworks.xstream.annotations.XStreamConverter;
+import com.thoughtworks.xstream.converters.extended.ToAttributedValueConverter;
+
 /**
  * Class used to unmarshal i-Code xml file.
  *
  * It contains meta data about the i-Code analysis.
  *
  * @author lequal
  */
+@XStreamConverter(ToAttributedValueConverter.class)
 public class AnalysisInformations {
     private String author;
 

src/main/java/fr/cnes/sonar/plugins/icode/model/AnalysisProject.java

@@ -16,6 +16,12 @@
  */
 package fr.cnes.sonar.plugins.icode.model;
 
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import com.thoughtworks.xstream.annotations.XStreamConverter;
+import com.thoughtworks.xstream.annotations.XStreamImplicit;
+import com.thoughtworks.xstream.annotations.XStreamInclude;
+import com.thoughtworks.xstream.converters.extended.ToAttributedValueConverter;
+
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -27,10 +33,14 @@
  *
  * @author lequal
  */
+@XStreamAlias("analysisProject")
+@XStreamInclude({AnalysisFile.class, AnalysisRule.class, AnalysisInformations.class})
 public class AnalysisProject {
     private AnalysisInformations analysisInformations;
-    private AnalysisFile[] analysisFile;
-    private AnalysisRule[] analysisRule;
+    @XStreamImplicit(itemFieldName = "analysisFile")
+    private List<AnalysisFile> analysisFile;
+    @XStreamImplicit(itemFieldName = "analysisRule")
+    private List<AnalysisRule> analysisRule;
 
     /**
      * Getter for accessing analysis rules (issues).
@@ -39,8 +49,8 @@ public class AnalysisProject {
     public List<AnalysisRule> getAnalysisRules() {
         // Retrieve issues (called rules)
         List<AnalysisRule> rules;
-        if(getAnalysisRule() !=null) {
-            rules = Arrays.asList(getAnalysisRule());
+        if(analysisRule !=null) {
+            rules = this.analysisRule;
         } else {
             rules = new ArrayList<>();
         }
@@ -54,8 +64,8 @@ public List<AnalysisRule> getAnalysisRules() {
     public List<AnalysisFile> getAnalysisFiles() {
         // Retrieve files
         List<AnalysisFile> files;
-        if(getAnalysisFile() !=null) {
-            files = Arrays.asList(getAnalysisFile());
+        if(analysisFile !=null) {
+            files = this.analysisFile;
         } else {
             files = new ArrayList<>();
         }
@@ -71,19 +81,11 @@ public void setAnalysisInformations(AnalysisInformations analysisInformations) {
         this.analysisInformations = analysisInformations;
     }
 
-    public AnalysisFile[] getAnalysisFile() {
-        return analysisFile;
-    }
-
     public void setAnalysisFile(AnalysisFile[] analysisFile) {
-        this.analysisFile = analysisFile;
-    }
-
-    public AnalysisRule[] getAnalysisRule() {
-        return analysisRule;
+        this.analysisFile = Arrays.asList(analysisFile);
     }
 
     public void setAnalysisRule(AnalysisRule[] analysisRule) {
-        this.analysisRule = analysisRule;
+        this.analysisRule = Arrays.asList(analysisRule);
     }
 }

src/main/java/fr/cnes/sonar/plugins/icode/model/AnalysisRule.java

@@ -17,15 +17,24 @@
 package fr.cnes.sonar.plugins.icode.model;
 
 
+import com.thoughtworks.xstream.annotations.XStreamConverter;
+import com.thoughtworks.xstream.annotations.XStreamInclude;
+import fr.cnes.sonar.plugins.icode.converter.AnalysisConverter;
+
 /**
  * Class used to unmarshal i-Code xml file.
  *
  * It contains an issue and a violated rule.
  *
  * @author lequal
  */
+@XStreamInclude(Result.class)
+@XStreamConverter(value = AnalysisConverter.class, strings = {"result"})
 public class AnalysisRule {
 
+    private String analysisRuleId;
+    private Result result;
+
     public String getAnalysisRuleId() {
         return analysisRuleId;
     }
@@ -34,7 +43,6 @@ public Result getResult() {
         return result;
     }
 
-    private String analysisRuleId;
 
     public void setAnalysisRuleId(String analysisRuleId) {
         this.analysisRuleId = analysisRuleId;
@@ -44,6 +52,7 @@ public void setResult(Result result) {
         this.result = result;
     }
 
-    private Result result;
 
 }
+
+

src/main/java/fr/cnes/sonar/plugins/icode/model/Result.java

@@ -16,13 +16,17 @@
  */
 package fr.cnes.sonar.plugins.icode.model;
 
+import com.thoughtworks.xstream.annotations.XStreamConverter;
+import com.thoughtworks.xstream.converters.extended.ToAttributedValueConverter;
+
 /**
  * Class used to unmarshal i-Code xml file.
  *
  * It contains an issue or a metric.
  *
  * @author lequal
  */
+@XStreamConverter(value = ToAttributedValueConverter.class)
 public class Result {
 
     private String fileName;

src/test/java/fr/cnes/sonar/plugins/icode/ParseResultTest.java

@@ -0,0 +1,41 @@
+package fr.cnes.sonar.plugins.icode;
+
+import fr.cnes.sonar.plugins.icode.model.AnalysisProject;
+import fr.cnes.sonar.plugins.icode.model.XmlHandler;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.io.InputStream;
+
+public class ParseResultTest {
+    @Test
+    public void parseIcodeOutputTest() {
+        InputStream icodeOutput = getClass().getResourceAsStream("/result.res");
+        AnalysisProject analysisProject = (AnalysisProject) XmlHandler.unmarshal(icodeOutput, AnalysisProject.class);
+
+
+        Assert.assertNotNull(analysisProject);
+        Assert.assertNotNull(analysisProject.getAnalysisRules().get(0));
+
+        // Try to get Analysis informations
+        Assert.assertNotNull(analysisProject.getAnalysisInformations().getAuthor());
+
+        // Try to get files informations
+        Assert.assertEquals(7, analysisProject.getAnalysisFiles().size());
+        Assert.assertNotNull(analysisProject.getAnalysisFiles().get(0).getFileName());
+        Assert.assertNotNull(analysisProject.getAnalysisFiles().get(0).getLanguage());
+
+        // Try to get rules analyzed
+        Assert.assertEquals(574, analysisProject.getAnalysisRules().size());
+        Assert.assertNotNull(analysisProject.getAnalysisRules().get(0).getResult());
+        Assert.assertNotNull(analysisProject.getAnalysisRules().get(0).getAnalysisRuleId());
+
+        // Try to get results
+        Assert.assertNotNull(analysisProject.getAnalysisRules().get(0).getResult().getResultTypePlace());
+        Assert.assertNotNull(analysisProject.getAnalysisRules().get(58).getResult().getResultMessage());
+        Assert.assertNull(analysisProject.getAnalysisRules().get(0).getResult().getResultMessage());
+        Assert.assertNotNull(analysisProject.getAnalysisRules().get(0).getResult().getFileName());
+        Assert.assertNotNull(analysisProject.getAnalysisRules().get(0).getResult().getResultValue());
+        Assert.assertNotNull(analysisProject.getAnalysisRules().get(0).getResult().getResultLine());
+    }
+}