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

…ecocode-rules-specifications` module
jycr · Jul 9, 2023 · a8d9f34 · a8d9f34
1 parent cdcb3f2
commit a8d9f34
Show file tree

Hide file tree

Showing 46 changed files with 156 additions and 118 deletions.
diff --git a/ecocode-rules-specifications/pom.xml b/ecocode-rules-specifications/pom.xml
@@ -110,6 +110,17 @@
 						<goals>
 							<goal>run</goal>
 						</goals>
+						<configuration>
+							<target>
+								<copy todir="${project.build.outputDirectory}/io/ecocode/rules/java">
+									<fileset dir="${project.build.directory}/rules">
+										<include name="*/java/EC*.html"/>
+										<include name="*/EC*.json"/>
+									</fileset>
+									<flattenmapper/>
+								</copy>
+							</target>
+						</configuration>
 					</execution>
 				</executions>
 			</plugin>
@@ -129,6 +140,18 @@
 				<artifactId>maven-assembly-plugin</artifactId>
 				<version>3.6.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/ecocode-rules-specifications/src/main/assembly/java.xml b/ecocode-rules-specifications/src/main/assembly/java.xml
@@ -0,0 +1,18 @@
+<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/*.*</include>
+			</includes>
+			<outputDirectory/>
+		</fileSet>
+	</fileSets>
+</assembly>
diff --git a/...einitiative/l10n/java/rules/java/EC1.json → ...pecifications/src/main/rules/EC1/EC1.json b/...einitiative/l10n/java/rules/java/EC1.json → ...pecifications/src/main/rules/EC1/EC1.json
diff --git a/...einitiative/l10n/java/rules/java/EC1.html → ...ions/src/main/rules/EC1/java/EC1.asciidoc b/...einitiative/l10n/java/rules/java/EC1.html → ...ions/src/main/rules/EC1/java/EC1.asciidoc
diff --git a/...einitiative/l10n/java/rules/java/EC2.json → ...pecifications/src/main/rules/EC2/EC2.json b/...einitiative/l10n/java/rules/java/EC2.json → ...pecifications/src/main/rules/EC2/EC2.json
diff --git a/...einitiative/l10n/java/rules/java/EC2.html → ...ions/src/main/rules/EC2/java/EC2.asciidoc b/...einitiative/l10n/java/rules/java/EC2.html → ...ions/src/main/rules/EC2/java/EC2.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC27.json → ...cifications/src/main/rules/EC27/EC27.json b/...initiative/l10n/java/rules/java/EC27.json → ...cifications/src/main/rules/EC27/EC27.json
diff --git a/...initiative/l10n/java/rules/java/EC27.html → ...ns/src/main/rules/EC27/java/EC27.asciidoc b/...initiative/l10n/java/rules/java/EC27.html → ...ns/src/main/rules/EC27/java/EC27.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC28.json → ...cifications/src/main/rules/EC28/EC28.json b/...initiative/l10n/java/rules/java/EC28.json → ...cifications/src/main/rules/EC28/EC28.json
diff --git a/...initiative/l10n/java/rules/java/EC28.html → ...ns/src/main/rules/EC28/java/EC28.asciidoc b/...initiative/l10n/java/rules/java/EC28.html → ...ns/src/main/rules/EC28/java/EC28.asciidoc
diff --git a/...einitiative/l10n/java/rules/java/EC3.json → ...pecifications/src/main/rules/EC3/EC3.json b/...einitiative/l10n/java/rules/java/EC3.json → ...pecifications/src/main/rules/EC3/EC3.json
diff --git a/...einitiative/l10n/java/rules/java/EC3.html → ...ions/src/main/rules/EC3/java/EC3.asciidoc b/...einitiative/l10n/java/rules/java/EC3.html → ...ions/src/main/rules/EC3/java/EC3.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC32.json → ...cifications/src/main/rules/EC32/EC32.json b/...initiative/l10n/java/rules/java/EC32.json → ...cifications/src/main/rules/EC32/EC32.json
diff --git a/...initiative/l10n/java/rules/java/EC32.html → ...ns/src/main/rules/EC32/java/EC32.asciidoc b/...initiative/l10n/java/rules/java/EC32.html → ...ns/src/main/rules/EC32/java/EC32.asciidoc
diff --git a/...einitiative/l10n/java/rules/java/EC4.json → ...pecifications/src/main/rules/EC4/EC4.json b/...einitiative/l10n/java/rules/java/EC4.json → ...pecifications/src/main/rules/EC4/EC4.json
diff --git a/...einitiative/l10n/java/rules/java/EC4.html → ...ions/src/main/rules/EC4/java/EC4.asciidoc b/...einitiative/l10n/java/rules/java/EC4.html → ...ions/src/main/rules/EC4/java/EC4.asciidoc
diff --git a/...einitiative/l10n/java/rules/java/EC5.json → ...pecifications/src/main/rules/EC5/EC5.json b/...einitiative/l10n/java/rules/java/EC5.json → ...pecifications/src/main/rules/EC5/EC5.json
diff --git a/...einitiative/l10n/java/rules/java/EC5.html → ...ions/src/main/rules/EC5/java/EC5.asciidoc b/...einitiative/l10n/java/rules/java/EC5.html → ...ions/src/main/rules/EC5/java/EC5.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC53.json → ...cifications/src/main/rules/EC53/EC53.json b/...initiative/l10n/java/rules/java/EC53.json → ...cifications/src/main/rules/EC53/EC53.json
diff --git a/...initiative/l10n/java/rules/java/EC53.html → ...ns/src/main/rules/EC53/java/EC53.asciidoc b/...initiative/l10n/java/rules/java/EC53.html → ...ns/src/main/rules/EC53/java/EC53.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC63.json → ...cifications/src/main/rules/EC63/EC63.json b/...initiative/l10n/java/rules/java/EC63.json → ...cifications/src/main/rules/EC63/EC63.json
diff --git a/...initiative/l10n/java/rules/java/EC63.html → ...ns/src/main/rules/EC63/java/EC63.asciidoc b/...initiative/l10n/java/rules/java/EC63.html → ...ns/src/main/rules/EC63/java/EC63.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC67.json → ...cifications/src/main/rules/EC67/EC67.json b/...initiative/l10n/java/rules/java/EC67.json → ...cifications/src/main/rules/EC67/EC67.json
diff --git a/...initiative/l10n/java/rules/java/EC67.html → ...ns/src/main/rules/EC67/java/EC67.asciidoc b/...initiative/l10n/java/rules/java/EC67.html → ...ns/src/main/rules/EC67/java/EC67.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC69.json → ...cifications/src/main/rules/EC69/EC69.json b/...initiative/l10n/java/rules/java/EC69.json → ...cifications/src/main/rules/EC69/EC69.json
diff --git a/...initiative/l10n/java/rules/java/EC69.html → ...ns/src/main/rules/EC69/java/EC69.asciidoc b/...initiative/l10n/java/rules/java/EC69.html → ...ns/src/main/rules/EC69/java/EC69.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC72.json → ...cifications/src/main/rules/EC72/EC72.json b/...initiative/l10n/java/rules/java/EC72.json → ...cifications/src/main/rules/EC72/EC72.json
diff --git a/...initiative/l10n/java/rules/java/EC72.html → ...ns/src/main/rules/EC72/java/EC72.asciidoc b/...initiative/l10n/java/rules/java/EC72.html → ...ns/src/main/rules/EC72/java/EC72.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC74.json → ...cifications/src/main/rules/EC74/EC74.json b/...initiative/l10n/java/rules/java/EC74.json → ...cifications/src/main/rules/EC74/EC74.json
diff --git a/...initiative/l10n/java/rules/java/EC74.html → ...ns/src/main/rules/EC74/java/EC74.asciidoc b/...initiative/l10n/java/rules/java/EC74.html → ...ns/src/main/rules/EC74/java/EC74.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC75.json → ...cifications/src/main/rules/EC75/EC75.json b/...initiative/l10n/java/rules/java/EC75.json → ...cifications/src/main/rules/EC75/EC75.json
diff --git a/...initiative/l10n/java/rules/java/EC75.html → ...ns/src/main/rules/EC75/java/EC75.asciidoc b/...initiative/l10n/java/rules/java/EC75.html → ...ns/src/main/rules/EC75/java/EC75.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC76.json → ...cifications/src/main/rules/EC76/EC76.json b/...initiative/l10n/java/rules/java/EC76.json → ...cifications/src/main/rules/EC76/EC76.json
diff --git a/...initiative/l10n/java/rules/java/EC76.html → ...ns/src/main/rules/EC76/java/EC76.asciidoc b/...initiative/l10n/java/rules/java/EC76.html → ...ns/src/main/rules/EC76/java/EC76.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC77.json → ...cifications/src/main/rules/EC77/EC77.json b/...initiative/l10n/java/rules/java/EC77.json → ...cifications/src/main/rules/EC77/EC77.json
diff --git a/...initiative/l10n/java/rules/java/EC77.html → ...ns/src/main/rules/EC77/java/EC77.asciidoc b/...initiative/l10n/java/rules/java/EC77.html → ...ns/src/main/rules/EC77/java/EC77.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC78.json → ...cifications/src/main/rules/EC78/EC78.json b/...initiative/l10n/java/rules/java/EC78.json → ...cifications/src/main/rules/EC78/EC78.json
diff --git a/...initiative/l10n/java/rules/java/EC78.html → ...ns/src/main/rules/EC78/java/EC78.asciidoc b/...initiative/l10n/java/rules/java/EC78.html → ...ns/src/main/rules/EC78/java/EC78.asciidoc
diff --git a/...initiative/l10n/java/rules/java/EC79.json → ...cifications/src/main/rules/EC79/EC79.json b/...initiative/l10n/java/rules/java/EC79.json → ...cifications/src/main/rules/EC79/EC79.json
diff --git a/...initiative/l10n/java/rules/java/EC79.html → ...ns/src/main/rules/EC79/java/EC79.asciidoc b/...initiative/l10n/java/rules/java/EC79.html → ...ns/src/main/rules/EC79/java/EC79.asciidoc
diff --git a/java-plugin/pom.xml b/java-plugin/pom.xml
@@ -16,21 +16,24 @@
     <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.analyzer-commons</groupId>
-            <artifactId>sonar-analyzer-commons</artifactId>
+            <scope>provided</scope>
         </dependency>
 
         <!-- for security on regex patterns : https://github.com/google/re2j -->

diff --git a/java-plugin/src/main/java/fr/greencodeinitiative/java/JavaCheckRegistrar.java b/java-plugin/src/main/java/fr/greencodeinitiative/java/JavaCheckRegistrar.java
@@ -16,8 +16,28 @@
  */
 package fr.greencodeinitiative.java;
 
+import java.util.Collections;
 import java.util.List;
 
+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.plugins.java.api.CheckRegistrar;
 import org.sonar.plugins.java.api.JavaCheck;
 import org.sonarsource.api.sonarlint.SonarLintSide;
@@ -30,6 +50,27 @@
  */
 @SonarLintSide
 public class JavaCheckRegistrar implements CheckRegistrar {
+    private 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
+    );
 
     /**
      * Register the classes that will be used to instantiate checks during analysis.
@@ -44,13 +85,13 @@ public void register(RegistrarContext registrarContext) {
      * 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 Collections.emptyList();
     }
 }
diff --git a/java-plugin/src/main/java/fr/greencodeinitiative/java/JavaRulesDefinition.java b/java-plugin/src/main/java/fr/greencodeinitiative/java/JavaRulesDefinition.java
@@ -16,30 +16,22 @@
  */
 package fr.greencodeinitiative.java;
 
+import java.util.ArrayList;
+
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.server.rule.RulesDefinition;
 import org.sonarsource.analyzer.commons.RuleMetadataLoader;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Objects;
-import java.util.Set;
-
 /**
  * Declare rule metadata in server repository of rules.
  * That allows to list the rules in the page "Rules".
  */
 public class JavaRulesDefinition implements RulesDefinition {
+    private static final String RESOURCE_BASE_PATH = "io/ecocode/rules/java";
 
-    // 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";
+    private static final String NAME = "ecoCode";
+    private static final String LANGUAGE = "java";
+    static final String REPOSITORY_KEY = "ecocode-java";
 
     private final SonarRuntime sonarRuntime;
 
@@ -53,17 +45,11 @@ public void define(Context context) {
 
         RuleMetadataLoader ruleMetadataLoader = new RuleMetadataLoader(RESOURCE_BASE_PATH, sonarRuntime);
 
-        ruleMetadataLoader.addRulesByAnnotatedClass(repository, new ArrayList<>(RulesList.getChecks()));
-
-        setTemplates(repository);
-
+        ruleMetadataLoader.addRulesByAnnotatedClass(repository, new ArrayList<>(JavaCheckRegistrar.checkClasses()));
         repository.done();
     }
 
-    private static void setTemplates(NewRepository repository) {
-        RULE_TEMPLATES_KEY.stream()
-                .map(repository::rule)
-                .filter(Objects::nonNull)
-                .forEach(rule -> rule.setTemplate(true));
+    public String repositoryKey() {
+        return REPOSITORY_KEY;
     }
 }
diff --git a/java-plugin/src/main/java/fr/greencodeinitiative/java/RulesList.java b/java-plugin/src/main/java/fr/greencodeinitiative/java/RulesList.java
diff --git a/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaPluginTest.java b/java-plugin/src/test/java/fr/greencodeinitiative/java/JavaPluginTest.java
@@ -16,6 +16,7 @@
  */
 package fr.greencodeinitiative.java;
 
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.sonar.api.Plugin;
 import org.sonar.api.SonarRuntime;
@@ -24,14 +25,17 @@
 import static org.mockito.Mockito.mock;
 
 class JavaPluginTest {
+  private Plugin.Context context;
 
-    @Test
-    void testName() {
+    @BeforeEach
+    void init() {
         SonarRuntime sonarRuntime = mock(SonarRuntime.class);
-        Plugin.Context context = new Plugin.Context(sonarRuntime);
-
+        context = new Plugin.Context(sonarRuntime);
         new JavaPlugin().define(context);
+    }
 
+    @Test
+    void test() {
         assertThat(context.getExtensions()).hasSize(2);
     }