v2.46.0-04: Fix bug while docker stop ; supervisor not getting SIGINT properly

Author: elgalu

CHANGELOG.md

@@ -4,10 +4,12 @@ Note sha256 digests are generated after pushing the image to the registry theref
 
 Note image ids also change after scm-source.json has being updated which triggers a cyclic problem so value TBD will be set here and updated in the [release][] page by navigating into any release tag.
 
-## v2.46.0-03 (2015-07-18)
+## v2.46.0-04 (2015-07-18)
  + Fix bug openbox X manager not waiting for Xvfb. (Leo Gallucci)
  + Fix entry.sh exiting immediately and not checking DISABLE_ROLLBACK.
  + Allow to choose X manager flavor via `-e XMANAGER=openbox|fluxbox`
+ + Fix bug in wait-docker-selenium.sh
+ + Fix bug while docker stop $NAME; supervisor not getting SIGINT properly.
  + Image tag details:
   + Selenium: v2.46.0 (87c69e2)
   + Chrome stable:   43.0.2357.134
@@ -23,8 +25,8 @@ Note image ids also change after scm-source.json has being updated which trigger
   + Built with: Docker version 1.7.1, build 786b29d
   + FROM ubuntu:wily-20150708
   + Python: 2.7.10
-  + Digest: sha256:7839b7e1a84471352f135815d55f4f9835c54e23e9555c2e5d5d818910c429fb
-  + Image ID: 6763523b770c6504b381231b499e4e71fccd440c86bc83aff1e207c23a5327a3
+  + Digest: sha256:TBD
+  + Image ID: TBD
 
 ## v2.46.0-02 (2015-07-17)
  + Add DISABLE_ROLLBACK so when true users can troubleshoot. (Leo Gallucci)

Dockerfile

@@ -704,6 +704,7 @@ ENV FIREFOX_VERSIONS="${FIREFOX_VERSIONS1}, ${FIREFOX_VERSIONS2}, ${FIREFOX_VERS
   VIDEO_FILE_EXTENSION="mkv" \
   VIDEO_FILE_NAME="test" \
   VIDEOS_DIR="${NORMAL_USER_HOME}/videos" \
+  FLUSH_VIDEO_SECS="0.5" \
   # You can choose what X manager to use
   XMANAGER="fluxbox" \
   #===============================

README.md

@@ -19,7 +19,7 @@ Note SeleniumHQ/docker-selenium project is more useful for building selenium gri
 In general: add `sudo` only if needed in your environment and `--privileged` if you really need it.
 
     sudo docker run --privileged -p 4444:24444 -p 5920:25900 \
-        -e VNC_PASSWORD=hola elgalu/selenium:v2.46.0-03
+        -e VNC_PASSWORD=hola elgalu/selenium:v2.46.0-04
 
 ### Non-privileged
 ### Run
@@ -31,7 +31,7 @@ If your setup is correct, privileged mode and sudo should not be necessary:
         -e SCREEN_WIDTH=1920 -e SCREEN_HEIGHT=1080 \
         -e VNC_PASSWORD=hola \
         -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" \
-        elgalu/selenium:v2.46.0-03
+        elgalu/selenium:v2.46.0-04
 
 Make sure `docker run` finishes with **selenium all done and ready for testing** else you won't be able to start your tests. To perform this check programatically please use this command where `ch` is the name of the container:
 
@@ -96,7 +96,7 @@ You can lunch a grid only container via environment variables:
 
     docker run --rm --name=hub -p 4444:24444 -p 5930:25900 -p 2223:22222 \
       -p=6081:26080 -e CHROME=false -e FIREFOX=false \
-      elgalu/selenium:v2.46.0-03
+      elgalu/selenium:v2.46.0-04
 
 The important part above is `-e CHROME=false -e FIREFOX=false` which tells the docker image not run run default chorme and firefox nodes turning the container into a grid-only one.
 
@@ -112,7 +112,7 @@ You can lunch a node only container via environment variables:
       -p 25550:25550 -p 25551:25551 \
       -e GRID=false -e CHROME=true -e FIREFOX=true \
       -v $(pwd)/videos:/videos \
