Support non-sudo environments like K8s for running the container #175

Author: elgalu

Dockerfile

@@ -583,6 +583,9 @@ RUN wget --no-verbose -O geckodriver.tar.gz \
   && rm -rf /opt/geckodriver* \
   && tar -C /opt -xvzf geckodriver.tar.gz \
   && chmod +x /opt/geckodriver \
+  && cp /opt/geckodriver /usr/bin/geckodriver \
+  && chown seluser:seluser /opt/geckodriver \
+  && chown seluser:seluser /usr/bin/geckodriver \
   && rm geckodriver.tar.gz
 
 #===============
@@ -619,6 +622,7 @@ COPY lib/* /usr/lib/
 # Use a custom wallpaper for Fluxbox
 COPY images/wallpaper-dosel.png /usr/share/images/fluxbox/ubuntu-light.png
 COPY images/wallpaper-zalenium.png /usr/share/images/fluxbox/
+RUN chown -R seluser:seluser /usr/share/images/fluxbox/
 
 #===================================================
 # Run the following commands as non-privileged user
@@ -924,6 +928,7 @@ ENV FIREFOX_VERSION="${FF_VER}" \
   GA_ENDPOINT=https://www.google-analytics.com/collect \
   GA_API_VERSION="1" \
   DEBIAN_FRONTEND="" \
+  USE_KUBERNETES="false" \
   DEBCONF_NONINTERACTIVE_SEEN=""
 
 #================================
@@ -957,16 +962,13 @@ COPY Analytics.md /home/seluser/
 #===================================
 # The .X11-unix stuff is useful when using Xephyr
 RUN mkdir -p /home/seluser/.vnc \
-  && sudo touch /capabilities3.json \
-  && sudo chown seluser:seluser /capabilities3.json \
-  && generate_capabilities3_json > /capabilities3.json \
-  && cp /capabilities3.json /home/seluser/capabilities3.json \
-  && cp /capabilities3.json /home/seluser/capabilities3 \
-  && cp /capabilities3.json /home/seluser/caps3.json \
-  && cp /capabilities3.json /home/seluser/caps3 \
-  && sudo cp /capabilities3.json /capabilities.json \
-  && sudo cp /capabilities3.json /home/seluser/capabilities.json \
-  && sudo cp /capabilities3.json /home/seluser/caps.json \
+  && sudo touch /capabilities.json \
+  && sudo chown seluser:seluser /capabilities.json \
+  && generate_capabilities_json > /capabilities.json \
+  && cp /capabilities.json /home/seluser/capabilities.json \
+  && cp /capabilities.json /home/seluser/capabilities \
+  && cp /capabilities.json /home/seluser/caps.json \
+  && cp /capabilities.json /home/seluser/caps \
   && mkdir -p ${VIDEOS_DIR} \
   && sudo ln -s ${VIDEOS_DIR} /videos \
   && sudo chown seluser:seluser /videos \

bin/clear_x_locks.sh

@@ -13,25 +13,32 @@ die () {
   exit $errnum
 }
 
+if [ -f /var/run/secrets/kubernetes.io/serviceaccount/token ]; then
+  log "Kubernetes service account found."
+  export USE_KUBERNETES=true
+fi
+
 #==============================================
 # Java blocks until kernel have enough entropy
 # to generate the /dev/random seed
 #==============================================
 # See: SeleniumHQ/docker-selenium/issues/14
-sudo haveged
+# Added a non-sudo conditional so this works on non-sudo environments like K8s
+(sudo haveged) || haveged
 
 # Workaround that might help to get dbus working in docker
 #  http://stackoverflow.com/a/38355729/511069
 #  https://github.com/SeleniumHQ/docker-selenium/issues/87#issuecomment-187659234
 #  - still unclear if this helps: `-v /var/run/dbus:/var/run/dbus`
 #  - this works generates errors: DBUS_SESSION_BUS_ADDRESS="/dev/null"
 #  - this gives less erros: DBUS_SESSION_BUS_ADDRESS="unix:abstract=/dev/null"
-sudo rm -f /var/lib/dbus/machine-id
-sudo mkdir -p /var/run/dbus
-sudo service dbus restart >dbus_service.log
+# Added a non-sudo conditional so this works on non-sudo environments like K8s
+(sudo rm -f /var/lib/dbus/machine-id) || (rm -f /var/lib/dbus/machine-id) || true
+(sudo mkdir -p /var/run/dbus) || (mkdir -p /var/run/dbus) || true
+(sudo service dbus restart >dbus_service.log) || (service dbus restart >dbus_service.log) || true
 # Test dbus works
-service dbus status >dbus_service_status.log
-export $(dbus-launch)
+(service dbus status >dbus_service_status.log) || true
+export $(dbus-launch) || true
 export NSS_USE_SHARED_DB=ENABLED
 # echo "-- INFO: DBUS_SESSION_BUS_ADDRESS=${DBUS_SESSION_BUS_ADDRESS}"
 #=> e.g. DBUS_SESSION_BUS_ADDRESS=unix:abstract=/tmp/dbus-APZO4BE4TJ,guid=6e9c098d053d3038cb0756ae57ecc885
@@ -44,22 +51,11 @@ stop >/dev/null 2>&1 || true
 rm -f ${LOGS_DIR}/*
 rm -f ${RUN_DIR}/*
 
-# Support restart docker container for selenium 3 @aituganov
-if [ ! -f /usr/bin/geckodriver ]; then
-  sudo mv /opt/geckodriver /usr/bin/geckodriver
-  sudo ln -fs /usr/bin/geckodriver /opt/geckodriver
-fi
-
-sudo cp /capabilities3.json /capabilities.json
-sudo cp /capabilities3.json /home/seluser/capabilities.json
-sudo cp /capabilities3.json /home/seluser/caps.json
-
 #---------------------
 # Fix/extend ENV vars
 #---------------------
 export SELENIUM_JAR_PATH="/home/seluser/selenium-server-standalone-3.jar"
 export FIREFOX_DEST_BIN="/home/seluser/firefox-for-sel-3/firefox"
-sudo ln -fs ${FIREFOX_DEST_BIN} /usr/bin/firefox
 export DOSEL_VERSION=$(cat VERSION)
 export FIREFOX_VERSION=$(firefox_version)
 # CHROME_FLAVOR would allow to have separate installations for stable, beta, unstable
@@ -183,7 +179,7 @@ echo "Please send us a PR if you know how to set the path for the Firefox browse
 # When running for Zalenium prepare certain customizations
 if [ "${ZALENIUM}" == "true" ]; then
   # Set proper desktop background
-  sudo mv -f /usr/share/images/fluxbox/wallpaper-zalenium.png /usr/share/images/fluxbox/ubuntu-light.png
+  mv -f /usr/share/images/fluxbox/wallpaper-zalenium.png /usr/share/images/fluxbox/ubuntu-light.png
 fi
 
 # TODO: Remove this duplicated logic
@@ -375,24 +371,23 @@ ga_track_start () {
   fi
 }
 
-#----------------------------------------
-# Remove lock files, thanks @garagepoort
-# clear_x_locks.sh
-
 #--------------------------------
 # Improve etc/hosts and fix dirs
-improve_etc_hosts.sh
-fix_dirs.sh
+if [ "${USE_KUBERNETES}" == "false" ]; then
+  sudo improve_etc_hosts.sh
+fi
 
 #-------------------------
 # Docker alongside docker
-docker_alongside_docker.sh
+if [ "${USE_KUBERNETES}" == "false" ]; then
+  docker_alongside_docker.sh
+fi
 
 #-------------------------------
 # Fix small tiny 64mb shm issue
 #-------------------------------
 # https://github.com/elgalu/docker-selenium/issues/20
-if [ "${SHM_TRY_MOUNT_UNMOUNT}" = "true" ]; then
+if [ "${SHM_TRY_MOUNT_UNMOUNT}" = "true" ] && [ "${USE_KUBERNETES}" == "false" ]; then
   sudo umount /dev/shm || true
   sudo mount -t tmpfs -o rw,nosuid,nodev,noexec,relatime,size=${SHM_SIZE} \
     tmpfs /dev/shm || true
@@ -440,6 +435,7 @@ echo "${SEL_UNREGISTER_IF_STILL_DOWN_AFTER}" > SEL_UNREGISTER_IF_STILL_DOWN_AFTE
 echo "${SELENIUM_NODE_PARAMS}" > SELENIUM_NODE_PARAMS
 echo "${CUSTOM_SELENIUM_NODE_PROXY_PARAMS}" > CUSTOM_SELENIUM_NODE_PROXY_PARAMS
 echo "${CUSTOM_SELENIUM_NODE_REGISTER_CYCLE}" > CUSTOM_SELENIUM_NODE_REGISTER_CYCLE
+echo "${USE_KUBERNETES}" > USE_KUBERNETES
 echo "${XMANAGER}" > XMANAGER
 echo "${GRID}" > GRID
 

bin/entry.sh

@@ -1,13 +1,13 @@
 #!/usr/bin/env bash
 
-sudo -E sh -c 'cat /tmp/hosts >> /etc/hosts'
-sudo -E sh -c 'echo "$DOCKER_HOST_IP  docker.host"        >> /etc/hosts'
-sudo -E sh -c 'echo "$CONTAINER_IP    docker.guest"       >> /etc/hosts'
-sudo -E sh -c 'echo "$DOCKER_HOST_IP  docker.host.dev"    >> /etc/hosts'
-sudo -E sh -c 'echo "$DOCKER_HOST_IP  d.host.loc.dev"     >> /etc/hosts'
-sudo -E sh -c 'echo "$CONTAINER_IP    docker.guest.dev"   >> /etc/hosts'
-sudo -E sh -c 'echo "$DOCKER_HOST_IP  host.docker.local"  >> /etc/hosts'
-sudo -E sh -c 'echo "$CONTAINER_IP    guest.docker.local" >> /etc/hosts'
-sudo -E sh -c 'echo "$CONTAINER_IP    d.guest.loc.dev"    >> /etc/hosts'
-sudo -E sh -c 'echo "$DOCKER_HOST_IP  host.docker"        >> /etc/hosts'
-sudo -E sh -c 'echo "$CONTAINER_IP    guest.docker"       >> /etc/hosts'
+cat /tmp/hosts >> /etc/hosts
+echo "$DOCKER_HOST_IP  docker.host"        >> /etc/hosts
+echo "$CONTAINER_IP    docker.guest"       >> /etc/hosts
+echo "$DOCKER_HOST_IP  docker.host.dev"    >> /etc/hosts
+echo "$DOCKER_HOST_IP  d.host.loc.dev"     >> /etc/hosts
+echo "$CONTAINER_IP    docker.guest.dev"   >> /etc/hosts
+echo "$DOCKER_HOST_IP  host.docker.local"  >> /etc/hosts
+echo "$CONTAINER_IP    guest.docker.local" >> /etc/hosts
+echo "$CONTAINER_IP    d.guest.loc.dev"    >> /etc/hosts
+echo "$DOCKER_HOST_IP  host.docker"        >> /etc/hosts
+echo "$CONTAINER_IP    guest.docker"       >> /etc/hosts

dns/bin/improve_etc_hosts.sh

@@ -86,4 +86,3 @@ fi
 docker exec grid errors || true
 docker cp grid:/test/console.png ./images/grid3_console.png
 docker cp grid:/capabilities.json .
-docker cp grid:/capabilities3.json .

test/script_scenario_basic

@@ -133,20 +133,22 @@ fi
 
 echo "#======================================================"
 echo "# Scenario 3c [node_dies]: Dies by killing a Multi-node"
+echo "#      + run tests again simulation USE_KUBERNETES=true"
 echo "#======================================================"
 
 # Ensure clean env
 docker rm -vf mynodes || true
 docker rm -vf grid_mock || true
 
-# Create container for Firefox
+# Create container for Firefox and simulate USE_KUBERNETES=true
 docker run --name=mynodes -d \
   -v /dev/shm:/dev/shm \
   --privileged \
   -e CHROME=false \
   -e FIREFOX=false \
   -e MULTINODE=true \
   -e CI \
+  -e USE_KUBERNETES=true \
   -e SELENIUM_MULTINODE_PORT \
   -p ${SELENIUM_MULTINODE_PORT}:${SELENIUM_MULTINODE_PORT} \
   selenium

test/script_scenario_node_dies

@@ -24,10 +24,12 @@ if [ -z "${HOST_GID}" ] && [ -z "${HOST_UID}" ]; then
   [ -z "${VIDEOS_DIR}" ] && die "Need env var set \$VIDEOS_DIR"
   export HOST_GID=$(stat -c "%g" ${VIDEOS_DIR})
   export HOST_UID=$(stat -c "%u" ${VIDEOS_DIR})
+elif [ "${USE_KUBERNETES}" == "true" ]; then
+  log "No sudo support in K8s so will skip setting up sudo groupadd -g ${HOST_GID} tempgroup"
 else
   GROUP_EXISTS=$(cat /etc/group | grep ${HOST_GID} | wc -l)
   # Create new group using target GID and add seluser user
-  if [ $GROUP_EXISTS == "0" ]; then
+  if [ ${GROUP_EXISTS} == "0" ]; then
     sudo groupadd -g ${HOST_GID} tempgroup
     sudo gpasswd -a seluser tempgroup
   else

utils/bin/fix_dirs.sh

@@ -10,7 +10,8 @@ set -e
     FFMPEG_FRAME_SIZE="${SCREEN_WIDTH}x${SCREEN_HEIGHT}"
 
 # Remove the video file if exists
-sudo rm -f "${VIDEO_BASE_PATH}"*
+# Added a non-sudo conditional so this works on non-sudo environments like K8s
+(sudo rm -f "${VIDEO_BASE_PATH}"*) || (rm -f "${VIDEO_BASE_PATH}"*)
 
 # record testing video using password file
 # using sudo due to http://stackoverflow.com/questions/23544282/
@@ -30,8 +31,9 @@ export tmp_video_path="${VIDEOS_DIR}/${VIDEO_FILE_NAME}.${VIDEO_TMP_FILE_EXTENSI
 export final_video_path="${VIDEOS_DIR}/${VIDEO_FILE_NAME}.${VIDEO_FILE_EXTENSION}"
 
 # Fix perms to be able to start ffmpeg without sudo
-sudo touch "${tmp_video_path}"
-sudo chown seluser:seluser "${tmp_video_path}"
+# Added a non-sudo conditional so this works on non-sudo environments like K8s
+(sudo touch "${tmp_video_path}") || (touch "${tmp_video_path}")
+(sudo chown seluser:seluser "${tmp_video_path}") || (chown seluser:seluser "${tmp_video_path}") || true
 
 # avconv or ffmpeg
 ffmpeg -f x11grab \