Update configs to disable plugins

fsantiag · Feb 7, 2021 · 0606222 · 0606222
1 parent 9c6b81d
commit 0606222
Show file tree

Hide file tree

Showing 23 changed files with 73 additions and 67 deletions.
diff --git a/README.md b/README.md
@@ -54,8 +54,8 @@ version, keep in mind that it might cause errors on SonarClojure analysis.
 ### Configuring Sensors
 
 #### Disabling
-Sensors can be disabled by setting `sonar.clojure.<sensorname>.disabled=true` in the sonar-project.properties or
-by using the command line argument `-Dsonar.clojure.<sensorname>.disabled` when running sonar-scanner.
+Sensors can be disabled by setting `sonar.clojure.<sensorname>.enabled=false` in the sonar-project.properties or
+by using the command line argument `-Dsonar.clojure.<sensorname>.enabled` when running sonar-scanner.
 Sensor names are `eastwood`, `kibit`, `clj-kondo`, `ancient`, `nvd` and `cloverage`.
 
 #### Report file location

diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>org.sonar.plugins.clojure</groupId>
     <artifactId>sonar-clojure-plugin</artifactId>
-    <version>2.1.0-SNAPSHOT</version>
+    <version>2.2.0-SNAPSHOT</version>
     <packaging>sonar-plugin</packaging>
     <name>sonar-clojure</name>
     <description>SonarClojure is a plugin for SonarQube to analyze Clojure source.</description>

diff --git a/src/main/java/org/sonar/plugins/clojure/sensors/AbstractSensor.java b/src/main/java/org/sonar/plugins/clojure/sensors/AbstractSensor.java
@@ -29,13 +29,13 @@ public AbstractSensor(LeiningenRunner leiningenRunner) {
         this.leiningenRunner = leiningenRunner;
     }
 
