Avoid loading SonarlintPythonIndexer on older versions of SonarLint (#923)

Author: guillaume-dequenne

pom.xml

@@ -92,7 +92,7 @@
     <sonar.version>8.9.0.43852</sonar.version>
     <sonar.orchestrator.version>3.35.1.2719</sonar.orchestrator.version>
     <sonar-analyzer-commons.version>1.14.1.690</sonar-analyzer-commons.version>
-    <sonarlint-core.version>5.4.0.31832</sonarlint-core.version>
+    <sonarlint-core.version>5.4.0.31923</sonarlint-core.version>
     <sslr.version>1.23</sslr.version>
   </properties>
 

sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonPlugin.java

@@ -25,6 +25,8 @@
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.config.PropertyDefinition;
 import org.sonar.api.resources.Qualifiers;
+import org.sonar.api.utils.log.Logger;
+import org.sonar.api.utils.log.Loggers;
 import org.sonar.plugins.python.bandit.BanditRulesDefinition;
 import org.sonar.plugins.python.bandit.BanditSensor;
 import org.sonar.plugins.python.coverage.PythonCoverageSensor;
@@ -39,6 +41,7 @@
 public class PythonPlugin implements Plugin {
 
   private static final String PYTHON_CATEGORY = "Python";
+  private static final Logger LOG = Loggers.get(PythonPlugin.class);
 
   // Subcategories
   private static final String GENERAL = "General";
@@ -81,7 +84,8 @@ public void define(Context context) {
       addFlake8Extensions(context);
     }
     if (sonarRuntime.getProduct() == SonarProduct.SONARLINT) {
-      context.addExtension(SonarLintPythonIndexer.class);
+      SonarLintPluginAPIManager sonarLintPluginAPIManager = new SonarLintPluginAPIManager();
+      sonarLintPluginAPIManager.addSonarlintPythonIndexer(context, new SonarLintPluginAPIVersion());
     }
   }
 
@@ -175,4 +179,26 @@ private static void addFlake8Extensions(Context context) {
       Flake8RulesDefinition.class);
   }
 
+  static class SonarLintPluginAPIManager {
+
+    public void addSonarlintPythonIndexer(Context context, SonarLintPluginAPIVersion sonarLintPluginAPIVersion) {
+      if (sonarLintPluginAPIVersion.isDependencyAvailable()) {
+        context.addExtension(SonarLintPythonIndexer.class);
+      } else {
+        LOG.debug("Error while trying to inject SonarLintPythonIndexer");
+      }
+    }
+  }
+
+  static class SonarLintPluginAPIVersion {
+
+    boolean isDependencyAvailable() {
+      try {
+        Class.forName("org.sonarsource.sonarlint.plugin.api.module.file.ModuleFileListener");
+      } catch (ClassNotFoundException e) {
+        return false;
+      }
+      return true;
+    }
+  }
 }

sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonPluginTest.java

@@ -27,12 +27,19 @@
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.internal.SonarRuntimeImpl;
 import org.sonar.api.utils.Version;
+import org.sonar.api.utils.log.LogTester;
+import org.sonar.api.utils.log.LoggerLevel;
 import org.sonar.plugins.python.warnings.DefaultAnalysisWarningsWrapper;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 public class PythonPluginTest {
 
+  @org.junit.Rule
+  public LogTester logTester = new LogTester();
+
   @Test
   public void testGetExtensions() {
     Version v79 = Version.create(7, 9);
@@ -42,6 +49,16 @@ public void testGetExtensions() {
     assertThat(extensions(SonarRuntimeImpl.forSonarLint(v79))).hasSize(6);
   }
 
+  @Test
+  public void classNotAvailable() {
+    PythonPlugin.SonarLintPluginAPIVersion sonarLintPluginAPIVersion = mock(PythonPlugin.SonarLintPluginAPIVersion.class);
+    when(sonarLintPluginAPIVersion.isDependencyAvailable()).thenReturn(false);
+    PythonPlugin.SonarLintPluginAPIManager sonarLintPluginAPIManager = new PythonPlugin.SonarLintPluginAPIManager();
+    Plugin.Context context = mock(Plugin.Context.class);
+    sonarLintPluginAPIManager.addSonarlintPythonIndexer(context, sonarLintPluginAPIVersion);
+    assertThat(logTester.logs(LoggerLevel.DEBUG)).containsExactly("Error while trying to inject SonarLintPythonIndexer");
+  }
+
   private static List extensions(SonarRuntime runtime) {
     Plugin.Context context = new Plugin.Context(runtime);
     new PythonPlugin().define(context);