Sauce Labs tunneling support

Author: elgalu

Dockerfile

@@ -766,6 +766,7 @@ ENV FIREFOX_VERSIONS="${FIREFOX_VERSIONS1}, ${FIREFOX_VERSIONS2}, ${FIREFOX_VERS
   SUPERVISOR_HTTP_PASSWORD=somehttpbasicauthpwd \
   SUPERVISOR_REQUIRED_SRV_LIST="vnc|novnc|sshd|xmanager|xvfb" \
   SLEEP_SECS_AFTER_KILLING_SUPERVISORD=3 \
+  SUPERVISOR_STOPWAITSECS=20 \
   # Supervisor loglevel and also general docker log level
   # can be: debug, warn, trace, info
   LOG_LEVEL=info \
@@ -811,11 +812,13 @@ ENV FIREFOX_VERSIONS="${FIREFOX_VERSIONS1}, ${FIREFOX_VERSIONS2}, ${FIREFOX_VERS
   SAUCE_TUNNEL_ID="docker-selenium" \
   SAUCE_TUNNEL_READY_FILE="/tmp/sauce-connect-ready" \
   SAUCE_LOCAL_SEL_PORT="4445" \
+  SAUCE_WAIT_TIMEOUT="100s" \
   # BrowserStack tunneling. Naming is required: BSTACK_TUNNEL_ID
   BSTACK_TUNNEL="false" \
   BSTACK_ACCESS_KEY="" \
   BSTACK_TUNNEL_ID="docker-selenium" \
   BSTACK_TUNNEL_OPTS="-skipCheck -v -forcelocal" \
+  BSTACK_WAIT_TIMEOUT="70s" \
   # Java stuff
   # MEM_JAVA="1024m" \
   #===============================

bin/entry.sh

@@ -11,6 +11,7 @@ export DISPLAY=":${DISP_N}"
 export XEPHYR_DISPLAY=":${DISP_N}"
 export VIDEO_LOG_FILE="${LOGS_DIR}/video-rec-stdout.log"
 export VIDEO_PIDFILE="${RUN_DIR}/video.pid"
+export SAUCE_LOG_FILE="${LOGS_DIR}/saucelabs-stdout.log"
 export BSTACK_LOG_FILE="${LOGS_DIR}/browserstack-stdout.log"
 export SUPERVISOR_PIDFILE="${RUN_DIR}/supervisord.pid"
 export DOCKER_SELENIUM_STATUS="${LOGS_DIR}/docker-selenium-status.log"
@@ -42,6 +43,8 @@ export FFMPEG_FRAME_SIZE="${SCREEN_WIDTH}x${SCREEN_HEIGHT}"
   SUPERVISOR_REQUIRED_SRV_LIST="${SUPERVISOR_REQUIRED_SRV_LIST}|selenium-node-firefox"
 [ "${VIDEO}" = "true" ] && export \
   SUPERVISOR_REQUIRED_SRV_LIST="${SUPERVISOR_REQUIRED_SRV_LIST}|video-rec"
+[ "${SAUCE_TUNNEL}" = "true" ] && export \
+  SUPERVISOR_REQUIRED_SRV_LIST="${SUPERVISOR_REQUIRED_SRV_LIST}|saucelabs"
 [ "${BSTACK_TUNNEL}" = "true" ] && export \
   SUPERVISOR_REQUIRED_SRV_LIST="${SUPERVISOR_REQUIRED_SRV_LIST}|browserstack"
 

browserstack/bin/start-browserstack.sh

@@ -40,12 +40,8 @@ function shutdown {
   exit 0
 }
 
-# Wait for the file to exists (Sauce Labs only)
-# echo "Waiting for file ${SAUCE_TUNNEL_READY_FILE} to be created..."
-# while ! ls -l "${SAUCE_TUNNEL_READY_FILE}"* >/dev/null 2>&1; do sleep 0.1; done
-
 # Now wait for the tunnel to finish starting
