JAVASE-6 Restrict registration of S2259 to SQ Community Build

Restrict the loading of java:S2259 to SQCB to enable other plugins to
provide an implementation S2259 for Java.

Because the other plugin might declare java:S2259 as deprecated, the
products might not be able to load a set of rules where java:S2259 is
both implemented and deprecated.

To avoid any further ambiguity, S2259 is now removed from the default
quality profile.

Author: dorian-burihabwa-sonarsource

its/ruling/src/test/java/org/sonar/java/it/JavaRulingTest.java

@@ -96,7 +96,7 @@ public static void prepare() throws Exception {
     List<String> extraNonDefaultRules = List.of("S3546", "S6374");
     ProfileGenerator.generate(ORCHESTRATOR, "Sonar Way", ImmutableMap.of(), new HashSet<>(), SUBSET_OF_ENABLED_RULES, result,
       extraNonDefaultRules);
-    assertThat(result).hasSize(23); // ALL symbolic-execution rules
+    assertThat(result).hasSize(22); // ALL symbolic-execution rules minus S2259 that has been deprecated
 
     Path allRulesFolder = Paths.get("src/test/resources");
     effectiveDumpOldFolder = tmpDumpOldFolder.getRoot().toPath().toAbsolutePath();

java-symbolic-execution/java-symbolic-execution-plugin/src/main/java/org/sonar/java/se/plugin/JavaSECheckList.java

@@ -17,6 +17,8 @@
 package org.sonar.java.se.plugin;
 
 import java.util.List;
+import java.util.Set;
+import java.util.function.Predicate;
 import org.sonar.java.se.checks.AllowXMLInclusionCheck;
 import org.sonar.java.se.checks.BooleanGratuitousExpressionsCheck;
 import org.sonar.java.se.checks.ConditionalUnreachableCodeCheck;
@@ -43,12 +45,24 @@
 import org.sonar.java.se.checks.XxeProcessingCheck;
 
 public class JavaSECheckList {
+  /**
+   * A list of checks that can be overridden by other analyzers.
+   */
+  public static final Set<Class<? extends SECheck>> OVERRIDABLE_CHECKS = Set.of(
+    NullDereferenceCheck.class // S2259
+  );
 
   private JavaSECheckList(){
     // no need to instantiate
   }
 
   public static List<Class<? extends SECheck>> getChecks() {
+    return getStandaloneChecks().stream()
+      .filter(Predicate.not(OVERRIDABLE_CHECKS::contains))
+      .toList();
+  }
+
+  public static List<Class<? extends SECheck>> getStandaloneChecks() {
     return List.of(
       // SEChecks ordered by ExplodedGraphWalker need
       NullDereferenceCheck.class,

java-symbolic-execution/java-symbolic-execution-plugin/src/main/java/org/sonar/java/se/plugin/JavaSECheckRegistrar.java

@@ -17,14 +17,18 @@
 package org.sonar.java.se.plugin;
 
 import java.util.ArrayList;
+import java.util.List;
 import java.util.Set;
+import org.sonar.api.SonarEdition;
+import org.sonar.api.SonarProduct;
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.batch.rule.CheckFactory;
 import org.sonar.api.batch.rule.Checks;
 import org.sonar.api.ce.ComputeEngineSide;
 import org.sonar.api.scanner.ScannerSide;
 import org.sonar.api.server.ServerSide;
 import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.java.annotations.VisibleForTesting;
 import org.sonar.java.se.SymbolicExecutionVisitor;
 import org.sonar.java.se.checks.SECheck;
 import org.sonar.plugins.java.api.CheckRegistrar;
@@ -54,7 +58,7 @@ public void register(RegistrarContext registrarContext) {
 
   @Override
   public void register(RegistrarContext registrarContext, CheckFactory checkFactory) {
-    Checks<JavaCheck> checks = checkFactory.<JavaCheck>create(REPOSITORY_KEY).addAnnotatedChecks(JavaSECheckList.getChecks());
+    Checks<JavaCheck> checks = checkFactory.<JavaCheck>create(REPOSITORY_KEY).addAnnotatedChecks(getChecks(runtime));
 
     var seChecks = checks.all().stream()
       .filter(SECheck.class::isInstance)
@@ -71,11 +75,26 @@ public void register(RegistrarContext registrarContext, CheckFactory checkFactor
   public void customRulesDefinition(RulesDefinition.Context context, RulesDefinition.NewRepository javaRepository) {
     RuleMetadataLoader ruleMetadataLoader = new RuleMetadataLoader(RESOURCE_BASE_PATH, SONAR_WAY_PATH, runtime);
 
-    ruleMetadataLoader.addRulesByAnnotatedClass(javaRepository, new ArrayList<>(JavaSECheckList.getChecks()));
+    ruleMetadataLoader.addRulesByAnnotatedClass(javaRepository, new ArrayList<>(getChecks(runtime)));
 
     setTemplates(javaRepository);
   }
 
+  @VisibleForTesting
+  static List<Class<? extends SECheck>> getChecks(SonarRuntime runtime) {
+    if (isStandaloneSymbolicExecutionPlugin(runtime)) {
+      return JavaSECheckList.getStandaloneChecks();
+    }
+    return JavaSECheckList.getChecks();
+  }
+
+  @VisibleForTesting
+  static boolean isStandaloneSymbolicExecutionPlugin(SonarRuntime runtime) {
+    return runtime != null &&
+      runtime.getProduct() != SonarProduct.SONARLINT &&
+      runtime.getEdition() == SonarEdition.COMMUNITY;
+  }
+
   private static void setTemplates(RulesDefinition.NewRepository repository) {
     RULE_TEMPLATES_KEY.forEach(ruleKey -> repository.rule(ruleKey).setTemplate(true));
   }

java-symbolic-execution/java-symbolic-execution-plugin/src/main/java/org/sonar/java/se/plugin/JavaSEProfileRegistrar.java

@@ -16,6 +16,7 @@
  */
 package org.sonar.java.se.plugin;
 
+import javax.annotation.Nullable;
 import org.sonar.plugins.java.api.ProfileRegistrar;
 
 public class JavaSEProfileRegistrar implements ProfileRegistrar {
@@ -24,4 +25,9 @@ public class JavaSEProfileRegistrar implements ProfileRegistrar {
   public void register(RegistrarContext registrarContext) {
     registrarContext.registerDefaultQualityProfileRules(RulesList.getSonarWayRuleKeys());
   }
+
+
+  String trigger_S2259(@Nullable Object parameter) {
+    return parameter.toString();
+  }
 }

java-symbolic-execution/java-symbolic-execution-plugin/src/main/java/org/sonar/java/se/plugin/RulesList.java

@@ -29,7 +29,6 @@ public static List<RuleKey> getSonarWayRuleKeys() {
       "S2095",
       "S2189",
       "S2222",
-      "S2259",
       "S2583",
       "S2589",
       "S2637",

java-symbolic-execution/java-symbolic-execution-plugin/src/test/java/org/sonar/java/se/plugin/JavaSECheckListTest.java

@@ -23,8 +23,16 @@
 class JavaSECheckListTest {
 
   @Test
-  void getChecks() {
-    assertThat(JavaSECheckList.getChecks()).isNotNull().hasSize(23);
+  void getChecks_returns_the_list_of_checks_that_cannot_be_overridden_by_other_plugins() {
+    assertThat(JavaSECheckList.getChecks())
+      .hasSize(22)
+      .doesNotContainAnyElementsOf(JavaSECheckList.OVERRIDABLE_CHECKS);
+  }
+
+  @Test
+  void getStandaloneChecks_returns_the_full_list_of_checks() {
+    assertThat(JavaSECheckList.getStandaloneChecks())
+      .hasSize(23);
   }
 
 }

java-symbolic-execution/java-symbolic-execution-plugin/src/test/java/org/sonar/java/se/plugin/JavaSECheckRegistrarTest.java

@@ -66,6 +66,32 @@ void register_rules() {
     assertThat(context.testRuleKeys).isEmpty();
   }
 
+  @Test
+  void is_only_in_standalone_mode_in_sqcb() {
+    var sonarQubeCloud = SonarRuntimeImpl.forSonarQube(
+      Version.parse("8.1"),
+      SonarQubeSide.SERVER,
+      SonarEdition.SONARCLOUD
+    );
+    assertThat(JavaSECheckRegistrar.isStandaloneSymbolicExecutionPlugin(sonarQubeCloud)).isFalse();
+    var sonarQubeCommunityBuild = SonarRuntimeImpl.forSonarQube(
+      Version.parse("25.1"),
+      SonarQubeSide.SERVER,
+      SonarEdition.COMMUNITY
+    );
+    assertThat(JavaSECheckRegistrar.isStandaloneSymbolicExecutionPlugin(sonarQubeCommunityBuild)).isTrue();
+    var sonarQubeServerDeveloper = SonarRuntimeImpl.forSonarQube(
+      Version.parse("2025.1"),
+      SonarQubeSide.SERVER,
+      SonarEdition.DEVELOPER
+    );
+    assertThat(JavaSECheckRegistrar.isStandaloneSymbolicExecutionPlugin(sonarQubeServerDeveloper)).isFalse();
+
+    var sonarQubeForIDE = SonarRuntimeImpl.forSonarLint(Version.parse("10.22.0.81232"));
+    assertThat(JavaSECheckRegistrar.isStandaloneSymbolicExecutionPlugin(sonarQubeForIDE)).isFalse();
+  }
+
+
   @Test
   void rules_definition() {
     SonarRuntime sonarRuntime = SonarRuntimeImpl.forSonarQube(Version.create(10, 2), SonarQubeSide.SERVER, SonarEdition.ENTERPRISE);
@@ -85,7 +111,7 @@ void rules_definition() {
     assertThat(repository.name()).isEqualTo("Sonar");
     assertThat(repository.language()).isEqualTo("java");
     List<RulesDefinition.Rule> rules = repository.rules();
-    assertThat(rules).hasSize(23);
+    assertThat(rules).hasSize(22);
 
     var activeByDefault = rules.stream()
       .filter(k -> !rulesNotActiveByDefault.contains(k.key()))

java-symbolic-execution/java-symbolic-execution-plugin/src/test/java/org/sonar/java/se/plugin/JavaSEProfileRegistrarTest.java

@@ -28,7 +28,6 @@ void constructor() {
     JavaSEProfileRegistrar registrar = new JavaSEProfileRegistrar();
     TestProfileRegistrarContext context = new TestProfileRegistrarContext();
     registrar.register(context);
-    assertThat(context.defaultQualityProfileRules).hasSize(21); // 2 are not in the default profile
+    assertThat(context.defaultQualityProfileRules).hasSize(20); // 3 are not in the default profile
   }
-
 }