SONAR-9507 add warning at CE startup if sonar.ce.workerCount exists

2 files changed, 123 insertions, 0 deletions

diff --git a/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeWorkerCountSettingWarning.java b/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeWorkerCountSettingWarning.java
new file mode 100644
index 00000000000..018e017028c
--- /dev/null
+++ b/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeWorkerCountSettingWarning.java
@@ -0,0 +1,53 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2017 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.ce.configuration;
+
+import org.picocontainer.Startable;
+import org.sonar.api.config.Configuration;
+import org.sonar.api.utils.log.Logger;
+import org.sonar.api.utils.log.Loggers;
+
+/**
+ * Displays a warning in the logs if property "sonar.ce.workerCount" is defined as it has been replaced
+ * by an internal property (see SONAR-9507).
+ */
+public class CeWorkerCountSettingWarning implements Startable {
+  private static final String PROPERTY_SONAR_CE_WORKER_COUNT = "sonar.ce.workerCount";
+  private static final Logger LOG = Loggers.get(CeWorkerCountSettingWarning.class);
+
+  private final Configuration configuration;
+
+  public CeWorkerCountSettingWarning(Configuration configuration) {
+    this.configuration = configuration;
+  }
+
+  @Override
+  public void start() {
+    configuration.get(PROPERTY_SONAR_CE_WORKER_COUNT)
+      .ifPresent(workerCount -> LOG.warn("Property {} is not supported anymore and will be ignored." +
+        " Remove it from sonar.properties to remove this warning.",
+        PROPERTY_SONAR_CE_WORKER_COUNT));
+  }
+
+  @Override
+  public void stop() {
+    // nothing to do
+  }
+}
diff --git a/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeWorkerCountSettingWarningTest.java b/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeWorkerCountSettingWarningTest.java
new file mode 100644
index 00000000000..88d2a4a146d
--- /dev/null
+++ b/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeWorkerCountSettingWarningTest.java
@@ -0,0 +1,70 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2017 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.ce.configuration;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.sonar.api.config.internal.MapSettings;
+import org.sonar.api.utils.log.LogTester;
+import org.sonar.api.utils.log.LoggerLevel;
+
+import static org.apache.commons.lang.RandomStringUtils.randomAlphabetic;
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class CeWorkerCountSettingWarningTest {
+  private static final String PROPERTY_SONAR_CE_WORKER_COUNT = "sonar.ce.workerCount";
+
+  @Rule
+  public LogTester logTester = new LogTester();
+
+  private MapSettings settings = new MapSettings();
+  private CeWorkerCountSettingWarning underTest = new CeWorkerCountSettingWarning(settings.asConfig());
+
+  @Test
+  public void start_does_not_log_anything_if_there_is_no_settings() {
+    underTest.start();
+
+    assertThat(logTester.logs()).isEmpty();
+  }
+
+  @Test
+  public void start_logs_a_warning_if_property_workerCount_exists_and_empty() {
+    settings.setProperty(PROPERTY_SONAR_CE_WORKER_COUNT, "");
+
+    underTest.start();
+
+    verifyWarnMessage();
+  }
+
+  @Test
+  public void start_logs_a_warning_if_property_ceWorkerCount_exists_with_a_value() {
+    settings.setProperty(PROPERTY_SONAR_CE_WORKER_COUNT, randomAlphabetic(12));
+
+    underTest.start();
+
+    verifyWarnMessage();
+  }
+
+  private void verifyWarnMessage() {
+    assertThat(logTester.logs()).hasSize(1);
+    assertThat(logTester.logs(LoggerLevel.WARN)).containsOnly("Property sonar.ce.workerCount is not supported anymore and will be ignored." +
+      " Remove it from sonar.properties to remove this warning.");
+  }
+}