-timeout --foreground ${WAIT_TIMEOUT} wait-browserstack.sh
+timeout --foreground ${BSTACK_WAIT_TIMEOUT} wait-browserstack.sh
 
 # Run function shutdown() when this process a killer signal
 trap shutdown SIGTERM SIGINT SIGKILL

saucelabs/bin/start-saucelabs.sh

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# echo fn that outputs to stderr http://stackoverflow.com/a/2990533/511069
+echoerr() {
+  cat <<< "$@" 1>&2;
+}
+
+# print error and exit
+die () {
+  echoerr "ERROR: $1"
+  # if $2 is defined AND NOT EMPTY, use $2; otherwise, set to "160"
+  errnum=${2-160}
+  exit $errnum
+}
+
+# Required params
+[ -z "${SAUCE_LOCAL_SEL_PORT}" ] && die "Required SAUCE_LOCAL_SEL_PORT"
+[ -z "${SAUCE_USER_NAME}" ] && die "Required env var SAUCE_USER_NAME"
+[ -z "${SAUCE_API_KEY}" ] && die "Required env var SAUCE_API_KEY"
+[ -z "${SAUCE_TUNNEL_READY_FILE}" ] && die "Required SAUCE_TUNNEL_READY_FILE"
+[ -z "${SAUCE_TUNNEL_ID}" ] && die "Required env var SAUCE_TUNNEL_ID"
+
+# Wait for this process dependencies
+# - none, the tunnel has no dependencies
+# timeout --foreground ${WAIT_TIMEOUT} wait-xvfb.sh
+
+# Start tunnel
+sc --se-port ${SAUCE_LOCAL_SEL_PORT} \
+   --user "${SAUCE_USER_NAME}" \
+   --api-key "${SAUCE_API_KEY}" \
+   --readyfile "${SAUCE_TUNNEL_READY_FILE}" \
+   --tunnel-identifier "${SAUCE_TUNNEL_ID}" &
+SAUCE_TUNNEL_PID=$!
+
+function shutdown {
+  echo "Trapped SIGTERM/SIGINT so shutting down Sauce Labs gracefully..."
+  kill -SIGINT ${SAUCE_TUNNEL_PID}
+  wait ${SAUCE_TUNNEL_PID}
+  echo "Sauce Labs tunnel shutdown complete."
+  exit 0
+}
+
+# Wait for the file to exists
+echo "Waiting for file ${SAUCE_TUNNEL_READY_FILE} to be created..."
+while ! ls -l "${SAUCE_TUNNEL_READY_FILE}" >/dev/null 2>&1; do sleep 0.1; done
+
+# Now wait for the tunnel to finish starting
+timeout --foreground ${SAUCE_WAIT_TIMEOUT} wait-saucelabs.sh
+
+# Run function shutdown() when this process a killer signal
+trap shutdown SIGTERM SIGINT SIGKILL
+
+# tells bash to wait until child processes have exited
+wait

saucelabs/bin/wait-saucelabs.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# echo fn that outputs to stderr http://stackoverflow.com/a/2990533/511069
+echoerr() {
+  cat <<< "$@" 1>&2;
+}
+
+# print error and exit
+die () {
+  echoerr "ERROR: $1"
+  # if $2 is defined AND NOT EMPTY, use $2; otherwise, set to "160"
+  errnum=${2-160}
+  exit $errnum
+}
+
+export DONE_MSG="Connection established."
+
+if [ "${SAUCE_TUNNEL}" = "true" ]; then
+  echo "Waiting for Sauce Labs tunnel to start..."
+  # Required params
+  [ -z "${SAUCE_LOG_FILE}" ] && die "Required env var SAUCE_LOG_FILE"
+  while ! grep "${DONE_MSG}" ${SAUCE_LOG_FILE} >/dev/null; do
+    echo -n '.'
+    sleep 0.2;
+  done
+  echo "Sauce Labs tunnel started! (wait-saucelabs.sh)"
+else
+  echo "Won't start Sauce Labs tunnel due to SAUCE_TUNNEL false"
+fi

