Enabling video recording, time zone & screen resolution settings in dynamic grid (#1140)

* Creating assets path to use when copying logs or session caps

* Updating README

Author: diemol

Base/Dockerfile

@@ -68,15 +68,15 @@ COPY supervisord.conf /etc
 #==========
 # Selenium & relaxing permissions for OpenShift and other non-sudo environments
 #==========
-RUN  mkdir -p /opt/selenium /var/run/supervisor /var/log/supervisor \
+RUN  mkdir -p /opt/selenium /opt/selenium/assets /var/run/supervisor /var/log/supervisor \
   && touch /opt/selenium/config.toml \
-  && chmod -R 777 /opt/selenium /var/run/supervisor /var/log/supervisor /etc/passwd \
-  && wget --no-verbose https://github.com/SeleniumHQ/docker-selenium/raw/alpha-jars/selenium-server-4.0.0-alpha-7-4a3bb6d550.jar \
+  && chmod -R 777 /opt/selenium /opt/selenium/assets /var/run/supervisor /var/log/supervisor /etc/passwd \
+  && wget --no-verbose https://github.com/SeleniumHQ/docker-selenium/raw/alpha-jars/selenium-server-4.0.0-alpha-7-f89bec1f87.jar \
     -O /opt/selenium/selenium-server.jar \
 #  && wget --no-verbose https://selenium-release.storage.googleapis.com/4.0-alpha-6/selenium-server-4.0.0-alpha-6.jar \
 #    -O /opt/selenium/selenium-server.jar \
-  && chgrp -R 0 /opt/selenium ${HOME} /var/run/supervisor /var/log/supervisor \
-  && chmod -R g=u /opt/selenium ${HOME} /var/run/supervisor /var/log/supervisor
+  && chgrp -R 0 /opt/selenium ${HOME} /opt/selenium/assets /var/run/supervisor /var/log/supervisor \
+  && chmod -R g=u /opt/selenium ${HOME} /opt/selenium/assets /var/run/supervisor /var/log/supervisor
 
 #===================================================
 # Run the following commands as non-privileged user

README.md

@@ -8,7 +8,7 @@ and made the source code freely available under the [Apache License 2.0](LICENSE
 
 # :point_right: Status: Grid 4 is under development and on a [Alpha stage](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha)
 We are doing prereleases on a regular basis to get early feedback. This means that all other Selenium components
-can be currently at a different alpha version (e.g. bindings on Alpha 6, and these Docker images on prerelease Alpha 7).
+can be currently at a different alpha version (e.g. bindings on Alpha 7, and Docker images on prerelease Beta 1).
 
 Docker images for Grid 4 come with a handful of tags to simplify its usage, have a look at them in one of 
 our [prereleases](https://github.com/SeleniumHQ/docker-selenium/releases/tag/4.0.0-alpha-7-prerelease-20201009)
@@ -51,7 +51,7 @@ To inspect visually the browser activity, see the [Debugging](#debugging) sectio
 The shm size of 2gb is arbitrary but known to work well, your specific use case might need a different value, it is recommended
 to tune this value according to your needs. Along the examples `-v /dev/shm:/dev/shm` will be used, but both are known to work.
 
-:point_up: Always use a tag with an element suffix to pin a specific browser version.
+:point_up: Always use a Docker image with a full tag to pin a specific browser and Grid version.
 See [Tagging Conventions](https://github.com/SeleniumHQ/docker-selenium/wiki/Tagging-Convention) for details.
 
 ___
@@ -123,7 +123,6 @@ linked resources below, save them locally, and check the execution instructions
 To stop the Grid and cleanup the created containers, run `docker-compose down`.
 
 #### Version 3 with Swarm support 
-
 [`docker-compose-v3-swarm.yml`](docker-compose-v3-swarm.yml)
 
 ___
@@ -138,6 +137,48 @@ instructions on top of it.
 
 ___
 
+## Video recording ![BETA](https://img.shields.io/badge/beta!-blue?style=for-the-badge)
+
+It is possible to record your tests running in containers by using the `selenium/video:ffmpeg-4.3.1-20201009`
+Docker image. One container is needed per each container where a browser is running. This means if you are
+running 5 Nodes/Standalone containers, you will need 5 video containers, the mapping is 1-1.
+
+Currently, the only way to do this mapping is manually (either starting the containers manually, or through
+`docker-compose`). We are iterating on this process and probably this setup will be more simple in the future.
+
+The video Docker image we provide is based on the ffmpeg Ubuntu image provided by the 
+[jrottenberg/ffmpeg](https://github.com/jrottenberg/ffmpeg) project, thank you for providing this image and
+simplifying our work :tada:
+
+**Notes**:
+- If you have questions or feedback, please use the community contact points shown [here](https://www.selenium.dev/support/). 
+- Please report any bugs through GitHub [issues](https://github.com/SeleniumHQ/docker-selenium/issues/new/choose), and provide
+all the information requested on the template.
+- Video recording for headless browsers is not supported. 
+- Video recording tends to use considerable amounts of CPU. Normally you should estimate 1CPU per video container, 
+and 1 CPU per browser container.
+- Videos are stored in the `/videos` directory inside the video container. Map a local directory to get the videos.
+- If you are running more than one video container, be sure to overwrite the video file name through the `FILE_NAME`
+environment variable to avoid unexpected results.
+
+This example shows how to start the containers manually:
+
+``` bash
+$ docker network create grid
+$ docker run -d -p 4444:4444 -p 6900:5900 --net grid --name selenium -v /dev/shm:/dev/shm selenium/standalone-chrome:4.0.0-alpha-7-prerelease-20201009
+$ docker run -d --net grid --name video -v /tmp/videos:/videos selenium/video:ffmpeg-4.3.1-20201009
+# Run your tests
+$ docker stop video && docker rm video
+$ docker stop selenium && docker rm selenium
+```
+After the containers are stopped and removed, you should see a video file on your machine's `/tmp/videos` directory.
+
+Here is an example using a Hub and 3 Nodes (Chrome, Firefox, and Opera):
+
+[`docker-compose-v3-video.yml`](docker-compose-v3-video.yml)
+
+___
+
 ## Dynamic Grid ![BETA](https://img.shields.io/badge/beta!-blue?style=for-the-badge)
 
 Grid 4 has the ability to start Docker containers on demand, this means that it starts
@@ -167,6 +208,14 @@ configs = [
 # To have Docker listening through tcp on macOS, install socat and run the following command
 # socat -4 TCP-LISTEN:2375,fork UNIX-CONNECT:/var/run/docker.sock
 host = "tcp://host.docker.internal:2375"
+# Docker imagee used for video recording
+video-image = "selenium/video:ffmpeg-4.3.1-20201009"
+# Absolute path where test assets will be stored (this path must exist on the host)
+assets-path = "/assets/path/on/your/host/machine"
+# Absolute path where test assets will be stored inside the container
+# "/opt/selenium/assets" already exists inside the containers
+# If you want to use another one, be sure it exists.
+container-assets-path = "/opt/selenium/assets"
 ```
 
 ### Execution with Hub & Node roles
@@ -182,6 +231,7 @@ $ docker run -d --net grid -e SE_EVENT_BUS_HOST=selenium-hub \
     -e SE_EVENT_BUS_PUBLISH_PORT=4442 \
     -e SE_EVENT_BUS_SUBSCRIBE_PORT=4443 \
     -v ${PWD}/config.toml:/opt/bin/config.toml \
+    -v /path/on/your/host/machine:/opt/selenium/assets \
     selenium/node-docker:4.0.0-alpha-7-prerelease-20201009
 ```
 
@@ -197,51 +247,28 @@ $ docker network rm grid
 ```bash
 docker run --rm -ti --name selenium-docker -p 4444:4444 \
     -v ${PWD}/config.toml:/opt/bin/config.toml \
+    -v /path/on/your/host/machine:/opt/selenium/assets \
     selenium/standalone-docker:4.0.0-alpha-7-prerelease-20201009
 ```
 
-___
-
-## Video recording ![BETA](https://img.shields.io/badge/beta!-blue?style=for-the-badge)
-
-It is possible to record your tests running in containers by using the `selenium/video:ffmpeg-4.3.1-20201009`
-Docker image. One container is needed per each container where a browser is running. This means if you are
-running 5 Nodes/Standalone containers, you will need 5 video containers, the mapping is 1-1.
-
-Currently, the only way to do this mapping is manually (either starting the containers manually, or through
-`docker-compose`). We are iterating on this process and probably this setup will be more simple in the future.
-
-The video Docker image we provide is based on the ffmpeg Ubuntu image provided by the 
-[jrottenberg/ffmpeg](https://github.com/jrottenberg/ffmpeg) project, thank you for providing this image and
-simplifying our work :tada:
+### Video recording, screen resolution, and time zones in a Dynamic Grid
+To record your WebDriver session, you need to add a `se:options` section to
+your capabilities and inside it, configure the desired settings, for example:
 
-**Notes**:
-- If you have questions or feedback, please use the community contact points shown [here](https://www.selenium.dev/support/). 
-- Please report any bugs through GitHub [issues](https://github.com/SeleniumHQ/docker-selenium/issues/new/choose), and provide
-all the information requested on the template.
-- Video recording for headless browsers is not supported. 
-- Video recording tends to use considerable amounts of CPU. Normally you should estimate 1CPU per video container, 
-and 1 CPU per browser container.
-- Videos are stored in the `/videos` directory inside the video container. Map a local directory to get the videos.
-- If you are running more than one video container, be sure to overwrite the video file name through the `FILE_NAME`
-environment variable to avoid unexpected results.
-
-This example shows how to start the containers manually:
-
-``` bash
-$ docker network create grid
-$ docker run -d -p 4444:4444 -p 6900:5900 --net grid --name selenium -v /dev/shm:/dev/shm selenium/standalone-chrome:4.0.0-alpha-7-prerelease-20201009
-$ docker run -d --net grid --name video -v /tmp/videos:/videos selenium/video:ffmpeg-4.3.1-20201009
-# Run your tests
-$ docker stop video && docker rm video
-$ docker stop selenium && docker rm selenium
+```json
+{
+  "browserName": "firefox",
+  "platformName": "linux",
+  "se:options": {
+    "recordVideo": "true",
+    "timeZone": "US/Pacific",
+    "screenResolution": "1920x1080"
+  }
+}
 ```
-After the containers are stopped and removed, you should see a video file on your machine's `/tmp/videos` directory.
-
-Here is an example using a Hub and 3 Nodes (Chrome, Firefox, and Opera):
-
-[`docker-compose-v3-video.yml`](docker-compose-v3-video.yml)
 
+After running a test, check the path you mounted to the Docker container, 
+(`/path/on/your/host/machine`), and you should see videos and session information. 
 ___
 
 ## Deploying to Kubernetes