SONARPY-3206 SONARPY-3333: Enable parallel rule execution by default (#486)

GitOrigin-RevId: 8df8795e038f8ff02683a5d8c9cd21023c81171c

Author: joke1196

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

@@ -62,7 +62,6 @@ public class PythonScanner extends Scanner {
 
   private static final Logger LOG = LoggerFactory.getLogger(PythonScanner.class);
   private static final Pattern DATABRICKS_MAGIC_COMMAND_PATTERN = Pattern.compile("^\\h*#\\h*(MAGIC|COMMAND).*");
-  public static final String THREADS_PROPERTY_NAME = "sonar.python.analysis.threads";
   private static final String ARCHITECTURE_CALLBACK_LOCK_KEY = "architectureCallbackLock";
 
   private final Supplier<PythonParser> parserSupplier;
@@ -117,7 +116,7 @@ protected void logStart(int numThreads) {
   protected void scanFile(PythonInputFile inputFile) throws IOException {
     var pythonFile = SonarQubePythonFile.create(inputFile);
     InputFile.Type fileType = inputFile.wrappedFile().type();
-    PythonVisitorContext visitorContext = createVisitorContext(inputFile, pythonFile, fileType);
+    PythonVisitorContext visitorContext = createVisitorContext(inputFile, pythonFile);
 
     executeChecks(visitorContext, checks.sonarPythonChecks(), fileType, inputFile);
     executeOtherChecks(inputFile, visitorContext, fileType);
@@ -144,7 +143,7 @@ protected void scanFile(PythonInputFile inputFile) throws IOException {
     searchForDataBricks(visitorContext);
   }
 
-  private PythonVisitorContext createVisitorContext(PythonInputFile inputFile, PythonFile pythonFile, InputFile.Type fileType) throws IOException {
+  private PythonVisitorContext createVisitorContext(PythonInputFile inputFile, PythonFile pythonFile) throws IOException {
     PythonVisitorContext visitorContext;
     try {
       AstNode astNode = parserSupplier.get().parse(inputFile.contents());
@@ -356,12 +355,6 @@ public boolean getFoundDatabricks() {
     return foundDatabricks.get();
   }
 
-  @Override
-  protected int getNumberOfThreads(SensorContext context) {
-    return context.config().getInt(THREADS_PROPERTY_NAME)
-      .orElse(1);
-  }
-
   private void runLockedByRepository(String repositoryKey, Runnable runnable) {
     var repositoryLock = repositoryLocks.computeIfAbsent(repositoryKey, k -> new ReentrantLock());
     try {

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

@@ -32,6 +32,7 @@
 public abstract class Scanner {
   private static final Logger LOG = LoggerFactory.getLogger(Scanner.class);
   private static final String FAIL_FAST_PROPERTY_NAME = "sonar.internal.analysis.failFast";
+  public static final String THREADS_PROPERTY_NAME = "sonar.python.analysis.threads";
   protected final SensorContext context;
 
   protected Scanner(SensorContext context) {
@@ -141,6 +142,16 @@ private static boolean isParseErrorOnTestFile(PythonInputFile file, Exception e)
     return e instanceof RecognitionException && file.wrappedFile().type() == InputFile.Type.TEST;
   }
 
-  protected abstract int getNumberOfThreads(SensorContext context);
+  protected int getNumberOfThreads(SensorContext context) {
+    int minNumOfThreads = 1;
+    int maxNumOfThreads = 6;
+    int availableProcessors = (int) Math.round(Runtime.getRuntime().availableProcessors() * 0.9);
+
+    // Disabling parallelization if threads property is not setup properly
+    return context.config()
+      .getInt(THREADS_PROPERTY_NAME)
+      .map(threads -> threads < 1 ? 1 : threads)
+      .orElse(Math.max(minNumOfThreads, Math.min(availableProcessors, maxNumOfThreads)));
+  }
 
 }

python-commons/src/main/java/org/sonar/plugins/python/indexer/PythonIndexer.java

@@ -161,7 +161,6 @@ public boolean canBeFullyScannedWithoutParsing(PythonInputFile inputFile) {
   public abstract CacheContext cacheContext();
 
   class GlobalSymbolsScanner extends Scanner {
-    private static final String THREADS_PROPERTY_NAME = "sonar.python.symbols.threads";
     protected GlobalSymbolsScanner(SensorContext context) {
       super(context);
     }
@@ -186,12 +185,6 @@ protected void scanFile(PythonInputFile inputFile) throws IOException {
       }
     }
 
-    @Override
-    protected int getNumberOfThreads(SensorContext context) {
-      return context.config().getInt(THREADS_PROPERTY_NAME)
-        .orElse(Math.max(2, Math.min((int) Math.round(Runtime.getRuntime().availableProcessors() * 0.9), 6)));
-    }
-
     @Override
     protected void processException(Exception e, PythonInputFile file) {
       LOG.debug("Unable to construct project-level symbol table for file: {}", file, e);

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

@@ -0,0 +1,90 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.plugins.python;
+
+import java.io.IOException;
+import java.util.Optional;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.config.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+class ScannerTest {
+
+  private SensorContext context;
+  private Configuration configuration;
+  private Scanner scanner;
+
+  private class TestScanner extends Scanner {
+
+    protected TestScanner(SensorContext context) {
+      super(context);
+    }
+
+    @Override
+    protected void logStart(int numThreads) {
+      throw new UnsupportedOperationException("Unimplemented method 'logStart'");
+    }
+
+    @Override
+    protected String name() {
+      throw new UnsupportedOperationException("Unimplemented method 'name'");
+    }
+
+    @Override
+    protected void scanFile(PythonInputFile file) throws IOException {
+      throw new UnsupportedOperationException("Unimplemented method 'scanFile'");
+    }
+
+    @Override
+    protected void processException(Exception e, PythonInputFile file) {
+      throw new UnsupportedOperationException("Unimplemented method 'processException'");
+    }
+
+  }
+
+  @BeforeEach
+  void setUp() {
+    context = mock(SensorContext.class);
+    configuration = mock(Configuration.class);
+    when(context.config()).thenReturn(configuration);
+    scanner = new TestScanner(context);
+  }
+
+  @Test
+  void testGetNumberOfThreads_whenPropertySetToValidValue_shouldReturnConfiguredValue() {
+    when(configuration.getInt("sonar.python.analysis.threads")).thenReturn(Optional.of(4));
+
+    int numberOfThreads = scanner.getNumberOfThreads(context);
+    assertThat(numberOfThreads).isEqualTo(4);
+  }
+
+  @ParameterizedTest
+  @ValueSource(ints = {-1, 0, -12})
+  void testGetNumberOfThreads_whenPropertySetIncorrectly_shouldReturnOne(int threads) {
+    when(configuration.getInt("sonar.python.analysis.threads")).thenReturn(Optional.of(threads));
+
+    int numberOfThreads = scanner.getNumberOfThreads(context);
+    assertThat(numberOfThreads).isEqualTo(1);
+  }
+}

python-commons/src/test/java/org/sonar/plugins/python/indexer/SonarQubePythonIndexerTest.java

@@ -83,7 +83,7 @@ void init() throws IOException {
     Path workDir = Files.createTempDirectory("workDir");
     context.fileSystem().setWorkDir(workDir);
     context.settings().setProperty("sonar.python.skipUnchanged", true);
-    context.settings().setProperty("sonar.python.symbols.threads", 2);
+    context.settings().setProperty("sonar.python.analysis.threads", 2);
 
     writeCache = new TestWriteCache();
     readCache = new TestReadCache();
@@ -480,16 +480,14 @@ void test_notebook_should_not_be_in_project_level_symbol_table() {
   @Test
   void test_sensor_single_thread() throws IOException {
     var contextSingleThread = SensorContextTester.create(baseDir);
-    contextSingleThread.settings().setProperty("sonar.python.symbols.threads", 1);
+    contextSingleThread.settings().setProperty("sonar.python.analysis.threads", 1);
     contextSingleThread.fileSystem().setWorkDir(Files.createTempDirectory("workDir"));
 
     var inputFiles = List.of(createInputFile(baseDir, "main.py", InputFile.Status.SAME, InputFile.Type.MAIN));
     var indexer = new SonarQubePythonIndexer(inputFiles, cacheContext, contextSingleThread, new ProjectConfigurationBuilder());
     indexer.buildOnce(contextSingleThread);
 
     assertThat(indexer.projectLevelSymbolTable().getSymbolsFromModule("main")).isNotEmpty();
-
-
   }
 
   private byte[] importsAsByteArray(List<String> mod) {