green-code-initiative#92 refactor(rule/java): moves Java rules into `…

…ecocode-rule-specification` module
jycr · Apr 12, 2023 · 182aa39 · 182aa39
1 parent 2bc395c
commit 182aa39
Show file tree

Hide file tree

Showing 46 changed files with 164 additions and 130 deletions.
diff --git a/ecocode-rule-specification/src/main/assembly/java.xml b/ecocode-rule-specification/src/main/assembly/java.xml
@@ -0,0 +1,22 @@
+<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.1"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.1 https://maven.apache.org/xsd/assembly-2.1.1.xsd">
+	<id>java</id>
+	<formats>
+		<format>jar</format>
+	</formats>
+	<includeBaseDirectory>false</includeBaseDirectory>
+	<fileSets>
+		<fileSet>
+			<directory>${project.build.outputDirectory}</directory>
+			<includes>
+				<include>io/ecocode/rules/java/*.class</include>
+			</includes>
+			<outputDirectory/>
+		</fileSet>
+		<fileSet>
+			<directory>${project.build.directory}/java</directory>
+			<outputDirectory>io/ecocode/rules/java/specifications</outputDirectory>
+		</fileSet>
+	</fileSets>
+</assembly>
diff --git a/ecocode-rule-specification/src/main/java/io/ecocode/rules/java/JavaRulesRepository.java b/ecocode-rule-specification/src/main/java/io/ecocode/rules/java/JavaRulesRepository.java
@@ -0,0 +1,8 @@
+package io.ecocode.rules.java;
+
+public class JavaRulesRepository {
+  public static final String REPOSITORY_KEY = "ecocode-java";
+  public static final String NAME = "ecoCode";
+  public static final String LANGUAGE = "java";
+  public static final String RESOURCE_BASE_PATH = JavaRulesRepository.class.getPackageName().replace('.', '/') + "/specifications";
+}
diff --git a/...einitiative/l10n/java/rules/java/EC1.json → ...specification/src/main/rules/EC1/EC1.json b/...einitiative/l10n/java/rules/java/EC1.json → ...specification/src/main/rules/EC1/EC1.json
diff --git a/...einitiative/l10n/java/rules/java/EC1.html → ...tion/src/main/rules/EC1/java/EC1.asciidoc b/...einitiative/l10n/java/rules/java/EC1.html → ...tion/src/main/rules/EC1/java/EC1.asciidoc
diff --git a/...einitiative/l10n/java/rules/java/EC2.json → ...specification/src/main/rules/EC2/EC2.json b/...einitiative/l10n/java/rules/java/EC2.json → ...specification/src/main/rules/EC2/EC2.json
diff --git a/...einitiative/l10n/java/rules/java/EC2.html → ...tion/src/main/rules/EC2/java/EC2.asciidoc b/...einitiative/l10n/java/rules/java/EC2.html → ...tion/src/main/rules/EC2/java/EC2.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC27.json → ...ecification/src/main/rules/EC27/EC27.json b/...initiative/l10n/java/rules/java/EC27.json → ...ecification/src/main/rules/EC27/EC27.json
diff --git a/...initiative/l10n/java/rules/java/EC27.html → ...on/src/main/rules/EC27/java/EC27.asciidoc b/...initiative/l10n/java/rules/java/EC27.html → ...on/src/main/rules/EC27/java/EC27.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC28.json → ...ecification/src/main/rules/EC28/EC28.json b/...initiative/l10n/java/rules/java/EC28.json → ...ecification/src/main/rules/EC28/EC28.json
diff --git a/...initiative/l10n/java/rules/java/EC28.html → ...on/src/main/rules/EC28/java/EC28.asciidoc b/...initiative/l10n/java/rules/java/EC28.html → ...on/src/main/rules/EC28/java/EC28.asciidoc
diff --git a/...einitiative/l10n/java/rules/java/EC3.json → ...specification/src/main/rules/EC3/EC3.json b/...einitiative/l10n/java/rules/java/EC3.json → ...specification/src/main/rules/EC3/EC3.json
diff --git a/...einitiative/l10n/java/rules/java/EC3.html → ...tion/src/main/rules/EC3/java/EC3.asciidoc b/...einitiative/l10n/java/rules/java/EC3.html → ...tion/src/main/rules/EC3/java/EC3.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC32.json → ...ecification/src/main/rules/EC32/EC32.json b/...initiative/l10n/java/rules/java/EC32.json → ...ecification/src/main/rules/EC32/EC32.json
diff --git a/...initiative/l10n/java/rules/java/EC32.html → ...on/src/main/rules/EC32/java/EC32.asciidoc b/...initiative/l10n/java/rules/java/EC32.html → ...on/src/main/rules/EC32/java/EC32.asciidoc
diff --git a/...einitiative/l10n/java/rules/java/EC4.json → ...specification/src/main/rules/EC4/EC4.json b/...einitiative/l10n/java/rules/java/EC4.json → ...specification/src/main/rules/EC4/EC4.json
diff --git a/...einitiative/l10n/java/rules/java/EC4.html → ...tion/src/main/rules/EC4/java/EC4.asciidoc b/...einitiative/l10n/java/rules/java/EC4.html → ...tion/src/main/rules/EC4/java/EC4.asciidoc
diff --git a/...einitiative/l10n/java/rules/java/EC5.json → ...specification/src/main/rules/EC5/EC5.json b/...einitiative/l10n/java/rules/java/EC5.json → ...specification/src/main/rules/EC5/EC5.json
diff --git a/...einitiative/l10n/java/rules/java/EC5.html → ...tion/src/main/rules/EC5/java/EC5.asciidoc b/...einitiative/l10n/java/rules/java/EC5.html → ...tion/src/main/rules/EC5/java/EC5.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC53.json → ...ecification/src/main/rules/EC53/EC53.json b/...initiative/l10n/java/rules/java/EC53.json → ...ecification/src/main/rules/EC53/EC53.json
diff --git a/...initiative/l10n/java/rules/java/EC53.html → ...on/src/main/rules/EC53/java/EC53.asciidoc b/...initiative/l10n/java/rules/java/EC53.html → ...on/src/main/rules/EC53/java/EC53.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC63.json → ...ecification/src/main/rules/EC63/EC63.json b/...initiative/l10n/java/rules/java/EC63.json → ...ecification/src/main/rules/EC63/EC63.json
diff --git a/...initiative/l10n/java/rules/java/EC63.html → ...on/src/main/rules/EC63/java/EC63.asciidoc b/...initiative/l10n/java/rules/java/EC63.html → ...on/src/main/rules/EC63/java/EC63.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC67.json → ...ecification/src/main/rules/EC67/EC67.json b/...initiative/l10n/java/rules/java/EC67.json → ...ecification/src/main/rules/EC67/EC67.json
diff --git a/...initiative/l10n/java/rules/java/EC67.html → ...on/src/main/rules/EC67/java/EC67.asciidoc b/...initiative/l10n/java/rules/java/EC67.html → ...on/src/main/rules/EC67/java/EC67.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC69.json → ...ecification/src/main/rules/EC69/EC69.json b/...initiative/l10n/java/rules/java/EC69.json → ...ecification/src/main/rules/EC69/EC69.json
diff --git a/...initiative/l10n/java/rules/java/EC69.html → ...on/src/main/rules/EC69/java/EC69.asciidoc b/...initiative/l10n/java/rules/java/EC69.html → ...on/src/main/rules/EC69/java/EC69.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC72.json → ...ecification/src/main/rules/EC72/EC72.json b/...initiative/l10n/java/rules/java/EC72.json → ...ecification/src/main/rules/EC72/EC72.json
diff --git a/...initiative/l10n/java/rules/java/EC72.html → ...on/src/main/rules/EC72/java/EC72.asciidoc b/...initiative/l10n/java/rules/java/EC72.html → ...on/src/main/rules/EC72/java/EC72.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC74.json → ...ecification/src/main/rules/EC74/EC74.json b/...initiative/l10n/java/rules/java/EC74.json → ...ecification/src/main/rules/EC74/EC74.json
diff --git a/...initiative/l10n/java/rules/java/EC74.html → ...on/src/main/rules/EC74/java/EC74.asciidoc b/...initiative/l10n/java/rules/java/EC74.html → ...on/src/main/rules/EC74/java/EC74.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC75.json → ...ecification/src/main/rules/EC75/EC75.json b/...initiative/l10n/java/rules/java/EC75.json → ...ecification/src/main/rules/EC75/EC75.json
diff --git a/...initiative/l10n/java/rules/java/EC75.html → ...on/src/main/rules/EC75/java/EC75.asciidoc b/...initiative/l10n/java/rules/java/EC75.html → ...on/src/main/rules/EC75/java/EC75.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC76.json → ...ecification/src/main/rules/EC76/EC76.json b/...initiative/l10n/java/rules/java/EC76.json → ...ecification/src/main/rules/EC76/EC76.json
diff --git a/...initiative/l10n/java/rules/java/EC76.html → ...on/src/main/rules/EC76/java/EC76.asciidoc b/...initiative/l10n/java/rules/java/EC76.html → ...on/src/main/rules/EC76/java/EC76.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC77.json → ...ecification/src/main/rules/EC77/EC77.json b/...initiative/l10n/java/rules/java/EC77.json → ...ecification/src/main/rules/EC77/EC77.json
diff --git a/...initiative/l10n/java/rules/java/EC77.html → ...on/src/main/rules/EC77/java/EC77.asciidoc b/...initiative/l10n/java/rules/java/EC77.html → ...on/src/main/rules/EC77/java/EC77.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC78.json → ...ecification/src/main/rules/EC78/EC78.json b/...initiative/l10n/java/rules/java/EC78.json → ...ecification/src/main/rules/EC78/EC78.json
diff --git a/...initiative/l10n/java/rules/java/EC78.html → ...on/src/main/rules/EC78/java/EC78.asciidoc b/...initiative/l10n/java/rules/java/EC78.html → ...on/src/main/rules/EC78/java/EC78.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC79.json → ...ecification/src/main/rules/EC79/EC79.json b/...initiative/l10n/java/rules/java/EC79.json → ...ecification/src/main/rules/EC79/EC79.json
diff --git a/...initiative/l10n/java/rules/java/EC79.html → ...on/src/main/rules/EC79/java/EC79.asciidoc b/...initiative/l10n/java/rules/java/EC79.html → ...on/src/main/rules/EC79/java/EC79.asciidoc
diff --git a/ecocode-rules-specifications/pom.xml b/ecocode-rules-specifications/pom.xml
@@ -63,13 +63,42 @@
 				<artifactId>maven-antrun-plugin</artifactId>
 				<version>3.1.0</version>
 				<executions>
+					<execution>
+						<phase>process-resources</phase>
+						<configuration>
+							<target>
+								<copy todir="${project.build.directory}/java">
+									<fileset dir="${project.build.directory}/rules">
+										<include name="*/java/EC*.html"/>
+										<include name="*/EC*.json"/>
+									</fileset>
+									<flattenmapper/>
+								</copy>
+							</target>
+						</configuration>
+						<goals>
+							<goal>run</goal>
+						</goals>
+					</execution>
 				</executions>
 			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-assembly-plugin</artifactId>
 				<version>3.5.0</version>
 				<executions>
+					<execution>
+						<id>assembly-java</id>
+						<phase>prepare-package</phase>
+						<goals>
+							<goal>single</goal>
+						</goals>
+						<configuration>
+							<descriptors>
+								<descriptor>${project.basedir}/src/main/assembly/java.xml</descriptor>
+							</descriptors>
+						</configuration>
+					</execution>
 				</executions>
 				<configuration>
 					<appendAssemblyId>true</appendAssemblyId>

diff --git a/java-plugin/pom.xml b/java-plugin/pom.xml
@@ -16,26 +16,30 @@
     <url>https://github.com/green-code-initiative/ecoCode/tree/main/java-plugin</url>
 
     <dependencies>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>ecocode-rules-specifications</artifactId>
+            <version>${project.version}</version>
+            <classifier>java</classifier>
+        </dependency>
 
         <dependency>
             <groupId>org.sonarsource.java</groupId>
             <artifactId>sonar-java-plugin</artifactId>
             <type>sonar-plugin</type>
+            <scope>provided</scope>
         </dependency>
 
         <dependency>
             <groupId>org.sonarsource.sonarqube</groupId>
             <artifactId>sonar-plugin-api</artifactId>
-        </dependency>
-
-        <dependency>
-            <groupId>org.sonarsource.sonarqube</groupId>
-            <artifactId>sonar-plugin-api-impl</artifactId>
+            <scope>provided</scope>
         </dependency>
 
         <dependency>
             <groupId>org.sonarsource.analyzer-commons</groupId>
             <artifactId>sonar-analyzer-commons</artifactId>
+            <scope>provided</scope>
         </dependency>
 
         <dependency>
@@ -133,6 +137,12 @@
                                         <exclude>META-INF/**</exclude>
                                     </excludes>
                                 </filter>
+                                <filter>
+                                    <artifact>*:ecocode-rules-specifications</artifact>
+                                    <excludes>
+                                        <exclude>META-INF/**</exclude>
+                                    </excludes>
+                                </filter>
                             </filters>
                         </configuration>
                     </execution>

diff --git a/java-plugin/src/main/java/fr/greencodeinitiative/java/JavaCheckRegistrar.java b/java-plugin/src/main/java/fr/greencodeinitiative/java/JavaCheckRegistrar.java
@@ -21,10 +21,14 @@
 
 import java.util.List;
 
+import io.ecocode.rules.java.JavaRulesRepository;
 import org.sonar.plugins.java.api.CheckRegistrar;
 import org.sonar.plugins.java.api.JavaCheck;
 import org.sonarsource.api.sonarlint.SonarLintSide;
 
+import static fr.greencodeinitiative.java.JavaRulesDefinition.ANNOTATED_RULE_CLASSES;
+import static fr.greencodeinitiative.java.JavaRulesDefinition.ANNOTATED_RULE_TEST_CLASSES;
+
 /**
  * Provide the "checks" (implementations of rules) classes that are going be executed during
  * source code analysis.
@@ -40,20 +44,20 @@ public class JavaCheckRegistrar implements CheckRegistrar {
     @Override
     public void register(RegistrarContext registrarContext) {
         // Call to registerClassesForRepository to associate the classes with the correct repository key
-        registrarContext.registerClassesForRepository(JavaRulesDefinition.REPOSITORY_KEY, checkClasses(), testCheckClasses());
+        registrarContext.registerClassesForRepository(JavaRulesRepository.REPOSITORY_KEY, checkClasses(), testCheckClasses());
     }
 
     /**
      * Lists all the main checks provided by the plugin
      */
     public static List<Class<? extends JavaCheck>> checkClasses() {
-        return RulesList.getJavaChecks();
+        return ANNOTATED_RULE_CLASSES;
     }
 
     /**
      * Lists all the test checks provided by the plugin
      */
     public static List<Class<? extends JavaCheck>> testCheckClasses() {
-        return RulesList.getJavaTestChecks();
+        return ANNOTATED_RULE_TEST_CLASSES;
     }
 }
diff --git a/java-plugin/src/main/java/fr/greencodeinitiative/java/JavaRulesDefinition.java b/java-plugin/src/main/java/fr/greencodeinitiative/java/JavaRulesDefinition.java
@@ -19,54 +19,99 @@
  */
 package fr.greencodeinitiative.java;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Objects;
-import java.util.Set;
-
+import fr.greencodeinitiative.java.checks.ArrayCopyCheck;
+import fr.greencodeinitiative.java.checks.AvoidConcatenateStringsInLoop;
+import fr.greencodeinitiative.java.checks.AvoidFullSQLRequest;
+import fr.greencodeinitiative.java.checks.AvoidGettingSizeCollectionInLoop;
+import fr.greencodeinitiative.java.checks.AvoidMultipleIfElseStatement;
+import fr.greencodeinitiative.java.checks.AvoidRegexPatternNotStatic;
+import fr.greencodeinitiative.java.checks.AvoidSQLRequestInLoop;
+import fr.greencodeinitiative.java.checks.AvoidSetConstantInBatchUpdate;
+import fr.greencodeinitiative.java.checks.AvoidSpringRepositoryCallInLoopCheck;
+import fr.greencodeinitiative.java.checks.AvoidStatementForDMLQueries;
+import fr.greencodeinitiative.java.checks.AvoidUsageOfStaticCollections;
+import fr.greencodeinitiative.java.checks.AvoidUsingGlobalVariablesCheck;
+import fr.greencodeinitiative.java.checks.FreeResourcesOfAutoCloseableInterface;
+import fr.greencodeinitiative.java.checks.IncrementCheck;
+import fr.greencodeinitiative.java.checks.InitializeBufferWithAppropriateSize;
+import fr.greencodeinitiative.java.checks.NoFunctionCallWhenDeclaringForLoop;
+import fr.greencodeinitiative.java.checks.OptimizeReadFileExceptions;
+import fr.greencodeinitiative.java.checks.UnnecessarilyAssignValuesToVariables;
+import fr.greencodeinitiative.java.checks.UseCorrectForLoop;
 import org.sonar.api.SonarEdition;
+import org.sonar.api.SonarProduct;
 import org.sonar.api.SonarQubeSide;
 import org.sonar.api.SonarRuntime;
-import org.sonar.api.internal.SonarRuntimeImpl;
 import org.sonar.api.server.rule.RulesDefinition;
 import org.sonar.api.utils.Version;
+import org.sonar.plugins.java.api.JavaCheck;
 import org.sonarsource.analyzer.commons.RuleMetadataLoader;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import static io.ecocode.rules.java.JavaRulesRepository.LANGUAGE;
+import static io.ecocode.rules.java.JavaRulesRepository.NAME;
+import static io.ecocode.rules.java.JavaRulesRepository.REPOSITORY_KEY;
+import static io.ecocode.rules.java.JavaRulesRepository.RESOURCE_BASE_PATH;
+
 /**
  * Declare rule metadata in server repository of rules.
  * That allows to list the rules in the page "Rules".
  */
 public class JavaRulesDefinition implements RulesDefinition {
+  static final List<Class<? extends JavaCheck>> ANNOTATED_RULE_CLASSES = List.of(
+          ArrayCopyCheck.class,
+          IncrementCheck.class,
+          AvoidConcatenateStringsInLoop.class,
+          AvoidUsageOfStaticCollections.class,
+          AvoidGettingSizeCollectionInLoop.class,
+          AvoidRegexPatternNotStatic.class,
+          NoFunctionCallWhenDeclaringForLoop.class,
+          AvoidStatementForDMLQueries.class,
+          AvoidSpringRepositoryCallInLoopCheck.class,
+          AvoidSQLRequestInLoop.class,
+          AvoidFullSQLRequest.class,
+          UseCorrectForLoop.class,
+          UnnecessarilyAssignValuesToVariables.class,
+          OptimizeReadFileExceptions.class,
+          InitializeBufferWithAppropriateSize.class,
+          AvoidUsingGlobalVariablesCheck.class,
+          AvoidSetConstantInBatchUpdate.class,
+          FreeResourcesOfAutoCloseableInterface.class,
+          AvoidMultipleIfElseStatement.class
+  );
 
-    // don't change that because the path is hard coded in CheckVerifier
-    private static final String RESOURCE_BASE_PATH = "fr/greencodeinitiative/l10n/java/rules/java";
-
-
-    // Add the rule keys of the rules which need to be considered as template-rules
-    private static final Set<String> RULE_TEMPLATES_KEY = Collections.emptySet();
-    public static final String NAME = "ecoCode";
-    public static final String LANGUAGE = "java";
-    public static final String REPOSITORY_KEY = "ecocode-java";
-
+  static final List<Class<? extends JavaCheck>> ANNOTATED_RULE_TEST_CLASSES = Collections.emptyList();
+  private static final Version SONARQUBE_RUNTIME_VERSION = Version.create(9, 8);
+  private static final SonarRuntime SONARQUBE_RUNTIME = new SonarRuntime() {
     @Override
-    public void define(Context context) {
-        NewRepository repository = context.createRepository(REPOSITORY_KEY, LANGUAGE).setName(NAME);
-
-        SonarRuntime sonarRuntime = SonarRuntimeImpl.forSonarQube(Version.create(9, 8), SonarQubeSide.SCANNER, SonarEdition.DEVELOPER);
-
-        RuleMetadataLoader ruleMetadataLoader = new RuleMetadataLoader(RESOURCE_BASE_PATH, sonarRuntime);
-
-        ruleMetadataLoader.addRulesByAnnotatedClass(repository, new ArrayList<>(RulesList.getChecks()));
+    public Version getApiVersion() {
+      return SONARQUBE_RUNTIME_VERSION;
+    }
 
-        setTemplates(repository);
+    @Override
+    public SonarProduct getProduct() {
+      return SonarProduct.SONARQUBE;
+    }
 
-        repository.done();
+    @Override
+    public SonarQubeSide getSonarQubeSide() {
+      return SonarQubeSide.SCANNER;
     }
 
-    private static void setTemplates(NewRepository repository) {
-        RULE_TEMPLATES_KEY.stream()
-                .map(repository::rule)
-                .filter(Objects::nonNull)
-                .forEach(rule -> rule.setTemplate(true));
+    @Override
+    public SonarEdition getEdition() {
+      return SonarEdition.COMMUNITY;
     }
+  };
+
+  @Override
+  public void define(Context context) {
+    NewRepository repository = context.createRepository(REPOSITORY_KEY, LANGUAGE).setName(NAME);
+    RuleMetadataLoader ruleMetadataLoader = new RuleMetadataLoader(RESOURCE_BASE_PATH, SONARQUBE_RUNTIME);
+    ruleMetadataLoader.addRulesByAnnotatedClass(repository, new ArrayList<>(ANNOTATED_RULE_CLASSES));
+    repository.done();
+  }
 }
diff --git a/java-plugin/src/main/java/fr/greencodeinitiative/java/RulesList.java b/java-plugin/src/main/java/fr/greencodeinitiative/java/RulesList.java