Merge pull request #72 from jycr/feature/ISSUE-67--Rename-rule-IDs

[#67]  rename rule IDs

Author: jhertout

android-plugin/src/main/java/io/ecocode/java/Java.java

@@ -20,11 +20,10 @@
 package io.ecocode.java;
 
 public interface Java { //NOSONAR - we use the interface for constant without inheriting it
-    String REPOSITORY_NAME = "ecoCode";
-    String PROFILE_NAME = "ecoCode";
+    String REPOSITORY_NAME = "ecoCode (Android)";
     String KEY = "java";
-    String REPOSITORY_KEY = "ecoCode-java";
-    // don't change that because the path is hard coded in CheckVerifier
-    String JAVA_RESOURCE_PATH = "/org/sonar/l10n/java/rules/squid"; //NOSONAR - tis URI is the same everywhere
-    String PROFILE_PATH = "org/sonar/l10n/java/rules/squid/ecocode_java_profile.json";
+    String REPOSITORY_KEY = "ecocode-android-java";
+    String RULES_SPECIFICATIONS_JAVA_PATH = "/io/ecocode/rules/java"; //NOSONAR - this URI is the same everywhere
+    String PROFILE_NAME = "ecoCode (Android)";
+    String PROFILE_PATH = "io/ecocode/android/java/ecocode_java_profile.json";
 }

android-plugin/src/main/java/io/ecocode/java/JavaRulesDefinition.java

@@ -37,7 +37,7 @@
 import org.sonar.squidbridge.annotations.RuleTemplate;
 
 /**
- * Declare rule metadata in server repository of rules. 
+ * Declare rule metadata in server repository of rules.
  * That allows to list the rules in the page "Rules".
  */
 public class JavaRulesDefinition implements RulesDefinition {
@@ -84,7 +84,7 @@ private void ruleMetadata(NewRule rule) {
   }
 
   private void addMetadata(NewRule rule, String metadataKey) {
-    URL resource = JavaRulesDefinition.class.getResource(Java.JAVA_RESOURCE_PATH + "/" + metadataKey + "_java.json");
+    URL resource = JavaRulesDefinition.class.getResource(Java.RULES_SPECIFICATIONS_JAVA_PATH + "/" + metadataKey + ".json");
     if (resource != null) {
       RuleMetatada metatada = gson.fromJson(readResource(resource), RuleMetatada.class);
       rule.setSeverity(metatada.defaultSeverity.toUpperCase(Locale.US));
@@ -100,7 +100,7 @@ private void addMetadata(NewRule rule, String metadataKey) {
   }
 
   private static void addHtmlDescription(NewRule rule, String metadataKey) {
-    URL resource = JavaRulesDefinition.class.getResource(Java.JAVA_RESOURCE_PATH + "/" + metadataKey + "_java.html");
+    URL resource = JavaRulesDefinition.class.getResource(Java.RULES_SPECIFICATIONS_JAVA_PATH + "/" + metadataKey + ".html");
     if (resource != null) {
       rule.setHtmlDescription(readResource(resource));
     }

android-plugin/src/main/java/io/ecocode/java/checks/environment/batch/JobCoalesceRule.java

@@ -26,16 +26,18 @@
 import org.sonar.plugins.java.api.semantic.MethodMatchers;
 import org.sonar.plugins.java.api.tree.MethodInvocationTree;
 import org.sonar.plugins.java.api.tree.Tree;
+import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 import java.util.List;
 
 /**
  * Checks the call of "set", "setAlarmClock", "setExact", "setInexactRepeating", "setRepeating" & "setWindow" from "android.app.AlarmManager".
  * Checks also the call of "onPerformSync" & "getSyncAdapterBinder" from "android.content.AbstractThreadedSyncAdapter".
  */
-@Rule(key = "EBAT003", name = "ecocodeJobCoalesce")
+@Rule(key = "EC501")
+@DeprecatedRuleKey(repositoryKey = "ecoCode-java", ruleKey = "EBAT003")
 public class JobCoalesceRule extends IssuableSubscriptionVisitor {
-	
+
 	private static final String ALARM_MANAGER_CLASS = "android.app.AlarmManager";
 
     private final MethodMatchers alarmSchedulerMethodMatcher = MethodMatchers.or(

android-plugin/src/main/java/io/ecocode/java/checks/environment/batch/SensorCoalesceRule.java

@@ -28,6 +28,7 @@
 import org.sonar.plugins.java.api.tree.ExpressionTree;
 import org.sonar.plugins.java.api.tree.MethodInvocationTree;
 import org.sonar.plugins.java.api.tree.Tree;
+import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 import java.util.List;
 import java.util.Optional;
@@ -36,7 +37,8 @@
  * Check the call of the method "registerListener" of "android.hardware.SensorManager" with 4 parameters (the 4th one being the latency).
  * If it isn't present, report issue.
  */
-@Rule(key = "EBAT002", name = "ecoCodeSensorCoalesce")
+@Rule(key = "EC500")
+@DeprecatedRuleKey(repositoryKey = "ecoCode-java", ruleKey = "EBAT002")
 public class SensorCoalesceRule extends IssuableSubscriptionVisitor {
 
     private final MethodMatchers sensorListenerMethodMatcher = MethodMatchers.create().ofTypes("android.hardware.SensorManager").names("registerListener").withAnyParameters().build();

android-plugin/src/main/java/io/ecocode/java/checks/environment/bottleneck/InternetInTheLoopRule.java

@@ -25,14 +25,16 @@
 import org.sonar.plugins.java.api.semantic.MethodMatchers;
 import org.sonar.plugins.java.api.tree.MethodInvocationTree;
 import org.sonar.plugins.java.api.tree.Tree;
+import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 import java.util.List;
 
 /**
  * Check if the method openConnection of the Url class is called inside a loop.
  * Not thrown if openConnection() call is deported into an other method.
  */
-@Rule(key = "EBOT001", name = "ecocodeInternetInTheLoop")
+@Rule(key = "EC502")
+@DeprecatedRuleKey(repositoryKey = "ecoCode-java", ruleKey = "EBOT001")
 public class InternetInTheLoopRule extends IssuableSubscriptionVisitor {
 
     private static final String ERROR_MESSAGE = "Internet connection should not be opened in loops to preserve the battery.";
@@ -67,4 +69,4 @@ private void reportIssueIfInLoop(Tree treeToCheck, Tree issueTree) {
             reportIssueIfInLoop(treeToCheck.parent(), issueTree);
         }
     }
-}
+}

android-plugin/src/main/java/io/ecocode/java/checks/environment/bottleneck/UncompressedDataTransmissionRule.java

@@ -37,16 +37,18 @@
 import com.google.common.collect.ImmutableList;
 
 import io.ecocode.java.checks.helpers.CheckArgumentComplexTypeUtils;
+import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 /**
  * If an OutputStream class is created:
  * - if the method getOutputStream from the URLConnection class is called, reports the issue.
  * - if a constructor is called with for parameter getOutputStream, reports the issue if the constructor isn't a GZIPOutputStream.
  */
-@Rule(key = "EBOT003", name = "ecoCodeUncompressedDataTransmission")
+@Rule(key = "EC504")
+@DeprecatedRuleKey(repositoryKey = "ecoCode-java", ruleKey = "EBOT003")
 public class UncompressedDataTransmissionRule extends IssuableSubscriptionVisitor {
     private static final Logger LOG = Loggers.get(UncompressedDataTransmissionRule.class);
-    
+
     private static final String ERROR_MESSAGE = "Prefer using GzipOutputStream instead of OutputStream to improve energy efficiency.";
     private static final MethodMatchers matcherUrlConnection = MethodMatchers.create().ofSubTypes("java.net.URLConnection").names("getOutputStream").addWithoutParametersMatcher().build();
     // TODO: 22/03/2022 Change methodMatcher for anything but a "new GZIPOutputStream()", the new being the problem here.
@@ -105,4 +107,4 @@ private void checkMethodInitilization(Tree treeToCheck, Tree treeToReport) {
             LOG.error("Error in checkMethodInitilization : {}", e.getMessage(), e);
         }
     }
-}
+}

android-plugin/src/main/java/io/ecocode/java/checks/environment/bottleneck/WifiMulticastLockRule.java

@@ -21,13 +21,15 @@
 
 import io.ecocode.java.checks.helpers.OpeningClosingMethodCheck;
 import org.sonar.check.Rule;
+import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 /**
  * Check that WifiManager.MulticastLock#release() method is closed after WifiManager.MulticastLock#acquire().
  *
  * @see OpeningClosingMethodCheck
  */
-@Rule(key = "EBOT002", name = "ecoCodeWifiMulticastLock")
+@Rule(key = "EC503")
+@DeprecatedRuleKey(repositoryKey = "ecoCode-java", ruleKey = "EBOT002")
 public class WifiMulticastLockRule extends OpeningClosingMethodCheck {
     private static final String ERROR_MESSAGE = "Failing to call WifiManager.MulticastLock#release() can cause a noticeable battery drain.";
 

android-plugin/src/main/java/io/ecocode/java/checks/environment/idleness/ContinuousRenderingRule.java

@@ -21,12 +21,14 @@
 
 import io.ecocode.java.checks.helpers.constant.FlagOnMethodCheck;
 import org.sonar.check.Rule;
+import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 /**
  * Check the call of the method "setRenderMode" of "opengl.GLSurfaceView".
  * If argument value is "1" report issue.
  */
-@Rule(key = "EIDL008", name = "ecocodeContinuousRendering")
+@Rule(key = "EC510")
+@DeprecatedRuleKey(repositoryKey = "ecoCode-java", ruleKey = "EIDL008")
 public class ContinuousRenderingRule extends FlagOnMethodCheck {
 
     public ContinuousRenderingRule() {

android-plugin/src/main/java/io/ecocode/java/checks/environment/idleness/DurableWakeLockRule.java

@@ -25,14 +25,16 @@
 import org.sonar.plugins.java.api.semantic.MethodMatchers;
 import org.sonar.plugins.java.api.tree.MethodInvocationTree;
 import org.sonar.plugins.java.api.tree.Tree;
+import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 import java.util.List;
 
 /**
  * Check the call of the method "acquire" of "android.os.PowerManager$WakeLock".
  * Reports an issue if found without any parameters.
  */
-@Rule(key = "EIDL006", name = "ecocodeDurableWakeLock")
+@Rule(key = "EC508")
+@DeprecatedRuleKey(repositoryKey = "ecoCode-java", ruleKey = "EIDL006")
 public class DurableWakeLockRule extends IssuableSubscriptionVisitor {
     private String methodOwnerType = "android.os.PowerManager$WakeLock";
     private String methodName = "acquire";

android-plugin/src/main/java/io/ecocode/java/checks/environment/idleness/KeepCpuOnRule.java

@@ -21,12 +21,14 @@
 
 import io.ecocode.java.checks.helpers.SpecificMethodCheck;
 import org.sonar.check.Rule;
+import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 /**
  * Check the call of the method "newWakeLock" of "android.os.PowerManager".
  * Reports an issue if found.
  */
-@Rule(key = "EIDL004", name = "ecocodeKeepCpuOn")
+@Rule(key = "EC507")
+@DeprecatedRuleKey(repositoryKey = "ecoCode-java", ruleKey = "EIDL004")
 public class KeepCpuOnRule extends SpecificMethodCheck {