feat: add docker-compose video upload

Signed-off-by: Viet Nguyen Duc <[email protected]>

Author: VietND96

.github/workflows/helm-chart-test.yml

@@ -52,7 +52,11 @@ jobs:
           echo "BUILD_DATE=$(date '+%Y%m%d')" >> $GITHUB_ENV
           echo "IMAGE_REGISTRY=artifactory/selenium" >> $GITHUB_ENV
       - name: Setup Kubernetes environment
-        run: make chart_setup_env
+        uses: nick-invision/retry@master
+        with:
+          timeout_minutes: 10
+          max_attempts: 3
+          command: make chart_setup_env
       - name: Build Helm charts
         run: |
           BUILD_DATE=${BUILD_DATE} make chart_build

Makefile

@@ -19,8 +19,6 @@ MAJOR_MINOR_PATCH := $(word 1,$(subst -, ,$(TAG_VERSION)))
 FFMPEG_TAG_VERSION := $(or $(FFMPEG_TAG_VERSION),$(FFMPEG_TAG_VERSION),ffmpeg-6.1)
 FFMPEG_BASED_NAME := $(or $(FFMPEG_BASED_NAME),$(FFMPEG_BASED_NAME),ndviet)
 FFMPEG_BASED_TAG := $(or $(FFMPEG_BASED_TAG),$(FFMPEG_BASED_TAG),6.1-ubuntu2204)
-RCLONE_BASED_TAG := $(or $(RCLONE_BASED_TAG),$(RCLONE_BASED_TAG),1.65)
-RCLONE_TAG_VERSION := $(or $(RCLONE_TAG_VERSION),$(RCLONE_TAG_VERSION),rclone-1.65)
 
 all: hub \
 	distributor \
@@ -434,29 +432,29 @@ chart_test_template:
 	./tests/charts/bootstrap.sh
 
 chart_test_chrome:
