SONARJS-775 Set up default profile for SonarLint (SonarSource#397)

pynicolas · vilchik-elena · commit c276cc8dfeb9 · 2016-11-14T14:47:13.000+01:00
diff --git a/sonar-javascript-plugin/src/main/java/org/sonar/plugins/javascript/JavaScriptPlugin.java b/sonar-javascript-plugin/src/main/java/org/sonar/plugins/javascript/JavaScriptPlugin.java
@@ -69,7 +69,7 @@ public void define(Context context) {
     context.addExtensions(
       JavaScriptLanguage.class,
       JavaScriptSquidSensor.class,
-      JavaScriptRulesDefinition.class,
+      new JavaScriptRulesDefinition(context.getSonarQubeVersion()),
       JavaScriptProfile.class);
 
     // Do not waste resources adding coverage sensors to SonarLint, as they are handled as no-ops.
diff --git a/sonar-javascript-plugin/src/main/java/org/sonar/plugins/javascript/JavaScriptProfile.java b/sonar-javascript-plugin/src/main/java/org/sonar/plugins/javascript/JavaScriptProfile.java
@@ -31,9 +31,7 @@
 import org.sonar.api.rules.RuleFinder;
 import org.sonar.api.utils.ValidationMessages;
 import org.sonar.javascript.checks.CheckList;
-import org.sonarsource.api.sonarlint.SonarLintSide;
 
-@SonarLintSide
 public class JavaScriptProfile extends ProfileDefinition {
 
   private final RuleFinder ruleFinder;
@@ -61,22 +59,22 @@ private void loadFromCommonRepository(RulesProfile profile) {
   }
 
   private void loadActiveKeysFromJsonProfile(RulesProfile rulesProfile) {
-    URL profileUrl = JavaScriptProfile.class.getResource("/org/sonar/l10n/javascript/rules/javascript/Sonar_way_profile.json");
+    for (String ruleKey : activatedRuleKeys()) {
+      Rule rule = ruleFinder.findByKey(CheckList.REPOSITORY_KEY, ruleKey);
+      rulesProfile.activateRule(rule, null);
+    }
+  }
 
+  public static Set<String> activatedRuleKeys() {
+    URL profileUrl = JavaScriptProfile.class.getResource("/org/sonar/l10n/javascript/rules/javascript/Sonar_way_profile.json");
     try {
       Gson gson = new Gson();
-      Profile profile = gson.fromJson(Resources.toString(profileUrl, Charsets.UTF_8), Profile.class);
-      for (String ruleKey : profile.ruleKeys) {
-        Rule rule = ruleFinder.findByKey(CheckList.REPOSITORY_KEY, ruleKey);
-        rulesProfile.activateRule(rule, null);
-      }
-
+      return gson.fromJson(Resources.toString(profileUrl, Charsets.UTF_8), Profile.class).ruleKeys;
     } catch (IOException e) {
       throw new IllegalStateException("Failed to read: " + profileUrl, e);
     }
   }
 
-
   private static class Profile {
     Set<String> ruleKeys;
   }
diff --git a/sonar-javascript-plugin/src/main/java/org/sonar/plugins/javascript/rules/JavaScriptRulesDefinition.java b/sonar-javascript-plugin/src/main/java/org/sonar/plugins/javascript/rules/JavaScriptRulesDefinition.java
@@ -25,18 +25,26 @@
 import java.io.IOException;
 import java.net.URL;
 import java.util.Locale;
+import java.util.Set;
 import javax.annotation.Nullable;
 import org.sonar.api.rule.RuleStatus;
 import org.sonar.api.rules.RuleType;
 import org.sonar.api.server.debt.DebtRemediationFunction;
 import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.api.utils.Version;
 import org.sonar.javascript.checks.CheckList;
 import org.sonar.plugins.javascript.JavaScriptLanguage;
+import org.sonar.plugins.javascript.JavaScriptProfile;
 import org.sonar.squidbridge.annotations.AnnotationBasedRulesDefinition;
 
 public class JavaScriptRulesDefinition implements RulesDefinition {
 
   private final Gson gson = new Gson();
+  private final Version sonarRuntimeVersion;
+
+  public JavaScriptRulesDefinition(Version sonarRuntimeVersion) {
+    this.sonarRuntimeVersion = sonarRuntimeVersion;
+  }
 
   @Override
   public void define(Context context) {
@@ -55,6 +63,14 @@ public void define(Context context) {
       addMetadata(rule, metadataKey);
     }
 
+    boolean shouldSetupSonarLintProfile = sonarRuntimeVersion.isGreaterThanOrEqual(Version.parse("6.0"));
+    if (shouldSetupSonarLintProfile) {
+      Set<String> activatedRuleKeys = JavaScriptProfile.activatedRuleKeys();
+      for (NewRule rule : repository.rules()) {
+        rule.setActivatedByDefault(activatedRuleKeys.contains(rule.key()));
+      }
+    }
+
     repository.done();
   }
 
diff --git a/sonar-javascript-plugin/src/test/java/org/sonar/plugins/javascript/rules/JavaScriptRulesDefinitionTest.java b/sonar-javascript-plugin/src/test/java/org/sonar/plugins/javascript/rules/JavaScriptRulesDefinitionTest.java
@@ -27,6 +27,7 @@
 import org.sonar.api.server.rule.RulesDefinition.Param;
 import org.sonar.api.server.rule.RulesDefinition.Repository;
 import org.sonar.api.server.rule.RulesDefinition.Rule;
+import org.sonar.api.utils.Version;
 import org.sonar.javascript.checks.CheckList;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -35,10 +36,7 @@ public class JavaScriptRulesDefinitionTest {
 
   @Test
   public void test() {
-    JavaScriptRulesDefinition rulesDefinition = new JavaScriptRulesDefinition();
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    rulesDefinition.define(context);
-    RulesDefinition.Repository repository = context.repository("javascript");
+    RulesDefinition.Repository repository = buildRepository(Version.parse("5.6"));
 
     assertThat(repository.name()).isEqualTo("SonarAnalyzer");
     assertThat(repository.language()).isEqualTo("js");
@@ -49,6 +47,21 @@ public void test() {
     assertAllRuleParametersHaveDescription(repository);
   }
 
+  @Test
+  public void sonarlint() {
+    RulesDefinition.Repository repository = buildRepository(Version.parse("6.0"));
+    assertThat(repository.rule("ContinueStatement").activatedByDefault()).isFalse();
+    assertThat(repository.rule("S2583").activatedByDefault()).isTrue();
+  }
+
+  private RulesDefinition.Repository buildRepository(Version sonarRuntimeVersion) {
+    JavaScriptRulesDefinition rulesDefinition = new JavaScriptRulesDefinition(sonarRuntimeVersion);
+    RulesDefinition.Context context = new RulesDefinition.Context();
+    rulesDefinition.define(context);
+    RulesDefinition.Repository repository = context.repository("javascript");
+    return repository;
+  }
+
   private void assertParameterProperties(Repository repository) {
     // TooManyLinesInFunctionCheck
     Param max = repository.rule("S138").param("max");
