Merge pull request #1062 from turkeylurkey/issue-1060

Add environment variable to set the timeout when starting dev mode Liberty for debugging

Author: turkeylurkey

src/main/java/io/openliberty/tools/intellij/util/DebugModeHandler.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022 IBM Corporation.
+ * Copyright (c) 2022, 2024 IBM Corporation.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -165,15 +165,16 @@ private void createAndRunDebugConfiguration(ProgressIndicator indicator, Liberty
      */
     private String waitForSocketActivation(ProgressIndicator monitor, LibertyModule libertyModule, String host, int debugPort) throws Exception {
         byte[] handshakeString = "JDWP-Handshake".getBytes(StandardCharsets.US_ASCII);
-        int retryLimit = 60; // wait up to 3 minutes for dev mode to start (polling rate 20 per minute, 3s)
+        int retryLimit = getDebuggerTimeoutInSeconds();
+        int retryInc = 3; // time to wait after each try
 
         // Retrieve the location of the server.env in the liberty installation at the default location (wpl/usr/servers/<serverName>).
         Path serverEnvPath = getServerEnvPath(libertyModule);
         // If the server.env has not been created yet then someone did a 'clean' before starting
         boolean cleanStart = serverEnvPath == null;
         Path serverEnvBakPath = null;
 
-        for (int retryCount = 0; retryCount < retryLimit; retryCount++) {
+        for (int retryCount = 0; retryCount < retryLimit; retryCount+=retryInc) {
             // check if cancelled
             if (monitor.isCanceled()) {
                 return null;
@@ -210,11 +211,30 @@ private String waitForSocketActivation(ProgressIndicator monitor, LibertyModule
                     LOGGER.trace(String.format("ConnectException waiting for runtime to start on port %d", debugPort));
                 }
             }
-            TimeUnit.SECONDS.sleep(3);
+            TimeUnit.SECONDS.sleep(retryInc);
         }
         throw new Exception(LocalizedResourceUtil.getMessage("cannot.attach.debugger.host.port", host, String.format("%d",debugPort)));
     }
 
+    /**
+     * Check an environment variable to see if the user specifies a timeout to use for the debugger.
+     * This is not an exposed environment variable, it is only used for testing.
+     */
+    private int getDebuggerTimeoutInSeconds() {
+        // Number of seconds to wait for Liberty dev mode to start. Note that Gradle can take a while
+        // to get going so we default to 3 minutes. During testing it can take even longer, 4-5 minutes.
+        int defaultTimeout = 180;
+        String userSpecifiedTimeout = System.getenv("LIBERTY_TOOLS_INTELLIJ_DEBUGGER_TIMEOUT");
+        if (userSpecifiedTimeout != null) {
+            try {
+                return Integer.parseInt(userSpecifiedTimeout);
+            } catch (NumberFormatException n) {
+                // return the default below
+            }
+        }
+        return defaultTimeout;
+    }
+
     /**
      * Returns the default path of the server.env file after Liberty server deployment.
      *

src/test/resources/ci/scripts/run.sh

@@ -155,6 +155,8 @@ main() {
 
     # Start the IDE.
     echo -e "\n$(${currentTime[@]}): INFO: Starting the IntelliJ IDE..."
+    # Have liberty tools debugger wait 480s for Maven or Gradle dev mode to start
+    export LIBERTY_TOOLS_INTELLIJ_DEBUGGER_TIMEOUT=480
     ./gradlew runIdeForUiTests -PuseLocal=$USE_LOCAL_PLUGIN --info  > remoteServer.log  2>&1 &
 
     # Wait for the IDE to come up.