Fix sonarlint: activate default rules

pynicolas · pynicolas · commit 3fe3bc4d0273 · 2017-05-11T15:55:29.000+02:00
diff --git a/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonPlugin.java b/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonPlugin.java
@@ -19,10 +19,8 @@
  */
 package org.sonar.plugins.python;
 
-import com.google.common.collect.ImmutableList;
-import java.util.List;
+import org.sonar.api.Plugin;
 import org.sonar.api.PropertyType;
-import org.sonar.api.SonarPlugin;
 import org.sonar.api.config.PropertyDefinition;
 import org.sonar.api.resources.Qualifiers;
 import org.sonar.plugins.python.coverage.PythonCoverageSensor;
@@ -33,7 +31,7 @@
 import org.sonar.plugins.python.pylint.PylintSensor;
 import org.sonar.plugins.python.xunit.PythonXUnitSensor;
 
-public class PythonPlugin extends SonarPlugin {
+public class PythonPlugin implements Plugin {
 
   private static final String PYTHON_CATEGORY = "Python";
 
@@ -44,10 +42,11 @@ public class PythonPlugin extends SonarPlugin {
 
   public static final String FILE_SUFFIXES_KEY = "sonar.python.file.suffixes";
 
+
   @Override
-  public List getExtensions() {
+  public void define(Context context) {
 
-    return ImmutableList.of(
+    context.addExtensions(
 
       PropertyDefinition.builder(FILE_SUFFIXES_KEY)
         .name("File Suffixes")
@@ -145,7 +144,7 @@ public List getExtensions() {
       PythonProfile.class,
 
       PythonSquidSensor.class,
-      PythonRuleRepository.class,
+      new PythonRuleRepository(context.getSonarQubeVersion()),
 
       PylintConfiguration.class,
       PylintSensor.class,
diff --git a/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonProfile.java b/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonProfile.java
@@ -55,7 +55,7 @@ private void loadActiveKeysFromJsonProfile(RulesProfile rulesProfile) {
     }
   }
 
-  private static Set<String> activatedRuleKeys() {
+  public static Set<String> activatedRuleKeys() {
     URL profileUrl = PythonProfile.class.getResource("/org/sonar/l10n/py/rules/python/Sonar_way_profile.json");
     try {
       Gson gson = new Gson();
diff --git a/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonRuleRepository.java b/sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonRuleRepository.java
@@ -25,11 +25,13 @@
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
 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.python.checks.CheckList;
 import org.sonar.squidbridge.annotations.AnnotationBasedRulesDefinition;
 
@@ -38,6 +40,11 @@ public class PythonRuleRepository implements RulesDefinition {
   private static final String REPOSITORY_NAME = "SonarAnalyzer";
 
   private final Gson gson = new Gson();
+  private final Version sonarRuntimeVersion;
+
+  public PythonRuleRepository(Version sonarRuntimeVersion) {
+    this.sonarRuntimeVersion = sonarRuntimeVersion;
+  }
 
   @Override
   public void define(Context context) {
@@ -51,9 +58,21 @@ public void define(Context context) {
       addMetadata(rule, rule.key());
     }
 
+    setupDefaultActivatedRules(repository);
+
     repository.done();
   }
 
+  private void setupDefaultActivatedRules(NewRepository repository) {
+    boolean shouldSetupSonarLintProfile = sonarRuntimeVersion.isGreaterThanOrEqual(Version.parse("6.0"));
+    if (shouldSetupSonarLintProfile) {
+      Set<String> activatedRuleKeys = PythonProfile.activatedRuleKeys();
+      for (NewRule rule : repository.rules()) {
+        rule.setActivatedByDefault(activatedRuleKeys.contains(rule.key()));
+      }
+    }
+  }
+
   @Nullable
   private static String readRuleDefinitionResource(String fileName) {
     URL resource = PythonRuleRepository.class.getResource("/org/sonar/l10n/py/rules/python/" + fileName);
diff --git a/sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonPluginTest.java b/sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonPluginTest.java
@@ -20,14 +20,22 @@
 package org.sonar.plugins.python;
 
 import org.junit.Test;
+import org.sonar.api.Plugin;
+import org.sonar.api.SonarQubeSide;
+import org.sonar.api.SonarRuntime;
+import org.sonar.api.internal.SonarRuntimeImpl;
+import org.sonar.api.utils.Version;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class PythonPluginTest {
 
   @Test
   public void testGetExtensions() {
-    assertThat(new PythonPlugin().getExtensions()).hasSize(20);
+    SonarRuntime runtime = SonarRuntimeImpl.forSonarQube(Version.create(5, 6), SonarQubeSide.SERVER);
+    Plugin.Context context = new Plugin.Context(runtime);
+    new PythonPlugin().define(context);
+    assertThat(context.getExtensions()).hasSize(20);
   }
 
 }
diff --git a/sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonRuleRepositoryTest.java b/sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonRuleRepositoryTest.java
@@ -19,23 +19,19 @@
  */
 package org.sonar.plugins.python;
 
+import java.util.List;
 import org.junit.Test;
 import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.api.utils.Version;
 import org.sonar.python.checks.CheckList;
 
-import java.util.List;
-
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class PythonRuleRepositoryTest {
 
   @Test
   public void createRulesTest() {
-    PythonRuleRepository ruleRepository = new PythonRuleRepository();
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    ruleRepository.define(context);
-
-    RulesDefinition.Repository repository = context.repository(CheckList.REPOSITORY_KEY);
+    RulesDefinition.Repository repository = buildRepository(Version.parse("5.6"));
 
     assertThat(repository.language()).isEqualTo("py");
     assertThat(repository.name()).isEqualTo("SonarAnalyzer");
@@ -45,4 +41,25 @@ public void createRulesTest() {
     assertThat(rules).hasSize(54);
   }
 
+  @Test
+  public void sonarqube56() {
+    RulesDefinition.Repository repository = buildRepository(Version.parse("5.6"));
+    assertThat(repository.rule("S1578").activatedByDefault()).isFalse();
+    assertThat(repository.rule("BackticksUsage").activatedByDefault()).isFalse();
+  }
+
+  @Test
+  public void sonarlint() {
+    RulesDefinition.Repository repository = buildRepository(Version.parse("6.0"));
+    assertThat(repository.rule("S1578").activatedByDefault()).isFalse();
+    assertThat(repository.rule("BackticksUsage").activatedByDefault()).isTrue();
+  }
+
+  private RulesDefinition.Repository buildRepository(Version sonarRuntimeVersion) {
+    PythonRuleRepository ruleRepository = new PythonRuleRepository(sonarRuntimeVersion);
+    RulesDefinition.Context context = new RulesDefinition.Context();
+    ruleRepository.define(context);
+    return context.repository(CheckList.REPOSITORY_KEY);
+  }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ private void loadActiveKeysFromJsonProfile(RulesProfile rulesProfile) {`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`
`58`		`- private static Set<String> activatedRuleKeys() {`
	`58`	`+ public static Set<String> activatedRuleKeys() {`
`59`	`59`	`URL profileUrl = PythonProfile.class.getResource("/org/sonar/l10n/py/rules/python/Sonar_way_profile.json");`
`60`	`60`	`try {`
`61`	`61`	`Gson gson = new Gson();`