Add sonar.ce.gracefulStopTimeOutInMs for unit tests

diff --git a/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeConfiguration.java b/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeConfiguration.java
index f1fd9a3f3fc1ffa4210bc0adb0d1b253ddff7915..d4d4bdbb32e6ce711c33afbfcde0c55bfaa8d11d 100644 (file)
--- a/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeConfiguration.java
+++ b/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeConfiguration.java
@@ -52,4 +52,9 @@ public interface CeConfiguration {
    */
   long getCleanCeTasksDelay();
 
+  /**
+   * Delay before stopping workers during a graceful timeout using milliseconds unit.
+   */
+  int getGracefulStopTimeoutInMs();
+
 }

diff --git a/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeConfigurationImpl.java b/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeConfigurationImpl.java
index ca43fd3abe5bd99423ed2e41246fed00ddb5174d..3a1c704da149cd77f5176fad6d3c13bb97f55ba0 100644 (file)
--- a/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeConfigurationImpl.java
+++ b/server/sonar-ce/src/main/java/org/sonar/ce/configuration/CeConfigurationImpl.java
@@ -21,6 +21,7 @@ package org.sonar.ce.configuration;
 
 import javax.annotation.CheckForNull;
 import org.picocontainer.Startable;
+import org.sonar.api.config.Configuration;
 import org.sonar.api.utils.MessageException;
 
 import static java.lang.String.format;