-      elgalu/selenium:v2.46.0-03
+      elgalu/selenium:v2.46.0-04
 
 The important part above is `-e GRID=false` which tells the container to be a node-only node, this this case with 2 browsers `-e CHROME=true -e FIREFOX=true` but could be just 1.
 
@@ -136,17 +136,17 @@ There are also additional steps you can take to ensure you're using the correct
 ### Option 1 - Use immutable image digests
 Given docker.io currently allows to push the same tag image twice this represent a security concern but since docker >= 1.6.2 is possible to fetch the digest sha256 instead of the tag so you can be sure you're using the exact same docker image every time:
 
-    # e.g. sha256 for tag v2.46.0-03
-    export SHA=7839b7e1a84471352f135815d55f4f9835c54e23e9555c2e5d5d818910c429fb
+    # e.g. sha256 for tag v2.46.0-04
+    export SHA=TBD
     docker pull elgalu/selenium@sha256:${SHA}
 
 ### Option 2 - Check the Full Image Id
 
 Verify that image id is indeed correct
 
-    # e.g. full image id for tag v2.46.0-03
-    export IMGID=6763523b770c6504b381231b499e4e71fccd440c86bc83aff1e207c23a5327a3
-    if docker inspect -f='{{.Id}}' elgalu/selenium:v2.46.0-03 |grep ${IMGID} &> /dev/null; then
+    # e.g. full image id for tag v2.46.0-04
+    export IMGID=TBD
+    if docker inspect -f='{{.Id}}' elgalu/selenium:v2.46.0-04 |grep ${IMGID} &> /dev/null; then
         echo "Image ID tested ok"
     else
         echo "Image ID doesn't match"
@@ -168,7 +168,7 @@ Host machine, terminal 2:
     docker run --rm --name=ch -p=4470:24444 \
       -e SCREEN_WIDTH -e SCREEN_HEIGHT -e XE_DISP_NUM \
       -v /tmp/.X11-unix/X${XE_DISP_NUM}:/tmp/.X11-unix/X${XE_DISP_NUM} \
-      elgalu/selenium:v2.46.0-03
+      elgalu/selenium:v2.46.0-04
 
 Now when you run your tests instead of connecting. If docker run fails try `xhost +`
 
