Merge branch 'main' into groovy_rules_nomenclature

jhertout · web-flow · commit b4aab3269a1e · 2023-10-12T14:49:14.000+02:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,4 +1,5 @@
 name: Build
+
 on:
   push:
     branches:
@@ -10,39 +11,57 @@ on:
       - '[0-9]+.[0-9]+.[0-9]+'
   pull_request:
     types: [ opened, synchronize, reopened ]
+
 jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read # allows SonarCloud to decorate PRs with analysis results
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+
       - name: Set up JDK 11
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v3
         with:
+          distribution: 'temurin'
           java-version: 11
-      - name: Cache SonarCloud packages
-        uses: actions/cache@v1
-        with:
-          path: ~/.sonar/cache
-          key: ${{ runner.os }}-sonar
-          restore-keys: ${{ runner.os }}-sonar
+
       - name: Cache Maven packages
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
+
       - name: Setup Gradle
         uses: gradle/gradle-build-action@v2
+
       - name: Prepare CodeNarc dependency
         working-directory: .
-        run: |
-          ./tool_prepare-codenarc.sh
-      - name: Build and analyze
-        working-directory: .
+        run: ./tool_prepare-codenarc.sh
+
+      - name: Verify
+        run: mvn -e -B verify
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: 17
+
+      - name: Cache SonarQube packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+
+      - name: SonarQube Scan
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: mvn -e -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=green-code-initiative_ecocode-android
+        run: mvn -e -B org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=green-code-initiative_ecocode-android
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/batch/JobCoalesceRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/batch/JobCoalesceRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.batch;
 
