SONARPY-2788 Solve no Pyspark issue raised on SonarQubeCloud (#185)

GitOrigin-RevId: 6d6d43006cc8e70f72ce4f50a37336d3b03fff28

Author: thomas-serre-sonarsource

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

@@ -24,14 +24,18 @@
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.config.PropertyDefinition;
 import org.sonar.api.resources.Qualifiers;
+import org.sonar.plugins.python.api.PythonCustomRuleRepositoryWrapper;
 import org.sonar.plugins.python.api.SonarLintCache;
+import org.sonar.plugins.python.api.SonarLintCacheWrapper;
 import org.sonar.plugins.python.architecture.ArchitectureCallbackWrapper;
 import org.sonar.plugins.python.bandit.BanditRulesDefinition;
 import org.sonar.plugins.python.bandit.BanditSensor;
 import org.sonar.plugins.python.coverage.PythonCoverageSensor;
 import org.sonar.plugins.python.editions.OpenSourceRepositoryInfoProvider;
+import org.sonar.plugins.python.editions.RepositoryInfoProviderWrapper;
 import org.sonar.plugins.python.flake8.Flake8RulesDefinition;
 import org.sonar.plugins.python.flake8.Flake8Sensor;
+import org.sonar.plugins.python.indexer.PythonIndexerWrapper;
 import org.sonar.plugins.python.indexer.SonarLintPythonIndexer;
 import org.sonar.plugins.python.mypy.MypyRulesDefinition;
 import org.sonar.plugins.python.mypy.MypySensor;
@@ -74,7 +78,11 @@ public static void addCommonExtensions(Plugin.Context context) {
       PythonRuleRepository.class,
       AnalysisWarningsWrapper.class,
       ArchitectureCallbackWrapper.class,
-
+      PythonCustomRuleRepositoryWrapper.class,
+      PythonIndexerWrapper.class,
+      RepositoryInfoProviderWrapper.class,
+      SonarLintCacheWrapper.class, 
+      
       IPynb.class,
       IPynbProfile.class,
       IPynbSensor.class,

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

@@ -21,7 +21,9 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
+
 import javax.annotation.Nullable;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sonar.api.SonarProduct;
@@ -35,16 +37,18 @@
 import org.sonar.api.issue.NoSonarFilter;
 import org.sonar.api.measures.FileLinesContextFactory;
 import org.sonar.plugins.python.api.ProjectPythonVersion;
-import org.sonar.plugins.python.api.PythonCustomRuleRepository;
+import org.sonar.plugins.python.api.PythonCustomRuleRepositoryWrapper;
 import org.sonar.plugins.python.api.PythonFileConsumer;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.plugins.python.api.SonarLintCache;
+import org.sonar.plugins.python.api.SonarLintCacheWrapper;
 import org.sonar.plugins.python.api.caching.CacheContext;
 import org.sonar.plugins.python.architecture.ArchitectureCallbackWrapper;
-import org.sonar.plugins.python.editions.OpenSourceRepositoryInfoProvider;
 import org.sonar.plugins.python.editions.RepositoryInfoProvider;
 import org.sonar.plugins.python.editions.RepositoryInfoProvider.RepositoryInfo;
+import org.sonar.plugins.python.editions.RepositoryInfoProviderWrapper;
 import org.sonar.plugins.python.indexer.PythonIndexer;
+import org.sonar.plugins.python.indexer.PythonIndexerWrapper;
 import org.sonar.plugins.python.indexer.SonarQubePythonIndexer;
 import org.sonar.plugins.python.warnings.AnalysisWarningsWrapper;
 import org.sonar.python.caching.CacheContextImpl;
@@ -71,53 +75,28 @@ public final class PythonSensor implements Sensor {
   private final AnalysisWarningsWrapper analysisWarnings;
   private static final Logger LOG = LoggerFactory.getLogger(PythonSensor.class);
   static final String UNSET_VERSION_WARNING = "Your code is analyzed as compatible with all Python 3 versions by default." +
-    " You can get a more precise analysis by setting the exact Python version in your configuration via the parameter \"sonar.python" +
+    " You can get a more precise analysis by setting the exact Python version in your configuration via the parameter \"sonar.python"+
     ".version\"";
 
   private final SensorTelemetryStorage sensorTelemetryStorage;
 
-  /**
-   * Constructor to be used by pico if neither PythonCustomRuleRepository nor PythonIndexer are to be found and injected.
-   */
-  public PythonSensor(FileLinesContextFactory fileLinesContextFactory, CheckFactory checkFactory,
-    NoSonarFilter noSonarFilter, AnalysisWarningsWrapper analysisWarnings, ArchitectureCallbackWrapper architectureCallbackWrapper  ) {
-    this(fileLinesContextFactory, checkFactory, noSonarFilter, null, null, null, analysisWarnings,
-      new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()}, architectureCallbackWrapper);
-  }
-
-  public PythonSensor(FileLinesContextFactory fileLinesContextFactory, CheckFactory checkFactory, NoSonarFilter noSonarFilter,
-    @Nullable PythonCustomRuleRepository[] customRuleRepositories, AnalysisWarningsWrapper analysisWarnings, ArchitectureCallbackWrapper architectureCallbackWrapper) {
-    this(fileLinesContextFactory, checkFactory, noSonarFilter, customRuleRepositories, null, null, analysisWarnings,
-      new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()}, architectureCallbackWrapper);
-  }
-
-  public PythonSensor(FileLinesContextFactory fileLinesContextFactory, CheckFactory checkFactory, NoSonarFilter noSonarFilter,
-    PythonIndexer indexer, SonarLintCache sonarLintCache, AnalysisWarningsWrapper analysisWarnings, ArchitectureCallbackWrapper architectureCallbackWrapper) {
-    // ^^ This constructor implicitly assumes that a PythonIndexer and a SonarLintCache are always available at the same time.
-    // In practice, this is currently the case, since both are provided by PythonPlugin under the same conditions.
-    // See also PythonPlugin::SonarLintPluginAPIManager::addSonarlintPythonIndexer.
-    this(fileLinesContextFactory, checkFactory, noSonarFilter, null, indexer, sonarLintCache, analysisWarnings,
-      new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()}, architectureCallbackWrapper);
-  }
-
   public PythonSensor(
     FileLinesContextFactory fileLinesContextFactory,
     CheckFactory checkFactory,
     NoSonarFilter noSonarFilter,
-    @Nullable PythonCustomRuleRepository[] customRuleRepositories,
-    @Nullable PythonIndexer indexer,
-    @Nullable SonarLintCache sonarLintCache,
+    PythonCustomRuleRepositoryWrapper customRuleRepositoriesWrapper,
+    PythonIndexerWrapper indexerWrapper,
+    SonarLintCacheWrapper sonarLintCacheWrapper,
     AnalysisWarningsWrapper analysisWarnings,
-    RepositoryInfoProvider[] editionMetadataProviders,
+    RepositoryInfoProviderWrapper editionMetadataProviderWrapper,
     ArchitectureCallbackWrapper architectureUDGBuilderWrapper) {
 
-    this.checks = createPythonChecks(checkFactory, editionMetadataProviders)
-      .addCustomChecks(customRuleRepositories);
-
+    this.checks = createPythonChecks(checkFactory, editionMetadataProviderWrapper.infoProviders())
+        .addCustomChecks(customRuleRepositoriesWrapper.customRuleRepositories());
     this.fileLinesContextFactory = fileLinesContextFactory;
     this.noSonarFilter = noSonarFilter;
-    this.indexer = indexer;
-    this.sonarLintCache = sonarLintCache;
+    this.indexer = indexerWrapper.indexer();
+    this.sonarLintCache = sonarLintCacheWrapper.sonarLintCache();
     this.analysisWarnings = analysisWarnings;
     this.sensorTelemetryStorage = new SensorTelemetryStorage();
     this.architectureCallback = architectureUDGBuilderWrapper.architectureUdgBuilder();

python-commons/src/main/java/org/sonar/plugins/python/editions/RepositoryInfoProviderWrapper.java

@@ -0,0 +1,40 @@
+/*
+ * 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.editions;
+
+import org.sonar.api.scanner.ScannerSide;
+import org.sonarsource.api.sonarlint.SonarLintSide;
+
+@ScannerSide
+@SonarLintSide
+public class RepositoryInfoProviderWrapper {
+
+  private final RepositoryInfoProvider[] editionMetadataProviders;
+
+  public RepositoryInfoProviderWrapper() {
+    // Constructor to be used by pico if no editionMetadataProviders are to be found and injected.
+    this(new RepositoryInfoProvider[] {new OpenSourceRepositoryInfoProvider()});
+  }
+
+  public RepositoryInfoProviderWrapper(RepositoryInfoProvider[] editionMetadataProviders) {
+    this.editionMetadataProviders = editionMetadataProviders;
+  }
+
+  public RepositoryInfoProvider[] infoProviders() {
+    return editionMetadataProviders;
+  }
+}

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

@@ -0,0 +1,44 @@
+/*
+ * 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.indexer;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nullable;
+
+import org.sonar.api.scanner.ScannerSide;
+import org.sonarsource.api.sonarlint.SonarLintSide;
+
+@ScannerSide
+@SonarLintSide
+public class PythonIndexerWrapper {
+
+  private final PythonIndexer indexer;
+
+  public PythonIndexerWrapper() {
+    // Constructor to be used by pico if no indexer is to be found and injected.
+    this(null);
+  }
+
+  public PythonIndexerWrapper(@Nullable PythonIndexer indexer) {
+    this.indexer = indexer;
+  }
+
+  @CheckForNull
+  public PythonIndexer indexer() {
+    return indexer;
+  }
+}

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

@@ -43,10 +43,10 @@ class PythonExtensionsTest {
   void testGetExtensions() {
     Version v79 = Version.create(7, 9);
     SonarRuntime runtime = SonarRuntimeImpl.forSonarQube(v79, SonarQubeSide.SERVER, SonarEdition.DEVELOPER);
-    assertThat(extensions(runtime)).hasSize(36);
+    assertThat(extensions(runtime)).hasSize(40);
     assertThat(extensions(runtime)).contains(AnalysisWarningsWrapper.class);
     assertThat(extensions(SonarRuntimeImpl.forSonarLint(v79)))
-      .hasSize(16)
+      .hasSize(20)
       .contains(SonarLintCache.class);
   }
 

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

@@ -79,21 +79,22 @@
 import org.sonar.plugins.python.api.ProjectPythonVersion;
 import org.sonar.plugins.python.api.PythonCheck;
 import org.sonar.plugins.python.api.PythonCustomRuleRepository;
+import org.sonar.plugins.python.api.PythonCustomRuleRepositoryWrapper;
 import org.sonar.plugins.python.api.PythonFileConsumer;
 import org.sonar.plugins.python.api.PythonInputFileContext;
 import org.sonar.plugins.python.api.PythonVersionUtils;
 import org.sonar.plugins.python.api.PythonVisitorContext;
-import org.sonar.plugins.python.api.SonarLintCache;
+import org.sonar.plugins.python.api.SonarLintCacheWrapper;
 import org.sonar.plugins.python.api.caching.CacheContext;
 import org.sonar.plugins.python.api.internal.EndOfAnalysis;
 import org.sonar.plugins.python.api.tree.Token;
 import org.sonar.plugins.python.architecture.ArchitectureCallbackWrapper;
 import org.sonar.plugins.python.caching.Caching;
 import org.sonar.plugins.python.caching.TestReadCache;
 import org.sonar.plugins.python.caching.TestWriteCache;
-import org.sonar.plugins.python.editions.OpenSourceRepositoryInfoProvider;
-import org.sonar.plugins.python.editions.RepositoryInfoProvider;
+import org.sonar.plugins.python.editions.RepositoryInfoProviderWrapper;
 import org.sonar.plugins.python.indexer.PythonIndexer;
+import org.sonar.plugins.python.indexer.PythonIndexerWrapper;
 import org.sonar.plugins.python.indexer.SonarLintPythonIndexer;
 import org.sonar.plugins.python.indexer.TestModuleFileSystem;
 import org.sonar.plugins.python.warnings.AnalysisWarningsWrapper;
@@ -1523,25 +1524,16 @@ private PythonSensor sensor(@Nullable PythonCustomRuleRepository[] customRuleRep
     FileLinesContext fileLinesContext = mock(FileLinesContext.class);
     when(fileLinesContextFactory.createFor(Mockito.any(InputFile.class))).thenReturn(fileLinesContext);
     CheckFactory checkFactory = new CheckFactory(activeRules);
-    if (indexer == null && customRuleRepositories == null) {
-      return new PythonSensor(fileLinesContextFactory, checkFactory, mock(NoSonarFilter.class), analysisWarnings, architectureUDGBuilderWrapper);
-    }
-    if (indexer == null) {
-      return new PythonSensor(fileLinesContextFactory, checkFactory, mock(NoSonarFilter.class), customRuleRepositories, analysisWarnings, architectureUDGBuilderWrapper);
-    }
-    if (customRuleRepositories == null) {
-      return new PythonSensor(fileLinesContextFactory, checkFactory, mock(NoSonarFilter.class), indexer, new SonarLintCache(), analysisWarnings, architectureUDGBuilderWrapper);
-    }
     return new PythonSensor(
       fileLinesContextFactory,
       checkFactory,
       mock(NoSonarFilter.class),
-      customRuleRepositories,
-      indexer,
-      new SonarLintCache(),
+      new PythonCustomRuleRepositoryWrapper(customRuleRepositories),
+      new PythonIndexerWrapper(indexer),
+      new SonarLintCacheWrapper(),
       analysisWarnings,
-      new RepositoryInfoProvider[]{new OpenSourceRepositoryInfoProvider()},
-      new ArchitectureCallbackWrapper()
+      new RepositoryInfoProviderWrapper(),
+      architectureUDGBuilderWrapper
     );
   }
 

python-commons/src/test/java/org/sonar/plugins/python/editions/RepositoryInfoProviderWrapperTest.java

@@ -0,0 +1,41 @@
+/*
+ * 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.editions;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class RepositoryInfoProviderWrapperTest {
+
+  @Test
+  void testEmptyConstructor() {
+    RepositoryInfoProviderWrapper repositoryInfoProviderWrapper = new RepositoryInfoProviderWrapper();
+    assertThat(repositoryInfoProviderWrapper.infoProviders()).hasSize(1);
+    assertThat(repositoryInfoProviderWrapper.infoProviders()[0]).isInstanceOf(OpenSourceRepositoryInfoProvider.class);
+  }
+
+  @Test
+  void testConstructorWithParameter() {
+    RepositoryInfoProvider[] editionMetadataProviders = new RepositoryInfoProvider[] {new OpenSourceRepositoryInfoProvider(), new OpenSourceRepositoryInfoProvider()};
+    RepositoryInfoProviderWrapper repositoryInfoProviderWrapper = new RepositoryInfoProviderWrapper(editionMetadataProviders);
+    assertThat(repositoryInfoProviderWrapper.infoProviders()).hasSize(2);
+    assertThat(repositoryInfoProviderWrapper.infoProviders()[0]).isInstanceOf(OpenSourceRepositoryInfoProvider.class);
+    assertThat(repositoryInfoProviderWrapper.infoProviders()[1]).isInstanceOf(OpenSourceRepositoryInfoProvider.class);
+  }
+
+}

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

@@ -0,0 +1,40 @@
+/*
+ * 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.indexer;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.ArrayList;
+
+class PythonIndexerWrapperTest {
+
+  @Test
+  void testEmptyConstructor() {
+    PythonIndexerWrapper wrapper = new PythonIndexerWrapper();
+    assertThat(wrapper.indexer()).isNull();
+  }
+
+  @Test
+  void testConstructorWithParameter() {
+    TestModuleFileSystem moduleFileSystem = new TestModuleFileSystem(new ArrayList<>());
+    PythonIndexerWrapper wrapper = new PythonIndexerWrapper(new SonarLintPythonIndexer(moduleFileSystem));
+    assertThat(wrapper.indexer()).isNotNull().isInstanceOf(PythonIndexer.class);
+  }
+
+}