SONARPY-1234 Disable cache when sonar.modules is used (#1326)

Author: guillaume-dequenne

python-frontend/src/main/java/org/sonar/python/caching/CacheContextImpl.java

@@ -22,12 +22,17 @@
 import org.sonar.api.SonarProduct;
 import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.api.utils.Version;
+import org.sonar.api.utils.log.Logger;
+import org.sonar.api.utils.log.Loggers;
 import org.sonar.plugins.python.api.caching.CacheContext;
 import org.sonar.plugins.python.api.caching.PythonReadCache;
 import org.sonar.plugins.python.api.caching.PythonWriteCache;
 
 public class CacheContextImpl implements CacheContext {
 
+  private static final Logger LOG = Loggers.get(CacheContextImpl.class);
+  private static final Version MINIMUM_RUNTIME_VERSION = Version.create(9, 7);
+
   private final boolean isCacheEnabled;
   private final PythonWriteCache writeCache;
   private final PythonReadCache readCache;
@@ -54,7 +59,15 @@ public PythonWriteCache getWriteCache() {
   }
 
   public static CacheContextImpl of(SensorContext context) {
-    if (!context.runtime().getProduct().equals(SonarProduct.SONARLINT) && context.runtime().getApiVersion().isGreaterThanOrEqual(Version.create(9, 7))) {
+    String sonarModules = context.config().get("sonar.modules").orElse("");
+    boolean isUsingSonarModules = !sonarModules.isEmpty();
+    if (isUsingSonarModules && context.isCacheEnabled()) {
+      LOG.info("Caching will be disabled for this analysis due to the use of the \"sonar.modules\" property.");
+    }
+    if (!context.runtime().getProduct().equals(SonarProduct.SONARLINT)
+      && context.runtime().getApiVersion().isGreaterThanOrEqual(MINIMUM_RUNTIME_VERSION)
+      && !isUsingSonarModules
+    ) {
       return new CacheContextImpl(context.isCacheEnabled(), new PythonWriteCacheImpl(context.nextCache()), new PythonReadCacheImpl(context.previousCache()));
     }
     return new CacheContextImpl(false, new DummyCache(), new DummyCache());

python-frontend/src/test/java/org/sonar/python/caching/CacheContextImplTest.java

@@ -19,11 +19,15 @@
  */
 package org.sonar.python.caching;
 
+import java.util.Optional;
 import org.junit.Test;
 import org.sonar.api.SonarProduct;
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.api.config.Configuration;
 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.api.caching.CacheContext;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -34,6 +38,10 @@ public class CacheContextImplTest {
 
   private static final Version VERSION_WITH_CACHING = Version.create(9, 7);
   private static final Version VERSION_WITHOUT_CACHING = Version.create(9, 6);
+  private static final String EXPECTED_SONAR_MODULE_LOG = "Caching will be disabled for this analysis due to the use of the \"sonar.modules\" property.";
+
+  @org.junit.Rule
+  public LogTester logTester = new LogTester();
 
   @Test
   public void cache_context_of_enabled_cache() {
@@ -67,6 +75,30 @@ public void cache_context_on_old_version() {
     assertThat(cacheContext.isCacheEnabled()).isFalse();
   }
 
+  @Test
+  public void cache_context_with_sonar_modules_property() {
+    SensorContext sensorContext = sensorContext(SonarProduct.SONARQUBE, VERSION_WITH_CACHING, true);
+    Configuration configuration = mock(Configuration.class);
+    when(configuration.get("sonar.modules")).thenReturn(Optional.of("module1, module2"));
+    when(sensorContext.config()).thenReturn(configuration);
+
+    CacheContext cacheContext = CacheContextImpl.of(sensorContext);
+    assertThat(cacheContext.isCacheEnabled()).isFalse();
+    assertThat(logTester.logs(LoggerLevel.INFO)).contains(EXPECTED_SONAR_MODULE_LOG);
+  }
+
+  @Test
+  public void cache_context_when_cache_disabled_no_sonar_module_logs() {
+    SensorContext sensorContext = sensorContext(SonarProduct.SONARQUBE, VERSION_WITH_CACHING, false);
+    Configuration configuration = mock(Configuration.class);
+    when(configuration.get("sonar.modules")).thenReturn(Optional.of("module1, module2"));
+    when(sensorContext.config()).thenReturn(configuration);
+
+    CacheContext cacheContext = CacheContextImpl.of(sensorContext);
+    assertThat(cacheContext.isCacheEnabled()).isFalse();
+    assertThat(logTester.logs(LoggerLevel.INFO)).doesNotContain(EXPECTED_SONAR_MODULE_LOG);
+  }
+
   @Test
   public void dummy_cache() {
     CacheContext dummyCache = CacheContextImpl.dummyCache();
@@ -81,6 +113,8 @@ private static SensorContext sensorContext(SonarProduct product, Version version
     SensorContext sensorContext = mock(SensorContext.class);
     when(sensorContext.runtime()).thenReturn(runtime);
     when(sensorContext.isCacheEnabled()).thenReturn(isCacheEnabled);
+    Configuration configuration = mock(Configuration.class);
+    when(sensorContext.config()).thenReturn(configuration);
 
     return sensorContext;
   }

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

@@ -47,7 +47,6 @@
 import org.sonar.python.index.VariableDescriptor;
 import org.sonar.python.types.TypeShed;
 
-import static org.assertj.core.api.Assertions.as;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.when;