-import com.google.common.collect.ImmutableList;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.MethodMatchers;
@@ -58,7 +57,7 @@ public JobCoalesceRule() {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/batch/SensorCoalesceRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/batch/SensorCoalesceRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.batch;
 
-import com.google.common.collect.ImmutableList;
 import io.ecocode.java.checks.helpers.CheckArgumentComplexTypeUtils;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
@@ -47,7 +46,7 @@ public SensorCoalesceRule() {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/bottleneck/InternetInTheLoopRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/bottleneck/InternetInTheLoopRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.bottleneck;
 
-import com.google.common.collect.ImmutableList;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.MethodMatchers;
@@ -42,7 +41,7 @@ public class InternetInTheLoopRule extends IssuableSubscriptionVisitor {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/bottleneck/UncompressedDataTransmissionRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/bottleneck/UncompressedDataTransmissionRule.java
@@ -32,8 +32,6 @@
 import org.sonar.plugins.java.api.tree.Tree;
 import org.sonar.plugins.java.api.tree.VariableTree;
 
-import com.google.common.collect.ImmutableList;
-
 import io.ecocode.java.checks.helpers.CheckArgumentComplexTypeUtils;
 import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
@@ -54,7 +52,7 @@ public class UncompressedDataTransmissionRule extends IssuableSubscriptionVisito
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.VARIABLE);
+        return List.of(Tree.Kind.VARIABLE);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/idleness/DurableWakeLockRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/idleness/DurableWakeLockRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.idleness;
 
-import com.google.common.collect.ImmutableList;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.MethodMatchers;
@@ -41,7 +40,7 @@ public class DurableWakeLockRule extends IssuableSubscriptionVisitor {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/idleness/KeepVoiceAwakeRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/idleness/KeepVoiceAwakeRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.idleness;
 
-import com.google.common.collect.ImmutableList;
 import io.ecocode.java.checks.helpers.CheckArgumentComplexTypeUtils;
 import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.Loggers;
@@ -57,7 +56,7 @@ public class KeepVoiceAwakeRule extends IssuableSubscriptionVisitor {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.NEW_CLASS, Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.NEW_CLASS, Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/optimized_api/FusedLocationRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/optimized_api/FusedLocationRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.optimized_api;
 
-import com.google.common.collect.ImmutableList;
 import io.ecocode.java.checks.helpers.TreeHelper;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
@@ -47,7 +46,7 @@ public class FusedLocationRule extends IssuableSubscriptionVisitor {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.IMPORT);
+        return List.of(Tree.Kind.IMPORT);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/power/ChargeAwarenessRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/power/ChargeAwarenessRule.java
@@ -31,7 +31,6 @@
 import org.sonar.plugins.java.api.tree.NewClassTree;
 import org.sonar.plugins.java.api.tree.Tree;
 
-import com.google.common.collect.ImmutableList;
 import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 /**
@@ -58,7 +57,7 @@ public class ChargeAwarenessRule extends IssuableSubscriptionVisitor {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.NEW_CLASS, Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.NEW_CLASS, Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/power/SaveModeAwarenessRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/power/SaveModeAwarenessRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.power;
 
-import com.google.common.collect.ImmutableList;
 import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.Loggers;
 import org.sonar.check.Rule;
@@ -48,7 +47,7 @@ public class SaveModeAwarenessRule extends IssuableSubscriptionVisitor {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.NEW_CLASS, Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.NEW_CLASS, Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
@@ -72,10 +71,8 @@ public void visitNode(Tree tree) {
                 if ((addActionMatcher.matches(mit) || createIntentFilterMatcher.matches(mit))
                         && !mit.arguments().isEmpty()) {
                     mit.arguments().get(0).asConstant().ifPresentOrElse(o -> {
-                        if (o instanceof String) {
-                            if (o.equals(ACTION_BATTERY_CHANGED)) {
-                                reportIssue(mit.arguments().get(0), ADVICE_MESSAGE);
-                            }
+                        if (o instanceof String && o.equals(ACTION_BATTERY_CHANGED)) {
+                            reportIssue(mit.arguments().get(0), ADVICE_MESSAGE);
                         }
                     }, () -> {
                         if (isPowerSaveModeMatcher.matches(mit)) {
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/BrightnessOverrideRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/BrightnessOverrideRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.sobriety;
 
-import com.google.common.collect.ImmutableList;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.tree.*;
@@ -41,7 +40,7 @@ public class BrightnessOverrideRule extends IssuableSubscriptionVisitor {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.ASSIGNMENT);
+        return List.of(Tree.Kind.ASSIGNMENT);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/HighFrameRateRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/HighFrameRateRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.sobriety;
 
-import com.google.common.collect.ImmutableList;
 import io.ecocode.java.checks.helpers.CheckArgumentComplexTypeUtils;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
@@ -43,7 +42,7 @@ public HighFrameRateRule() {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/ThriftyGeolocationCriteriaRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/ThriftyGeolocationCriteriaRule.java
@@ -29,7 +29,6 @@
 import org.sonar.plugins.java.api.tree.MethodInvocationTree;
 import org.sonar.plugins.java.api.tree.Tree;
 
-import com.google.common.collect.ImmutableList;
 import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
 /**
@@ -70,7 +69,7 @@ public class ThriftyGeolocationCriteriaRule extends IssuableSubscriptionVisitor
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
@@ -115,9 +114,7 @@ public void visitNode(Tree tree) {
                 ExpressionTree arg = mit.arguments().get(0);
                 Optional<Object> optionalArg = arg.asConstant();
                 try {
-                    if (optionalArg.isPresent() && ((Integer) optionalArg.get()) == 1) {
-                        hasSeenSetPowerRequirement = true;
-                    } else {
+                    if (!(optionalArg.isPresent() && ((Integer) optionalArg.get()) == 1)) {
                         reportIssue(mit, REPORT_MESSAGE_SET_POWER_REQUIREMENT);
                     }
                 } catch (Exception e) {
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/ThriftyGeolocationMinDistanceRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/ThriftyGeolocationMinDistanceRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.sobriety;
 
-import com.google.common.collect.ImmutableList;
 import io.ecocode.java.checks.helpers.TreeHelper;
 import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.Loggers;
@@ -49,7 +48,7 @@ public class ThriftyGeolocationMinDistanceRule extends IssuableSubscriptionVisit
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
@@ -70,7 +69,7 @@ public void visitNode(Tree tree) {
                         TreeHelper.literalValueControl(mit.arguments().get(1), treesToReport, ARGUMENT_VALUE_TO_CONTROL);
                     }
                 } catch (Exception e) {
-                    LOG.debug(String.format("{} Cannot evaluate requestLocationUpdates(...) argument value.", getClass().getName()));
+                    LOG.debug(String.format("%s Cannot evaluate requestLocationUpdates(...) argument value.", getClass().getName()));
                     LOG.debug("Exception: {}", e.getMessage(), e);
                 }
             }
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/ThriftyGeolocationMinTimeRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/ThriftyGeolocationMinTimeRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.sobriety;
 
-import com.google.common.collect.ImmutableList;
 import io.ecocode.java.checks.helpers.TreeHelper;
 import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.Loggers;
@@ -49,7 +48,7 @@ public class ThriftyGeolocationMinTimeRule extends IssuableSubscriptionVisitor {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
@@ -70,7 +69,7 @@ public void visitNode(Tree tree) {
                         TreeHelper.literalValueControl(mit.arguments().get(0), treesToReport, ARGUMENT_VALUE_TO_CONTROL);
                     }
                 } catch (Exception e) {
-                    LOG.debug(String.format("{} Cannot evaluate requestLocationUpdates(...) argument value.", getClass().getName()));
+                    LOG.debug(String.format("%s Cannot evaluate requestLocationUpdates(...) argument value.", getClass().getName()));
                     LOG.debug("Exception: {}", e.getMessage(), e);
                 }
             }
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/ThriftyNotificationRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/ThriftyNotificationRule.java
@@ -17,7 +17,6 @@
  */
 package io.ecocode.java.checks.environment.sobriety;
 
-import com.google.common.collect.ImmutableList;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.MethodMatchers;
@@ -48,7 +47,7 @@ public ThriftyNotificationRule() {
 
     @Override
     public List<Tree.Kind> nodesToVisit() {
-        return ImmutableList.of(Tree.Kind.METHOD_INVOCATION);
+        return List.of(Tree.Kind.METHOD_INVOCATION);
     }
 
     @Override
diff --git a/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/TorchFreeRule.java b/android-plugin/src/main/java/io/ecocode/java/checks/environment/sobriety/TorchFreeRule.java
@@ -43,11 +43,8 @@ public String getMessage() {
 
     @Override
     protected void checkConstantValue(Optional<Object> optionalConstantValue, Tree reportTree, Object constantValueToCheck) {
-        try {
-            if (optionalConstantValue.isPresent() && (optionalConstantValue.get().equals(constantValueToCheck) || ((Boolean) optionalConstantValue.get()))) {
-                reportIssue(reportTree, getMessage());
-            }
-        } catch (Exception ignored) {
+        if (optionalConstantValue.isPresent() && (optionalConstantValue.get().equals(constantValueToCheck) || ((Boolean) optionalConstantValue.get()))) {
+            reportIssue(reportTree, getMessage());
         }
     }
 
