Issue #256: New metadata maintanence method: Fetch directly from checkstyle

gaurabdg · Calixte · commit 42971a1421c7 · 2021-01-29T08:23:34.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ net.sf.eclipsecs.core/lib/metadata-gen-1.0-SNAPSHOT.jar
 .checkstyle
 target/
 show.patch
+*.DS_Store
diff --git a/.travis.yml b/.travis.yml
@@ -27,19 +27,19 @@ matrix:
     - jdk: openjdk8
       env:
         - DESC="install (openjdk8)"
-        - CMD="./build-metafile-gen.sh && mvn install && git diff"
+        - CMD="mvn install && git diff"
 
     # JDK 11 (Long Term Support version)
     - jdk: openjdk11
       env:
         - DESC="install (openjdk11)"
-        - CMD="./build-metafile-gen.sh && mvn install && git diff"
+        - CMD="mvn install && git diff"
 
     # JDK 13 (most recent Java version)
     - jdk: openjdk13
       env:
         - DESC="install (openjdk13)"
-        - CMD="./build-metafile-gen.sh && mvn install && git diff"
+        - CMD="mvn install && git diff"
 
 script:
   - |
diff --git a/build-metafile-gen.sh b/build-metafile-gen.sh
diff --git a/net.sf.eclipsecs.checkstyle/.classpath b/net.sf.eclipsecs.checkstyle/.classpath
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
-	<classpathentry exported="true" kind="lib" path="checkstyle-8.35-all.jar" sourcepath="checkstyle-checkstyle-8.35.zip"/>
+	<classpathentry exported="true" kind="lib" path="checkstyle-8.36.1-all.jar" sourcepath="checkstyle-checkstyle-8.36.zip"/>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
diff --git a/net.sf.eclipsecs.checkstyle/META-INF/MANIFEST.MF b/net.sf.eclipsecs.checkstyle/META-INF/MANIFEST.MF
@@ -46,5 +46,5 @@ Export-Package: .,
  com.puppycrawl.tools.checkstyle.utils,
  org.apache.commons.beanutils;version="8.35.0"
 Bundle-ClassPath: .,
- checkstyle-8.35-all.jar
+ checkstyle-8.36.1-all.jar
 Automatic-Module-Name: net.sf.eclipsecs.checkstyle
diff --git a/net.sf.eclipsecs.checkstyle/build.properties b/net.sf.eclipsecs.checkstyle/build.properties
@@ -1,6 +1,6 @@
 bin.includes = META-INF/,\
                .,\
                license/,\
-               checkstyle-8.35-all.jar
+               checkstyle-8.36.1-all.jar
 jars.compile.order = .
 source.. = metadata/
diff --git a/net.sf.eclipsecs.checkstyle/checkstyle-8.36.1-all.jar b/net.sf.eclipsecs.checkstyle/checkstyle-8.36.1-all.jar
diff --git a/net.sf.eclipsecs.checkstyle/pom.xml b/net.sf.eclipsecs.checkstyle/pom.xml
@@ -11,7 +11,7 @@
     <name>Checkstyle Core Library Plugin</name>
     
     <properties>
-        <checkstyle.version>8.35</checkstyle.version>
+        <checkstyle.version>8.36.1</checkstyle.version>
     </properties>
     <build>
         <plugins>
diff --git a/net.sf.eclipsecs.checkstyle/test/net/sf/eclipsecs/checkstyle/ChecksTest.java b/net.sf.eclipsecs.checkstyle/test/net/sf/eclipsecs/checkstyle/ChecksTest.java
diff --git a/net.sf.eclipsecs.core/.classpath b/net.sf.eclipsecs.core/.classpath
@@ -1,11 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
-	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins">
+		<accessrules>
+			<accessrule kind="accessible" pattern="com/puppycrawl/tools/checkstyle/meta/**"/>
+		</accessrules>
+	</classpathentry>
 	<classpathentry kind="src" path="src"/>
 	<classpathentry exported="true" kind="lib" path="lib/dom4j-2.1.3.jar"/>
-	<classpathentry exported="true" kind="lib" path="lib/metadata-gen-1.0-SNAPSHOT.jar"/>
-	<classpathentry exported="true" kind="lib" path="lib/reflections-0.9.10.jar"/>
 	<classpathentry exported="true" kind="lib" path="lib/snakeyaml-1.26.jar"/>
