Add WORKDIR & exec grid cat HUB_PORT #=> 24444

Author: elgalu

.travis.yml

@@ -2,11 +2,8 @@
 # us to pick a language else it will pick Ruby by default
 language: generic
 
-sudo: required
-services:
-  - docker
-
-# Omit running tests on temporal branches
+# Omit running tests on temporal branches,
+#  i.e. branches with names that start with "tmp"
 branches:
   except:
     - /^tmp/
@@ -17,37 +14,59 @@ env:
 
 matrix:
   allow_failures:
-    - os: osx
-      env:
+    # Currently erroring in Mac (OSX):
+    #  https://travis-ci.org/elgalu/docker-selenium/jobs/143553463#L636
+    #   com.docker.docker Incompatible CPU detected
+    #   Docker requires a processor with virtualization capabilities
+    - env:
         - DOCKER_VERSION="1.12.0-rc3"
           DOCKER_COMPOSE_VERSION="1.8.0-rc2"
+          OPERATING_SYSTEM="osx"
   include:
     # Linux with docker:stable compose:stable
     - os: linux
+      sudo: required
+      dist: trusty
+      services:
+        - docker
       env:
         - DOCKER_VERSION="stable"
           DOCKER_COMPOSE_VERSION="1.7.1"
           DOCKER_PUSH=true
     # Linux with docker:beta compose:stable
     - os: linux
+      sudo: required
+      dist: trusty
+      services:
+        - docker
       env:
         - DOCKER_VERSION="1.12.0-rc3"
           DOCKER_COMPOSE_VERSION="1.7.1"
     # Linux with docker:stable compose:beta
     - os: linux
+      sudo: required
+      dist: trusty
+      services:
+        - docker
       env:
         - DOCKER_VERSION="stable"
           DOCKER_COMPOSE_VERSION="1.8.0-rc2"
     # Linux with docker:beta compose:beta
     - os: linux
+      sudo: required
+      dist: trusty
+      services:
+        - docker
       env:
         - DOCKER_VERSION="1.12.0-rc3"
           DOCKER_COMPOSE_VERSION="1.8.0-rc2"
     # Mac OSX: only test native docker version
     - os: osx
+      osx_image: xcode8
       env:
         - DOCKER_VERSION="1.12.0-rc3"
           DOCKER_COMPOSE_VERSION="1.8.0-rc2"
+          OPERATING_SYSTEM="osx"
 
 before_install:
   - travis_retry ./test/before_install_setup

CHANGELOG.md

@@ -9,7 +9,10 @@ Note image ids also change after scm-source.json has being updated which trigger
 
 ## TBD_DOCKER_TAG
  + Date: TBD_DATE
- + TBD_COMMIT_MSG
+ + Add OSX support closes #111 #110
+ + Add docs/share-host.md and docs/jenkins.md (WIP)
+ + Chore: Add `WORKDIR ${NORMAL_USER_HOME}`
+ + Chore: Add `docker exec grid cat HUB_PORT #=> 24444`
  + Image tag details:
   + Selenium: vTBD_SELENIUM_VERSION (TBD_SELENIUM_REVISION)
   + Chrome stable:  TBD_CHROME_STABLE

CONTRIBUTING.md

@@ -8,19 +8,19 @@ For pull requests or local commits:
     open ./images/grid_console.png #to verify the versions are correct
     git checkout ./images/grid_console.png && open ./videos/chrome/test.mkv
     travis lint #if you changed .travis.yml
-    git checkout -b tmp-2.53.1f #name your branch according to your changes
+    git checkout -b tmp-2.53.1g #name your branch according to your changes
     #git add ... git commit ... git push ... open pull request
 
 For repository owners only:
 
     git commit -m "Add OSX support closes #111 #110"
     git tag -d latest #tag latest will be updated from TravisCI
-    git tag 2.53.1f && git push origin tmp-2.53.1f && git push --tags
+    git tag 2.53.1g && git push origin tmp-2.53.1g && git push --tags
 
 -- Wait for Travis to pass OK
 -- Make sure changes got merged into master by elgalubot
 
