Makefile OSX fixes & discourage wmctrl

Author: elgalu

.env

@@ -27,7 +27,7 @@ export VNC_FROM_PORT ?= 40650
 export VNC_TO_PORT ?= 40700
 
 # Timeouts
-export WAIT_ALL_DONE ?= 40s
+export WAIT_ALL_DONE ?= 80s
 
 # Number of nodes
 export chrome ?= 1
@@ -50,6 +50,9 @@ export COMPOSE_PROJ_NAME ?= ${PROJ_NAME}
 # VNC viewer relative size, vncviewer -Scaling
 export SIZE ?= 40%
 
+# Enable video recording
+export VIDEO ?= true
+
 # App name is the service name for the web app under test
 export APP ?= mock
 export APP_NAME ?= ${APP}

CHANGELOG.md

@@ -7,6 +7,30 @@ Note image ids also change after scm-source.json has being updated which trigger
 ###### To get container versions
     docker exec grid versions
 
+## TBD_DOCKER_TAG
+ + Date: TBD_DATE
+ + Bugs: Makefile OSX fixes & discourage wmctrl
+ + Image tag details:
+  + Selenium: vTBD_SELENIUM_VERSION (TBD_SELENIUM_REVISION)
+  + Chrome stable:  TBD_CHROME_STABLE
+  + Firefox stable: TBD_FIREFOX_STABLE
+  + Chromedriver: TBD_CHROME_DRIVER (TBD_CHROMEDRIVER_COMMIT)
+  + Java: TBD_JAVA_VENDOR Java TBD_JAVA_BUILD
+  + Timezone: TBD_TIME_ZONE
+  + FROM ubuntu:UBUNTU_FLAVOR-UBUNTU_DATE
+  + Python: TBD_PYTHON_VERSION
+  + Sauce Connect TBD_SAUCE_CONNECT_VERS, build TBD_SAUCE_CONNECT_BUILD TBD_SAUCE_CONNECT_REVISION
+  + BrowserStack Local version TBD_BROWSER_STACK_VERSION
+  + Tested on kernel dev host: 4.4.0-31-generic x86_64
+  + Tested on kernel CI  host: TBD_HOST_UNAME
+  + Built at dev host with: Docker version 1.12.0-rc4, build e4a0dbc
+  + Built at CI  host with: Docker version TBD_DOCKER_VERS, build TBD_DOCKER_BUILD
+  + Built at dev host with: Docker Compose version 1.8.0-rc2, build c72c966
+  + Built at CI  host with: Docker Compose version TBD_DOCKER_COMPOSE_VERS, build TBD_DOCKER_COMPOSE_BUILD
+  + Image size: TBD_IMAGE_SIZE
+  + Digest: TBD_DIGEST
+  + Image ID: TBD_IMAGE_ID
+
 ## 2.53.1l
  + Date: 2016-07-17
  + OSX Makefile fixes

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/*.mkv
     travis lint #if you changed .travis.yml
-    git checkout -b tmp-2.53.1l #name your branch according to your changes
+    git checkout -b tmp-2.53.1m #name your branch according to your changes
     #git add ... git commit ... git push ... open pull request
 
 For repository owners only:
 
-    git commit -m "Easily gather video artifacts with `make videos`"
+    git commit -m "Makefile OSX fixes & discourage wmctrl"
     git tag -d latest #tag latest will be updated from TravisCI
-    git tag 2.53.1l && git push origin tmp-2.53.1l && git push --tags
+    git tag 2.53.1m && git push origin tmp-2.53.1m && 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.1l && git push origin --delete tmp-2.53.1l
+    git checkout master && git pull && git branch -d tmp-2.53.1m && git push origin --delete tmp-2.53.1m
 
 -- Re-add TBD_* section in CHANGELOG.md starting with TBD_DOCKER_TAG
 -- If Chrome version changed upload:
@@ -36,9 +36,9 @@ Keep certain bins if chrome version changed for example:
 ## Retry
 Failed in Travis? retry
 
-    git tag -d 2.53.1l && git push origin :2.53.1l
+    git tag -d 2.53.1m && git push origin :2.53.1m
     #git add ...
-    git commit --amend && git tag 2.53.1l && git push --force origin tmp-2.53.1l && git push --tags
+    git commit --amend && git tag 2.53.1m && git push --force origin tmp-2.53.1m && 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.

Makefile

@@ -128,6 +128,10 @@ warn_wmctrl:
 	fi
 
 check_wmctrl:
+	@if [ $(shell uname -s) = 'Darwin' ]; then \
+	  echo "Sorry: moving windows with wmctrl in OSX is not upported." 1>&2 ; \
+	  exit 11 ; \
+	fi
 	@if ! eval ${WMCTRL_CHECK_CMD}; then \
 	  ${ECHOERR} ${WMCTRL_CLIENT_ERROR_MSG} ; \
 	  exit 5; \
@@ -159,11 +163,27 @@ cleanup:
 	  --remove-orphans >./mk/compose_down.log 2>&1
 	@echo "Done!"
 
-# like cleanup but verbose
+# like cleanup but verbose plus graceful stop-video
 down:
+	@if [ "${VIDEO}" = "true" ]; then \
+	  $(MAKE) stop_videos_chrome ; \
+	  $(MAKE) stop_videos_firefox ; \
+	fi
 	docker-compose -f ${COMPOSE_FILE} -p ${COMPOSE_PROJ_NAME} down \
 	  --remove-orphans
 
+stop_videos:
+	@for node in $(shell seq --separator ' ' 1 ${tot_nodes}); do \
+	  docker exec "${proj}_${browser}_$$node" stop-video \
+	    >./mk/stop_video_${browser}_$$node.log || true ; \
+	done
+
+stop_videos_chrome:
+	@$(MAKE) stop_videos browser=chrome tot_nodes=${chrome}
+
+stop_videos_firefox:
+	@$(MAKE) stop_videos browser=firefox tot_nodes=${firefox}
+
 scale:
 	docker-compose -f ${COMPOSE_FILE} -p ${COMPOSE_PROJ_NAME} scale \
 	  ${APP_NAME}=1 hub=1 chrome=${chrome} firefox=${firefox}
@@ -251,5 +271,8 @@ test:
 	gather_videos \
 	gather_videos_chrome \
 	gather_videos_firefox \
+	stop_videos \
+	stop_videos_chrome \
+	stop_videos_firefox \
 	env \
 	test

README.md

@@ -102,7 +102,7 @@ This image is designed to run one test on each docker container but if you still
 
 1. The recommended way is via [docker-compose](./docs/docker-compose.md) and you should replace `mock` with your web service under test within the [docker-compose.yml][] file.
 
-        export SELENIUM_HUB_PORT=4444 VNC_FROM_PORT=40650 VNC_TO_PORT=40700
+        export SELENIUM_HUB_PORT=4444 VNC_FROM_PORT=40650 VNC_TO_PORT=40700 VIDEO=false
         docker-compose -p grid scale mock=1 hub=1 chrome=3 firefox=3
 
 1. The _(not recommended)_ way is by increasing `MAX_INSTANCES` and `MAX_SESSIONS` which now [defaults](https://github.com/elgalu/docker-selenium/blob/2.53.1a/Dockerfile#L967) to 1.

bin/entry.sh

@@ -13,8 +13,6 @@ echo "-- INFO: Available Firefox Versions: ${FIREFOX_VERSION}"
 # Fix/extend ENV vars
 #---------------------
 # export PATH="${PATH}:${BIN_UTILS}"
-export VIDEO_LOG_FILE="${LOGS_DIR}/video-rec-stdout.log"
-export VIDEO_PIDFILE="${RUN_DIR}/video.pid"
 export SAUCE_LOG_FILE="${LOGS_DIR}/saucelabs-stdout.log"
 export BSTACK_LOG_FILE="${LOGS_DIR}/browserstack-stdout.log"
 export SUPERVISOR_PIDFILE="${RUN_DIR}/supervisord.pid"
@@ -44,11 +42,12 @@ fi
 
 #----------------------------------------------------------
 # Extend required services depending on what the user needs
-if [ "${VIDEO}" = "true" ]; then
-  export SUPERVISOR_REQUIRED_SRV_LIST="${SUPERVISOR_REQUIRED_SRV_LIST}|video-rec"
-else
-  export SUPERVISOR_NOT_REQUIRED_SRV_LIST1="video-rec"
-fi
+export SUPERVISOR_NOT_REQUIRED_SRV_LIST1="video-rec"
+# if [ "${VIDEO}" = "true" ]; then
+#   export SUPERVISOR_REQUIRED_SRV_LIST="${SUPERVISOR_REQUIRED_SRV_LIST}|video-rec"
+# else
+#   export SUPERVISOR_NOT_REQUIRED_SRV_LIST1="video-rec"
+# fi
 
 sudo sh -c "echo 'X11Forwarding ${SSHD_X11FORWARDING}' >> /etc/ssh/sshd_config"
 sudo sh -c "echo 'GatewayPorts ${SSHD_GATEWAYPORTS}'   >> /etc/ssh/sshd_config"
@@ -118,13 +117,18 @@ elif [ "${PICK_ALL_RANDMON_PORTS}" = "true" ]; then
 fi
 
 # Video
+export VIDEO_LOG_FILE="${LOGS_DIR}/video-rec-stdout.log"
+export VIDEO_PIDFILE="${RUN_DIR}/video.pid"
 if [ "${VIDEO_FILE_NAME}" = "" ]; then
   export VIDEO_FILE_NAME="vid"
   [ "${CHROME}" = "true" ] && export VIDEO_FILE_NAME="${VIDEO_FILE_NAME}_chrome_${SELENIUM_NODE_CH_PORT}"
   [ "${FIREFOX}" = "true" ] && export VIDEO_FILE_NAME="${VIDEO_FILE_NAME}_firefox_${SELENIUM_NODE_FF_PORT}"
 fi
 export VIDEO_PATH="${VIDEOS_DIR}/${VIDEO_FILE_NAME}.${VIDEO_FILE_EXTENSION}"
-
+echo "${VIDEO_LOG_FILE}" > VIDEO_LOG_FILE
+echo "${VIDEO_PIDFILE}" > VIDEO_PIDFILE
+echo "${VIDEO_FILE_NAME}" > VIDEO_FILE_NAME
+echo "${VIDEO_PATH}" > VIDEO_PATH
 
 if [ "${VNC_START}" = "true" ]; then
   # TODO: Re enable shutdown at some point. But fails when

docker-compose.yml

@@ -27,7 +27,7 @@ services:
       - VNC_FROM_PORT
       - VNC_TO_PORT
       - PICK_ALL_RANDMON_PORTS=true
-      - VIDEO=true
+      - VIDEO
       - GRID=false
       - CHROME=true
       - FIREFOX=false
@@ -40,7 +40,7 @@ services:
       - VNC_FROM_PORT
       - VNC_TO_PORT
       - PICK_ALL_RANDMON_PORTS=true
-      - VIDEO=true
+      - VIDEO
       - GRID=false
       - CHROME=false
       - FIREFOX=true

docs/docker-compose.md

@@ -15,7 +15,7 @@ Either clone this repository or download the file [docker-compose.yml][] using `
 Start it with `docker-compose up` then **scale** it:
 You should replace `mock` with your web service under test within the [docker-compose.yml][] file.
 
-    export SELENIUM_HUB_PORT=4444 NODES=3 VNC_FROM_PORT=40650 VNC_TO_PORT=40700
+    export SELENIUM_HUB_PORT=4444 NODES=3 VNC_FROM_PORT=40650 VNC_TO_PORT=40700 VIDEO=false
     docker-compose -p grid up -d
     docker-compose -p grid scale chrome=${NODES} firefox=${NODES}
 

docs/make.md

@@ -10,9 +10,10 @@ If you want VNC helpers support _(optional)_
 
     make install_vnc
 
-If you also want windows manager support, i.e. want to `make move` _(optional but not recommended in OSX)_
+### OSX
+In OSX is convenient to increase the Docker service CPUs and Memory specially if you plan to run more than one Chrome and Firefox at the same time:
 
-    make install_wmctrl
+<img id="cpu" width="260" src="../images/Docker_Mac_CPUs_Memory.png" />
 
 ## Usage
 Make sure to [setup](#setup) first.