Add option to change "timeout" for idle Selenium Grid tests

Author: mdmintz

seleniumbase/utilities/selenium_grid/ReadMe.md

@@ -18,17 +18,18 @@ seleniumbase download server
 <h4><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Grid Hub server controls:</h4>
 
 ```bash
-seleniumbase grid-hub {start|stop} [OPTIONS]
+seleniumbase grid-hub {start|stop|restart} [OPTIONS]
 ```
 <b>Options:</b>
 <ul>
 <li> -v / --verbose  (Increases verbosity of logging output.)</li>
+<li> --timeout=TIMEOUT  (Close idle browser after TIMEOUT sec.)</li>
 </ul>
 
 <h4><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Grid node server controls:</h4>
 
 ```bash
-seleniumbase grid-node {start|stop} --hub=[HUB_IP] [OPTIONS]
+seleniumbase grid-node {start|stop|restart} --hub=[HUB_IP] [OPTIONS]
 ```
 <b>Options:</b>
 <ul>

seleniumbase/utilities/selenium_grid/grid-hub

@@ -1,16 +1,16 @@
 #!/usr/bin/env bash
 
 #
-# Usage: grid-hub {start|stop|restart}
+# Usage: grid-hub {start|stop} [TIMEOUT]
 #
 
 source $(dirname $0)/font_color
 
-EXPECTED_ARGS=1
+EXPECTED_ARGS=2
 E_BADARGS=65
 
 DO_showUsage() {
-    echo "Usage: $(basename $0) {start|stop|restart}"
+    echo "Usage: $(basename $0) {start|stop} [TIMEOUT]"
     exit $E_BADARGS
 }
 
@@ -34,7 +34,7 @@ if [ "$GRID_HUB_VERBOSE_LOGS" == "True" ]; then
 fi
 
 WEBDRIVER_SERVER_JAR=${DIR}/selenium-server-standalone.jar
-WEBDRIVER_HUB_PARAMS="-role hub -timeout 230 -browserTimeout 170 -port 4444"
+WEBDRIVER_HUB_PARAMS="-role hub -timeout $2 -browserTimeout 170 -port 4444"
 WEBDRIVER_HUB_PIDFILE="/tmp/webdriver_hub.pid"
 
 if [ ! -f $WEBDRIVER_SERVER_JAR ]; then

seleniumbase/utilities/selenium_grid/grid-node

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #
-# Usage: grid-node {start|stop|restart}
+# Usage: grid-node {start|stop}
 #
 
 source $(dirname $0)/font_color
@@ -10,7 +10,7 @@ EXPECTED_ARGS=1
 E_BADARGS=65
 
 DO_showUsage() {
-    echo "Usage: $(basename $0) {start|stop|restart}"
+    echo "Usage: $(basename $0) {start|stop}"
     exit $E_BADARGS
 }
 

seleniumbase/utilities/selenium_grid/grid_hub.py

@@ -16,13 +16,16 @@
     os.environ["PATH"] = DRIVER_DIR + os.pathsep + os.environ["PATH"]
 
 
-def invalid_run_command():
+def invalid_run_command(msg=None):
     exp = ("  ** grid-hub **\n\n")
     exp += "  Usage:\n"
-    exp += "        seleniumbase grid-hub {start|stop|restart}\n"
+    exp += "        seleniumbase grid-hub {start|stop|restart} [OPTIONS]\n"
     exp += "  Options:\n"
     exp += "        -v, --verbose  (Increase verbosity of logging output.)\n"
     exp += "                       (Default: Quiet logging / not verbose.)\n"
+    exp += "        --timeout=TIMEOUT  (Close idle browser after TIMEOUT.)\n"
+    exp += "                           (The default TIMEOUT: 230 seconds.)\n"
+    exp += "                           (Use --timeout=0 to skip timeouts.)\n"
     exp += "  Example:\n"
     exp += "        seleniumbase grid-hub start\n"
     exp += "  Output:\n"
@@ -31,10 +34,13 @@ def invalid_run_command():
     exp += "        to speed up test runs and reduce the total time\n"
     exp += "        of test suite execution.\n"
     exp += "        You can start, restart, or stop the Grid Hub Server.\n"
+    if msg:
+        exp += msg
     raise Exception('INVALID RUN COMMAND!\n\n%s' % exp)
 
 
 def main():
+    timeout = 230  # The default number of seconds that a test can be idle
     dir_path = os.path.dirname(os.path.realpath(__file__))
     num_args = len(sys.argv)
     if sys.argv[0].split('/')[-1] == "seleniumbase" or (
@@ -55,6 +61,12 @@ def main():
         for option in options:
             if option == '-v' or option == '--verbose':
                 verbose = "True"
+            elif option.startswith("--timeout=") and len(option) > 10:
+                timeout = option.split("--timeout=")[1]
+                if not timeout.isdigit():
+                    msg = '\n"timeout" must be a non-negative integer!\n'
+                    print(msg)
+                    invalid_run_command(msg)
             else:
                 invalid_run_command()
 
@@ -70,18 +82,22 @@ def main():
 
     if "linux" in sys.platform or "darwin" in sys.platform:
         if grid_hub_command == "start":
-            subprocess.check_call(dir_path + "/grid-hub start", shell=True)
+            subprocess.check_call(
+                dir_path + "/grid-hub start %s" % timeout, shell=True)
         elif grid_hub_command == "restart":
-            subprocess.check_call(dir_path + "/grid-hub restart", shell=True)
+            subprocess.check_call(dir_path + "/grid-hub stop .", shell=True)
+            subprocess.check_call(
+                dir_path + "/grid-hub start %s" % timeout, shell=True)
         elif grid_hub_command == "stop":
-            subprocess.check_call(dir_path + "/grid-hub stop", shell=True)
+            subprocess.check_call(dir_path + "/grid-hub stop .", shell=True)
         else:
             invalid_run_command()
     else:
         if grid_hub_command == "start" or grid_hub_command == "restart":
             shell_command = (
                 """java -jar %s/selenium-server-standalone.jar -role hub """
-                """-timeout 230 -browserTimeout 170 -port 4444""" % dir_path)
+                """-timeout %s -browserTimeout 170 -port 4444"""
+                "" % (dir_path, timeout))
             print("\nStarting Selenium-WebDriver Grid Hub...\n")
             print(shell_command)
             print("")

seleniumbase/utilities/selenium_grid/grid_node.py

@@ -99,7 +99,8 @@ def main():
         if grid_hub_command == "start":
             subprocess.check_call(dir_path + "/grid-node start", shell=True)
         elif grid_hub_command == "restart":
-            subprocess.check_call(dir_path + "/grid-node restart", shell=True)
+            subprocess.check_call(dir_path + "/grid-node stop", shell=True)
+            subprocess.check_call(dir_path + "/grid-node start", shell=True)
         elif grid_hub_command == "stop":
             subprocess.check_call(dir_path + "/grid-node stop", shell=True)
         else: