Issue #331: add template backward compatibility

Author: gaurabdg

config/suppressions.xml

@@ -32,5 +32,5 @@
     <suppress checks="MagicNumber" files=".*[\\/]src[\\/]test[\\/]"/>
     <suppress checks="AnonInnerLength" files=".*[\\/]src[\\/]test[\\/]"/>
     <suppress checks="ClassDataAbstractionCoupling" files=".*[\\/]src[\\/]test[\\/]"/>
-    <suppress checks="TrailingComment" files=".*[\\/]CheckstyleMetadata\.java"/>
+    <suppress checks="TrailingComment" files=".*[\\/]Checkstyle(RulesDefinition|Metadata)\.java"/>
 </suppressions>

pom.xml

@@ -576,6 +576,7 @@
                     <exclude>org.sonar.plugins.checkstyle.CheckstyleSeverityUtils</exclude>
                     <exclude>org.sonar.plugins.checkstyle.CheckstyleConfiguration</exclude>
                     <exclude>org.sonar.plugins.checkstyle.CheckstyleProfileImporter</exclude>
+                    <exclude>org.sonar.plugins.checkstyle.CheckstyleRulesDefinition</exclude>
                     <exclude>org.sonar.plugins.checkstyle.metadata.CheckstyleMetadata</exclude>
                     <exclude>org.sonar.plugins.checkstyle.metadata.CheckUtil</exclude>
                   </excludes>
@@ -700,6 +701,24 @@
                     </limit>
                   </limits>
                 </rule>
+                <rule>
+                  <element>CLASS</element>
+                  <includes>
+                    <include>org.sonar.plugins.checkstyle.CheckstyleRulesDefinition</include>
+                  </includes>
+                  <limits>
+                    <limit>
+                      <counter>LINE</counter>
+                      <value>COVEREDRATIO</value>
+                      <minimum>0.90</minimum>
+                    </limit>
+                    <limit>
+                      <counter>BRANCH</counter>
+                      <value>COVEREDRATIO</value>
+                      <minimum>0.5</minimum>
+                    </limit>
+                  </limits>
+                </rule>
                 <rule>
                   <element>CLASS</element>
                   <includes>
@@ -714,7 +733,7 @@
                     <limit>
                       <counter>BRANCH</counter>
                       <value>COVEREDRATIO</value>
-                      <minimum>0.92</minimum>
+                      <minimum>0.90</minimum>
                     </limit>
                   </limits>
                 </rule>

src/main/java/org/sonar/plugins/checkstyle/CheckstyleRulesDefinition.java

@@ -19,10 +19,20 @@
 
 package org.sonar.plugins.checkstyle;
 
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Objects;
+import java.util.Properties;
+
 import org.sonar.api.ExtensionPoint;
 import org.sonar.api.batch.ScannerSide;
 import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.api.server.rule.RulesDefinitionXmlLoader;
 import org.sonar.plugins.checkstyle.metadata.CheckstyleMetadata;
+import org.sonar.squidbridge.rules.ExternalDescriptionLoader;
+import org.sonar.squidbridge.rules.SqaleXmlLoader;
+
+import com.google.common.annotations.VisibleForTesting;
 
 @ExtensionPoint
 @ScannerSide
@@ -33,10 +43,65 @@ public void define(Context context) {
         final NewRepository repository = context.createRepository(
                 CheckstyleConstants.REPOSITORY_KEY, "java").setName(
                 CheckstyleConstants.REPOSITORY_NAME);
+        try {
+            extractRulesData(repository, "/org/sonar/plugins/checkstyle/rules.xml",
+                    "/org/sonar/l10n/checkstyle/rules/checkstyle");
+        }
+        catch (IOException ex) {
+            throw new IllegalStateException("Exception during extractRulesData", ex);
+        }
 
         final CheckstyleMetadata checkstyleMetadata = new CheckstyleMetadata(repository);
         checkstyleMetadata.createRulesWithMetadata();
 
         repository.done();
     }
+
+    @VisibleForTesting
+    static void extractRulesData(NewRepository repository, String xmlRulesFilePath,
+                                 String htmlDescriptionFolder) throws IOException {
+        final RulesDefinitionXmlLoader ruleLoader = new RulesDefinitionXmlLoader();
+        try (InputStream resource = CheckstyleRulesDefinition.class
+                .getResourceAsStream(xmlRulesFilePath)) {
+            ruleLoader.load(repository, resource, "UTF-8");
+        }
+        ExternalDescriptionLoader.loadHtmlDescriptions(repository, // NOSONAR
+                htmlDescriptionFolder);
+        try (InputStream resource = CheckstyleRulesDefinition.class
+                .getResourceAsStream("/org/sonar/l10n/checkstyle.properties")) {
+            loadNames(repository, resource);
+        }
+        SqaleXmlLoader.load(repository, "/com/sonar/sqale/checkstyle-model.xml"); // NOSONAR
+    }
+
+    private static void loadNames(NewRepository repository, InputStream stream) {
+        // code taken from:
+        // https://github.com/SonarSource/sslr-squid-bridge/blob/2.5.2/
+        // src/main/java/org/sonar/squidbridge/rules/PropertyFileLoader.java#L46
+        final Properties properties = new Properties();
+        try {
+            properties.load(stream);
+        }
+        catch (IOException ex) {
+            throw new IllegalArgumentException("Could not read names from properties", ex);
+        }
+
+        if (Objects.nonNull(repository.rules())) {
+            repository.rules().forEach(rule -> {
+                final String baseKey = "rule." + repository.key() + "." + rule.key();
+                final String nameKey = baseKey + ".name";
+                final String ruleName = properties.getProperty(nameKey);
+                if (Objects.nonNull(ruleName)) {
+                    rule.setName(ruleName);
+                }
+                rule.params().forEach(param -> {
+                    final String paramDescriptionKey = baseKey + ".param." + param.key();
+                    final String paramDescription = properties.getProperty(paramDescriptionKey);
+                    if (Objects.nonNull(paramDescription)) {
+                        param.setDescription(paramDescription);
+                    }
+                });
+            });
+        }
+    }
 }

src/main/java/org/sonar/plugins/checkstyle/metadata/CheckstyleMetadata.java

@@ -100,9 +100,10 @@ public void createRulesWithMetadata() {
                     final SonarRulePropertyLoader.AdditionalRuleProperties additionalDetails =
                             additionalRuleData.get(check.getKey());
                     final RulesDefinition.NewRule rule =
-                            repository.createRule(moduleDetails.getFullQualifiedName());
+                            repository.createRule(moduleDetails.getFullQualifiedName()
+                                    + "template");
                     rule.setHtmlDescription(moduleDetails.getDescription())
-                            .setName(getFullCheckName(moduleDetails.getName()))
+                            .setName(getFullCheckName(moduleDetails.getName()) + " Template")
                             .setInternalKey(getInternalKey(moduleDetails))
                             .setSeverity("MINOR")
                             .setStatus(RuleStatus.READY);

src/test/java/org/sonar/plugins/checkstyle/CheckstyleRulesDefinitionTest.java

@@ -21,7 +21,10 @@
 
 import static org.fest.assertions.Assertions.assertThat;
 
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
 
 import org.junit.Rule;
 import org.junit.Test;
@@ -61,7 +64,23 @@ public void test() {
         assertThat(repository.language()).isEqualTo("java");
 
         final List<RulesDefinition.Rule> rules = repository.rules();
-        assertThat(rules).hasSize(179);
+        final Map<String, Integer> ruleCounts = new HashMap<>();
+        rules.forEach(rule -> {
+            final String name = rule.key().replace("template", "");
+            ruleCounts.merge(name, 1, Integer::sum);
+        });
+        final List<String> duplicatedRuleWithTemplate = ruleCounts.entrySet().stream()
+                .filter(entry -> entry.getValue() > 1)
+                .map(entry -> entry.getKey())
+                .collect(Collectors.toList());
+        final List<String> rulesWithDuplicateTemplate = ruleCounts.entrySet().stream()
+                .filter(entry -> entry.getValue() == 1)
+                .map(entry -> entry.getKey())
+                .collect(Collectors.toList());
+        // such number should not change during checkstyle version upgrade
+        assertThat(duplicatedRuleWithTemplate).hasSize(174);
+        // all new Rules should fall in this group
+        assertThat(rulesWithDuplicateTemplate).hasSize(5);
 
         for (RulesDefinition.Rule rule : rules) {
             assertThat(rule.key()).isNotNull();