SONARJAVA-6234 Autoscan check filter silently removes custom file scanners (#5553)

Author: kaufco

sonar-java-plugin/src/main/java/org/sonar/plugins/java/JavaSensor.java

@@ -137,7 +137,7 @@ private UnaryOperator<List<JavaCheck>> createCheckFilter(boolean isAutoScanCheck
       autoScanCompatibleRules.addAll(sonarComponents.getAdditionalAutoScanCompatibleRuleKeys());
 
       return checks -> checks.stream()
-        .filter(check -> sonarComponents.getRuleKey(check).map(autoScanCompatibleRules::contains).orElse(false))
+        .filter(check -> sonarComponents.getRuleKey(check).map(autoScanCompatibleRules::contains).orElse(true))
         .toList();
     } else {
       return UnaryOperator.identity();

sonar-java-plugin/src/test/java/org/sonar/plugins/java/JavaSensorTest.java

@@ -52,6 +52,7 @@
 import org.sonar.api.measures.FileLinesContext;
 import org.sonar.api.measures.FileLinesContextFactory;
 import org.sonar.api.rule.RuleKey;
+import org.sonar.api.rule.RuleScope;
 import org.sonar.api.rules.RuleAnnotationUtils;
 import org.sonar.api.testfixtures.log.LogTesterJUnit5;
 import org.sonar.api.utils.AnnotationUtils;
@@ -118,7 +119,7 @@ void test_toString() throws IOException {
   @Test
   void test_issues_creation_on_main_file() throws IOException {
     // Expected issues : the number of methods violating BadMethodName rule. Currently, 18 tests.
-    testIssueCreation(InputFile.Type.MAIN, 15);
+    testIssueCreation(InputFile.Type.MAIN, 16);
 
     Map<String, String> telemetryMap = telemetry.toMap();
     assertThat(telemetryMap).containsOnlyKeys(
@@ -134,7 +135,7 @@ void test_issues_creation_on_main_file() throws IOException {
       "java.scanner_app");
     assertThat(telemetryMap.get("java.analysis.main.success.size_chars")).matches("\\d{5}");
     assertThat(telemetryMap.get("java.analysis.main.success.time_ms")).matches("\\d+");
-    assertThat(telemetryMap).containsEntry("java.analysis.main.success.type_error_count", "199");
+    assertThat(telemetryMap).containsEntry("java.analysis.main.success.type_error_count", "205");
   }
 
   @Test
@@ -156,7 +157,7 @@ void test_issues_creation_on_test_file() throws IOException { // NOSONAR require
       "java.scanner_app");
     assertThat(telemetryMap.get("java.analysis.test.success.size_chars")).matches("\\d{5}");
     assertThat(telemetryMap.get("java.analysis.test.success.time_ms")).matches("\\d+");
-    assertThat(telemetryMap).containsEntry("java.analysis.test.success.type_error_count", "199");
+    assertThat(telemetryMap).containsEntry("java.analysis.test.success.type_error_count", "205");
   }
 
   private static int lineNumberOfTheMethodWithNoSonar(FileSystem fs) throws IOException {
@@ -462,6 +463,55 @@ void filter_checks_when_autoscan_true() throws IOException {
     );
   }
 
+  @Test
+  void custom_file_scanner_is_not_filtered_in_autoscan() throws IOException {
+    MapSettings settings = new MapSettings();
+    settings.setProperty("sonar.internal.analysis.autoscan", "true");
+
+    SensorContextTester context = SensorContextTester.create(new File("src/test/files").getAbsoluteFile())
+      .setSettings(settings)
+      .setRuntime(SonarRuntimeImpl.forSonarQube(Version.create(8, 7), SonarQubeSide.SCANNER, SonarEdition.COMMUNITY));
+
+    DefaultFileSystem fs = context.fileSystem();
+    fs.setWorkDir(tmp.newFolder().toPath());
+
+    File mainFile = new File(fs.baseDir(), "CodeWithIssues.java");
+    fs.add(new TestInputFileBuilder("", mainFile.getName()).setLanguage("java").setModuleBaseDir(fs.baseDirPath())
+      .setType(InputFile.Type.MAIN).initMetadata(Files.readString(mainFile.toPath())).setCharset(UTF_8).build());
+
+    FileLinesContextFactory fileLinesContextFactory = mock(FileLinesContextFactory.class);
+    when(fileLinesContextFactory.createFor(any(InputFile.class))).thenReturn(mock(FileLinesContext.class));
+    ClasspathForTest javaTestClasspath = new ClasspathForTest(context.config(), fs);
+    ClasspathForMain javaClasspath = new ClasspathForMain(context.config(), fs);
+    DefaultJavaResourceLocator resourceLocator = createDefaultJavaResourceLocator(context.config(), fs);
+
+    CustomFileScannerHook hook = new CustomFileScannerHook();
+    CheckRegistrar[] checkRegistrars = new CheckRegistrar[] {new CustomRegistrar(), hook};
+
+    ActiveRulesBuilder activeRulesBuilder = new ActiveRulesBuilder();
+    GeneratedCheckList.getChecks().stream()
+      .map(check -> AnnotationUtils.getAnnotation(check, org.sonar.check.Rule.class).key())
+      .map(key -> new NewActiveRule.Builder().setRuleKey(RuleKey.of("java", key)).build())
+      .forEach(activeRulesBuilder::addRule);
+    Stream.of("CustomMainCheck", "CustomJspCheck", "CustomTestCheck")
+      .map(key -> new NewActiveRule.Builder().setRuleKey(RuleKey.of("CustomRepository", key)).build())
+      .forEach(activeRulesBuilder::addRule);
+
+    CheckFactory specificCheckFactory = new CheckFactory(activeRulesBuilder.build());
+    SonarComponents components = new SonarComponents(fileLinesContextFactory, fs,
+      javaClasspath, javaTestClasspath, specificCheckFactory, context.activeRules(), checkRegistrars, null, null);
+
+    JavaSensor jss = new JavaSensor(components, fs, resourceLocator, context.config(), mock(NoSonarFilter.class), null, telemetry);
+    jss.execute(context);
+
+    assertThat(hook.scanFileCount).as("Custom file scanner should be called even in autoscan mode").isPositive();
+
+    assertThat(context.allIssues())
+      .extracting(issue -> issue.ruleKey().toString())
+      .as("Rule-based autoscan filtering should still apply")
+      .doesNotContain("CustomRepository:CustomMainCheck");
+  }
+
   @Test
   void test_describe_sensor() throws IOException {
     DefaultSensorDescriptor descriptor = new DefaultSensorDescriptor();
@@ -563,4 +613,18 @@ public void register(RegistrarContext registrarContext) {
     }
   }
 
+  public static class CustomFileScannerHook implements CheckRegistrar, JavaFileScanner {
+    int scanFileCount;
+
+    @Override
+    public void register(RegistrarContext registrarContext) {
+      registrarContext.registerCustomFileScanner(RuleScope.ALL, this);
+    }
+
+    @Override
+    public void scanFile(JavaFileScannerContext context) {
+      scanFileCount++;
+    }
+  }
+
 }