Refactoring, tests and fix for SERVERNUM.

- Add a common place for functions to be used in entry_point.sh
  scripts.
- Refactor the calls to "echo $DISPLAY | sed..." into a function
  named get_server_num.
- Add tests for this function.
- Fix regex used in sed call.

Author: kayabendroth

NodeBase/Dockerfile

@@ -23,7 +23,10 @@ RUN apt-get update -qqy \
 #==============================
 # Scripts to run Selenium Node
 #==============================
-COPY entry_point.sh /opt/bin/entry_point.sh
+COPY \
+  entrypoint.sh \
+  functions.sh \
+    /opt/bin/
 RUN chmod +x /opt/bin/entry_point.sh
 
 #============================

NodeBase/Dockerfile.txt

@@ -22,7 +22,10 @@ RUN apt-get update -qqy \
 #==============================
 # Scripts to run Selenium Node
 #==============================
-COPY entry_point.sh /opt/bin/entry_point.sh
+COPY \
+  entry_point.sh \
+  functions.sh \
+    /opt/bin/
 RUN chmod +x /opt/bin/entry_point.sh
 
 #============================

NodeBase/entry_point.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+source /opt/bin/functions.sh
+
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
 if [ ! -e /opt/selenium/config.json ]; then
@@ -28,7 +31,7 @@ fi
 
 # TODO: Look into http://www.seleniumhq.org/docs/05_selenium_rc.jsp#browser-side-logs
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 xvfb-run -n $SERVERNUM --server-args="-screen 0 $GEOMETRY -ac +extension RANDR" \
   java ${JAVA_OPTS} -jar /opt/selenium/selenium-server-standalone.jar \
     -role node \

NodeBase/functions.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# https://github.com/SeleniumHQ/docker-selenium/issues/184
+function get_server_num() {
+  echo $(echo $DISPLAY | sed -r -e 's/([^:]+)?:([0-9]+)(\.[0-9]+)?/\2/')
+}
+

NodeBase/test-functions.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bats
+
+source "$BATS_TEST_DIRNAME"/functions.sh
+
+# Tests for function get_server_num
+#
+# Test data from http://askubuntu.com/questions/432255/what-is-display-environment-variable
+@test 'get_server_num of :99.1' {
+
+  export DISPLAY=':99.1'
+  expected_result='99'
+  result="$(get_server_num)"
+  echo "result: $result"
+  [ "$result" == "$expected_result" ]
+}
+
+@test 'get_server_num of :0' {
+
+  export DISPLAY=':0'
+  expected_result='0'
+  result="$(get_server_num)"
+  echo "result: $result"
+  [ "$result" == "$expected_result" ]
+}
+
+@test 'get_server_num of localhost:4' {
+
+  export DISPLAY='localhost:4'
+  expected_result='4'
+  result="$(get_server_num)"
+  echo "result: $result"
+  [ "$result" == "$expected_result" ]
+}
+
+@test 'get_server_num of google.com:0' {
+
+  export DISPLAY='google.com:0'
+  expected_result='0'
+  result="$(get_server_num)"
+  echo "result: $result"
+  [ "$result" == "$expected_result" ]
+}
+
+@test 'get_server_num of google.com:99.1' {
+
+  export DISPLAY='google.com:99.1'
+  expected_result='99'
+  result="$(get_server_num)"
+  echo "result: $result"
+  [ "$result" == "$expected_result" ]
+}
+

NodeChromeDebug/entry_point.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+source /opt/bin/functions.sh
+
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
 if [ ! -e /opt/selenium/config.json ]; then
@@ -28,7 +31,7 @@ fi
 
 # TODO: Look into http://www.seleniumhq.org/docs/05_selenium_rc.jsp#browser-side-logs
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 env | cut -f 1 -d "=" | sort > asroot
   sudo -E -u seluser -i env | cut -f 1 -d "=" | sort > asseluser
   sudo -E -i -u seluser \

NodeFirefoxDebug/entry_point.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+source /opt/bin/functions.sh
+
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
 if [ ! -e /opt/selenium/config.json ]; then
@@ -28,7 +31,7 @@ fi
 
 # TODO: Look into http://www.seleniumhq.org/docs/05_selenium_rc.jsp#browser-side-logs
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 env | cut -f 1 -d "=" | sort > asroot
   sudo -E -u seluser -i env | cut -f 1 -d "=" | sort > asseluser
   sudo -E -i -u seluser \

