Managing processes via Supervisor, this simplifies the configuration of (#793)

every process running in the containers, and allows to handle logging
in a more simple way. Logging in node containers will be less noisy
since only Selenium activity is logged to /std/out.

Author: diemol

.gitignore

@@ -7,10 +7,11 @@ node_modules/
 # Vim swap files.
 *.swp
 
-# Ignoring the generated entry_point.sh files in different folders
-Node*Debug/entry_point.sh
-StandaloneC*/entry_point.sh
-StandaloneF*/entry_point.sh
+# Ignoring generated files during the build process
+Node*Debug/selenium-debug.conf
+Node*Debug/start-*.sh
+Standalone*/selenium.conf
+Standalone*/start-*.sh
 
 # Created by https://www.gitignore.io/api/virtualenv
 

Base/Dockerfile

@@ -27,6 +27,7 @@ RUN apt-get -qqy update \
     wget \
     jq \
     curl \
+    supervisor \
   && rm -rf /var/lib/apt/lists/* /var/cache/apt/* \
   && sed -i 's/securerandom\.source=file:\/dev\/random/securerandom\.source=file:\/dev\/urandom/' ./usr/lib/jvm/java-8-openjdk-amd64/jre/lib/security/java.security
 
@@ -55,12 +56,16 @@ ENV HOME=/home/seluser
 RUN  mkdir -p /opt/bin 
 
 #======================================
-# Add intermediate service discovery
+# Add Grid check script
 #======================================
-COPY check-grid.sh \
-       /opt/bin/
+COPY check-grid.sh /opt/bin/
 RUN chmod +x /opt/bin/check-grid.sh
 
+#======================================
+# Add Supervisor configuration file
+#======================================
+COPY supervisord.conf /etc
+
 #===================================================
 # Run the following commands as non-privileged user
 #===================================================
@@ -74,4 +79,11 @@ RUN  sudo mkdir -p /opt/selenium \
   && wget --no-verbose https://selenium-release.storage.googleapis.com/3.14/selenium-server-standalone-3.14.0.jar \
     -O /opt/selenium/selenium-server-standalone.jar \
   && sudo chgrp -R 0 /opt/selenium $HOME \
-  && sudo chmod -R g=u /opt/selenium $HOME
+  && sudo chmod -R g=u /opt/selenium $HOME \
+  && sudo mkdir -p /var/run/supervisor/ \
+  && sudo mkdir -p /var/log/supervisor/ \
+  && sudo chown -R seluser:seluser /var/run/supervisor \
+  && sudo chown -R seluser:seluser /var/log/supervisor
+
+
+CMD ["/usr/bin/supervisord", "--configuration", "/etc/supervisord.conf"]

Base/supervisord.conf

@@ -0,0 +1,15 @@
+; Documentation of this file format -> http://supervisord.org/configuration.html
+
+[supervisord]
+childlogdir=/var/log/supervisor               ; ('AUTO' child log dir, default $TEMP)
+logfile=/var/log/supervisor/supervisord.log   ; (main log file;default $CWD/supervisord.log)
+logfile_maxbytes=50MB                         ; (max main logfile bytes b4 rotation;default 50MB)
+logfile_backups=10                            ; (num of main logfile rotation backups;default 10)
+loglevel=info                                 ; (log level;default info; others: debug,warn,trace)
+pidfile=/var/run/supervisor/supervisord.pid   ; (supervisord pidfile;default supervisord.pid)
+nodaemon=true                                 ; (start in foreground if true;default false)
+minfds=1024                                   ; (min. avail startup file descriptors;default 1024)
+minprocs=200                                  ; (min. avail process descriptors;default 200)
+
+[include]
+files = /etc/supervisor/conf.d/*.conf

Hub/Dockerfile.txt

@@ -28,9 +28,9 @@ ENV GRID_HUB_PORT 4444
 ENV GRID_HUB_HOST "0.0.0.0"
 
 COPY generate_config \
-    entry_point.sh \
+    start-selenium-hub.sh \
     /opt/bin/
 
-RUN /opt/bin/generate_config > /opt/selenium/config.json
+COPY selenium-hub.conf /etc/supervisor/conf.d/
 
-CMD ["/opt/bin/entry_point.sh"]
+RUN /opt/bin/generate_config > /opt/selenium/config.json

Hub/entry_point.sh

@@ -1,4 +1,5 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
 VERSION=$1
 NAMESPACE=$2
 AUTHORS=$3
@@ -7,7 +8,7 @@ echo "# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!" > ./Dockerfile
 echo "# NOTE: DO *NOT* EDIT THIS FILE.  IT IS GENERATED." >> ./Dockerfile
 echo "# PLEASE UPDATE Dockerfile.txt INSTEAD OF THIS FILE" >> ./Dockerfile
 echo "# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!" >> ./Dockerfile
-echo FROM $NAMESPACE/base:$VERSION >> ./Dockerfile
+echo FROM ${NAMESPACE}/base:${VERSION} >> ./Dockerfile
 echo LABEL authors="$AUTHORS" >> ./Dockerfile
 echo "" >> ./Dockerfile
-cat ./Dockerfile.txt >> ./Dockerfile
+cat ./Dockerfile.txt >> ./Dockerfile

Hub/generate.sh

@@ -1,18 +1,18 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 cat <<_EOF
 {
-  "host": "$GRID_HUB_HOST",
-  "port": $GRID_HUB_PORT,
+  "host": "${GRID_HUB_HOST}",
+  "port": ${GRID_HUB_PORT},
   "role": "hub",
-  "maxSession": $GRID_MAX_SESSION,
-  "newSessionWaitTimeout": $GRID_NEW_SESSION_WAIT_TIMEOUT,
+  "maxSession": ${GRID_MAX_SESSION},
+  "newSessionWaitTimeout": ${GRID_NEW_SESSION_WAIT_TIMEOUT},
   "capabilityMatcher": "org.openqa.grid.internal.utils.DefaultCapabilityMatcher",
-  "throwOnCapabilityNotPresent": $GRID_THROW_ON_CAPABILITY_NOT_PRESENT,
-  "jettyMaxThreads": $GRID_JETTY_MAX_THREADS,
-  "cleanUpCycle": $GRID_CLEAN_UP_CYCLE,
-  "browserTimeout": $GRID_BROWSER_TIMEOUT,
-  "timeout": $GRID_TIMEOUT,
-  "debug": $GRID_DEBUG
+  "throwOnCapabilityNotPresent": ${GRID_THROW_ON_CAPABILITY_NOT_PRESENT},
+  "jettyMaxThreads": ${GRID_JETTY_MAX_THREADS},
+  "cleanUpCycle": ${GRID_CLEAN_UP_CYCLE},
+  "browserTimeout": ${GRID_BROWSER_TIMEOUT},
+  "timeout": ${GRID_TIMEOUT},
+  "debug": ${GRID_DEBUG}
 }
 _EOF

Hub/generate_config

@@ -0,0 +1,16 @@
+; Documentation of this file format -> http://supervisord.org/configuration.html
+
+[program:selenium-hub]
+
+priority=0
+user=seluser
+command=/opt/bin/start-selenium-hub.sh
+autostart=true
+autorestart=false
+startsecs=0
+startretries=0
+
+;Logs (all Hub activity redirected to stdout so it can be seen through "docker logs"
+redirect_stderr=true
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0

Hub/selenium-hub.conf

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+# set -e: exit asap if a command exits with a non-zero status
+set -e
+
+ROOT=/opt/selenium
+CONF=${ROOT}/config.json
+
+/opt/bin/generate_config >${CONF}
+
+echo "Starting Selenium Hub with configuration:"
+cat ${CONF}
+
+if [ ! -z "$SE_OPTS" ]; then
+  echo "Appending Selenium options: ${SE_OPTS}"
+fi
+
+java ${JAVA_OPTS} -jar /opt/selenium/selenium-server-standalone.jar \
+  -role hub \
+  -hubConfig ${CONF} \
+  ${SE_OPTS}

Hub/start-selenium-hub.sh

@@ -70,16 +70,25 @@ RUN apt-get -qqy update \
 USER seluser
 
 #==============================
-# Scripts to run Selenium Node
+# Scripts to run Selenium Node and XVFB
 #==============================
-COPY entry_point.sh  /opt/bin/
+COPY start-selenium-node.sh \
+      start-xvfb.sh \
+      /opt/bin/
+
+#==============================
+# Supervisor configuration file
+#==============================
+COPY selenium.conf /etc/supervisor/conf.d/
+
 
 #============================
 # Some configuration options
 #============================
 ENV SCREEN_WIDTH 1360
 ENV SCREEN_HEIGHT 1020
 ENV SCREEN_DEPTH 24
+ENV DISPLAY :99.0
 
 #========================
 # Selenium Configuration
@@ -106,4 +115,5 @@ ENV NODE_APPLICATION_NAME ""
 # Following line fixes https://github.com/SeleniumHQ/docker-selenium/issues/87
 ENV DBUS_SESSION_BUS_ADDRESS=/dev/null
 
-CMD ["/opt/bin/entry_point.sh"]
+# Creating base directory for Xvfb
+RUN  sudo mkdir -p /tmp/.X11-unix && sudo chmod 1777 /tmp/.X11-unix