feat: config startup timeout (#80)

Author: csviri

core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServer.java

@@ -31,7 +31,7 @@ public KubeAPIServer(KubeAPIServerConfig config) {
     this.certManager = new CertManager(config.getJenvtestDir());
     this.kubeConfig = new KubeConfig(certManager, binaryManager);
     this.etcdProcess = new EtcdProcess(binaryManager, this,
-        config.isWaitForEtcdHealthCheckOnStartup());
+        config.isWaitForEtcdHealthCheckOnStartup(), config.getStartupTimeout());
     this.kubeApiServerProcess =
         new KubeAPIServerProcess(certManager, binaryManager, this, config);
   }

core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServerConfig.java

@@ -43,19 +43,27 @@ public class KubeAPIServerConfig {
   private final boolean updateKubeConfig;
 
   /**
-   * This is mostly not needed, and increases startup time.
+   * This is mostly not needed, and increases startup time. Might be removed in the future.
    */
   private final boolean waitForEtcdHealthCheckOnStartup;
 
+  /**
+   * Startup timeout of Kube API Server (and ETCD if enabled - might adds up in this case), the
+   * default value is quite high, to support parallel tests. Tuning is possible based on the actual
+   * setup.
+   */
+  private final int startupTimeout;
+
   KubeAPIServerConfig(String jenvtestDir, String apiServerVersion, boolean offlineMode,
       List<String> apiServerFlags, boolean updateKubeConfig,
-      boolean waitForEtcdHealthCheckOnStartup) {
+      boolean waitForEtcdHealthCheckOnStartup, int startupTimeout) {
     this.jenvtestDir = jenvtestDir;
     this.apiServerVersion = apiServerVersion;
     this.offlineMode = offlineMode;
     this.apiServerFlags = apiServerFlags;
     this.updateKubeConfig = updateKubeConfig;
     this.waitForEtcdHealthCheckOnStartup = waitForEtcdHealthCheckOnStartup;
+    this.startupTimeout = startupTimeout;
   }
 
   public String getJenvtestDir() {
@@ -81,4 +89,8 @@ public boolean isUpdateKubeConfig() {
   public boolean isWaitForEtcdHealthCheckOnStartup() {
     return waitForEtcdHealthCheckOnStartup;
   }
+
+  public int getStartupTimeout() {
+    return startupTimeout;
+  }
 }

core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServerConfigBuilder.java

@@ -12,6 +12,7 @@ public final class KubeAPIServerConfigBuilder {
   public static final String JENVTEST_API_SERVER_VERSION_ENV_VAR = "JENVTEST_API_SERVER_VERSION";
   public static final String JENVTEST_WAIT_FOR_ETCD_HEALTH_CHECK =
       "JENVTEST_WAIT_FOR_ETCD_HEALTH_CHECK";
+  public static final String JENVTEST_STARTUP_TIMEOUT = "JENVTEST_STARTUP_TIMEOUT";
 
   public static final String DIRECTORY_NAME = ".jenvtest";
 
@@ -21,6 +22,7 @@ public final class KubeAPIServerConfigBuilder {
   private boolean updateKubeConfig = false;
   private final List<String> apiServerFlags = new ArrayList<>(0);
   private Boolean waitForEtcdHealthCheckOnStartup;
+  private Integer startupTimeout;
 
   public KubeAPIServerConfigBuilder() {}
 
@@ -75,8 +77,16 @@ public KubeAPIServerConfig build() {
         this.waitForEtcdHealthCheckOnStartup = false;
       }
     }
+    if (startupTimeout == null) {
+      var envStartupTimeout = System.getenv(JENVTEST_STARTUP_TIMEOUT);
+      if (envStartupTimeout != null) {
+        this.startupTimeout = Integer.parseInt(envStartupTimeout);
+      } else {
+        this.startupTimeout = 60_000;
+      }
+    }
     return new KubeAPIServerConfig(jenvtestDir, apiServerVersion, offlineMode, apiServerFlags,
-        updateKubeConfig, waitForEtcdHealthCheckOnStartup);
+        updateKubeConfig, waitForEtcdHealthCheckOnStartup, startupTimeout);
   }
 
   public KubeAPIServerConfigBuilder withUpdateKubeConfig(boolean updateKubeConfig) {
@@ -102,6 +112,11 @@ public KubeAPIServerConfigBuilder withApiServerFlag(String key) {
     return this;
   }
 
+  public KubeAPIServerConfigBuilder withStartupTimeout(Integer startupTimeout) {
+    this.startupTimeout = startupTimeout;
+    return this;
+  }
+
   public KubeAPIServerConfigBuilder withWaitForEtcdHealthCheckOnStartup(
       boolean waitForEtcdHealthCheckOnStartup) {
     this.waitForEtcdHealthCheckOnStartup = waitForEtcdHealthCheckOnStartup;

core/src/main/java/io/javaoperatorsdk/jenvtest/process/EtcdProcess.java

@@ -24,14 +24,17 @@ public class EtcdProcess {
   private volatile boolean stopped = false;
   private final UnexpectedProcessStopHandler processStopHandler;
   private final boolean waitForHealthCheck;
+  private final int startupTimeout;
   private File tempWalDir;
   private File tempDataDir;
 
   public EtcdProcess(BinaryManager binaryManager,
-      UnexpectedProcessStopHandler processStopHandler, boolean waitForHealthCheck) {
+      UnexpectedProcessStopHandler processStopHandler, boolean waitForHealthCheck,
+      int startupTimeout) {
     this.binaryManager = binaryManager;
     this.processStopHandler = processStopHandler;
     this.waitForHealthCheck = waitForHealthCheck;
+    this.startupTimeout = startupTimeout;
   }
 
   public int startEtcd() {
@@ -79,7 +82,7 @@ public int startEtcd() {
   }
 
   private void waitUntilEtcdHealthy(int port) {
-    new ProcessReadinessChecker().waitUntilReady(port, "health", "etcd", false);
+    new ProcessReadinessChecker().waitUntilReady(port, "health", "etcd", false, startupTimeout);
   }
 
   public void cleanEtcdData() {

core/src/main/java/io/javaoperatorsdk/jenvtest/process/KubeAPIServerProcess.java

@@ -87,8 +87,12 @@ private List<String> createCommand(File apiServerBinary, int apiServerPort, int
 
   public void waitUntilReady() {
     var readinessChecker = new ProcessReadinessChecker();
-    readinessChecker.waitUntilReady(apiServerPort, "readyz", KUBE_API_SERVER, true);
-    readinessChecker.waitUntilDefaultNamespaceAvailable(apiServerPort, binaryManager, certManager);
+    var timeout = config.getStartupTimeout();
+    var startTime = System.currentTimeMillis();
+    readinessChecker.waitUntilReady(apiServerPort, "readyz", KUBE_API_SERVER, true, timeout);
+    int newTimout = (int) (timeout - (System.currentTimeMillis() - startTime));
+    readinessChecker.waitUntilDefaultNamespaceAvailable(apiServerPort, binaryManager, certManager,
+        newTimout);
   }
 
   public void stopApiServer() {

core/src/main/java/io/javaoperatorsdk/jenvtest/process/ProcessReadinessChecker.java

@@ -34,15 +34,13 @@ public class ProcessReadinessChecker {
 
   private static final Logger log = LoggerFactory.getLogger(ProcessReadinessChecker.class);
 
-  public static final int STARTUP_TIMEOUT = 60_000;
   public static final int POLLING_INTERVAL = 200;
 
-
   public void waitUntilDefaultNamespaceAvailable(int apiServerPort,
       BinaryManager binaryManager,
-      CertManager certManager) {
+      CertManager certManager, int timeoutMillis) {
     pollWithTimeout(() -> defaultNamespaceExists(apiServerPort, binaryManager, certManager),
-        KUBE_API_SERVER);
+        KUBE_API_SERVER, timeoutMillis);
   }
 
   private boolean defaultNamespaceExists(int apiServerPort, BinaryManager binaryManager,
@@ -65,20 +63,21 @@ private boolean defaultNamespaceExists(int apiServerPort, BinaryManager binaryMa
   }
 
   public void waitUntilReady(int port, String readyCheckPath, String processName,
-      boolean useTLS) {
+      boolean useTLS, int timeoutMillis) {
     var client = getHttpClient();
     var request = getHttpRequest(useTLS, readyCheckPath, port);
-    pollWithTimeout(() -> ready(client, request, processName, port), processName);
+    pollWithTimeout(() -> ready(client, request, processName, port), processName, timeoutMillis);
   }
 
-  private static void pollWithTimeout(BooleanSupplier predicate, String processName) {
+  private static void pollWithTimeout(BooleanSupplier predicate, String processName,
+      int timeoutMillis) {
     try {
       var startedAt = LocalTime.now();
       while (true) {
         if (predicate.getAsBoolean()) {
           return;
         }
-        if (LocalTime.now().isAfter(startedAt.plus(STARTUP_TIMEOUT, ChronoUnit.MILLIS))) {
+        if (LocalTime.now().isAfter(startedAt.plus(timeoutMillis, ChronoUnit.MILLIS))) {
           throw new JenvtestException(processName + " did not start properly");
         }
         Thread.sleep(POLLING_INTERVAL);

core/src/test/java/io/javaoperatorsdk/jenvtest/sample/KubeApiServerTest.java

@@ -5,12 +5,14 @@
 import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.jenvtest.JenvtestException;
 import io.javaoperatorsdk.jenvtest.KubeAPIServer;
 import io.javaoperatorsdk.jenvtest.KubeAPIServerConfigBuilder;
 
 import static io.javaoperatorsdk.jenvtest.sample.TestUtils.NON_LATEST_API_SERVER_VERSION;
 import static io.javaoperatorsdk.jenvtest.sample.TestUtils.simpleTest;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 class KubeApiServerTest {
 
@@ -66,6 +68,14 @@ void creatingClientFromConfigString() {
     kubeApi.stop();
   }
 
+  @Test
+  void canSetStartupTimeout() {
+    var kubeApi = new KubeAPIServer(KubeAPIServerConfigBuilder.anAPIServerConfig()
+        .withStartupTimeout(500)
+        .build());
+    assertThrows(JenvtestException.class, kubeApi::start);
+  }
+
   void testWithAPIServer(KubeAPIServer kubeApi) {
     kubeApi.start();
     var client = createClient(kubeApi.getKubeConfigYaml());