-    protected boolean isPluginDisabled(SensorContext context, String pluginName, String propertyName, boolean defaultValue) {
-        Boolean pluginDisabled = context.config().getBoolean(propertyName).orElse(defaultValue);
-        LOG.debug(String.format("Property: %s Value: %s", propertyName, pluginDisabled));
-        if (pluginDisabled) {
+    protected boolean isPluginEnabled(SensorContext context, String pluginName, String propertyName, boolean defaultValue) {
+        Boolean pluginEnabled = context.config().getBoolean(propertyName).orElse(defaultValue);
+        LOG.debug(String.format("Property: %s Value: %s", propertyName, pluginEnabled));
+        if (!pluginEnabled) {
             LOG.info(pluginName + " disabled");
         }
-        return pluginDisabled;
+        return pluginEnabled;
     }
 
     protected Optional<InputFile> getFile(String filePath, FileSystem fileSystem) {

diff --git a/src/main/java/org/sonar/plugins/clojure/sensors/ancient/AncientSensor.java b/src/main/java/org/sonar/plugins/clojure/sensors/ancient/AncientSensor.java
@@ -22,8 +22,8 @@
 import java.util.Optional;
 
 import static org.sonar.plugins.clojure.sensors.ancient.AncientOutputParser.parse;
-import static org.sonar.plugins.clojure.settings.AncientProperties.DISABLED_PROPERTY;
-import static org.sonar.plugins.clojure.settings.AncientProperties.DISABLED_PROPERTY_DEFAULT;
+import static org.sonar.plugins.clojure.settings.AncientProperties.ENABLED_PROPERTY;
+import static org.sonar.plugins.clojure.settings.AncientProperties.ENABLED_PROPERTY_DEFAULT;
 import static org.sonar.plugins.clojure.settings.Properties.SENSORS_TIMEOUT_PROPERTY;
 import static org.sonar.plugins.clojure.settings.Properties.SENSORS_TIMEOUT_PROPERTY_DEFAULT;
 
@@ -47,7 +47,7 @@ public void describe(SensorDescriptor descriptor) {
 
     @Override
     public void execute(SensorContext context) {
-        if (!isPluginDisabled(context, PLUGIN_NAME, DISABLED_PROPERTY, DISABLED_PROPERTY_DEFAULT)) {
+        if (isPluginEnabled(context, PLUGIN_NAME, ENABLED_PROPERTY, ENABLED_PROPERTY_DEFAULT)) {
             LOG.info("Running Lein Ancient");
 
             long timeOut = context.config().getLong(SENSORS_TIMEOUT_PROPERTY)

diff --git a/src/main/java/org/sonar/plugins/clojure/sensors/cloverage/CloverageSensor.java b/src/main/java/org/sonar/plugins/clojure/sensors/cloverage/CloverageSensor.java
@@ -37,7 +37,7 @@ public void describe(SensorDescriptor descriptor) {
 
     @Override
     public void execute(SensorContext context) {
-        if (!isPluginDisabled(context, PLUGIN_NAME, DISABLED_PROPERTY, DISABLED_PROPERTY_DEFAULT)) {
+        if (isPluginEnabled(context, PLUGIN_NAME, ENABLED_PROPERTY, ENABLED_PROPERTY_DEFAULT)) {
             LOG.info("Running " + PLUGIN_NAME);
 
             long timeOut = context.config().getLong(SENSORS_TIMEOUT_PROPERTY)

diff --git a/src/main/java/org/sonar/plugins/clojure/sensors/eastwood/EastwoodSensor.java b/src/main/java/org/sonar/plugins/clojure/sensors/eastwood/EastwoodSensor.java
@@ -47,6 +47,8 @@ public void execute(SensorContext context) {
 
             LOG.debug("Saving issues: " + issues.size());
             issues.forEach(issue -> saveIssue(issue, context));
+        } else {
+            LOG.info("Eastwood disabled");
         }
     }
     private boolean isSensorEnabled(SensorContext context) {

diff --git a/src/main/java/org/sonar/plugins/clojure/sensors/kibit/KibitSensor.java b/src/main/java/org/sonar/plugins/clojure/sensors/kibit/KibitSensor.java
@@ -38,7 +38,7 @@ public void describe(SensorDescriptor descriptor) {
 
     @Override
     public void execute(SensorContext context) {
-        if (!isPluginDisabled(context, PLUGIN_NAME, KibitProperties.DISABLED_PROPERTY, KibitProperties.DISABLED_PROPERTY_DEFAULT)) {
+        if (isPluginEnabled(context, PLUGIN_NAME, KibitProperties.ENABLED_PROPERTY, KibitProperties.ENABLED_PROPERTY_DEFAULT)) {
             LOG.info("Running Kibit");
             long timeOut = context.config().getLong(SENSORS_TIMEOUT_PROPERTY)
                     .orElse(Long.valueOf(SENSORS_TIMEOUT_PROPERTY_DEFAULT));

diff --git a/src/main/java/org/sonar/plugins/clojure/sensors/kondo/KondoSensor.java b/src/main/java/org/sonar/plugins/clojure/sensors/kondo/KondoSensor.java
@@ -86,7 +86,7 @@ private Severity getSeverity(String level) {
 
     @Override
     public void execute(SensorContext context) {
-        if (!isPluginDisabled(context, PLUGIN_NAME, DISABLED_PROPERTY, DISABLED_PROPERTY_DEFAULT)) {
+        if (isPluginEnabled(context, PLUGIN_NAME, ENABLED_PROPERTY, ENABLED_PROPERTY_DEFAULT)) {
             LOG.info("Running clj-kondo");
 
             String config = context.config().get(CONFIG).orElse(DEFAULT_CONFIG);

diff --git a/src/main/java/org/sonar/plugins/clojure/sensors/leinnvd/LeinNvdSensor.java b/src/main/java/org/sonar/plugins/clojure/sensors/leinnvd/LeinNvdSensor.java
@@ -43,7 +43,7 @@ public void describe(SensorDescriptor descriptor) {
     @Override
     public void execute(SensorContext context) {
 
-        if (!isPluginDisabled(context, PLUGIN_NAME, DISABLED_PROPERTY, DISABLED_PROPERTY_DEFAULT)) {
+        if (isPluginEnabled(context, PLUGIN_NAME, ENABLED_PROPERTY, ENABLED_PROPERTY_DEFAULT)) {
             LOG.info("Running Lein NVD");
             String reportPath = context.config().get(NvdProperties.REPORT_LOCATION_PROPERTY).orElse(REPORT_LOCATION_DEFAULT);
 

diff --git a/src/main/java/org/sonar/plugins/clojure/settings/AncientProperties.java b/src/main/java/org/sonar/plugins/clojure/settings/AncientProperties.java
@@ -10,17 +10,17 @@
 import static org.sonar.plugins.clojure.settings.Properties.SUB_CATEGORY;
 
 public class AncientProperties {
-    public static final String DISABLED_PROPERTY = "sonar.clojure.ancient.disabled";
-    public static final boolean DISABLED_PROPERTY_DEFAULT = false;
+    public static final String ENABLED_PROPERTY = "sonar.clojure.ancient.enabled";
+    public static final boolean ENABLED_PROPERTY_DEFAULT = true;
 
     private AncientProperties() {
     }
 
     static PropertyDefinition getAncientDisabled() {
-        return PropertyDefinition.builder(DISABLED_PROPERTY)
+        return PropertyDefinition.builder(ENABLED_PROPERTY)
                 .category(MAIN_CATEGORY)
                 .subCategory(SUB_CATEGORY)
-                .defaultValue(valueOf(DISABLED_PROPERTY_DEFAULT))
+                .defaultValue(valueOf(ENABLED_PROPERTY_DEFAULT))
                 .name("Ancient Disabled")
                 .description("Indicates the ancient sensor should be disabled")
                 .build();

diff --git a/src/main/java/org/sonar/plugins/clojure/settings/CloverageProperties.java b/src/main/java/org/sonar/plugins/clojure/settings/CloverageProperties.java
@@ -9,19 +9,19 @@
 import static org.sonar.plugins.clojure.settings.Properties.SUB_CATEGORY;
 
 public class CloverageProperties {
-    public static final String DISABLED_PROPERTY = "sonar.clojure.cloverage.disabled";
-    public static final boolean DISABLED_PROPERTY_DEFAULT = false;
+    public static final String ENABLED_PROPERTY = "sonar.clojure.cloverage.enabled";
+    public static final boolean ENABLED_PROPERTY_DEFAULT = true;
     public static final String REPORT_LOCATION_PROPERTY = "sonar.clojure.cloverage.reportPath";
     public static final String REPORT_LOCATION_DEFAULT = "target/coverage/codecov.json";
 
     private CloverageProperties() {
     }
 
-    static PropertyDefinition getDisabledProperty() {
-        return PropertyDefinition.builder(DISABLED_PROPERTY)
+    static PropertyDefinition getEnabledProperty() {
+        return PropertyDefinition.builder(ENABLED_PROPERTY)
                 .category(MAIN_CATEGORY)
                 .subCategory(SUB_CATEGORY)
-                .defaultValue("false")
+                .defaultValue(String.valueOf(ENABLED_PROPERTY_DEFAULT))
                 .name("Cloverage Disabled")
                 .description("Indicates if cloverage sensor should be disabled")
                 .build();
@@ -38,6 +38,6 @@ static PropertyDefinition getReportLocationProperty() {
     }
 
     static List<PropertyDefinition> getProperties() {
-        return asList(getDisabledProperty(), getReportLocationProperty());
+        return asList(getEnabledProperty(), getReportLocationProperty());
     }
 }
diff --git a/src/main/java/org/sonar/plugins/clojure/settings/KibitProperties.java b/src/main/java/org/sonar/plugins/clojure/settings/KibitProperties.java
@@ -10,23 +10,23 @@
 import static org.sonar.plugins.clojure.settings.Properties.SUB_CATEGORY;
 
 public class KibitProperties {
-    public static final String DISABLED_PROPERTY = "sonar.clojure.kibit.disabled";
-    public static final boolean DISABLED_PROPERTY_DEFAULT = false;
+    public static final String ENABLED_PROPERTY = "sonar.clojure.kibit.enabled";
+    public static final boolean ENABLED_PROPERTY_DEFAULT = true;
 
     private KibitProperties() {
     }
 
-    static PropertyDefinition getDisabledProperty() {
-        return PropertyDefinition.builder(DISABLED_PROPERTY)
+    static PropertyDefinition getEnabledProperty() {
+        return PropertyDefinition.builder(ENABLED_PROPERTY)
                 .category(MAIN_CATEGORY)
                 .subCategory(SUB_CATEGORY)
-                .defaultValue(valueOf(DISABLED_PROPERTY_DEFAULT))
+                .defaultValue(valueOf(ENABLED_PROPERTY_DEFAULT))
                 .name("Kibit Disabled")
                 .description("Indicates if kibit sensor should be disabled")
                 .build();
     }
 
     static List<PropertyDefinition> getProperties() {
-        return singletonList(getDisabledProperty());
+        return singletonList(getEnabledProperty());
     }
 }
diff --git a/src/main/java/org/sonar/plugins/clojure/settings/KondoProperties.java b/src/main/java/org/sonar/plugins/clojure/settings/KondoProperties.java
@@ -10,21 +10,21 @@
 import static org.sonar.plugins.clojure.settings.Properties.SUB_CATEGORY;
 
 public class KondoProperties {
-    public static final String DISABLED_PROPERTY = "sonar.clojure.kondo.disabled";
+    public static final String ENABLED_PROPERTY = "sonar.clojure.kondo.enabled";
     public static final String OPTIONS = "sonar.clojure.kondo.options";
     public static final String CONFIG = "sonar.clojure.kondo.config";
-    public static final boolean DISABLED_PROPERTY_DEFAULT = true;
+    public static final boolean ENABLED_PROPERTY_DEFAULT = false;
     public static final String DEFAULT_OPTIONS = "--lint src";
     public static final String DEFAULT_CONFIG = "{:output {:format :edn}}";
 
     private KondoProperties() {
     }
 
-    static PropertyDefinition getDisabledProperty() {
-        return PropertyDefinition.builder(DISABLED_PROPERTY)
+    static PropertyDefinition getEnabledProperty() {
+        return PropertyDefinition.builder(ENABLED_PROPERTY)
                 .category(MAIN_CATEGORY)
                 .subCategory(SUB_CATEGORY)
-                .defaultValue(valueOf(DISABLED_PROPERTY_DEFAULT))
+                .defaultValue(valueOf(ENABLED_PROPERTY_DEFAULT))
                 .name("clj-kondo disabled")
                 .description("Indicates if clj-kondo sensor should be disabled")
                 .build();
@@ -51,6 +51,6 @@ static PropertyDefinition getConfigProperty() {
     }
 
     static List<PropertyDefinition> getProperties() {
-        return asList(getDisabledProperty(), getOptionsProperty(), getConfigProperty());
+        return asList(getEnabledProperty(), getOptionsProperty(), getConfigProperty());
     }
 }
diff --git a/src/main/java/org/sonar/plugins/clojure/settings/NvdProperties.java b/src/main/java/org/sonar/plugins/clojure/settings/NvdProperties.java
@@ -10,19 +10,19 @@
 import static org.sonar.plugins.clojure.settings.Properties.SUB_CATEGORY;
 
 public class NvdProperties {
-    public static final String DISABLED_PROPERTY = "sonar.clojure.nvd.disabled";
-    public static final boolean DISABLED_PROPERTY_DEFAULT = false;
+    public static final String ENABLED_PROPERTY = "sonar.clojure.nvd.enabled";
+    public static final boolean ENABLED_PROPERTY_DEFAULT = true;
     public static final String REPORT_LOCATION_PROPERTY = "sonar.clojure.nvd.reportPath";
     public static final String REPORT_LOCATION_DEFAULT = "target/nvd/dependency-check-report.json";
 
     private NvdProperties() {
     }
 
-    static PropertyDefinition getDisabledProperty() {
-        return PropertyDefinition.builder(DISABLED_PROPERTY)
+    static PropertyDefinition getEnabledProperty() {
+        return PropertyDefinition.builder(ENABLED_PROPERTY)
                 .category(MAIN_CATEGORY)
                 .subCategory(SUB_CATEGORY)
-                .defaultValue(valueOf(DISABLED_PROPERTY_DEFAULT))
+                .defaultValue(valueOf(ENABLED_PROPERTY_DEFAULT))
                 .name("Lein NVD Disabled")
                 .description("Indicates if lein-nvd sensor should be disabled")
                 .build();
@@ -39,6 +39,6 @@ static PropertyDefinition getReportLocationProperty() {
     }
 
     static List<PropertyDefinition> getProperties() {
-        return asList(getDisabledProperty(), getReportLocationProperty());
+        return asList(getEnabledProperty(), getReportLocationProperty());
     }
 }
diff --git a/src/test/java/org/sonar/plugins/clojure/sensors/AbstractSensorTest.java b/src/test/java/org/sonar/plugins/clojure/sensors/AbstractSensorTest.java
@@ -11,9 +11,10 @@
 
 import java.io.File;
 
+import static junit.framework.TestCase.assertTrue;
+import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.CoreMatchers.hasItem;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.junit.Assert.assertTrue;
 
 @RunWith(MockitoJUnitRunner.class)
 public class AbstractSensorTest {
@@ -34,11 +35,11 @@ public void setUp() {
     @Test
     public void shouldDisablePluginWhenPropertyIsSet() {
         SensorContextTester context = SensorContextTester.create(new File("/"));
-        context.settings().appendProperty("property.foo", "true");
+        context.settings().appendProperty("property.enabled", "false");
 
-        boolean isDisabled = dummySensor.isPluginDisabled(context, "SOME_PLUGIN", "property.foo", false);
+        boolean isDisabled = dummySensor.isPluginEnabled(context, "SOME_PLUGIN", "property.enabled", true);
 
-        assertTrue(isDisabled);
+        assertThat(isDisabled, equalTo(false));
         assertThat(logTester.logs(), hasItem("SOME_PLUGIN disabled"));
     }
 

diff --git a/src/test/java/org/sonar/plugins/clojure/sensors/ancient/AncientSensorTest.java b/src/test/java/org/sonar/plugins/clojure/sensors/ancient/AncientSensorTest.java
@@ -11,6 +11,7 @@
 import org.sonar.plugins.clojure.language.Clojure;
 import org.sonar.plugins.clojure.sensors.LeiningenRunner;
 import org.sonar.plugins.clojure.sensors.CommandStreamConsumer;
+import org.sonar.plugins.clojure.settings.AncientProperties;
 
 import java.io.File;
 import java.io.IOException;
@@ -20,12 +21,12 @@
 import java.util.List;
 
 import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertThat;
-import static org.junit.Assert.assertTrue;
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.when;
 import static org.mockito.MockitoAnnotations.initMocks;
+import static org.sonar.plugins.clojure.settings.KondoProperties.ENABLED_PROPERTY;
 
 public class AncientSensorTest {
     @Mock
@@ -44,7 +45,7 @@ public void shouldConfigureSensor() {
         DefaultSensorDescriptor descriptor = new DefaultSensorDescriptor();
         ancientSensor.describe(descriptor);
         assertThat(descriptor.name(), is("Ancient"));
-        assertTrue(descriptor.languages().contains("clj"));
+        assertThat(descriptor.languages().contains("clj"), is(true));
         assertThat(descriptor.languages().size(), is(1));
     }
 
@@ -75,6 +76,8 @@ public void shouldExecuteAncient() throws IOException {
     private SensorContextTester prepareContext() throws IOException {
         SensorContextTester context = SensorContextTester.create(new File("/"));
 
+        context.settings().appendProperty(AncientProperties.ENABLED_PROPERTY, "true");
+
         File baseDir = new File("src/test/resources/");
         File file = new File(baseDir, "project.clj");
 

diff --git a/src/test/java/org/sonar/plugins/clojure/sensors/cloverage/CloverageSensorTest.java b/src/test/java/org/sonar/plugins/clojure/sensors/cloverage/CloverageSensorTest.java
@@ -14,6 +14,7 @@
 import org.sonar.plugins.clojure.language.Clojure;
 import org.sonar.plugins.clojure.sensors.LeiningenRunner;
 import org.sonar.plugins.clojure.sensors.CommandStreamConsumer;
+import org.sonar.plugins.clojure.settings.CloverageProperties;
 
 import java.io.File;
 import java.io.IOException;
@@ -26,6 +27,7 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 import static org.sonar.plugins.clojure.settings.CloverageProperties.REPORT_LOCATION_PROPERTY;
+import static org.sonar.plugins.clojure.settings.KondoProperties.ENABLED_PROPERTY;
 
 @RunWith(MockitoJUnitRunner.class)
 public class CloverageSensorTest {

diff --git a/src/test/java/org/sonar/plugins/clojure/sensors/kibit/KibitSensorTest.java b/src/test/java/org/sonar/plugins/clojure/sensors/kibit/KibitSensorTest.java
@@ -20,8 +20,7 @@
 import java.util.List;
 
 import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertThat;
-import static org.junit.Assert.assertTrue;
+import static org.hamcrest.MatcherAssert.assertThat;
 import static org.mockito.Mockito.when;
 import static org.mockito.MockitoAnnotations.initMocks;
 
@@ -43,7 +42,7 @@ public void shouldConfigureSensor() {
         DefaultSensorDescriptor descriptor = new DefaultSensorDescriptor();
         kibitSensor.describe(descriptor);
         assertThat(descriptor.name(), is("Kibit"));
-        assertTrue(descriptor.languages().contains("clj"));
+        assertThat(descriptor.languages().contains("clj"), is(true));
         assertThat(descriptor.languages().size(), is(1));
     }
 

diff --git a/src/test/java/org/sonar/plugins/clojure/sensors/kondo/KondoSensorTest.java b/src/test/java/org/sonar/plugins/clojure/sensors/kondo/KondoSensorTest.java
@@ -24,7 +24,6 @@
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.mockito.Mockito.when;
-import static org.mockito.MockitoAnnotations.initMocks;
 import static org.sonar.plugins.clojure.settings.KondoProperties.*;
 
 @RunWith(MockitoJUnitRunner.class)
@@ -73,7 +72,7 @@ private SensorContextTester prepareContext() throws IOException {
 
         context.settings().appendProperty(OPTIONS, "--lint src");
         context.settings().appendProperty(CONFIG, "{:output {:format :edn}}");
-        context.settings().appendProperty(DISABLED_PROPERTY, "false");
+        context.settings().appendProperty(ENABLED_PROPERTY, "true");
 
         File baseDir = new File("src/test/resources/");
         File file = new File(baseDir, "file.clj");

diff --git a/src/test/java/org/sonar/plugins/clojure/settings/AncientPropertiesTest.java b/src/test/java/org/sonar/plugins/clojure/settings/AncientPropertiesTest.java
@@ -10,11 +10,11 @@ public class AncientPropertiesTest {
     @Test
     public void shouldHaveAncientDisabledProperty() {
         PropertyDefinition ancientDisabled = AncientProperties.getAncientDisabled();
-        assertThat(ancientDisabled.key(), is("sonar.clojure.ancient.disabled"));
+        assertThat(ancientDisabled.key(), is("sonar.clojure.ancient.enabled"));
         assertThat(ancientDisabled.name(), is("Ancient Disabled"));
         assertThat(ancientDisabled.category(), is("SonarClojure"));
         assertThat(ancientDisabled.subCategory(), is("Sensors"));
-        assertThat(ancientDisabled.defaultValue(), is("false"));
+        assertThat(ancientDisabled.defaultValue(), is("true"));
         assertThat(ancientDisabled.description(), is("Indicates the ancient sensor should be disabled"));
     }