SONARPY-2894 Ensure custom rules repositories reuse the same PythonCheck instances to avoid a change in behavior (#242)

GitOrigin-RevId: 6973c21af2bdf75010e412e6f6722c3d079b2680

Author: ghislainpiot

python-commons/src/main/java/org/sonar/plugins/python/PythonChecks.java

@@ -36,7 +36,7 @@ public class PythonChecks {
 
   private final CheckFactory checkFactory;
   private final Map<String, RepositoryChecksInfo> sonarPythonRepositoriesChecks;
-  private final Map<String, RepositoryChecksInfo> noSonarPythonRepositoriesChecks;
+  private final Map<String, Checks<PythonCheck>> noSonarPythonRepositoriesChecks;
   private final Map<Class<? extends PythonCheck>, RuleKey> ruleKeys;
 
   PythonChecks(CheckFactory checkFactory) {
@@ -57,7 +57,7 @@ public PythonChecks addChecks(String repositoryKey, Iterable<Class<?>> checkClas
     if (SONAR_PYTHON_REPOSITORIES.contains(repositoryKey)) {
       sonarPythonRepositoriesChecks.put(repositoryChecksInfo.repositoryKey, repositoryChecksInfo);
     } else {
-      noSonarPythonRepositoriesChecks.put(repositoryChecksInfo.repositoryKey, repositoryChecksInfo);
+      noSonarPythonRepositoriesChecks.put(repositoryChecksInfo.repositoryKey, createChecks(repositoryChecksInfo));
     }
     return this;
   }
@@ -78,11 +78,11 @@ public synchronized List<PythonCheck> sonarPythonChecks() {
   }
 
   public synchronized Map<String, List<PythonCheck>> noSonarPythonChecks() {
-    return noSonarPythonRepositoriesChecks.values()
+    return noSonarPythonRepositoriesChecks.entrySet()
       .stream()
-      .collect(Collectors.toMap(
-        RepositoryChecksInfo::repositoryKey,
-        repositoryChecksInfo -> createChecks(repositoryChecksInfo).all().stream().toList()));
+      .collect(Collectors.toMap(Map.Entry::getKey,
+        entry -> entry.getValue().all().stream().toList())
+      );
   }
 
   public List<EndOfAnalysis> sonarPythonEndOfAnalyses() {

python-commons/src/test/java/org/sonar/plugins/python/PythonSensorTest.java

@@ -31,6 +31,7 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
+import java.util.concurrent.atomic.AtomicInteger;
 import java.util.function.Function;
 import javax.annotation.Nullable;
 import org.junit.jupiter.api.BeforeEach;
@@ -141,6 +142,7 @@ class PythonSensorTest {
   private static final String CUSTOM_REPOSITORY_KEY = "customKey";
   private static final String CUSTOM_RULE_KEY = "key";
   private static final String RULE_CRASHING_ON_SCAN_KEY = "key2";
+  private static final String END_OF_ANALYSIS_KEY = "key3";
 
   private static final Version SONARLINT_DETECTABLE_VERSION = Version.create(6, 0);
 
@@ -154,7 +156,7 @@ public String repositoryKey() {
 
     @Override
     public List<Class<?>> checkClasses() {
-      return List.of(MyCustomRule.class, RuleCrashingOnRegularScan.class);
+      return List.of(MyCustomRule.class, RuleCrashingOnRegularScan.class, AccumulatingForEndOfAnalysis.class);
     }
   }};
   private static Path workDir;
@@ -164,9 +166,7 @@ public List<Class<?>> checkClasses() {
     name = "name",
     description = "desc",
     tags = {"bug"})
-  public static class MyCustomRule implements PythonCheck, EndOfAnalysis {
-
-    private static final Logger LOG = LoggerFactory.getLogger(MyCustomRule.class);
+  public static class MyCustomRule implements PythonCheck {
 
     @RuleProperty(
       key = "customParam",
@@ -184,10 +184,6 @@ public boolean scanWithoutParsing(PythonInputFileContext inputFile) {
       return false;
     }
 
-    @Override
-    public void endOfAnalysis(CacheContext cacheContext) {
-      LOG.trace("End of analysis called!");
-    }
   }
 
   @Rule(
@@ -208,6 +204,27 @@ public boolean scanWithoutParsing(PythonInputFileContext inputFile) {
     }
   }
 
+  @Rule(key = END_OF_ANALYSIS_KEY)
+  public static class AccumulatingForEndOfAnalysis implements PythonCheck, EndOfAnalysis {
+    private static final Logger LOG = LoggerFactory.getLogger(AccumulatingForEndOfAnalysis.class);
+    private final AtomicInteger scanFileCount = new AtomicInteger(0);
+
+    @Override
+    public void scanFile(PythonVisitorContext visitorContext) {
+      scanFileCount.incrementAndGet();
+    }
+
+    @Override
+    public boolean scanWithoutParsing(PythonInputFileContext inputFile) {
+      return false;
+    }
+
+    @Override
+    public void endOfAnalysis(CacheContext cacheContext) {
+      LOG.trace("End of analysis called with {} files", scanFileCount.get());
+    }
+  }
+
   private final File baseDir = new File("src/test/resources/org/sonar/plugins/python/sensor").getAbsoluteFile();
 
   private SensorContextTester context;
@@ -506,15 +523,16 @@ void not_relying_on_stubs_for_project_under_analysis_2() {
 
   @Test
   void end_of_analysis_called() {
+    inputFile(FILE_1);
     inputFile(FILE_2);
     activeRules = new ActiveRulesBuilder()
       .addRule(new NewActiveRule.Builder()
-        .setRuleKey(RuleKey.of(CUSTOM_REPOSITORY_KEY, CUSTOM_RULE_KEY))
+        .setRuleKey(RuleKey.of(CUSTOM_REPOSITORY_KEY, END_OF_ANALYSIS_KEY))
         .build())
       .build();
     sensor().execute(context);
 
-    assertThat(traceLogTester.logs(Level.TRACE)).containsExactly("End of analysis called!");
+    assertThat(traceLogTester.logs(Level.TRACE)).containsExactly("End of analysis called with 2 files");
   }
 
   @Test