-    git checkout master && git pull && git branch -d tmp-2.53.1f && git push origin --delete tmp-2.53.1f
+    git checkout master && git pull && git branch -d tmp-2.53.1g && git push origin --delete tmp-2.53.1g
 
 -- Re-add TBD_* section in CHANGELOG.md starting with TBD_DOCKER_TAG
 -- Upgrade release tag in github.com with latest CHANGELOG.md
@@ -37,9 +37,9 @@ Keep certain bins if chrome version changed for example:
 ## Retry
 Failed in Travis? retry
 
-    git tag -d 2.53.1f && git push origin :2.53.1f
+    git tag -d 2.53.1g && git push origin :2.53.1g
     #git add ...
-    git commit --amend && git tag 2.53.1f && git push --force origin tmp-2.53.1f && git push --tags
+    git commit --amend && git tag 2.53.1g && git push --force origin tmp-2.53.1g && git push --tags
 
 ## Docker push from Travis CI
 Travis [steps](https://docs.travis-ci.com/user/docker/#Pushing-a-Docker-Image-to-a-Registry) involve `docker login` and docker credentials encryptions.

Dockerfile

@@ -440,6 +440,7 @@ RUN apt-get update -qqy \
   && pip install --upgrade pip \
   && pip install --upgrade setuptools \
   && pip install --upgrade selenium \
+  && pip install --upgrade retrying \
   && rm -rf /var/lib/apt/lists/*
 
 #=========================================
@@ -970,7 +971,10 @@ ENV FIREFOX_VERSION="${FF_VER}" \
   SELENIUM_HUB_PARAMS="" \
   SELENIUM_NODE_PARAMS="" \
   SELENIUM_NODE_PROXY_PARAMS="" \
-  SELENIUM_NODE_REGISTER_CYCLE="" \
+  # How often in ms the node will try to register itself again.
+  # Allow to restart the hub without having to restart the nodes.
+  #  (node) in ms. Selenium default: 5000
+  SELENIUM_NODE_REGISTER_CYCLE="0" \
   # To taggle issue #58 see https://goo.gl/fz6RTu
   CHROME_ARGS="--no-sandbox" \
   # e.g. CHROME_ARGS="--no-sandbox --ignore-certificate-errors" \
@@ -982,8 +986,12 @@ ENV FIREFOX_VERSION="${FF_VER}" \
   MAX_SESSIONS=1 \
   SEL_RELEASE_TIMEOUT_SECS=19000 \
   SEL_BROWSER_TIMEOUT_SECS=16000 \
-  SEL_CLEANUPCYCLE_MS=90000 \
-  SEL_NODEPOLLING_MS=80000 \
+  # How often a proxy will check for timed out thread.
+  #  (node) in ms. Selenium default: 5000
+  SEL_CLEANUPCYCLE_MS=9000 \
+  # Interval between alive checks of node how often the hub checks if the node is still alive.
+  #  (node) in ms. Selenium default: 5000
+  SEL_NODEPOLLING_MS=6000 \
   # Docker for Mac beta - containers do not start #227
   no_proxy=localhost \
   HUB_ENV_no_proxy=localhost \
@@ -1169,6 +1177,7 @@ COPY scm-source.json /
 # Ensure the file is up-to-date else you should update it by running
 #  ./host-scripts/gen-scm-source.sh
 # on the host machine
+WORKDIR ${NORMAL_USER_HOME}
 
 #===================
 # CMD or ENTRYPOINT

README.md

@@ -39,6 +39,26 @@ If you don't require a real browser [PhantomJS](https://github.com/ariya/phantom
 You can also configure [xvfb](https://docs.travis-ci.com/user/gui-and-headless-browsers/#Using-xvfb-to-Run-Tests-That-Require-a-GUI) yourself but it involves some manual steps and doesn't include video recording, nor does PhantomJS nor Electron.
 A [new chromium headless project](https://github.com/electron/electron/issues/228#issuecomment-223797342) looks very promising so might we worth to take a look though as of now leaves video recording out of scope there and Firefox also out of scope.
 
+### Requisites
+This project is normally tested in the last version of Docker and docker-compose and also in the release candidates.
+To figure out the currently used specific versions it surely works on,
+see file [.travis.yml](./.travis.yml) example values:
+
+    docker --version         #=> 1.11.2
+    docker-compose --version #=> 1.7.1
+
+If you need to use docker-machine to run docker
+(like for example on a Mac before the Docker native version 1.12),
+you also need to install VirtualBox and then run these commands to get started:
+
+
+```sh
+docker-machine create --driver virtualbox default
+eval "$(docker-machine env default)"
+```
+
+You will need to run the second `eval` command for every new terminal window.
+
 ### Usage
 
 <h4 id="run"><img width="24" src="./images/icons/logo.png" /> Run</h4>
@@ -76,6 +96,9 @@ Shutdown immediately, no mercy
 ### Docker Compose
 See [docker-compose](./docs/docker-compose.md)
 
+### Jenkins
+See [jenkins](./docs/jenkins.md)
+
 ### Parallel
 This image is designed to run one test on each docker container but if you still want to run multiple tests in parallel you can still do, there are some ways to do this:
 

bin/entry.sh

@@ -339,6 +339,26 @@ if [ "${SHM_TRY_MOUNT_UNMOUNT}" = "true" ]; then
     tmpfs /dev/shm || true
 fi
 
+#-------------------------------------------
+# Keep updated environment vars inside files
+#-------------------------------------------
+# So can be consulted later on with:
+#  docker exec grid cat HUB_PORT #=> 24444
+#  docker exec selenium_chrome_1 cat FF_PORT #=> 44023
+echo "${SELENIUM_HUB_PORT}" > SELENIUM_HUB_PORT
+echo "${SELENIUM_HUB_PORT}" > HUB_PORT
+echo "${SELENIUM_NODE_CH_PORT}" > SELENIUM_NODE_CH_PORT
+echo "${SELENIUM_NODE_CH_PORT}" > CH_PORT
+echo "${SELENIUM_NODE_FF_PORT}" > SELENIUM_NODE_FF_PORT
+echo "${SELENIUM_NODE_FF_PORT}" > FF_PORT
+echo "${DISPLAY}" > DISPLAY
+echo "${VNC_PORT}" > VNC_PORT
+echo "${NOVNC_PORT}" > NOVNC_PORT
+echo "${SSHD_PORT}" > SSHD_PORT
+echo "${SAUCE_LOCAL_SEL_PORT}" > SAUCE_LOCAL_SEL_PORT
+echo "${SUPERVISOR_HTTP_PORT}" > SUPERVISOR_HTTP_PORT
+env > env
+
 #------
 # exec
 #------

docker-compose-host.yml

@@ -14,6 +14,8 @@ services:
 
   chrome:
     image: elgalu/selenium
+    depends_on:
+      - hub
     network_mode: host
     shm_size: 1g
     environment:
@@ -23,11 +25,11 @@ services:
       - GRID=false
       - CHROME=true
       - FIREFOX=false
-    depends_on:
-      - hub
 
   firefox:
     image: elgalu/selenium
+    depends_on:
+      - hub
     network_mode: host
     environment:
       - SELENIUM_HUB_PORT
@@ -36,8 +38,6 @@ services:
       - GRID=false
       - CHROME=false
       - FIREFOX=true
-    depends_on:
-      - hub
 
 #-- Notes --#
 # shm_size: 1g

docker-compose.yml

@@ -4,7 +4,7 @@ services:
   hub:
     image: elgalu/selenium
     ports:
-      - 4444:${SELENIUM_HUB_PORT}
+      - ${SELENIUM_HUB_PORT}:${SELENIUM_HUB_PORT}
     environment:
       - SELENIUM_HUB_PORT
       - VNC_START=false
@@ -15,8 +15,6 @@ services:
 
   chrome:
     image: elgalu/selenium
-    depends_on:
-      - hub
     network_mode: "service:hub"
     shm_size: 1g
     environment:
@@ -29,8 +27,6 @@ services:
 
   firefox:
     image: elgalu/selenium
-    depends_on:
-      - hub
     network_mode: "service:hub"
     environment:
       - SELENIUM_HUB_PORT

docs/docker-compose.md

@@ -1,29 +1,42 @@
 # Compose
 Scale up and down the nodes by using [docker-compose](https://docs.docker.com/compose/).
-Install the tooling by following that link and make sure you have latest stable versions of both tools.
 
-## Requisites
-Docker and docker-compose:
+For using it by sharing the host (localhost) network interface see [share-host](./share-host.md)
 
-    docker --version         #=> 1.11.2
-    docker-compose --version #=> 1.7.1
+For requirements check [README#requisites](../README.md#requisites)
 
 ## Usage
-Either clone this repository or download the file [docker-compose.yml](../docker-compose.yml) using `wget`
+Either clone this repository or download the file [docker-compose.yml][] using `wget`
 
     wget -nv "https://raw.githubusercontent.com/elgalu/docker-selenium/master/docker-compose.yml"
+    docker-compose -p selenium down #ensure is not already running
 
 ### Run
-Either start with `docker-compose ... scale` as shown in below example or you can also use `docker-compose up` and scale after in a second command.
+Start it with `docker-compose up` then **scale** it:
 
-    SELENIUM_HUB_PORT=4444 docker-compose -p selenium up -d
-    docker-compose -p selenium scale chrome=3 firefox=3
+    export SELENIUM_HUB_PORT=4444 NODES=3
+    docker-compose -p selenium up -d
+    docker-compose -p selenium scale chrome=${NODES} firefox=${NODES}
 
 Wait until the grid starts properly before starting the tests _(Optional but recommended)_
 
-    docker-compose -p selenium exec -T --index=3 chrome wait_all_done 30s
+    docker exec selenium_hub_1 wait_all_done 30s
+    for ((i=1; i<=${NODES}; i++)); do
+      docker-compose -p selenium exec -T --index=$i chrome wait_all_done 30s
+      docker-compose -p selenium exec -T --index=$i firefox wait_all_done 30s
+    done
+
+### Test
+You can now run your tests by using the `--seleniumUrl="http://localhost:4444/wd/hub"`.
+
+However if your web application under test is running in localhost, e.g. `--appHost=localhost`
+you should instead either dockerize your application and add it to the [docker-compose.yml][] file as another [service](https://docs.docker.com/compose/compose-file/#/service-configuration-reference) or somehow replace `--appHost=localhost` with `--appHost=d.host.loc.dev` in the config file of your testing framework. The string `d.host.loc.dev` is a place holder inside the docker container that points to the IP of your localhost.
 
 ### Cleanup
-The `down` compose command stops and remove containers, networks, volumes, and images created by `up` or `scale`
+Once your tests are done you can clean up:
 
     docker-compose -p selenium down
+
+The `down` compose command stops and remove containers, networks, volumes, and images created by `up` or `scale`
+
+[docker-compose.yml]: ../docker-compose.yml

docs/jenkins.md

@@ -1,22 +1,2 @@
-# Compose
-Scale up and down the nodes by using [docker-compose](https://docs.docker.com/compose/).
-For requirements check [docker-compose#requisites](./docker-compose.md#requisites)
-
-## Usage
-Either clone this repository or download the file [docker-compose-host.yml](../docker-compose-host.yml) using `wget`
-
-    wget -nv -O docker-compose.yml "https://raw.githubusercontent.com/elgalu/docker-selenium/master/docker-compose-host.yml"
-
-### Run
-Either start with `docker-compose ... scale` as shown in below example or you can also use `docker-compose up` and scale after in a second command.
-
-    SELENIUM_HUB_PORT=4444 docker-compose -p selenium scale hub=1 chrome=3 firefox=3
-
-Wait until the grid starts properly before starting the tests _(Optional but recommended)_
-
-    docker-compose -p selenium exec -T --index=3 chrome wait_all_done 30s
-
-### Cleanup
-The `down` compose command stops and remove containers, networks, volumes, and images created by `up` or `scale`
-
-    docker-compose -p selenium down
+# Jenkins
+Follow the same procedure as explained in [docker-compose](./docker-compose.md)