SONARPY-3287: Introduce alias boolean property 'sonar.python.analysis.parallel' (#487)

GitOrigin-RevId: 95190c61590396607aa6085ccf8b95315f8952f0

Author: joke1196

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

@@ -32,7 +32,9 @@
 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";
+  private static final int MAX_NUMBER_OF_THREADS = 6;
   public static final String THREADS_PROPERTY_NAME = "sonar.python.analysis.threads";
+  public static final String PARALLEL_PROPERTY_NAME = "sonar.python.analysis.parallel";
   protected final SensorContext context;
 
   protected Scanner(SensorContext context) {
@@ -65,8 +67,7 @@ protected void processFiles(List<PythonInputFile> files, SensorContext context,
       var allTasks = CompletableFuture.allOf(
         files.stream()
           .map(file -> CompletableFuture.runAsync(() -> processFile(context, file, progressReport, numScannedWithoutParsing), executor))
-          .toArray(CompletableFuture[]::new)
-      );
+          .toArray(CompletableFuture[]::new));
       allTasks.join();
     } catch (CompletionException e) {
       var cause = e.getCause();
@@ -143,15 +144,18 @@ private static boolean isParseErrorOnTestFile(PythonInputFile file, Exception e)
   }
 
   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)));
+    boolean isParallelizationEnabled = context.config().getBoolean(PARALLEL_PROPERTY_NAME).orElse(true);
+    if (isParallelizationEnabled) {
+      int minNumOfThreads = 1;
+      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, MAX_NUMBER_OF_THREADS)));
+    }
+    return 1;
   }
 
 }

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

@@ -74,7 +74,6 @@ void setUp() {
   @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);
   }
@@ -87,4 +86,26 @@ void testGetNumberOfThreads_whenPropertySetIncorrectly_shouldReturnOne(int threa
     int numberOfThreads = scanner.getNumberOfThreads(context);
     assertThat(numberOfThreads).isEqualTo(1);
   }
+
+  @Test
+  void testGetNumberOfThreads_whenParallelPropertyIsFalse_shouldReturnOne() {
+    when(configuration.getInt("sonar.python.analysis.threads")).thenReturn(Optional.of(4));
+    when(configuration.getBoolean("sonar.python.analysis.parallel")).thenReturn(Optional.of(false));
+
+    int numberOfThreads = scanner.getNumberOfThreads(context);
+    assertThat(numberOfThreads).isEqualTo(1);
+  }
+
+  @Test
+  void testGetNumberOfThreads_whenParallelPropertyIsTrueOrNotSet_shouldReturnConfiguredValue() {
+    when(configuration.getInt("sonar.python.analysis.threads")).thenReturn(Optional.of(4));
+    when(configuration.getBoolean("sonar.python.analysis.parallel")).thenReturn(Optional.empty());
+    int numberOfThreads = scanner.getNumberOfThreads(context);
+    assertThat(numberOfThreads).isEqualTo(4);
+
+    when(configuration.getBoolean("sonar.python.analysis.parallel")).thenReturn(Optional.of(true));
+    numberOfThreads = scanner.getNumberOfThreads(context);
+    assertThat(numberOfThreads).isEqualTo(4);
+
+  }
 }