#55 i-Code exceptions are converted to issues

begarco · begarco · commit 0e811741635e · 2020-03-06T00:47:04.000+01:00
diff --git a/README.md b/README.md
@@ -21,15 +21,16 @@ You can get i-Code CNES on GitHub: [lequal/i-CodeCNES](https://github.com/lequal
 - Run an analysis with *sonar-scanner*, *maven*, *gradle*, *msbuild*, etc.
 
 #### Run i-Code automatically
-This SonarQube plugin is now able to run automaticcaly an embedded version of i-Code. If you do not specify properties to run i-Code [manually](#run-i-Code-manually) or [from a specific version](#Run-a-specific-i-Code-version-through-sonaricode-plugin), embedded version of i-Code will be executed.
+This SonarQube plugin is now able to run automatically an embedded version of i-Code. If you do not specify properties to run i-Code [manually](#run-i-Code-manually) or [from a specific version](#Run-a-specific-i-Code-version-through-sonaricode-plugin), embedded version of i-Code will be executed.
 
 Here is the compatibility matrix of the plugin:
 
 | sonaricode version | embedded i-Code version | supported SonarQube version |
 |:------------------:|:-----------------------:|:---------------------------:|
 |       < 2.0.0      |           none          |          6.7.x              |
-|        2.0.0       |          4.0.0          |        7.9 -> 8.1           |
-|        2.0.1       |          4.0.0          |        7.9 -> 8.1           |
+|        2.0.0       |          4.0.0          |        7.9 -> 8.2           |
+|        2.0.1       |          4.0.0          |        7.9 -> 8.2           |
+|        2.0.2       |          4.0.0          |        7.9 -> 8.2           |
 
 #### Run i-Code manually
 If you need help to run i-Code please refer to the [official user manual](https://github.com/lequal/i-CodeCNES/blob/master/documentation/i-Code%20CNES%20-%20User%20Manual.pdf) or [i-Code issue tracker](https://github.com/lequal/i-CodeCNES/issues).
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
     <groupId>fr.cnes.sonar.plugins</groupId>
     <artifactId>sonar-icode-cnes-plugin</artifactId>
     <packaging>sonar-plugin</packaging>
-    <version>2.0.1</version>
+    <version>2.0.2</version>
 
     <name>Sonar i-Code CNES plugin</name>
 
@@ -67,6 +67,7 @@
         <sonar.pluginKey>icode</sonar.pluginKey>
         <sonar.pluginClass>fr.cnes.sonar.plugins.icode.ICodePlugin</sonar.pluginClass>
         <sonar.pluginUrl>https://github.com/lequal/sonar-icode-cnes-plugin</sonar.pluginUrl>
+        <sonar.pluginSourcesUrl>https://github.com/lequal/sonar-icode-cnes-plugin</sonar.pluginSourcesUrl>
         <sonar.pluginOrganizationName>CNES</sonar.pluginOrganizationName>
         <sonar.sources>src/main/java</sonar.sources>
         <sonar.test>src/test/java</sonar.test>
diff --git a/src/main/java/fr/cnes/sonar/plugins/icode/check/ICodeSensor.java b/src/main/java/fr/cnes/sonar/plugins/icode/check/ICodeSensor.java
@@ -16,9 +16,15 @@
  */
 package fr.cnes.sonar.plugins.icode.check;
 
-import fr.cnes.icode.Analyzer;
+import com.google.common.collect.Lists;
+import com.google.common.collect.Maps;
+import fr.cnes.icode.data.AbstractChecker;
 import fr.cnes.icode.data.CheckResult;
 import fr.cnes.icode.exception.JFlexException;
+import fr.cnes.icode.logger.ICodeLogger;
+import fr.cnes.icode.services.checkers.CheckerContainer;
+import fr.cnes.icode.services.checkers.CheckerService;
+import fr.cnes.icode.services.languages.ILanguage;
 import fr.cnes.icode.services.languages.LanguageService;
 import fr.cnes.sonar.plugins.icode.exceptions.ICodeException;
 import fr.cnes.sonar.plugins.icode.languages.Fortran77Language;
@@ -170,42 +176,140 @@ protected void executeExternalResultsImport(final SensorContext sensorContext) {
      */
     private void executeEmbeddedICode(final SensorContext sensorContext) {
         // Initialisation of tools for analysis.
-        final Analyzer analyzer = new Analyzer();
         final FileSystem fileSystem = sensorContext.fileSystem();
         final FilePredicates predicates = fileSystem.predicates();
         final ActiveRules activeRules = sensorContext.activeRules();
         final Iterable<InputFile> inputFiles = fileSystem.inputFiles(predicates.hasType(InputFile.Type.MAIN));
         final HashSet<File> files = new HashSet<>();
         final HashMap<String,InputFile> filesMap = new HashMap<>();
 
-        try {
-            // Gather all files in a Set.
-            for(final InputFile inputFile : inputFiles) {
-                files.add(inputFile.file());
-                filesMap.put(inputFile.file().getPath(), inputFile);
+        // Gather all files in a Set.
+        for(final InputFile inputFile : inputFiles) {
+            files.add(inputFile.file());
+            filesMap.put(inputFile.file().getPath(), inputFile);
+        }
+
+        // Run all checkers on all files.
+        final List<CheckResult> results = sonarCheck(files, LanguageService.getLanguagesIds(), null);
+
+        // Add each issue to SonarQube.
+        for(final CheckResult result : results) {
+            if(isRuleActive(activeRules, result.getName())) { // manage active rules
+                saveIssue(sensorContext, result);
+            } else if (ICodeMetricsProcessor.isMetric(result.getName())) { // manage trivial measures
+                ICodeMetricsProcessor.saveMeasure(sensorContext, result);
+            } else { // log ignored data
+                LOGGER.info(String.format(
+                        "An issue for rule '%s' was detected by i-Code but this rule is deactivated in current analysis.",
+                        result.getName()));
             }
+        }
+
+        ICodeMetricsProcessor.saveExtraMeasures(sensorContext, filesMap, results);
+
+    }
 
-            // Run all checkers on all files.
-            final List<CheckResult> results = analyzer.stableCheck(files, LanguageService.getLanguagesIds(), null);
-
-            // Add each issue to SonarQube.
-            for(final CheckResult result : results) {
-                if(isRuleActive(activeRules, result.getName())) { // manage active rules
-                    saveIssue(sensorContext, result);
-                } else if (ICodeMetricsProcessor.isMetric(result.getName())) { // manage trivial measures
-                    ICodeMetricsProcessor.saveMeasure(sensorContext, result);
-                } else { // log ignored data
-                    LOGGER.info(String.format(
-                            "An issue for rule '%s' was detected by i-Code but this rule is deactivated in current analysis.",
-                            result.getName()));
+    /**
+     * <h1>{@link #sonarCheck(Set, List, List)}</h1>
+     * <p>
+     * This method apply all rules of the different contributions set in
+     * parameter except the one excluded. File in parameters are being analyzed
+     * by each contribution able to handle it or none if it isn't.
+     * </p>
+     * <p>
+     * <strong>Important :</strong> Default configurations to run analysis are
+     * available when setting parameters.
+     *
+     * @param pInputFiles
+     *            to analyze
+     * @param pLanguageIds
+     *            to include in the analysis. <strong>Set null</strong> to run
+     *            an analysis including all contributions.
+     * @param pExcludedCheckIds
+     *            rules identifier to exclude from the analysis. <strong>Set
+     *            null</strong> run analysis with every rules.
+     * @return list of {@link CheckResult} found by the analysis.
+     */
+    public List<CheckResult> sonarCheck(final Set<File> pInputFiles, final List<String> pLanguageIds,
+                                         final List<String> pExcludedCheckIds) {
+        final String methodName = "check";
+        ICodeLogger.entering(this.getClass().getName(), methodName);
+
+        List<String> languageIds = pLanguageIds;
+        if (languageIds == null) {
+            languageIds = LanguageService.getLanguagesIds();
+        }
+        List<String> excludedCheckIds = pExcludedCheckIds;
+        if (pExcludedCheckIds == null) {
+            excludedCheckIds = new ArrayList<>();
+        }
+        final List<CheckResult> analysisResultCheckResult = new ArrayList<>();
+
+        // Contains checkers by language.
+        final Map<String,List<CheckerContainer>> checkers = Maps.newHashMap();
+        // Contains files by language.
+        final Map<String, List<File>> inputs = Maps.newLinkedHashMap();
+        // Get languages to check during the analysis.
+        final List<ILanguage> languages = LanguageService.getLanguages(languageIds);
+        // Get checkers to run during analysis.
+        for(final ILanguage language : languages) {
+            checkers.put(language.getId(), CheckerService.getCheckers(language.getId(), excludedCheckIds));
+        }
+
+        // Sort files by language.
+        for (final File file : pInputFiles) {
+            final String languageId = LanguageService.getLanguageId(getFileExtension(file.getAbsolutePath()));
+            final List<File> tempList = inputs.getOrDefault(languageId, Lists.newArrayList());
+            tempList.add(file);
+            inputs.put(languageId, tempList);
+        }
+        // For each selected language, run selected checkers on selected files.
+        for (final ILanguage language : languages) {
+            for (final File input : inputs.getOrDefault(language.getId(), Lists.newArrayList())) {
+                for (final CheckerContainer checker : checkers.get(language.getId())) {
+                    try {
+                        AbstractChecker check = checker.getChecker();
+                        check.setInputFile(input);
+                        analysisResultCheckResult.addAll(check.run());
+                    } catch (final Exception e) {
+                        // Set the error message.
+                        final String errorMessage = String.format("Internal i-Code error: exception [%s] thrown while checking [%s] on file [%s] - %s",
+                                e.getClass().getSimpleName(), checker.getName(), input.getPath(), e.getMessage());
+                        // Log the error in i-Code and SonarQube logger.
+                        LOGGER.error(errorMessage, e);
+                        // Create an issue to be displayed in SonarQube.
+                        final CheckResult exception = new CheckResult("Parsing Error", "Parsing Error", input);
+                        exception.setLangageId(language.getId());
+                        exception.setLocation("unknown");
+                        exception.setLine(0);
+                        exception.setMessage(errorMessage);
+                        // Add the exception as a Parsing Error result.
+                        analysisResultCheckResult.add(exception);
+                    }
                 }
             }
+        }
+
+        return analysisResultCheckResult;
+    }
+
+    /**
+     * Return the file extension without the final point '.'.
+     *
+     * @param pFileName
+     *            to retrieve the extension
+     * @return The extension name of the file
+     */
+    private String getFileExtension(final String pFileName) {
+        String extension = null;
 
-            ICodeMetricsProcessor.saveExtraMeasures(sensorContext, filesMap, results);
+        final int i = pFileName.lastIndexOf('.');
+        final int p = Math.max(pFileName.lastIndexOf('/'), pFileName.lastIndexOf('\\'));
 
-        } catch (final JFlexException e) {
-            LOGGER.warn(e.getMessage(), e);
+        if (i > p) {
+            extension = pFileName.substring(i + 1);
         }
+        return extension;
     }
 
     /**
diff --git a/src/main/resources/rules/icode-f77-rules.xml b/src/main/resources/rules/icode-f77-rules.xml
@@ -4,7 +4,15 @@
 		<key>Parsing Error</key>
 		<name>Parsing Error</name>
 		<internalKey>*</internalKey>
-		<description>An error occurs when parsing a file.</description>
+		<description><![CDATA[
+<p>
+An error occurred when parsing a file. This is an internal error of i-Code CNES analysis.
+</p>
+<p>
+Please, report this error to i-Code CNES maintainers to improve the tool: <a href="https://github.com/lequal/i-CodeCNES/issues">https://github.com/lequal/i-CodeCNES/issues</a>
+</p>
+        ]]>
+		</description>
 		<severity>BLOCKER</severity>
 		<cardinality>SINGLE</cardinality>
 		<status>READY</status>
diff --git a/src/main/resources/rules/icode-f90-rules.xml b/src/main/resources/rules/icode-f90-rules.xml
@@ -4,7 +4,15 @@
 		<key>Parsing Error</key>
 		<name>Parsing Error</name>
 		<internalKey>*</internalKey>
-		<description>An error occurs when parsing a file.</description>
+		<description><![CDATA[
+<p>
+An error occurred when parsing a file. This is an internal error of i-Code CNES analysis.
+</p>
+<p>
+Please, report this error to i-Code CNES maintainers to improve the tool: <a href="https://github.com/lequal/i-CodeCNES/issues">https://github.com/lequal/i-CodeCNES/issues</a>
+</p>
+        ]]>
+		</description>
 		<severity>BLOCKER</severity>
 		<cardinality>SINGLE</cardinality>
 		<status>READY</status>
diff --git a/src/main/resources/rules/icode-shell-rules.xml b/src/main/resources/rules/icode-shell-rules.xml
@@ -4,7 +4,15 @@
 		<key>Parsing Error</key>
 		<name>Parsing Error</name>
 		<internalKey>*</internalKey>
-		<description>An error occurs when parsing a file.</description>
+		<description><![CDATA[
+<p>
+An error occurred when parsing a file. This is an internal error of i-Code CNES analysis.
+</p>
+<p>
+Please, report this error to i-Code CNES maintainers to improve the tool: <a href="https://github.com/lequal/i-CodeCNES/issues">https://github.com/lequal/i-CodeCNES/issues</a>
+</p>
+        ]]>
+		</description>
 		<severity>BLOCKER</severity>
 		<cardinality>SINGLE</cardinality>
 		<status>READY</status>
