Breaking changes! Supervisor final fixes and ready to release v2.46.0-sup

Author: Leo Gallucci

CHANGELOG.md

@@ -4,7 +4,7 @@ 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-sup (2015-07-12)
+## v2.46.0-sup (2015-07-13)
  + Switched to supervidord for process management, closes #24 (Leo Gallucci)
  + Extracted guacamole (with tomcat) into elgalu/guaca-docker.
  + Refactored code and directory structure.

Dockerfile

@@ -64,11 +64,6 @@ RUN apt-get update -qqy \
     bc \
     grc \
     moreutils \
-  # TODO: do we need this X11-unix things?
-  && mkdir -p /tmp/.X11-unix /tmp/.ICE-unix \
-  && chmod 1777 /tmp/.X11-unix /tmp/.ICE-unix \
-  && mkdir -p /var/log/sele \
-  && mkdir -p /var/run/sele \
   && rm -rf /var/lib/apt/lists/*
 
 #==============================
@@ -288,10 +283,6 @@ ENV NORMAL_USER_HOME /home/${NORMAL_USER}
 # TODO: Upgrade to supervisor stable 4.0 as soon as is released
 RUN pip install --upgrade \
       https://github.com/Supervisor/supervisor/zipball/b3ad59703b554f \
-  && mkdir -p /var/log/sele/supervisor \
-  && mkdir -p /etc/supervisor/conf.d \
-  && mkdir -p /var/run/sele \
-  && touch /var/run/sele/supervisord.pid \
   && rm -rf /var/lib/apt/lists/*
 
 #=====================
@@ -395,6 +386,8 @@ RUN apt-get update -qqy \
     xserver-xorg-video-dummy \
   && rm -rf /var/lib/apt/lists/*
 
+ENV RUN_DIR /var/run/sele
+
 #======================
 # OpenSSH server (sshd)
 #======================
@@ -403,9 +396,7 @@ RUN apt-get update -qqy \
 RUN apt-get update -qqy \
   && apt-get -qqy install \
     openssh-server \
-  && mkdir -p /var/run/sshd \
-  && chmod 744 /var/run/sshd \
-  && echo "PidFile /tmp/run_sshd.pid" >> /etc/ssh/sshd_config \
+  && echo "PidFile ${RUN_DIR}/sshd.pid" >> /etc/ssh/sshd_config \
   && echo "X11Forwarding yes" >> /etc/ssh/sshd_config \
   && echo "GatewayPorts yes"  >> /etc/ssh/sshd_config \
   && rm -rf /var/lib/apt/lists/*
@@ -513,14 +504,6 @@ ADD xterm/etc/supervisor/conf.d/* /etc/supervisor/conf.d/
 USER ${NORMAL_USER}
 ENV USER ${NORMAL_USER}
 ENV HOME ${NORMAL_USER_HOME}
-RUN mkdir -p ~/.ssh \
-  && touch ~/.ssh/authorized_keys \
-  && chmod 700 ~/.ssh \
-  && chmod 600 ~/.ssh/authorized_keys \
-  && sudo chown -R ${NORMAL_USER}:${NORMAL_GROUP} /var/log/sele \
-  && sudo chown -R ${NORMAL_USER}:${NORMAL_GROUP} /var/run/sele \
-  && sudo chown -R ${NORMAL_USER}:${NORMAL_GROUP} /etc/supervisor \
-  && mkdir -p ${HOME}/.vnc
 ENV VNC_STORE_PWD_FILE ${HOME}/.vnc/passwd
 
 #========================================================================
@@ -549,8 +532,6 @@ ENV NOVNC_PORT 26080
 # You can set the VNC password or leave null so a random password is generated:
 # ENV VNC_PASSWORD topsecret
 ENV SSHD_PORT 22222
-# Logs are now managed by supervisord.conf, see
-#  /var/log/sele/supervisor/*.log
 # Supervisor (process management) http server
 ENV SUPERVISOR_HTTP_PORT 29001
 ENV SUPERVISOR_HTTP_USERNAME supervisorweb
@@ -560,6 +541,9 @@ ENV SUPERVISOR_HTTP_PASSWORD somehttpbasicauthpwd
 ENV LOGLEVEL info
 ENV LOGFILE_MAXBYTES 10MB
 ENV LOGFILE_BACKUPS 5
+# Logs are now managed by supervisord.conf, see
+#  ${LOGS_DIR}/*.log
+ENV LOGS_DIR /var/log/sele
 #===============================
 # Run docker from inside docker
 # Usage: docker run -v /var/run/docker.sock:/var/run/docker.sock
@@ -569,7 +553,7 @@ ENV DOCKER_SOCK "/var/run/docker.sock"
 #================================
 # Expose Container's Directories
 #================================
-VOLUME /var/log/sele
+# VOLUME ${LOGS_DIR}
 
 # Only expose ssh port given the other services are not secured
 # forcing the user to open ssh tunnels or use docker run -p ports...

README.md

@@ -27,11 +27,11 @@ If your setup is correct, privileged mode and sudo should not be necessary:
     docker run --rm --name=ch -p=0.0.0.0:4470:24444 -p=0.0.0.0:5920:25900 \
                               -p=0.0.0.0:2222:22222 -p=0.0.0.0:6080:26080 \
         -e SCREEN_WIDTH=1920 -e SCREEN_HEIGHT=1080 \
-        -e VNC_PASSWORD=hola -v /var/log/sele \
+        -e VNC_PASSWORD=hola \
         -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" \
         elgalu/selenium:v2.46.0-sup
 
-Make sure `docker run` finishes with **start.sh all done and ready for testing** else you won't be able to start your tests.
+Make sure `docker run` finishes with **selenium all done and ready for testing** else you won't be able to start your tests.
 Selenium should be up and running at http://localhost:4470/wd/hub open the web page to confirm is running.
 
 You can also ssh into the machine as long as `SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)"` is correct.
@@ -140,8 +140,8 @@ CONTAINER=$(docker run -d -p=0.0.0.0:${ANYPORT}:22222 -e SCREEN_HEIGHT=1110 \
     elgalu/selenium:v2.46.0-sup
 
 # -- Common: Wait for the container to start
-while ! docker logs ${CONTAINER} 2>&1 | grep \
-    "start.sh all done" >/dev/null; do sleep 0.2; done
+while ! docker exec ch grep 'all done and ready for testing' \
+    /var/log/sele/xterm-stdout.log > /dev/null 2>&1; do sleep 0.2; done
 json_filter='{{(index (index .NetworkSettings.Ports "22222/tcp") 0).HostPort}}'
 SSHD_PORT=$(docker inspect -f='${json_filter}' $CONTAINER)
 echo $SSHD_PORT #=> e.g. SSHD_PORT=32769

READMELeo.md

@@ -1,13 +1,20 @@
 ## Build
 
     time (docker build -t="elgalu/selenium:v2.46.0-sup" . ;echo $?;beep)
-    docker run --rm --name=ch -p=4470:24444 -p=5920:25900 -p=2222:22222 -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" -e VNC_PASSWORD=hola elgalu/selenium:v2.46.0-sup
-    docker run --rm --name=ch --net=host -p=4470:24444 -p=5920:25900 -p=2222:22222 -p=9001:29001 -p=6080:26080 -e SSH_AUTH_KEYS="$(cat ~/.ssh/id_rsa.pub)" -e VNC_PASSWORD=hola elgalu/selenium:v2.46.0-sup
+    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)" -e VNC_PASSWORD=hola -v /var/log/sele elgalu/selenium:v2.46.0-sup
+
+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-sup
 
+Wait for docker-selenium to finish starting
+
+    while ! docker exec ch grep 'all done and ready for testing' /var/log/sele/xterm-stdout.log > /dev/null 2>&1; do sleep 0.2; done
+
 ## Transfer used browser source artifacts to keep them in the cloud
 
     SSHCMD="-o StrictHostKeyChecking=no -q -P 2222 application@localhost"

bin/entry.sh

@@ -13,9 +13,10 @@ export DOCKER_HOST_IP=$(netstat -nr | grep '^0\.0\.0\.0' | awk '{print $2}')
 export CONTAINER_IP=$(ip addr show dev eth0 | grep "inet " | awk '{print $2}' | cut -d '/' -f 1)
 #end.
 
-#--------------------
-# Improve etc/hosts
+#--------------------------------
+# Improve etc/hosts and fix dirs
 improve_etc_hosts.sh
+fix_dirs.sh
 
 #-------------------------
 # Docker alongside docker
@@ -25,10 +26,10 @@ docker_alongside_docker.sh
 # Fix running user
 #------------------
 RUN_PREFIX="sudo -E HOME=/home/$NORMAL_USER -u $NORMAL_USER"
-# RUN_SUPERVISOR="supervisord -c /etc/supervisor/supervisord.conf --pidfile /var/run/sele/supervisord.pid"
+# RUN_SUPERVISOR="supervisord -c /etc/supervisor/supervisord.conf --pidfile ${RUN_DIR}/supervisord.pid"
 RUN_SUPERVISOR="supervisord -c /etc/supervisor/supervisord.conf"
 RUN_START="${RUN_PREFIX} $BIN_UTILS/start.sh"
-# RUN_TAIL="grc tail -f /var/log/sele/supervisor/supervisord.log --pid=$(cat /var/run/sele/supervisord.pid) --sleep-interval=0.1"
+# RUN_TAIL="grc tail -f ${LOGS_DIR}/supervisord.log --pid=$(cat ${RUN_DIR}/supervisord.pid) --sleep-interval=0.1"
 WHOAMI=$(whoami)
 WHOAMI_EXIT_CODE=$?
 echo "-- INFO: Container USER var is: '$USER', \$(whoami) returns '$WHOAMI', UID is '$UID'"

novnc/etc/supervisor/conf.d/novnc.conf

@@ -38,8 +38,8 @@ startretries=0
 
 ;Logs
 redirect_stderr=false
-stdout_logfile=/var/log/sele/supervisor/novnc-stdout.log
-stderr_logfile=/var/log/sele/supervisor/novnc-stderr.log
+stdout_logfile=%(ENV_LOGS_DIR)s/novnc-stdout.log
+stderr_logfile=%(ENV_LOGS_DIR)s/novnc-stderr.log
 stdout_logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
 stderr_logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
 stdout_logfile_backups=%(ENV_LOGFILE_BACKUPS)s

scm-source.json

@@ -1,6 +1,6 @@
 {
     "url": "https://github.com/elgalu/docker-selenium",
-    "revision": "822ae681465090192e4a5f98a5179ffd5b2d08bb",
+    "revision": "05243375de86d6a0cdafef1551f8245e78b3a25b",
     "author": "lgallucci",
     "status": ""
 }

selenium/etc/supervisor/conf.d/selenium.conf

@@ -38,8 +38,8 @@ startretries=0
 
 ;Logs
 redirect_stderr=false
-stdout_logfile=/var/log/sele/supervisor/selenium-stdout.log
-stderr_logfile=/var/log/sele/supervisor/selenium-stderr.log
+stdout_logfile=%(ENV_LOGS_DIR)s/selenium-stdout.log
+stderr_logfile=%(ENV_LOGS_DIR)s/selenium-stderr.log
 stdout_logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
 stderr_logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
 stdout_logfile_backups=%(ENV_LOGFILE_BACKUPS)s

sshd/etc/supervisor/conf.d/sshd.conf

@@ -38,8 +38,8 @@ startretries=0
 
 ;Logs
 redirect_stderr=false
-stdout_logfile=/var/log/sele/supervisor/sshd-stdout.log
-stderr_logfile=/var/log/sele/supervisor/sshd-stderr.log
+stdout_logfile=%(ENV_LOGS_DIR)s/sshd-stdout.log
+stderr_logfile=%(ENV_LOGS_DIR)s/sshd-stderr.log
 stdout_logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
 stderr_logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
 stdout_logfile_backups=%(ENV_LOGFILE_BACKUPS)s

supervisor/etc/supervisor/supervisord.conf

@@ -4,7 +4,7 @@
 nodaemon=true
 
 ;main log file;default $CWD/supervisord.log
-logfile=/var/log/sele/supervisor/supervisord.log
+logfile=%(ENV_LOGS_DIR)s/supervisord.log
 
 ;max main logfile bytes b4 rotation;default 50MB
 logfile_maxbytes=%(ENV_LOGFILE_MAXBYTES)s
@@ -16,14 +16,14 @@ logfile_backups=%(ENV_LOGFILE_BACKUPS)s
 ;debug will log all monitored process outputs
 ;an alternative to debug would be to tail all logs
 ;and pipe `ts` to inject the timestamp:
-; tail -f /var/log/sele/supervisor/*.log --pid.... | ts
+; tail -f %(ENV_LOGS_DIR)s/*.log --pid.... | ts
 loglevel=%(ENV_LOGLEVEL)s
 
 ;supervisord pidfile;default supervisord.pid
-pidfile=/var/run/sele/supervisord.pid
+pidfile=%(ENV_RUN_DIR)s/supervisord.pid
 
 ;'AUTO' child log dir, default $TEMP
-childlogdir=/var/log/sele/supervisor
+childlogdir=%(ENV_LOGS_DIR)s
 
 ;The number of seconds to wait for the OS to return a SIGCHILD to
 ;supervisord after the program has been sent a stopsignal.
@@ -33,7 +33,7 @@ childlogdir=/var/log/sele/supervisor
 stopwaitsecs=1
 
 [unix_http_server]
-file=/var/run/sele/supervisor.sock
+file=%(ENV_RUN_DIR)s/supervisor.sock
 username=%(ENV_SUPERVISOR_HTTP_USERNAME)s
 password=%(ENV_SUPERVISOR_HTTP_PASSWORD)s
 ;sockef file mode (default 0700)
@@ -47,7 +47,7 @@ supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
 
 [supervisorctl]
 ; use a unix:// URL  for a unix socket
-serverurl=unix:///var/run/sele/supervisor.sock
+serverurl=unix://%(ENV_RUN_DIR)s/supervisor.sock
 username=%(ENV_SUPERVISOR_HTTP_USERNAME)s
 password=%(ENV_SUPERVISOR_HTTP_PASSWORD)s