+	<classpathentry exported="true" kind="lib" path="lib/reflections-0.9.10.jar"/>
+	<classpathentry kind="lib" path="lib/checkstyle-8.36.1-all.jar"/>
 	<classpathentry kind="output" path="target/classes"/>
 </classpath>
diff --git a/net.sf.eclipsecs.core/META-INF/MANIFEST.MF b/net.sf.eclipsecs.core/META-INF/MANIFEST.MF
@@ -8,7 +8,7 @@ Bundle-ClassPath: .,
  lib/dom4j-2.1.3.jar,
  lib/snakeyaml-1.26.jar,
  lib/reflections-0.9.10.jar,
- lib/metadata-gen-1.0-SNAPSHOT.jar
+ lib/checkstyle-8.36.1-all.jar
 Bundle-Activator: net.sf.eclipsecs.core.CheckstylePlugin
 Bundle-ActivationPolicy: lazy
 Bundle-Vendor: Eclipse Checkstyle Project
diff --git a/net.sf.eclipsecs.core/build.properties b/net.sf.eclipsecs.core/build.properties
@@ -10,7 +10,7 @@ bin.includes = .,\
                lib/dom4j-2.1.3.jar, \
                lib/reflections-0.9.10.jar, \
                lib/snakeyaml-1.26.jar, \
-               lib/metadata-gen-1.0-SNAPSHOT.jar
+               lib/checkstyle-8.36.1-all.jar
                
 source.. = src/
 
diff --git a/net.sf.eclipsecs.core/lib/checkstyle-8.36.1-all.jar b/net.sf.eclipsecs.core/lib/checkstyle-8.36.1-all.jar
diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/MetadataFactory.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/MetadataFactory.java
@@ -23,6 +23,9 @@
 import com.puppycrawl.tools.checkstyle.PackageNamesLoader;
 import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
 import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
+import com.puppycrawl.tools.checkstyle.meta.ModuleDetails;
+import com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails;
+import com.puppycrawl.tools.checkstyle.meta.XmlMetaReader;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -61,9 +64,6 @@
 import org.dom4j.DocumentException;
 import org.dom4j.Element;
 import org.dom4j.io.SAXReader;
-import org.example.ModuleDetails;
-import org.example.ModulePropertyDetails;
-import org.example.XMLMetaReader;
 import org.reflections.Reflections;
 import org.reflections.scanners.ResourcesScanner;
 import org.yaml.snakeyaml.Yaml;