@@ -190,7 +190,7 @@ ANYPORT=0
 REMOTE_DOCKER_SRV=localhost
 CONTAINER=$(docker run -d -p=0.0.0.0:${ANYPORT}:22222 -p=0.0.0.0:${ANYPORT}:24444 \
     -p=0.0.0.0:${ANYPORT}:25900 -e SCREEN_HEIGHT=1110 -e VNC_PASSWORD=hola \
-    -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" elgalu/selenium:v2.46.0-03
+    -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" elgalu/selenium:v2.46.0-04
 
 # -- Option 2.docker run- Running docker on remote docker server like in the cloud
 # Useful if the docker server is running in the cloud. Establish free local ports
@@ -200,7 +200,7 @@ ssh ${REMOTE_DOCKER_SRV} #get into the remote docker provider somehow
 # it acts as a jump host so my public key is already on that server
 CONTAINER=$(docker run -d -p=0.0.0.0:${ANYPORT}:22222 -e SCREEN_HEIGHT=1110 \
     -e VNC_PASSWORD=hola -e SSH_AUTH_KEYS="$(cat ~/.ssh/authorized_keys)" \
-    elgalu/selenium:v2.46.0-03
+    elgalu/selenium:v2.46.0-04
 
 # -- Common: Wait for the container to start
 ./host-scripts/wait-docker-selenium.sh ch 7s
@@ -271,7 +271,7 @@ If you git clone this repo locally, i.e. cd into where the Dockerfile is, you ca
 
 If you prefer to download the final built image from docker you can pull it, personally I always prefer to build them manually except for the base images like Ubuntu 14.04.2:
 
-    docker pull elgalu/selenium:v2.46.0-03
+    docker pull elgalu/selenium:v2.46.0-04
 
 #### 2. Use this image
 

READMELeo.md

@@ -1,15 +1,15 @@
 ## Build
 
-    time (docker build -t="elgalu/selenium:v2.46.0-03" . ;echo $?;beep)
-    docker run --rm -ti --name=ch -p=4470:24444 -p=5920:25900 -p=2222:22222 -p=6080:26080 -p=29001:29001 -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" -v $(pwd)/videos:/videos -e DISABLE_ROLLBACK=true -e CHROME_FLAVOR=unstable -e FIREFOX_VERSION=38.0.6 -e VIDEO=true -e VIDEO_FILE_NAME=hola elgalu/selenium:v2.46.0-03
+    time (docker build -t="elgalu/selenium:v2.46.0-04" . ;echo $?;beep)
+    docker run --rm -ti --name=ch -p=4470:24444 -p=5920:25900 -p=2222:22222 -p=6080:26080 -p=29001:29001 -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" -v $(pwd)/videos:/videos -e DISABLE_ROLLBACK=true -e CHROME_FLAVOR=unstable -e FIREFOX_VERSION=38.0.6 -e VIDEO=true -e VIDEO_FILE_NAME=hola elgalu/selenium:v2.46.0-04
 
 See logs
 
     docker exec -ti ch bash -c "ls -lah /var/log/sele/"
 
 Testing in ssh [email protected]
 
-    docker run --rm --name=ch -p=4470:24444 -p=5920:25900 -p=2222:22222 -e SSH_AUTH_KEYS="$(cat ~/.ssh/authorized_keys)" -e VNC_PASSWORD=Hola3 os-registry.stups.zalan.do/tip/selenium:v2.46.0-03
+    docker run --rm --name=ch -p=4470:24444 -p=5920:25900 -p=2222:22222 -e SSH_AUTH_KEYS="$(cat ~/.ssh/authorized_keys)" -e VNC_PASSWORD=Hola3 os-registry.stups.zalan.do/tip/selenium:v2.46.0-04
 
 ## Transfer used browser source artifacts to keep them in the cloud
 
@@ -32,18 +32,18 @@ List firefox versions via docker exe
 
 ## To update image id and digest
 
-    docker inspect -f='{{.Id}}' elgalu/selenium:v2.46.0-03
+    docker inspect -f='{{.Id}}' elgalu/selenium:v2.46.0-04
     docker images --digests
 
 ## Run with shared dir
 
     docker run --rm --name=ch -p=127.0.0.1:4460:24444 -p=127.0.0.1:5910:25900 \
-      -v /e2e/uploads:/e2e/uploads elgalu/selenium:v2.46.0-03
+      -v /e2e/uploads:/e2e/uploads elgalu/selenium:v2.46.0-04
     docker run --rm --name=ch -p=4460:24444 -p=5910:25900 \
-      -v /var/run/docker.sock:/var/run/docker.sock -v $(which docker):$(which docker) elgalu/selenium:v2.46.0-03
+      -v /var/run/docker.sock:/var/run/docker.sock -v $(which docker):$(which docker) elgalu/selenium:v2.46.0-04
 
 
-    docker run --rm --name=ff -p=127.0.0.1:4461:24444 -p=127.0.0.1:5911:25900 -v /e2e/uploads:/e2e/uploads elgalu/selenium:v2.46.0-03
+    docker run --rm --name=ff -p=127.0.0.1:4461:24444 -p=127.0.0.1:5911:25900 -v /e2e/uploads:/e2e/uploads elgalu/selenium:v2.46.0-04
 
 ## Run without shared dir and bind ports to all network interfaces
 
@@ -66,11 +66,11 @@ List firefox versions via docker exe
 ## Run without dir and bind to all interfaces
 Note anything after the image will be taken as arguments for the cmd/entrypoint
 
-    docker run --rm --name=ch -p=0.0.0.0:8813:8484 -p=0.0.0.0:2222:2222 -p=0.0.0.0:4470:24444 -p=0.0.0.0:5920:25900 -e SCREEN_WIDTH=1800 -e SCREEN_HEIGHT=1110 -e VNC_PASSWORD=hola -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" elgalu/selenium:v2.46.0-03
+    docker run --rm --name=ch -p=0.0.0.0:8813:8484 -p=0.0.0.0:2222:2222 -p=0.0.0.0:4470:24444 -p=0.0.0.0:5920:25900 -e SCREEN_WIDTH=1800 -e SCREEN_HEIGHT=1110 -e VNC_PASSWORD=hola -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" elgalu/selenium:v2.46.0-04
 
-    docker run --rm --name=ch -p=4470:24444 -p=5920:25900 -e VNC_PASSWORD=hola elgalu/selenium:v2.46.0-03
-    docker run --rm --name=ch -p=4470:24444 -p=5920:25900 -e VNC_PASSWORD=hola docker.io/elgalu/selenium:v2.46.0-03
-    docker run --rm --name=ch -p=0.0.0.0:4470:24444 -p=0.0.0.0:5920:25900 --add-host myserver.dev:172.17.42.1 elgalu/selenium:v2.46.0-03
+    docker run --rm --name=ch -p=4470:24444 -p=5920:25900 -e VNC_PASSWORD=hola elgalu/selenium:v2.46.0-04
+    docker run --rm --name=ch -p=4470:24444 -p=5920:25900 -e VNC_PASSWORD=hola docker.io/elgalu/selenium:v2.46.0-04
+    docker run --rm --name=ch -p=0.0.0.0:4470:24444 -p=0.0.0.0:5920:25900 --add-host myserver.dev:172.17.42.1 elgalu/selenium:v2.46.0-04
 
 However adding a custom host IP to server-selenium.local (e.g. bsele ssh config) is more work:
 
@@ -79,32 +79,32 @@ However adding a custom host IP to server-selenium.local (e.g. bsele ssh config)
 
     vncv localhost:5920 -Scaling=60%  &
 
-    docker run --rm --name=ff -p=0.0.0.0:4471:24444 -p=0.0.0.0:5921:25900 elgalu/selenium:v2.46.0-03
+    docker run --rm --name=ff -p=0.0.0.0:4471:24444 -p=0.0.0.0:5921:25900 elgalu/selenium:v2.46.0-04
 
 Automatic builds not working for me right now, maybe there is an issue with docker registry v1 vs v2
 https://registry.hub.docker.com/u/elgalu/docker-selenium/builds_history/31621/
 
 ## Push version
 
     docker login
-    docker push docker.io/elgalu/selenium:v2.46.0-03 ;echo $?;beep
-    docker tag elgalu/selenium:v2.46.0-03 elgalu/selenium:latest
+    docker push docker.io/elgalu/selenium:v2.46.0-04 ;echo $?;beep
+    docker tag elgalu/selenium:v2.46.0-04 elgalu/selenium:latest
     docker push docker.io/elgalu/selenium:latest
 
 Not working maybe because it has automated builds enabled but then it fails in the cloud but works locally
 https://registry.hub.docker.com/u/elgalu/selenium/tags/manage/
 
-    docker push elgalu/selenium:v2.46.0-03
-    docker push elgalu/docker-selenium:v2.46.0-03
-    docker push docker.io/elgalu/docker-selenium:v2.46.0-03
+    docker push elgalu/selenium:v2.46.0-04
+    docker push elgalu/docker-selenium:v2.46.0-04
+    docker push docker.io/elgalu/docker-selenium:v2.46.0-04
 
 ## Pulling
 
-    docker pull registry.hub.docker.com/elgalu/selenium:v2.46.0-03
+    docker pull registry.hub.docker.com/elgalu/selenium:v2.46.0-04
 
 ## Pull
 
-    docker run -d --name=max -p=0.0.0.0:4411:24444 -p=0.0.0.0:5911:25900 elgalu/selenium:v2.46.0-03
+    docker run -d --name=max -p=0.0.0.0:4411:24444 -p=0.0.0.0:5911:25900 elgalu/selenium:v2.46.0-04
 
 How to connect through vnc (need a vnc client)
 

bin/entry.sh

@@ -69,42 +69,21 @@ if [ $WHOAMI_EXIT_CODE != 0 ]; then
     echo "-- INFO: Will try to fix uid before continuing"
     # TODO: fix it ...
     echo "-- now will try to use NORMAL_USER: '$NORMAL_USER' to continue"
-    ${RUN_PREFIX} run-supervisord.sh
+    exec ${RUN_PREFIX} run-supervisord.sh
   else
     echo "-- WARN: You seem to be running docker -u {{some-non-existing-user-in-container}}"
     echo "-- will try to use NORMAL_USER: '$NORMAL_USER' instead."
-    ${RUN_PREFIX} run-supervisord.sh
+    exec ${RUN_PREFIX} run-supervisord.sh
   fi
 elif [ "$WHOAMI" = "root" ]; then
   echo "-- WARN: Container running user is 'root' so switching to less privileged one"
   echo "-- will use NORMAL_USER: '$NORMAL_USER' instead."
-  ${RUN_PREFIX} run-supervisord.sh
+  exec ${RUN_PREFIX} run-supervisord.sh
 else
   echo "-- INFO: Will use \$USER '$USER' and \$(whoami) is '$WHOAMI'"
-  run-supervisord.sh
+  exec run-supervisord.sh
 fi
 
-# when DISABLE_ROLLBACK=true it will:
-#  - output logs
-#  - exec bash to permit troubleshooting
-if [ "$(cat ${DOCKER_SELENIUM_STATUS})" = "failed" ]; then
-  tail /var/log/sele/*
-  echo "" && echo "" && echo "==> errors <=="
-  selenium-grep.sh
-
-  if [ "${DISABLE_ROLLBACK}" = "true" ]; then
-    echo ""
-    echo "DEBUGGING: to find out what happened please analyze logs or run"
-    echo "  selenium-grep.sh"
-    echo ""
-
-    exec bash
-  fi
-fi
-
-# tells bash to wait until child processes have exited
-# wait
-
 # Note: sudo -i creates a login shell for someUser, which implies the following:
 # - someUser's user-specific shell profile, if defined, is loaded.
 # - $HOME points to someUser's home directory, so there's no need for -H (though you may still specify it)

supervisor/bin/run-supervisord.sh

@@ -1,3 +1,44 @@
 #!/usr/bin/env bash
 
-supervisord -c /etc/supervisor/supervisord.conf
+# Exit all child processes properly
+function shutdown {
+  echo "Trapped SIGTERM/SIGINT/x so shutting down supervisord gracefully..."
+  # First stop video recording because it needs some time to flush it
+  (supervisorctl -c /etc/supervisor/supervisord.conf stop \
+    video-rec && sleep ${FLUSH_VIDEO_SECS}) || true
+  supervisorctl -c /etc/supervisor/supervisord.conf stop all
+  # kill -SIGTERM $(cat ${SUPERVISOR_PIDFILE})
+  kill -SIGTERM ${SUPERVISOR_PID}
+  wait
+
+  # when DISABLE_ROLLBACK=true it will:
+  #  - output logs
+  #  - exec bash to permit troubleshooting
+  if [ "$(cat ${DOCKER_SELENIUM_STATUS})" = "failed" ]; then
+    tail /var/log/sele/*
+    echo "" && echo "" && echo "==> errors <=="
+    selenium-grep.sh
+
+    if [ "${DISABLE_ROLLBACK}" = "true" ]; then
+      echo ""
+      echo "DEBUGGING: to find out what happened please analyze logs or run"
+      echo "  selenium-grep.sh"
+      echo ""
+
+      exec bash
+    else
+      exit 3
+    fi
+  else
+    exit 0
+  fi
+}
+
+supervisord -c /etc/supervisor/supervisord.conf &
+SUPERVISOR_PID=$!
+
+# Run function shutdown() when this process a killer signal
+trap shutdown SIGTERM SIGINT SIGKILL
+
+# tells bash to wait until child processes have exited
+wait

video-rec/bin/start-video-rec.sh

@@ -28,10 +28,10 @@ VID_TOOL_PID=$!
 function shutdown {
   echo "Trapped SIGTERM or SIGINT so shutting down ffmpeg gracefully..."
   sudo kill -SIGINT ${VID_TOOL_PID}
-  sleep 0.7 #wait so the file is flushed
+  sleep ${FLUSH_VIDEO_SECS}
   # sudo killall -SIGINT avconv
   sudo killall -SIGINT ffmpeg
-  sleep 0.3 #wait so the file is flushed
+  sleep ${FLUSH_VIDEO_SECS}
   echo "ffmpeg shutdown complete."
   exit 0
 }