Standalone/entry_point.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+source /opt/bin/functions.sh
+
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
 function shutdown {
@@ -10,7 +13,7 @@ if [ ! -z "$SE_OPTS" ]; then
   echo "appending selenium options: ${SE_OPTS}"
 fi
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 xvfb-run -n $SERVERNUM --server-args="-screen 0 $GEOMETRY -ac +extension RANDR" \
   java ${JAVA_OPTS} -jar /opt/selenium/selenium-server-standalone.jar \
   ${SE_OPTS} &

StandaloneChrome/entry_point.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+source /opt/bin/functions.sh
+
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
 function shutdown {
@@ -10,7 +13,7 @@ if [ ! -z "$SE_OPTS" ]; then
   echo "appending selenium options: ${SE_OPTS}"
 fi
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 xvfb-run -n $SERVERNUM --server-args="-screen 0 $GEOMETRY -ac +extension RANDR" \
   java ${JAVA_OPTS} -jar /opt/selenium/selenium-server-standalone.jar \
   ${SE_OPTS} &

StandaloneChromeDebug/entry_point.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
-source "/opt/bin/clear_x_locks.sh"
+
+source /opt/bin/clear_x_locks.sh
+source /opt/bin/functions.sh
 
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
@@ -12,7 +14,7 @@ if [ ! -z "$SE_OPTS" ]; then
   echo "appending selenium options: ${SE_OPTS}"
 fi
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 env | cut -f 1 -d "=" | sort > asroot
 sudo -E -u seluser -i env | cut -f 1 -d "=" | sort > asseluser
 sudo -E -i -u seluser \

StandaloneDebug/entry_point.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+source /opt/bin/functions.sh
+
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
 function shutdown {
@@ -10,7 +13,7 @@ if [ ! -z "$SE_OPTS" ]; then
   echo "appending selenium options: ${SE_OPTS}"
 fi
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 env | cut -f 1 -d "=" | sort > asroot
 sudo -E -u seluser -i env | cut -f 1 -d "=" | sort > asseluser
 sudo -E -i -u seluser \

StandaloneFirefox/entry_point.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+source /opt/bin/functions.sh
+
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
 function shutdown {
@@ -10,7 +13,7 @@ if [ ! -z "$SE_OPTS" ]; then
   echo "appending selenium options: ${SE_OPTS}"
 fi
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 xvfb-run -n $SERVERNUM --server-args="-screen 0 $GEOMETRY -ac +extension RANDR" \
   java ${JAVA_OPTS} -jar /opt/selenium/selenium-server-standalone.jar \
   ${SE_OPTS} &

StandaloneFirefoxDebug/entry_point.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+source /opt/bin/functions.sh
+
 export GEOMETRY="$SCREEN_WIDTH""x""$SCREEN_HEIGHT""x""$SCREEN_DEPTH"
 
 function shutdown {
@@ -10,7 +13,7 @@ if [ ! -z "$SE_OPTS" ]; then
   echo "appending selenium options: ${SE_OPTS}"
 fi
 
-SERVERNUM=$(echo $DISPLAY | sed 's/:\([0-9][0-9]*\).[0-9][0-9]*/\1/')
+SERVERNUM=$(get_server_num)
 env | cut -f 1 -d "=" | sort > asroot
 sudo -E -u seluser -i env | cut -f 1 -d "=" | sort > asseluser
 sudo -E -i -u seluser \

circle.yml

@@ -3,8 +3,11 @@ machine:
     - docker
   environment:
     DELETE_CONTAINERS: false
+
 dependencies:
   override:
+    # Install bats for testing shell scripts.
+    - git clone https://github.com/sstephenson/bats.git && cd bats && sudo ./install.sh /usr/local
     - docker info
     - make build
 

test.sh

@@ -5,6 +5,20 @@ if [ -n "$1" ] && [ $1 == 'debug' ]; then
   DEBUG='-debug'
 fi
 
+# Due to the dependency GNU sed, we're skipping this part when running
+# on Mac OS X.
+if [ "$(uname)" != 'Darwin' ] ; then
+  echo 'Testing shell functions...'
+  which bats > /dev/null 2>&1
+  if [ $? -ne 0 ] ; then
+    echo "Could not find 'bats'. Please install it first, e.g., following https://github.com/sstephenson/bats#installing-bats-from-source."
+    exit 1
+  fi
+  NodeBase/test-functions.sh || exit 1
+else
+  echo 'Skipping shell functions test on Mac OS X.'
+fi
+
 echo Building test container image
 docker build -t selenium/test:local ./Test