SONARPY-2755 Implement instantiation of all rules for each file (#210)

GitOrigin-RevId: ba3f7280b1131ec45b54dd14fed7e8a39408ffae

Author: maksim-grebeniuk-sonarsource

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

@@ -16,46 +16,73 @@
  */
 package org.sonar.plugins.python;
 
-import java.util.ArrayList;
+import java.util.Collection;
 import java.util.List;
-import java.util.Objects;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Stream;
 import javax.annotation.Nullable;
 import org.sonar.api.batch.rule.CheckFactory;
 import org.sonar.api.batch.rule.Checks;
 import org.sonar.api.rule.RuleKey;
 import org.sonar.plugins.python.api.PythonCheck;
 import org.sonar.plugins.python.api.PythonCustomRuleRepository;
+import org.sonar.plugins.python.api.internal.EndOfAnalysis;
 
 public class PythonChecks {
   private final CheckFactory checkFactory;
-  private List<Checks<PythonCheck>> checksByRepository = new ArrayList<>();
+  private final Map<String, RepositoryChecksInfo> repositoriesChecks;
+  private final Map<Class<? extends PythonCheck>, RuleKey> ruleKeys;
 
   PythonChecks(CheckFactory checkFactory) {
     this.checkFactory = checkFactory;
+    this.repositoriesChecks = new ConcurrentHashMap<>();
+    this.ruleKeys = new ConcurrentHashMap<>();
   }
-  public PythonChecks addChecks(String repositoryKey, Iterable<Class<?>> checkClass) {
-    checksByRepository.add(checkFactory.<PythonCheck>create(repositoryKey).addAnnotatedChecks(checkClass));
 
+  public PythonChecks addChecks(String repositoryKey, Iterable<Class<?>> checkClasses) {
+    var repositoryChecksInfo = new RepositoryChecksInfo(repositoryKey, checkClasses);
+    var checks = createChecks(repositoryChecksInfo);
+    checks.all().forEach(check -> {
+      var checkClass = check.getClass();
+      var ruleKey = checks.ruleKey(check);
+      ruleKeys.put(checkClass, ruleKey);
+    });
+    repositoriesChecks.put(repositoryChecksInfo.repositoryKey, repositoryChecksInfo);
     return this;
   }
 
   public PythonChecks addCustomChecks(@Nullable PythonCustomRuleRepository[] customRuleRepositories) {
-    if (customRuleRepositories != null) {
-      for (PythonCustomRuleRepository ruleRepository : customRuleRepositories) {
-        addChecks(ruleRepository.repositoryKey(), ruleRepository.checkClasses());
-      }
-    }
-
+    Stream.ofNullable(customRuleRepositories)
+      .flatMap(Stream::of)
+      .forEach(ruleRepository -> addChecks(ruleRepository.repositoryKey(), ruleRepository.checkClasses()));
     return this;
   }
 
-  public List<PythonCheck> all() {
-    return checksByRepository.stream().flatMap(c -> c.all().stream()).toList();
+  public synchronized List<PythonCheck> all() {
+    return repositoriesChecks.values().stream()
+      .map(this::createChecks)
+      .map(Checks::all)
+      .flatMap(Collection::stream)
+      .toList();
+  }
+
+  public List<EndOfAnalysis> endOfAnalyses() {
+    return all().stream()
+      .filter(EndOfAnalysis.class::isInstance)
+      .map(EndOfAnalysis.class::cast)
+      .toList();
   }
 
   @Nullable
   public RuleKey ruleKey(PythonCheck check) {
-    return checksByRepository.stream().map(c -> c.ruleKey(check)).filter(Objects::nonNull).findFirst().orElse(null);
+    return ruleKeys.getOrDefault(check.getClass(), null);
   }
 
+  private Checks<PythonCheck> createChecks(RepositoryChecksInfo repositoryChecksInfo) {
+    return checkFactory.<PythonCheck>create(repositoryChecksInfo.repositoryKey).addAnnotatedChecks(repositoryChecksInfo.checkClasses);
+  }
+
+  private record RepositoryChecksInfo(String repositoryKey, Iterable<Class<?>> checkClasses) {}
+
 }

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

@@ -30,6 +30,7 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Supplier;
 import java.util.regex.Pattern;
 import javax.annotation.CheckForNull;
@@ -79,7 +80,7 @@ public class PythonScanner extends Scanner {
   private final NoSonarFilter noSonarFilter;
   private final PythonCpdAnalyzer cpdAnalyzer;
   private final PythonIndexer indexer;
-  private final Map<PythonInputFile, Set<PythonCheck>> checksExecutedWithoutParsingByFiles = new HashMap<>();
+  private final Map<PythonInputFile, Set<Class<? extends PythonCheck>>> checksExecutedWithoutParsingByFiles;
   private int recognitionErrorCount = 0;
   private static final Pattern DATABRICKS_MAGIC_COMMAND_PATTERN = Pattern.compile("^\\h*#\\h*(MAGIC|COMMAND).*");
   private boolean foundDatabricks = false;
@@ -97,6 +98,7 @@ public PythonScanner(
     this.indexer = indexer;
     this.indexer.buildOnce(context);
     this.architectureCallback = architectureCallback;
+    this.checksExecutedWithoutParsingByFiles = new ConcurrentHashMap<>();
   }
 
   @Override
@@ -141,7 +143,7 @@ protected void scanFile(PythonInputFile inputFile) throws IOException {
     List<PythonSubscriptionCheck> checksBasedOnTree = new ArrayList<>();
     for (PythonCheck check : checks.all()) {
       if (!isCheckApplicable(check, fileType)
-        || checksExecutedWithoutParsingByFiles.getOrDefault(inputFile, Collections.emptySet()).contains(check)) {
+        || checksExecutedWithoutParsingByFiles.getOrDefault(inputFile, Collections.emptySet()).contains(check.getClass())) {
         continue;
       }
       if (check instanceof PythonSubscriptionCheck pythonSubscriptionCheck) {
@@ -202,8 +204,8 @@ public boolean scanFileWithoutParsing(PythonInputFile inputFile) {
       }
 
       if (check.scanWithoutParsing(inputFileContext)) {
-        Set<PythonCheck> executedChecks = checksExecutedWithoutParsingByFiles.getOrDefault(inputFile, new HashSet<>());
-        executedChecks.add(check);
+        var executedChecks = checksExecutedWithoutParsingByFiles.getOrDefault(inputFile, new HashSet<>());
+        executedChecks.add(check.getClass());
         checksExecutedWithoutParsingByFiles.putIfAbsent(inputFile, executedChecks);
       } else {
         result = false;
@@ -225,10 +227,7 @@ private boolean checkRequiresParsingOfImpactedFile(PythonInputFile inputFile, Py
   @Override
   public void endOfAnalysis() {
     indexer.postAnalysis(context);
-    checks.all().stream()
-      .filter(EndOfAnalysis.class::isInstance)
-      .map(EndOfAnalysis.class::cast)
-      .forEach(c -> c.endOfAnalysis(indexer.cacheContext()));
+    checks.endOfAnalyses().forEach(c -> c.endOfAnalysis(indexer.cacheContext()));
   }
 
   boolean isCheckApplicable(PythonCheck pythonCheck, InputFile.Type fileType) {