saucelabs/etc/supervisor/conf.d/saucelabs.conf

@@ -0,0 +1,52 @@
+[program:saucelabs]
+
+;The relative priority of the program in the start and shutdown ordering.
+;Lower priorities indicate programs that start first and shut down last.
+priority=15
+
+;User to run-as, note environment expansion outside of `command` is only
+;supported in supervisor >= 3.2
+user=%(ENV_NORMAL_USER)s
+
+;The command that will be run when this program is started.
+;Controlled programs should themselves not be daemons, as supervisord
+;assumes it is responsible for daemonizing its subprocesses
+directory=%(ENV_NORMAL_USER_HOME)s
+command=%(ENV_BIN_UTILS)s/start-saucelabs.sh
+
+;If true, this program will start automatically when supervisord is started.
+;default=true
+autostart=%(ENV_SAUCE_TUNNEL)s
+
+;If false, the process will never be autorestarted.
+;If true, the process will be unconditionally restarted when it exits,
+;without regard to its exit code. default=unexpected
+;If unexpected, the process will be restart when the program exits with an
+;exit code that is not one of the exit codes associated with this process.
+autorestart=false
+
+;Set to 0 to indicate that the program needn’t stay running for any
+;particular amount of time.
+;So using custom wait-xxxx.sh scripts to perform a more efficient
+;active waiting until https://github.com/Supervisor/supervisor/issues/584
+startsecs=0
+
+;The number of serial failure attempts that supervisord will allow when
+;attempting to start the program before giving up and puting the process
+;into an FATAL state.
+startretries=0
+
+;Logs
+redirect_stderr=false
+stdout_logfile=%(ENV_LOGS_DIR)s/saucelabs-stdout.log
+stderr_logfile=%(ENV_LOGS_DIR)s/saucelabs-stderr.log
+stdout_logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
+stderr_logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
+stdout_logfile_backups=%(ENV_LOGFILE_BACKUPS)s
+stderr_logfile_backups=%(ENV_LOGFILE_BACKUPS)s
+stdout_capture_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
+stderr_capture_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
+
+;The signal used to kill the program when a stop is requested. This can be
+;any of TERM, HUP, INT, QUIT, KILL, USR1, or USR2. default=TERM
+stopsignal=INT

supervisor/etc/supervisor/supervisord.conf

@@ -30,7 +30,7 @@ childlogdir=%(ENV_LOGS_DIR)s
 ;If this number of seconds elapses before supervisord receives a SIGCHILD
 ;from the process, supervisord will attempt to kill it with a final.
 ;default=10
-stopwaitsecs=1
+stopwaitsecs=%(ENV_SUPERVISOR_STOPWAITSECS)s
 
 [unix_http_server]
 file=%(ENV_RUN_DIR)s/supervisor.sock

xterm/bin/start-xterm.sh

@@ -50,7 +50,9 @@ timeout --foreground ${WAIT_TIMEOUT} wait-selenium-node-firefox.sh || shutdown \
   "Failed while waiting for selenium node firefox to start!"
 timeout --foreground ${WAIT_TIMEOUT} wait-video-rec.sh || shutdown \
   "Failed while waiting for video recording to start!"
-timeout --foreground ${WAIT_TIMEOUT} wait-browserstack.sh || shutdown \
+timeout --foreground ${SAUCE_WAIT_TIMEOUT} wait-saucelabs.sh || shutdown \
+  "Failed while waiting for Sauce Labs tunnel to start!"
+timeout --foreground ${BSTACK_WAIT_TIMEOUT} wait-browserstack.sh || shutdown \
   "Failed while waiting for BrowserStack tunnel to start!"
 
 # Help at http://supervisord.org/subprocess.html#process-states