@@ -80,6 +80,12 @@ public final class MetadataFactory {
   private static final Pattern ECLIPSE_EXTENSION_CONFIG_FILE
       = Pattern.compile(".*eclipse-metadata.*\\.yml");
 
+  /** Pattern for dot. */
+  private static final String DOT_PATTERN = "\\.";
+
+  /** Other rule group name. */
+  private static final String OTHER_GROUP_NAME = "Other";
+
   /** Metadata for the rule groups. */
   private static Map<String, RuleGroupMetadata> sRuleGroupMetadata;
 
@@ -145,7 +151,7 @@ private static void loadThirdPartyModuleExtensionMetadata() {
     Set<String> eclipseMetaDataFiles = new HashSet<>();
 
     for (String packageName : sPackageNameSet) {
-      String topMostPackageName = packageName.split("\\.")[0];
+      final String topMostPackageName = packageName.split(DOT_PATTERN)[0];
       Reflections reflections = new Reflections(topMostPackageName, new ResourcesScanner());
       eclipseMetaDataFiles.addAll(reflections.getResources(ECLIPSE_EXTENSION_CONFIG_FILE));
     }
@@ -232,7 +238,7 @@ public static RuleMetadata createRuleMetadata(ModuleDetails moduleDetails) {
     String moduleClassName = moduleDetails.getFullQualifiedName();
     // standard checkstyle module
     if (moduleClassName.startsWith("com.puppycrawl.tools.checkstyle")) {
-      final String[] packageTokens = moduleDetails.getFullQualifiedName().split("\\.");
+      final String[] packageTokens = moduleDetails.getFullQualifiedName().split(DOT_PATTERN);
       group = getRuleGroupMetadata(sPackageToGroupNameMap
               .get(packageTokens[packageTokens.length - 2]));
     }
@@ -251,9 +257,9 @@ public static RuleMetadata createRuleMetadata(ModuleDetails moduleDetails) {
         sRuleGroupMetadata.put(ruleGroupName, group);
       }
     }
-
+    final String[] packageTokens = moduleDetails.getParent().split(DOT_PATTERN);
     RuleMetadata ruleMeta = new RuleMetadata(moduleDetails.getName(), moduleDetails.getName(),
-            moduleDetails.getParent(), MetadataFactory.getDefaultSeverity(),
+            packageTokens[packageTokens.length - 1], MetadataFactory.getDefaultSeverity(),
             false, true, true, false, group);
     ruleMeta.setDescription(moduleDetails.getDescription());
     moduleDetails.getProperties().forEach(modulePropertyDetails -> ruleMeta.getPropertyMetadata()
@@ -267,7 +273,7 @@ public static RuleMetadata createRuleMetadata(ModuleDetails moduleDetails) {
    * {@code sThirdPartyRuleGroupMap}.
    */
   private static String findLookupKey(String packageName) {
-    final String[] packageTokens = packageName.split("\\.");
+    final String[] packageTokens = packageName.split(DOT_PATTERN);
     List<String> prefixList = new ArrayList<>();
     String lookupKey = packageTokens[0];
     prefixList.add(lookupKey);
@@ -287,33 +293,6 @@ private static String findLookupKey(String packageName) {
     return result;
   }
 
-  /**
-   * Update the existing eclipse files based metadata with checkstyle files metadata, updating
-   * only those fields which are provided by checkstyle.
-   *
-   * @param ruleMetadata module rule metadata by eclipse
-   * @param moduleDetails module metadata by checkstyle
-   * @return updated rule metadata
-   */
-  public static RuleMetadata updateRuleMetadata(RuleMetadata ruleMetadata,
-          ModuleDetails moduleDetails) {
-    RuleMetadata modifiedRuleMetadata = new RuleMetadata(
-            ruleMetadata.getRuleName(), moduleDetails.getFullQualifiedName(),
-            moduleDetails.getParent(), ruleMetadata.getDefaultSeverityLevel(),
-            ruleMetadata.isHidden(), ruleMetadata.hasSeverity(),
-            ruleMetadata.isDeletable(), ruleMetadata.isSingleton(), ruleMetadata.getGroup());
-    modifiedRuleMetadata.setDescription(moduleDetails.getDescription());
-    for (ConfigPropertyMetadata configPropertyMetadata : ruleMetadata.getPropertyMetadata()) {
-      ModulePropertyDetails modulePropertyDetails =
-              moduleDetails.getModulePropertyByKey(configPropertyMetadata.getName());
-      modifiedRuleMetadata.getPropertyMetadata()
-          .add(createPropertyConfig(moduleDetails, modulePropertyDetails));
-    }
-
-    return modifiedRuleMetadata;
-
-  }
-
   /**
    * Create module property config data based on current/default data,
    * which are overridden partially with all the metadata fetched from checkstyle.
@@ -600,26 +579,21 @@ private static void doInitialization() throws CheckstylePluginException {
    * Create repository of Module Details from checkstyle metadata and third party extension checks metadata.
    */
   public static void createMetadataMap() {
-    new XMLMetaReader()
-        .readAllModulesIncludingThirdPartyIfAny(
-            sPackageNameSet.toArray(new String[sPackageNameSet.size()]))
+    XmlMetaReader.readAllModulesIncludingThirdPartyIfAny(
+        sPackageNameSet.toArray(new String[sPackageNameSet.size()]))
         .forEach(moduleDetail -> sModuleDetailsRepo.put(moduleDetail.getName(), moduleDetail));
   }
 
   /**
-   * Creates new RuleMetadata which are absent in the eclipse-cs metadata package.
+   * Creates RuleMetadata.
    */
   public static void loadRuleMetadata() {
-    if (sModuleDetailsRepo.size() != sRuleMetadata.size()) {
-      for (Entry<String, ModuleDetails> entry : sModuleDetailsRepo.entrySet()) {
-        if (!sRuleMetadata.containsKey(entry.getKey())) {
-          ModuleDetails moduleDetails = entry.getValue();
-          RuleMetadata createdRuleMetadata = createRuleMetadata(moduleDetails);
-          sRuleMetadata.put(moduleDetails.getName(), createdRuleMetadata);
-          sRuleGroupMetadata.get(createdRuleMetadata.getGroup().getGroupName())
-                 .getRuleMetadata().add(createdRuleMetadata);
-        }
-      }
+    for (Entry<String, ModuleDetails> entry : sModuleDetailsRepo.entrySet()) {
+      final ModuleDetails moduleDetails = entry.getValue();
+      final RuleMetadata createdRuleMetadata = createRuleMetadata(moduleDetails);
+      sRuleMetadata.put(moduleDetails.getName(), createdRuleMetadata);
+      sRuleGroupMetadata.get(createdRuleMetadata.getGroup().getGroupName())
+         .getRuleMetadata().add(createdRuleMetadata);
     }
   }
 
@@ -642,7 +616,7 @@ private static void createPropertyTypeMapping() {
   private static void createPackageToGroupNameMapping() {
     sPackageToGroupNameMap.put("annotation", "Annotations");
     sPackageToGroupNameMap.put("checks", "Miscellaneous");
-    sPackageToGroupNameMap.put("checkstyle", "Other");
+    sPackageToGroupNameMap.put("checkstyle", OTHER_GROUP_NAME);
     sPackageToGroupNameMap.put("blocks", "Blocks");
     sPackageToGroupNameMap.put("coding", "Coding Problems");
     sPackageToGroupNameMap.put("design", "Class Design");
@@ -651,7 +625,7 @@ private static void createPackageToGroupNameMapping() {
     sPackageToGroupNameMap.put("indentation", "Indentation");
     sPackageToGroupNameMap.put("javadoc", "Javadoc Comments");
     sPackageToGroupNameMap.put("metrics", "Metrics");
-    sPackageToGroupNameMap.put("modifier", "Modifier Order");
+    sPackageToGroupNameMap.put("modifier", "Modifiers");
     sPackageToGroupNameMap.put("naming", "Naming Conventions");
     sPackageToGroupNameMap.put("regexp", "Regexp");
     sPackageToGroupNameMap.put("sizes", "Size Violations");
@@ -749,7 +723,9 @@ private static void parseMetadata(InputStream metadataStream, ResourceBundle met
       }
 
       // process the modules
-      processModules(groupEl, group, metadataBundle);
+      if (OTHER_GROUP_NAME.equals(groupName)) {
+        processModules(groupEl, group, metadataBundle);
+      }
     }
   }
 
@@ -817,14 +793,6 @@ private static void processModules(Element groupElement, RuleGroupMetadata group
         module.addMessageKey(messageKey);
       }
 
-      // Update the metadata with module details from checkstyle
-      if (sModuleDetailsRepo.containsKey(internalName)) {
-        if (internalName.contains("Check")) {
-          internalName = internalName.substring(0, internalName.indexOf("Check"));
-        }
-        module = updateRuleMetadata(module, sModuleDetailsRepo.get(internalName));
-      }
-
       groupMetadata.getRuleMetadata().add(module);
     }
   }
diff --git a/net.sf.eclipsecs.ui/.classpath b/net.sf.eclipsecs.ui/.classpath
@@ -6,21 +6,9 @@
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
-	<classpathentry kind="src" path="src"/>
-	<classpathentry kind="src" output="target/test-classes" path="test">
-		<attributes>
-			<attribute name="test" value="true"/>
-		</attributes>
-	</classpathentry>
-    <accessrules>
-        <accessrule kind="accessible" pattern="org/eclipse/**"/>
-        <accessrule kind="accessible" pattern="com/google/**"/>
-        <accessrule kind="accessible" pattern="org/osgi/**"/>
-        <accessrule kind="accessible" pattern="com/puppycrawl/**"/>
-    </accessrules>
+	<classpathentry kind="src" path="src/"/>
 	<classpathentry exported="true" kind="lib" path="lib/jfreechart-1.0.19.jar"/>
 	<classpathentry exported="true" kind="lib" path="lib/jfreechart-1.0.19-swt.jar"/>
 	<classpathentry exported="true" kind="lib" path="lib/jcommon-1.0.23.jar"/>
-	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5"/>
 	<classpathentry kind="output" path="target/classes"/>
 </classpath>
