SONARPY-2764 Add analysis property to change number of threads or disable parallel (#221)

GitOrigin-RevId: 0ce2700c26e08a73c9af2dfad8d1957c3a87efda

Author: ghislainpiot

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

@@ -76,6 +76,7 @@ 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 final Supplier<PythonParser> parserSupplier;
   private final PythonChecks checks;
@@ -113,8 +114,14 @@ protected String name() {
   @Override
   protected void processFiles(List<PythonInputFile> files, SensorContext context, MultiFileProgressReport progressReport,
     AtomicInteger numScannedWithoutParsing) {
-    ForkJoinPool pool = new ForkJoinPool(1);
+    var numberOfThreads = getNumberOfThreads(context);
+    if (numberOfThreads == 1) {
+      super.processFiles(files, context, progressReport, numScannedWithoutParsing);
+      return;
+    }
+    var pool = new ForkJoinPool(numberOfThreads);
     try {
+      LOG.debug("Scanning files in {} threads", numberOfThreads);
       pool.submit(() -> super.processFiles(files, context, progressReport, numScannedWithoutParsing))
         .join();
     } finally {
@@ -124,7 +131,7 @@ protected void processFiles(List<PythonInputFile> files, SensorContext context,
 
   @Override
   protected Stream<PythonInputFile> getFilesStream(List<PythonInputFile> files) {
-    return files.stream().parallel();
+    return getNumberOfThreads(context) == 1 ? files.stream() : files.stream().parallel();
   }
 
   @Override
@@ -451,4 +458,9 @@ public int getRecognitionErrorCount() {
   public boolean getFoundDatabricks() {
     return foundDatabricks.get();
   }
+
+  private static Integer getNumberOfThreads(SensorContext context) {
+    return context.config().getInt(THREADS_PROPERTY_NAME)
+      .orElse(1);
+  }
 }

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

@@ -345,8 +345,9 @@ void test_symbol_visitor() {
     verifyUsages(key, 47, 5, reference(48, 14, 48, 17));
   }
 
-  @Test
-  void test_issues() {
+  @ParameterizedTest
+  @ValueSource(ints = {1, 2})
+  void test_issues(int threads) {
     activeRules = new ActiveRulesBuilder()
       .addRule(new NewActiveRule.Builder()
         .setRuleKey(RuleKey.of(PythonRuleRepository.REPOSITORY_KEY, ONE_STATEMENT_PER_LINE_RULE_KEY))
@@ -361,6 +362,7 @@ void test_issues() {
       .build();
 
     PythonInputFile inputFile = inputFile(FILE_2);
+    context.settings().setProperty(PythonScanner.THREADS_PROPERTY_NAME, String.valueOf(threads));
     sensor().execute(context);
 
     assertThat(context.allIssues()).hasSize(3);
@@ -404,7 +406,11 @@ void test_issues() {
     assertThat(logTester.logs(Level.INFO)).contains("Starting global symbols computation");
     assertThat(logTester.logs(Level.INFO)).contains("Starting rules execution");
     assertThat(logTester.logs(Level.INFO).stream().filter(line -> line.equals("1 source file to be analyzed")).count()).isEqualTo(2);
-
+    if (threads == 1) {
+      assertThat(logTester.logs(Level.DEBUG)).doesNotContain("Scanning files in");
+    } else {
+      assertThat(logTester.logs(Level.DEBUG)).contains("Scanning files in " + threads + " threads");
+    }
     assertThat(PythonScanner.getWorkingDirectory(context)).isEqualTo(workDir.toFile());
   }