@@ -41,22 +42,28 @@ public class CeConfigurationImpl implements CeConfiguration, Startable {
   private static final long CANCEL_WORN_OUTS_INITIAL_DELAY = 1;
   // 10 minutes
   private static final long CANCEL_WORN_OUTS_DELAY = 10;
+  // 40 seconds
+  private static final int GRACEFUL_STOP_TIMEOUT = 40;
+  public static final String SONAR_CE_GRACEFUL_STOP_TIME_OUT_IN_MS = "sonar.ce.gracefulStopTimeOutInMs";
 
   @CheckForNull
   private final WorkerCountProvider workerCountProvider;
   private final int workerThreadCount;
+  private final int gracefultStopTimeoutInMs;
   private int workerCount;
 
-  public CeConfigurationImpl() {
+  public CeConfigurationImpl(Configuration configuration) {
     this.workerCountProvider = null;
     this.workerThreadCount = DEFAULT_WORKER_THREAD_COUNT;
     this.workerCount = DEFAULT_WORKER_COUNT;
+    this.gracefultStopTimeoutInMs = configuration.getInt(SONAR_CE_GRACEFUL_STOP_TIME_OUT_IN_MS).orElse(GRACEFUL_STOP_TIMEOUT);
   }
 
-  public CeConfigurationImpl(WorkerCountProvider workerCountProvider) {
+  public CeConfigurationImpl(Configuration configuration, WorkerCountProvider workerCountProvider) {
     this.workerCountProvider = workerCountProvider;
     this.workerThreadCount = MAX_WORKER_THREAD_COUNT;
     this.workerCount = readWorkerCount(workerCountProvider);
+    this.gracefultStopTimeoutInMs = configuration.getInt(SONAR_CE_GRACEFUL_STOP_TIME_OUT_IN_MS).orElse(GRACEFUL_STOP_TIMEOUT);
   }
 
   private static int readWorkerCount(WorkerCountProvider workerCountProvider) {
@@ -115,4 +122,9 @@ public class CeConfigurationImpl implements CeConfiguration, Startable {
     return CANCEL_WORN_OUTS_DELAY;
   }
 
+  @Override
+  public int getGracefulStopTimeoutInMs() {
+    return gracefultStopTimeoutInMs;
+  }
+
 }

diff --git a/server/sonar-ce/src/main/java/org/sonar/ce/taskprocessor/CeProcessingSchedulerImpl.java b/server/sonar-ce/src/main/java/org/sonar/ce/taskprocessor/CeProcessingSchedulerImpl.java
index c3549ca18d3c2c8928461b22882797d9e66525e1..0f1d756b9ddf4b620cccc458f149caabc1e14d2a 100644 (file)
--- a/server/sonar-ce/src/main/java/org/sonar/ce/taskprocessor/CeProcessingSchedulerImpl.java
+++ b/server/sonar-ce/src/main/java/org/sonar/ce/taskprocessor/CeProcessingSchedulerImpl.java
@@ -42,6 +42,7 @@ public class CeProcessingSchedulerImpl implements CeProcessingScheduler {
   private final TimeUnit timeUnit;
   private final ChainingCallback[] chainingCallbacks;
   private final EnabledCeWorkerController ceWorkerController;
+  private final int gracefulStopTimeoutInMs;
 
   public CeProcessingSchedulerImpl(CeConfiguration ceConfiguration,
     CeProcessingSchedulerExecutorService processingExecutorService, CeWorkerFactory ceCeWorkerFactory,
@@ -49,6 +50,7 @@ public class CeProcessingSchedulerImpl implements CeProcessingScheduler {
     this.executorService = processingExecutorService;
 
     this.delayBetweenEnabledTasks = ceConfiguration.getQueuePollingDelay();
+    this.gracefulStopTimeoutInMs = ceConfiguration.getGracefulStopTimeoutInMs();
     this.ceWorkerController = ceWorkerController;
     this.timeUnit = MILLISECONDS;
 
@@ -80,7 +82,7 @@ public class CeProcessingSchedulerImpl implements CeProcessingScheduler {
     }
 
     // Workers have 40s to gracefully stop processing tasks
-    long until = System.currentTimeMillis() + 40_000L;
+    long until = System.currentTimeMillis() + gracefulStopTimeoutInMs;
     LOG.info("Waiting for workers to finish in-progress tasks");
     while (System.currentTimeMillis() < until && ceWorkerController.hasAtLeastOneProcessingWorker()) {
       try {

diff --git a/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeConfigurationImplTest.java b/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeConfigurationImplTest.java
index 65f2b5a3c00cfa7f381868081b2cccef1bf6fda6..adbc160c54e651ae2953011ed1c1c72c8a1956f5 100644 (file)
--- a/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeConfigurationImplTest.java
+++ b/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeConfigurationImplTest.java
@@ -24,12 +24,15 @@ import java.util.stream.IntStream;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
+import org.sonar.api.config.internal.ConfigurationBridge;
+import org.sonar.api.config.internal.MapSettings;
 import org.sonar.api.utils.MessageException;
 
 import static java.lang.Math.abs;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class CeConfigurationImplTest {
+  public static final ConfigurationBridge EMPTY_CONFIGURATION = new ConfigurationBridge(new MapSettings());
   @Rule
   public ExpectedException expectedException = ExpectedException.none();
 
@@ -37,12 +40,12 @@ public class CeConfigurationImplTest {
 
   @Test
   public void getWorkerCount_returns_1_when_there_is_no_WorkerCountProvider() {
-    assertThat(new CeConfigurationImpl().getWorkerCount()).isEqualTo(1);
+    assertThat(new CeConfigurationImpl(EMPTY_CONFIGURATION).getWorkerCount()).isEqualTo(1);
   }
 
   @Test
   public void getWorkerMaxCount_returns_1_when_there_is_no_WorkerCountProvider() {
-    assertThat(new CeConfigurationImpl().getWorkerMaxCount()).isEqualTo(1);
+    assertThat(new CeConfigurationImpl(EMPTY_CONFIGURATION).getWorkerMaxCount()).isEqualTo(1);
   }
 
   @Test
@@ -50,7 +53,7 @@ public class CeConfigurationImplTest {
     int value = randomValidWorkerCount();
     workerCountProvider.set(value);
 
-    assertThat(new CeConfigurationImpl(workerCountProvider).getWorkerCount()).isEqualTo(value);
+    assertThat(new CeConfigurationImpl(EMPTY_CONFIGURATION, workerCountProvider).getWorkerCount()).isEqualTo(value);
   }
 
   @Test
@@ -58,7 +61,7 @@ public class CeConfigurationImplTest {
     int value = randomValidWorkerCount();
     workerCountProvider.set(value);
 
-    assertThat(new CeConfigurationImpl(workerCountProvider).getWorkerMaxCount()).isEqualTo(10);
+    assertThat(new CeConfigurationImpl(EMPTY_CONFIGURATION, workerCountProvider).getWorkerMaxCount()).isEqualTo(10);
   }
 
   @Test
@@ -67,7 +70,7 @@ public class CeConfigurationImplTest {
 
     expectMessageException(0);
 
-    new CeConfigurationImpl(workerCountProvider);
+    new CeConfigurationImpl(EMPTY_CONFIGURATION, workerCountProvider);
   }
 
   @Test
@@ -77,7 +80,7 @@ public class CeConfigurationImplTest {
 
     expectMessageException(value);
 
-    new CeConfigurationImpl(workerCountProvider);
+    new CeConfigurationImpl(EMPTY_CONFIGURATION, workerCountProvider);
   }
 
   @Test
@@ -87,7 +90,7 @@ public class CeConfigurationImplTest {
 
     expectMessageException(value);
 
-    new CeConfigurationImpl(workerCountProvider);
+    new CeConfigurationImpl(EMPTY_CONFIGURATION, workerCountProvider);
   }
 
   private void expectMessageException(int value) {
@@ -98,25 +101,25 @@ public class CeConfigurationImplTest {
 
   @Test
   public void getCleanCeTasksInitialDelay_returns_1() {
-    assertThat(new CeConfigurationImpl().getCleanCeTasksInitialDelay())
+    assertThat(new CeConfigurationImpl(EMPTY_CONFIGURATION).getCleanCeTasksInitialDelay())
       .isEqualTo(1L);
     workerCountProvider.set(1);
-    assertThat(new CeConfigurationImpl(workerCountProvider).getCleanCeTasksInitialDelay())
+    assertThat(new CeConfigurationImpl(EMPTY_CONFIGURATION, workerCountProvider).getCleanCeTasksInitialDelay())
       .isEqualTo(1L);
   }
 
   @Test
   public void getCleanCeTasksDelay_returns_10() {
-    assertThat(new CeConfigurationImpl().getCleanCeTasksDelay())
+    assertThat(new CeConfigurationImpl(EMPTY_CONFIGURATION).getCleanCeTasksDelay())
       .isEqualTo(10L);
     workerCountProvider.set(1);
-    assertThat(new CeConfigurationImpl(workerCountProvider).getCleanCeTasksDelay())
+    assertThat(new CeConfigurationImpl(EMPTY_CONFIGURATION, workerCountProvider).getCleanCeTasksDelay())
       .isEqualTo(10L);
   }
 
   @Test
   public void refresh_does_not_change_any_value_when_there_is_no_WorkerCountProvider() {
-    CeConfigurationImpl underTest = new CeConfigurationImpl();
+    CeConfigurationImpl underTest = new CeConfigurationImpl(EMPTY_CONFIGURATION);
     long cleanCeTasksInitialDelay = underTest.getCleanCeTasksInitialDelay();
     long cleanCeTasksDelay = underTest.getCleanCeTasksDelay();
     long queuePollingDelay = underTest.getQueuePollingDelay();
@@ -137,7 +140,7 @@ public class CeConfigurationImplTest {
   @Test
   public void refresh_updates_only_workerCount_from_WorkerCountProvider_when_there_WorkerCountProvider_is_present() {
     workerCountProvider.set(randomValidWorkerCount());
-    CeConfigurationImpl underTest = new CeConfigurationImpl(workerCountProvider);
+    CeConfigurationImpl underTest = new CeConfigurationImpl(EMPTY_CONFIGURATION, workerCountProvider);
     long cleanCeTasksInitialDelay = underTest.getCleanCeTasksInitialDelay();
     long cleanCeTasksDelay = underTest.getCleanCeTasksDelay();
     long queuePollingDelay = underTest.getQueuePollingDelay();

diff --git a/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeConfigurationRule.java b/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeConfigurationRule.java
index 95fa52a359de231b7f84e56fc590e61f604f7c4c..56a66ca66f825480de85adabb4c4e9aa4d0f2dc6 100644 (file)
--- a/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeConfigurationRule.java
+++ b/server/sonar-ce/src/test/java/org/sonar/ce/configuration/CeConfigurationRule.java
@@ -92,6 +92,11 @@ public class CeConfigurationRule extends ExternalResource implements CeConfigura
     return cancelWornOutsDelay;
   }
 
+  @Override
+  public int getGracefulStopTimeoutInMs() {
+    return 40_000;
+  }
+
   public void setCleanCeTasksDelay(long cancelWornOutsDelay) {
     checkArgument(cancelWornOutsDelay > 0, "cancel worn-outs polling delay must be >= 1");
     this.cancelWornOutsDelay = cancelWornOutsDelay;

diff --git a/server/sonar-ce/src/test/java/org/sonar/ce/monitoring/CeTasksMBeanImplTest.java b/server/sonar-ce/src/test/java/org/sonar/ce/monitoring/CeTasksMBeanImplTest.java
index 277d2d3ced830d1332a9731087d830a1cd87e869..c161c86d5a8438cab1a11b37ad665a8f5d207157 100644 (file)
--- a/server/sonar-ce/src/test/java/org/sonar/ce/monitoring/CeTasksMBeanImplTest.java
+++ b/server/sonar-ce/src/test/java/org/sonar/ce/monitoring/CeTasksMBeanImplTest.java
@@ -160,6 +160,11 @@ public class CeTasksMBeanImplTest {
       throw new UnsupportedOperationException("getCleanCeTasksDelay is not implemented");
     }
 
+    @Override
+    public int getGracefulStopTimeoutInMs() {
+      return 40_000;
+    }
+
   }
 
   @CheckForNull

diff --git a/tests/src/test/java/org/sonarqube/tests/ce/CeShutdownTest.java b/tests/src/test/java/org/sonarqube/tests/ce/CeShutdownTest.java
index 07ae9a9c5963b5b1ad590db3bb0bc8b8cc5d2a10..ab19828ace44fa7625520331dc26d616921519df 100644 (file)
--- a/tests/src/test/java/org/sonarqube/tests/ce/CeShutdownTest.java
+++ b/tests/src/test/java/org/sonarqube/tests/ce/CeShutdownTest.java
@@ -25,7 +25,6 @@ import java.io.File;
 import java.io.IOException;
 import java.util.regex.Pattern;
 import org.apache.commons.io.FileUtils;
-import org.junit.Ignore;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.DisableOnDebug;
@@ -49,7 +48,7 @@ public class CeShutdownTest {
 
   @Test
   public void stopping_CE_waits_for_in_progress_task_to_be_finished() throws Exception {
-    try (ComputeEngine ce = new ComputeEngine()) {
+    try (ComputeEngine ce = new ComputeEngine(40_000)) {
 
       try (LogsTailer.Watch watch = ce.logs().watch("CE analysis is paused")) {
         ce.triggerTask();
@@ -77,9 +76,8 @@ public class CeShutdownTest {
   }
 
   @Test
-  @Ignore("TODO make the graceful stop timeout configurable. 40 seconds is too long for a test.")
   public void stopping_CE_kills_in_progress_tasks_if_too_long_to_gracefully_stop() throws Exception {
-    try (ComputeEngine ce = new ComputeEngine()) {
+    try (ComputeEngine ce = new ComputeEngine(10)) {
 
       try (LogsTailer.Watch watch = ce.logs().watch("CE analysis is paused")) {
         ce.triggerTask();
@@ -95,11 +93,10 @@ public class CeShutdownTest {
         assertThat(ce.countInProgressTasks()).isEqualTo(1);
       }
 
-      // resume the in-progress task, so that it can
-      // finish successfully
+      // wait for task to be hard killed
       try (LogsTailer.Watch watch = ce.logs().watch("Process [ce] is stopped")) {
         watch.waitForLog();
-        assertThat(ce.hasTaskFinishedSuccessfully()).isTrue();
+        assertThat(ce.hasTaskFinishedSuccessfully()).isFalse();
         assertThat(ce.hasErrorLogs()).isTrue();
       }
     }
@@ -113,12 +110,13 @@ public class CeShutdownTest {
     private final LogsTailer logsTailer;
     private final LogsTailer.Content content = new LogsTailer.Content();
 
-    ComputeEngine() throws Exception {
+    ComputeEngine(int timeOutInMs) throws Exception {
       pauseFile = temp.newFile();
       FileUtils.touch(pauseFile);
 
       orchestrator = Orchestrator.builderEnv()
         .setServerProperty("sonar.ce.pauseTask.path", pauseFile.getAbsolutePath())
+        .setServerProperty("sonar.ce.gracefulStopTimeOutInMs", "" + timeOutInMs)
         .addPlugin(ItUtils.xooPlugin())
         .addPlugin(ItUtils.pluginArtifact("server-plugin"))
         .build();