-	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) UPLOADER_TAG=$(RCLONE_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
+	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
 	./tests/charts/make/chart_test.sh NodeChrome
 
 chart_test_firefox:
-	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) UPLOADER_TAG=$(RCLONE_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
+	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
 	./tests/charts/make/chart_test.sh NodeFirefox
 
 chart_test_edge:
-	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) UPLOADER_TAG=$(RCLONE_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
+	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
 	./tests/charts/make/chart_test.sh NodeEdge
 
 chart_test_autoscaling_deployment_https:
 	SELENIUM_GRID_TEST_HEADLESS=true SELENIUM_GRID_PROTOCOL=https SELENIUM_GRID_PORT=443 make chart_test_autoscaling_deployment
 
 chart_test_autoscaling_deployment:
-	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) UPLOADER_TAG=$(RCLONE_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
+	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
 	./tests/charts/make/chart_test.sh DeploymentAutoscaling
 
 chart_test_autoscaling_job_https:
 	SELENIUM_GRID_TEST_HEADLESS=true SELENIUM_GRID_PROTOCOL=https SELENIUM_GRID_PORT=443 make chart_test_autoscaling_job
 
 chart_test_autoscaling_job:
-	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) UPLOADER_TAG=$(RCLONE_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
+	VERSION=$(TAG_VERSION) VIDEO_TAG=$(FFMPEG_TAG_VERSION)-$(BUILD_DATE) NAMESPACE=$(NAMESPACE) \
 	./tests/charts/make/chart_test.sh JobAutoscaling
 
 .PHONY: \

README.md

@@ -21,45 +21,59 @@ Talk to us at https://www.selenium.dev/support/
 
 ## Contents
 
+<!-- TOC -->
+* [Community](#community)
+* [Contents](#contents)
 * [Quick start](#quick-start)
+  * [Try them out in a ready-to-use GitPod environment!](#try-them-out-in-a-ready-to-use-gitpod-environment)
 * [Experimental Mult-Arch aarch64/armhf/amd64 Images](#experimental-mult-arch-aarch64armhfamd64-images)
 * [Nightly Images](#nightly-images)
 * [Dev and Beta Channel Browser Images](#dev-and-beta-channel-browser-images)
-  + [Dev and Beta Standalone Mode](#dev-and-beta-standalone-mode)
-  + [Dev and Beta on the Grid](#dev-and-beta-on-the-grid)
+  * [Dev and Beta Standalone Mode](#dev-and-beta-standalone-mode)
+  * [Dev and Beta on the Grid](#dev-and-beta-on-the-grid)
 * [Execution modes](#execution-modes)
-  + [Standalone](#standalone)
-  + [Hub and Nodes](#hub-and-nodes)
-    - [Docker networking](#docker-networking)
-    - [Using different machines/VMs](#using-different-machinesvms)
-    - [Docker Compose](#docker-compose)
-  + [Fully distributed mode - Router, Queue, Distributor, EventBus, SessionMap and Nodes](#fully-distributed-mode---router-queue-distributor-eventbus-sessionmap-and-nodes)
+  * [Standalone](#standalone)
+  * [Hub and Nodes](#hub-and-nodes)
+  * [Fully distributed mode - Router, Queue, Distributor, EventBus, SessionMap and Nodes](#fully-distributed-mode---router-queue-distributor-eventbus-sessionmap-and-nodes)
 * [Video recording](#video-recording)
+* [Video recording and uploading](#video-recording-and-uploading)
 * [Dynamic Grid](#dynamic-grid)
-  + [Configuration example](#configuration-example)
-  + [Execution with Hub & Node roles](#execution-with-hub--node-roles)
-  + [Execution with Standalone roles](#execution-with-standalone-roles)
-  + [Using Dynamic Grid in different machines/VMs](#using-dynamic-grid-in-different-machinesvms)
-  + [Execution with Docker Compose](#execution-with-docker-compose)
-  + [Video recording, screen resolution, and time zones in a Dynamic Grid](#video-recording-screen-resolution-and-time-zones-in-a-dynamic-grid)
-* [Kubernetes](#deploying-to-kubernetes)
+  * [Configuration example](#configuration-example)
+  * [Execution with Hub & Node roles](#execution-with-hub--node-roles)
+  * [Execution with Standalone roles](#execution-with-standalone-roles)
+  * [Using Dynamic Grid in different machines/VMs](#using-dynamic-grid-in-different-machinesvms)
+  * [Execution with Docker Compose](#execution-with-docker-compose)
+  * [Configuring the child containers](#configuring-the-child-containers)
+  * [Video recording, screen resolution, and time zones in a Dynamic Grid](#video-recording-screen-resolution-and-time-zones-in-a-dynamic-grid)
+* [Deploying to Kubernetes](#deploying-to-kubernetes)
 * [Configuring the containers](#configuring-the-containers)
-  + [SE_OPTS Selenium Configuration Options](#se_opts-selenium-configuration-options)
-  + [SE_JAVA_OPTS Java Environment Options](#se_java_opts-java-environment-options)
-  + [Node configuration options](#node-configuration-options)
-  + [Setting Sub Path](#setting-sub-path)
-  + [Setting Screen Resolution](#setting-screen-resolution)
-  + [Grid Url and Session Timeout](#grid-url-and-session-timeout)
-  + [Session request timeout](#session-request-timeout)
-  + [Increasing session concurrency per container](#increasing-session-concurrency-per-container)
-  + [Running in Headless mode](#running-in-headless-mode)
+  * [SE_OPTS Selenium Configuration Options](#se_opts-selenium-configuration-options)
+  * [SE_JAVA_OPTS Java Environment Options](#se_java_opts-java-environment-options)
+  * [Node configuration options](#node-configuration-options)
+  * [Setting Sub Path](#setting-sub-path)
+  * [Setting Screen Resolution](#setting-screen-resolution)
+  * [Grid Url and Session Timeout](#grid-url-and-session-timeout)
+  * [Session request timeout](#session-request-timeout)
+  * [Increasing session concurrency per container](#increasing-session-concurrency-per-container)
+  * [Running in Headless mode](#running-in-headless-mode)
+  * [Stopping the Node/Standalone after N sessions have been executed](#stopping-the-nodestandalone-after-n-sessions-have-been-executed)
 * [Building the images](#building-the-images)
 * [Waiting for the Grid to be ready](#waiting-for-the-grid-to-be-ready)
+  * [Adding a HEALTHCHECK to the Grid](#adding-a-healthcheck-to-the-grid)
+  * [Using a bash script to wait for the Grid](#using-a-bash-script-to-wait-for-the-grid)
+* [Install certificates for Chromium-based browsers](#install-certificates-for-chromium-based-browsers)
+* [Alternative method: Add certificates to existing Selenium based images for browsers](#alternative-method-add-certificates-to-existing-selenium-based-images-for-browsers)
 * [Debugging](#debugging)
-* [Install certificates for Chromium based browsers](#install-certificates-for-Chromium-based-browsers)
+  * [Using a VNC client](#using-a-vnc-client)
+  * [Using your browser (no VNC client is needed)](#using-your-browser-no-vnc-client-is-needed)
+  * [Disabling VNC](#disabling-vnc)
 * [Tracing in Grid](#tracing-in-grid)
 * [Troubleshooting](#troubleshooting)
-
+  * [`--shm-size="2g"`](#--shm-size2g)
+  * [Headless](#headless)
+  * [Mounting volumes to retrieve downloaded files](#mounting-volumes-to-retrieve-downloaded-files)
+  * [Mounting volumes to retrieve video files](#mounting-volumes-to-retrieve-video-files)
+<!-- TOC -->
 
 ## Quick start
 
@@ -521,6 +535,47 @@ Here is an example using a Hub and a few Nodes:
 
 [`docker-compose-v3-video.yml`](docker-compose-v3-video.yml)
 
+## Video recording and uploading
+
+[RCLONE](https://rclone.org/) is installed in the video recorder image. You can use it to upload the videos to a cloud storage service.
+Besides the video recording mentioned above, you can enable the upload functionality by setting the following environment variables:
+
+```yaml
+version: "3"
+services:
+  chrome_video:
+    image: selenium/video:nightly
+    depends_on:
+      - chrome
+    environment:
+      - DISPLAY_CONTAINER_NAME=chrome
+      - SE_VIDEO_FILE_NAME=auto
+      - SE_VIDEO_UPLOAD_ENABLED=true
+      - SE_VIDEO_INTERNAL_UPLOAD=true
+      - SE_UPLOAD_DESTINATION_PREFIX=s3://mybucket/path
+      - RCLONE_CONFIG_S3_TYPE=s3
+      - RCLONE_CONFIG_S3_PROVIDER=GCS
+      - RCLONE_CONFIG_S3_ENV_AUTH=true
+      - RCLONE_CONFIG_S3_REGION=asia-southeast1
+      - RCLONE_CONFIG_S3_LOCATION_CONSTRAINT=asia-southeast1
+      - RCLONE_CONFIG_S3_ACL=private
+      - RCLONE_CONFIG_S3_ACCESS_KEY_ID=xxx
+      - RCLONE_CONFIG_S3_SECRET_ACCESS_KEY=xxx
+      - RCLONE_CONFIG_S3_ENDPOINT=https://storage.googleapis.com
+```
+
+`SE_VIDEO_FILE_NAME=auto` will use the session id as the video file name. This ensures that the video file name is unique to upload.
+
+`SE_VIDEO_UPLOAD_ENABLED=true` will enable the video upload feature. In the background, it will create a pipefile with file and destination for uploader to consume and proceed.
+
+`SE_VIDEO_INTERNAL_UPLOAD=true` will use RCLONE installed in the container for upload. If you want to use another container for upload, set it to `false`.
+
+For environment variables with prefix `RCLONE_` is used to pass remote configuration to RCLONE. You can find more information about RCLONE configuration [here](https://rclone.org/docs/).
+
+[`docker-compose-v3-video-upload.yml`](docker-compose-v3-video-upload.yml)
+
+Note that upload function is not supported for Dynamic Grid. If you want it, please create a feature request.
+
 ___
 
 ## Dynamic Grid
@@ -1336,4 +1391,11 @@ After doing this, you should be able to download files
 to the mounted directory. If you have a better workaround,
 please send us a pull request!
 
+### Mounting volumes to retrieve video files
+
+Similar to mount volumes to retrieve downloaded files. For video files, you might need to do the same
 
+```bash
+mkdir /tmp/videos
+chown 1200:1201 /tmp/videos
+```

Video/Dockerfile

@@ -85,6 +85,7 @@ COPY --chown="${SEL_UID}:${SEL_GID}" upload.sh upload.conf /opt/bin/
 ENV SE_VIDEO_UPLOAD_ENABLED false
 ENV SE_UPLOAD_DESTINATION_PREFIX ""
 ENV SE_VIDEO_INTERNAL_UPLOAD false
+ENV UPLOAD_OPTS "-P"
 
 ENV SE_VIDEO_FOLDER /videos
 RUN  mkdir -p /var/run/supervisor /var/log/supervisor $SE_VIDEO_FOLDER \

Video/upload.sh

@@ -6,38 +6,51 @@ UPLOAD_CONFIG_FILE_NAME=${UPLOAD_CONFIG_FILE_NAME:-"upload.conf"}
 UPLOAD_COMMAND=${UPLOAD_COMMAND:-"copy"}
 UPLOAD_RETAIN_LOCAL_FILE=${SE_UPLOAD_RETAIN_LOCAL_FILE:-"false"}
 UPLOAD_PIPE_FILE_NAME=${UPLOAD_PIPE_FILE_NAME:-"uploadpipe"}
-SE_VIDEO_INTERNAL_UPLOAD=${SE_VIDEO_INTERNAL_UPLOAD:-"true"}
+SE_VIDEO_INTERNAL_UPLOAD=${SE_VIDEO_INTERNAL_UPLOAD:-"false"}
 VIDEO_UPLOAD_ENABLED=${VIDEO_UPLOAD_ENABLED:-SE_VIDEO_UPLOAD_ENABLED}
+SE_VIDEO_UPLOAD_BATCH_CHECK=${SE_VIDEO_UPLOAD_BATCH_CHECK:-"10"}
 
-function consume_force_exit() {
-    rm -f ${FORCE_EXIT_FILE}
-    echo "Force exit signal consumed"
-}
+if [ "${SE_VIDEO_INTERNAL_UPLOAD}" = "true" ];
+then
+    # If using RCLONE in the same container, write signal to /tmp internally
+    UPLOAD_PIPE_FILE="/tmp/${UPLOAD_PIPE_FILE_NAME}"
+    FORCE_EXIT_FILE="/tmp/force_exit"
+else
+    # If using external container for uploading, write signal to the video folder
+    UPLOAD_PIPE_FILE="${SE_VIDEO_FOLDER}/${UPLOAD_PIPE_FILE_NAME}"
+    FORCE_EXIT_FILE="${SE_VIDEO_FOLDER}/force_exit"
+fi
+
+if [ "${UPLOAD_RETAIN_LOCAL_FILE}" = "false" ];
+then
+  echo "UPLOAD_RETAIN_LOCAL_FILE is set to false, force to use RCLONE command: move"
+  UPLOAD_COMMAND="move"
+fi
 
 function rename_rclone_env() {
   # This script is used to support passing environment variables for RCLONE configuration in Dynamic Grid
   # Dynamic Grid accepts environment variables with the prefix SE_*
   # RCLONE accepts environment variables with the prefix RCLONE_*
   # To pass the ENV vars to Dynamic Grid then to RCLONE, we need to rename the ENV vars from SE_RCLONE_* to RCLONE_*
   for var in $(env | cut -d= -f1); do
-      if [[ "$var" == SE_RCLONE_* ]]; then
+      if [[ "$var" == SE_RCLONE_* ]];
+      then
           suffix="${var#SE_RCLONE_}"
           new_var="RCLONE_$suffix"
           export "$new_var=${!var}"
       fi
   done
 }
 
-if [ "${SE_VIDEO_INTERNAL_UPLOAD}" = "true" ];
-then
-    UPLOAD_PIPE_FILE="/tmp/${UPLOAD_PIPE_FILE_NAME}"
-    FORCE_EXIT_FILE="/tmp/force_exit"
-else
-    UPLOAD_PIPE_FILE="${SE_VIDEO_FOLDER}/${UPLOAD_PIPE_FILE_NAME}"
-    FORCE_EXIT_FILE="${SE_VIDEO_FOLDER}/force_exit"
-fi
-
-trap consume_force_exit EXIT
+function graceful_exit() {
+    for pid in "${list_rclone_pid[@]}";
+    do
+        wait ${pid}
+    done
+    rm -rf ${FORCE_EXIT_FILE}
+    echo "Uploader is ready to shutdown"
+}
+trap graceful_exit EXIT
 
 while [ ! -p ${UPLOAD_PIPE_FILE} ];
 do
@@ -49,23 +62,28 @@ echo "Waiting for video files put into pipe for proceeding to upload"
 
 rename_rclone_env
 
+list_rclone_pid=()
 while read FILE DESTINATION < ${UPLOAD_PIPE_FILE}
 do
     if [ "${FILE}" = "exit" ];
     then
         exit
-    else [ "$FILE" != "" ] && [ "$DESTINATION" != "" ];
+    elif [ "$FILE" != "" ] && [ "$DESTINATION" != "" ];
+    then
         echo "Uploading ${FILE} to ${DESTINATION}"
-        rclone --config ${UPLOAD_CONFIG_DIRECTORY}/${UPLOAD_CONFIG_FILE_NAME} ${UPLOAD_COMMAND} ${UPLOAD_OPTS} "${FILE}" "${DESTINATION}"
-        if [ $? -eq 0 ] && [ "${UPLOAD_RETAIN_LOCAL_FILE}" = "false" ];
+        rclone --config ${UPLOAD_CONFIG_DIRECTORY}/${UPLOAD_CONFIG_FILE_NAME} ${UPLOAD_COMMAND} ${UPLOAD_OPTS} "${FILE}" "${DESTINATION}" &
+        list_rclone_pid+=($!)
+    else
+        # Wait for a batch rclone processes to finish
+        if [ ${#list_rclone_pid[@]} -eq ${SE_VIDEO_UPLOAD_BATCH_CHECK} ]
         then
-          rm -rf $FILE
+            for pid in "${list_rclone_pid[@]}";
+            do
+                wait ${pid}
+            done
+            list_rclone_pid=()
         fi
     fi
-    if [ -f ${FORCE_EXIT_FILE} ] && [ ! -s ${UPLOAD_PIPE_FILE} ];
-    then
-        exit
-    fi
 done
 
-consume_force_exit
+graceful_exit