SONARCH-708 SonarJava: extend CheckRegistrar API for registering custom file scanner hooks

Author: kaufco

java-checks-testkit/src/main/java/org/sonar/java/checks/verifier/TestCheckRegistrarContext.java

@@ -24,9 +24,11 @@
 import java.util.Set;
 import org.apache.commons.lang3.StringUtils;
 import org.sonar.api.rule.RuleKey;
+import org.sonar.api.rule.RuleScope;
 import org.sonar.api.rules.RuleAnnotationUtils;
 import org.sonar.plugins.java.api.CheckRegistrar;
 import org.sonar.plugins.java.api.JavaCheck;
+import org.sonar.plugins.java.api.JavaFileScanner;
 
 public class TestCheckRegistrarContext extends CheckRegistrar.RegistrarContext {
 
@@ -52,16 +54,34 @@ public void registerTestChecks(String repositoryKey, Collection<?> javaCheckClas
 
   @Override
   public void registerMainSharedCheck(JavaCheck check, Collection<RuleKey> ruleKeys) {
+    registerMainHook(check);
+    mainRuleKeys.addAll(ruleKeys);
+  }
+
+  private void registerMainHook(JavaCheck check) {
     mainCheckClasses.add(check.getClass());
     mainCheckInstances.add(check);
-    mainRuleKeys.addAll(ruleKeys);
   }
 
   @Override
   public void registerTestSharedCheck(JavaCheck check, Collection<RuleKey> ruleKeys) {
+    registerTestHook(check);
+    testRuleKeys.addAll(ruleKeys);
+  }
+
+  private void registerTestHook(JavaCheck check) {
     testCheckClasses.add(check.getClass());
     testCheckInstances.add(check);
-    testRuleKeys.addAll(ruleKeys);
+  }
+
+  @Override
+  public void registerCustomFileScanner(RuleScope ruleScope, JavaFileScanner scanner) {
+    if (ruleScope != RuleScope.TEST) {
+      registerMainHook(scanner);
+    }
+    if (ruleScope != RuleScope.MAIN) {
+      registerTestHook(scanner);
+    }
   }
 
   @Override

java-frontend/src/main/java/org/sonar/java/SonarComponents.java

@@ -56,6 +56,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.utils.Version;
 import org.sonar.java.annotations.VisibleForTesting;
 import org.sonar.java.caching.ContentHashCache;
@@ -69,6 +70,7 @@
 import org.sonar.java.reporting.JavaIssue;
 import org.sonar.plugins.java.api.CheckRegistrar;
 import org.sonar.plugins.java.api.JavaCheck;
+import org.sonar.plugins.java.api.JavaFileScanner;
 import org.sonar.plugins.java.api.JspCodeVisitor;
 import org.sonar.plugins.java.api.caching.SonarLintCache;
 import org.sonarsource.api.sonarlint.SonarLintSide;
@@ -305,6 +307,16 @@ public void registerTestSharedCheck(JavaCheck check, Collection<RuleKey> ruleKey
     }
   }
 
+  @Override
+  public void registerCustomFileScanner(RuleScope ruleScope, JavaFileScanner scanner) {
+    if (ruleScope != RuleScope.TEST) {
+      mainChecks.add(scanner);
+    }
+    if (ruleScope != RuleScope.MAIN) {
+      testChecks.add(scanner);
+    }
+  }
+
   @Override
   public void registerAutoScanCompatibleRules(Collection<RuleKey> ruleKeys) {
     additionalAutoScanCompatibleRuleKeys.addAll(ruleKeys);

java-frontend/src/main/java/org/sonar/plugins/java/api/CheckRegistrar.java

@@ -25,6 +25,7 @@
 import org.sonar.api.batch.rule.CheckFactory;
 import org.sonar.api.batch.rule.Checks;
 import org.sonar.api.rule.RuleKey;
+import org.sonar.api.rule.RuleScope;
 import org.sonar.api.server.rule.RulesDefinition;
 import org.sonar.java.Preconditions;
 import org.sonar.java.annotations.Beta;
@@ -171,6 +172,13 @@ public void registerMainSharedCheck(JavaCheck check, Collection<RuleKey> ruleKey
       // to be overridden
     }
 
+    /**
+     * Registers a custom file scanner not related to any rule or repository.
+     */
+    public void registerCustomFileScanner(RuleScope ruleScope, JavaFileScanner scanner) {
+      // to be overridden
+    }
+
     /**
      * Registers one test code check related to not one but a list of rules. The check will be active if at least one
      * of the given rule key is active. In this context injection of @RuleProperty and auto instantiation of rules

java-frontend/src/test/java/org/sonar/java/SonarComponentsTest.java

@@ -68,6 +68,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.testfixtures.log.LogTesterJUnit5;
 import org.sonar.api.utils.Version;
 import org.sonar.check.Rule;
@@ -81,6 +82,8 @@
 import org.sonar.java.testing.ThreadLocalLogTester;
 import org.sonar.plugins.java.api.CheckRegistrar;
 import org.sonar.plugins.java.api.JavaCheck;
+import org.sonar.plugins.java.api.JavaFileScanner;
+import org.sonar.plugins.java.api.JavaFileScannerContext;
 import org.sonar.plugins.java.api.JspCodeVisitor;
 import org.sonar.plugins.java.api.caching.SonarLintCache;
 import org.sonarsource.sonarlint.core.plugin.commons.sonarapi.SonarLintRuntimeImpl;
@@ -407,6 +410,46 @@ class RuleF implements JavaCheck {
       .containsExactly("RuleE");
   }
 
+  @Test
+  void register_custom_file_scanners_with_no_active_rules() {
+    var noActiveRules = (new ActiveRulesBuilder()).build();
+    CheckFactory specificCheckFactory = new CheckFactory(noActiveRules);
+    SensorContextTester specificContext = SensorContextTester.create(new File(".")).setActiveRules(noActiveRules);
+
+    class MainScanner implements JavaFileScanner {
+      @Override
+      public void scanFile(JavaFileScannerContext context) {
+      }
+    }
+
+    class TestScanner implements JavaFileScanner {
+      @Override
+      public void scanFile(JavaFileScannerContext context) {
+      }
+    }
+
+    class AllScanner implements JavaFileScanner {
+      @Override
+      public void scanFile(JavaFileScannerContext context) {
+      }
+    }
+
+    SonarComponents sonarComponents = new SonarComponents(fileLinesContextFactory, null, null,
+      null, specificCheckFactory, noActiveRules, new CheckRegistrar[]{
+      ctx -> ctx.registerCustomFileScanner(RuleScope.MAIN, new MainScanner()),
+      ctx -> ctx.registerCustomFileScanner(RuleScope.TEST, new TestScanner()),
+      ctx -> ctx.registerCustomFileScanner(RuleScope.ALL, new AllScanner())
+    });
+
+    sonarComponents.setSensorContext(specificContext);
+    assertThat(sonarComponents.mainChecks())
+      .extracting(c -> c.getClass().getSimpleName())
+      .containsExactly("MainScanner", "AllScanner");
+    assertThat(sonarComponents.testChecks())
+      .extracting(c -> c.getClass().getSimpleName())
+      .containsExactly("TestScanner", "AllScanner");
+  }
+
   @Test
   void register_custom_rule_by_instances_instead_of_classes() {
     ActiveRules activeRules = activeRules("java:S101", "java:S102");