[feat][test]: add env vars to generate config for Relay in node-base (#2254)

Author: VietND96

.github/workflows/build-test.yml

@@ -53,7 +53,7 @@ jobs:
       - name: Set Selenium base version
         if: contains(toJson(github.event.commits), '[deploy]') == false
         run: |
-          make set_nightly_env
+          make set_build_nightly
           cat .env | xargs -I {} echo {} >> $GITHUB_ENV
       - name: Sets build date
         run: |

.github/workflows/test-video.yml renamed to .github/workflows/docker-test.yml

@@ -23,8 +23,6 @@ on:
   pull_request:
     paths-ignore:
       - '**.md'
-  schedule:
-    - cron: '0 0 * * *'
 
 permissions:
   contents: read
@@ -45,6 +43,8 @@ jobs:
             test-video: true
           - test-strategy: test_parallel
             test-video: false
+          - test-strategy: test_node_relay
+            test-video: false
     steps:
       - uses: actions/checkout@main
       - name: Set up QEMU
@@ -61,6 +61,12 @@ jobs:
         with:
           python-version: '3.11'
           check-latest: true
+      - name: Enable KVM
+        if: matrix.test-strategy == 'test_node_relay'
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
       - name: Get branch name (only for push to branch)
         if: github.event_name == 'push'
         run: echo "BRANCH=$(echo ${PUSH_BRANCH##*/})" >> $GITHUB_ENV
@@ -76,7 +82,7 @@ jobs:
       - name: Set Selenium base version
         if: contains(toJson(github.event.commits), '[deploy]') == false
         run: |
-          make set_nightly_env
+          make set_build_nightly
           cat .env | xargs -I {} echo {} >> $GITHUB_ENV
       - name: Sets build date
         run: |

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

@@ -23,8 +23,6 @@ on:
         description: 'Test parameter for different log level'
         required: false
         default: 'FINE'
-  schedule:
-    - cron: '0 0 * * *'
 
 permissions:
   contents: read
@@ -111,7 +109,7 @@ jobs:
       - name: Set Selenium base version
         if: contains(toJson(github.event.commits), '[deploy]') == false
         run: |
-          make set_nightly_env
+          make set_build_nightly
           cat .env | xargs -I {} echo {} >> $GITHUB_ENV
       - name: Sets build date
         run: |

.github/workflows/nightly.yaml

@@ -5,7 +5,16 @@ on:
     - cron: '0 1 * * *'
 
 jobs:
+  docker-test:
+    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+    uses: ./.github/workflows/docker-test.yml
+
+  helm-chart-test:
+    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+    uses: ./.github/workflows/helm-chart-test.yml
+
   deploy:
+    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
     name: Nightly build
     runs-on: ubuntu-latest
     permissions: write-all

Makefile

@@ -38,9 +38,10 @@ all: hub \
 	standalone_docker \
 	video
 
-set_nightly_env:
+set_build_nightly:
 	echo BASE_VERSION=$(BASE_VERSION_NIGHTLY) > .env ; \
 	echo BASE_RELEASE=$(BASE_RELEASE_NIGHTLY) >> .env ;
+	echo "Execute 'source .env' to set the environment variables"
 
 docker_buildx_setup:
 	sudo apt-get install --upgrade docker-buildx-plugin
@@ -484,6 +485,27 @@ test_video: video hub chrome firefox edge
 	done
 	make test_video_integrity
 
+test_node_relay: hub node_base standalone_firefox
+	sudo rm -rf ./tests/tests
+	for node in Android NodeFirefox ; do \
+			cd ./tests || true ; \
+			echo TAG=$(TAG_VERSION) > .env ; \
+			echo LOG_LEVEL=$(or $(LOG_LEVEL), "INFO") >> .env ; \
+			echo REQUEST_TIMEOUT=$(or $(REQUEST_TIMEOUT), 300) >> .env ; \
+			echo SESSION_TIMEOUT=$(or $(SESSION_TIMEOUT), 300) >> .env ; \
+			echo ANDROID_BASED_NAME=$(or $(ANDROID_BASED_NAME),budtmo) >> .env ; \
+			echo ANDROID_BASED_IMAGE=$(or $(ANDROID_BASED_IMAGE),docker-android) >> .env ; \
+			echo ANDROID_BASED_TAG=$(or $(ANDROID_BASED_TAG),emulator_14.0) >> .env ; \
+			echo ANDROID_PLATFORM_API=$(or $(ANDROID_PLATFORM_API),14) >> .env ; \
+			echo TEST_DELAY_AFTER_TEST=$(or $(TEST_DELAY_AFTER_TEST), 15) >> .env ; \
+			echo NODE=$$node >> .env ; \
+			echo TEST_NODE_RELAY=$$node >> .env ; \
+			echo UID=$$(id -u) >> .env ; \
+			echo BINDING_VERSION=$(BINDING_VERSION) >> .env ; \
+			docker compose -f docker-compose-v3-test-node-relay.yml up --no-log-prefix --exit-code-from tests --build ; \
+			if [ $$? -ne 0 ]; then exit 1; fi ; \
+	done
+
 test_node_docker: hub standalone_docker standalone_chrome standalone_firefox standalone_edge video
 	sudo rm -rf ./tests/tests
 	sudo rm -rf ./tests/videos; mkdir -p ./tests/videos/Downloads

NodeBase/Dockerfile

@@ -143,7 +143,7 @@ COPY --chown="${SEL_UID}:${SEL_GID}" start-selenium-node.sh \
       start-xvfb.sh \
       start-vnc.sh \
       start-novnc.sh \
-      generate_config /opt/bin/
+      generate_config generate_relay_config /opt/bin/
 
 # Selenium Grid logo as wallpaper for Fluxbox
 COPY selenium_grid_logo.png /usr/share/images/fluxbox/ubuntu-light.png

NodeBase/generate_config

@@ -48,24 +48,34 @@ echo "session-timeout = \"${SE_NODE_SESSION_TIMEOUT}\"" >> "$FILENAME"
 echo "override-max-sessions = ${SE_NODE_OVERRIDE_MAX_SESSIONS}" >> "$FILENAME"
 echo "detect-drivers = false" >> "$FILENAME"
 echo "drain-after-session-count = ${DRAIN_AFTER_SESSION_COUNT:-$SE_DRAIN_AFTER_SESSION_COUNT}" >> "$FILENAME"
-echo "max-sessions = ${SE_NODE_MAX_SESSIONS}
+# When node is handled both browser and relay, SE_NODE_MAX_CONCURRENCY is used to configure max concurrency based on sum of them
+echo "max-sessions = ${SE_NODE_MAX_CONCURRENCY:-${SE_NODE_MAX_SESSIONS}}
 " >> "$FILENAME"
 
-SE_NODE_BROWSER_NAME=$(cat /opt/selenium/browser_name)
-SE_NODE_BROWSER_VERSION=$(short_version $(cat /opt/selenium/browser_version))
-SE__BROWSER_BINARY_LOCATION=$(cat /opt/selenium/browser_binary_location)
+if [ -f /opt/selenium/browser_name ]; then
+  SE_NODE_BROWSER_NAME=$(cat /opt/selenium/browser_name)
+fi
+if [ -f /opt/selenium/browser_version ]; then
+  SE_NODE_BROWSER_VERSION=$(short_version $(cat /opt/selenium/browser_version))
+fi
+if [ -f /opt/selenium/browser_binary_location ]; then
+  SE__BROWSER_BINARY_LOCATION=$(cat /opt/selenium/browser_binary_location)
+fi
 
-if [[ -z "$SE_NODE_STEREOTYPE" ]]; then
+# 'browserName' is mandatory for default stereotype
+if [[ -z "${SE_NODE_STEREOTYPE}" ]] && [[ -n "${SE_NODE_BROWSER_NAME}" ]]; then
 SE_NODE_STEREOTYPE="{\"browserName\": \"${SE_NODE_BROWSER_NAME}\", \"browserVersion\": \"${SE_NODE_BROWSER_VERSION}\", \"platformName\": \"Linux\", ${SE__BROWSER_BINARY_LOCATION}}"
 else
-SE_NODE_STEREOTYPE="$SE_NODE_STEREOTYPE"
+SE_NODE_STEREOTYPE="${SE_NODE_STEREOTYPE}"
 fi
 
-echo "[[node.driver-configuration]]" >> "$FILENAME"
-echo "display-name = \"${SE_NODE_BROWSER_NAME}\"" >> "$FILENAME"
-echo "stereotype = '${SE_NODE_STEREOTYPE}'" >> "$FILENAME"
-echo "max-sessions = ${SE_NODE_MAX_SESSIONS}
-" >> "$FILENAME"
-
+# 'stereotype' setting is mandatory
+if [[ -n "${SE_NODE_STEREOTYPE}" ]]; then
+    echo "[[node.driver-configuration]]" >> "$FILENAME"
+    echo "display-name = \"${SE_NODE_BROWSER_NAME}\"" >> "$FILENAME"
+    echo "stereotype = '${SE_NODE_STEREOTYPE}'" >> "$FILENAME"
+    echo "max-sessions = ${SE_NODE_MAX_SESSIONS}
+    " >> "$FILENAME"
+fi
 
 

NodeBase/generate_relay_config

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+if [[ -z "$CONFIG_FILE" ]]; then
+FILENAME="/opt/selenium/config.toml"
+else
+FILENAME="$CONFIG_FILE"
+fi
+
+if [[ -n "${SE_NODE_RELAY_URL}" ]]; then
+  echo "[relay]" >> "$FILENAME"
+  echo "url = \"${SE_NODE_RELAY_URL}\"" >> "$FILENAME"
+  if [[ -z "${SE_NODE_RELAY_STATUS_ENDPOINT}" ]]; then
+    echo "status-endpoint = \"/status\"" >> "$FILENAME"
+  else
+    echo "status-endpoint = \"${SE_NODE_RELAY_STATUS_ENDPOINT}\"" >> "$FILENAME"
+  fi
+  if [[ -n "${SE_NODE_RELAY_PROTOCOL_VERSION}" ]]; then
+    echo "protocol-version = \"${SE_NODE_RELAY_PROTOCOL_VERSION}\"" >> "$FILENAME"
+  fi
+  echo "configs = [
+  \"${SE_NODE_RELAY_MAX_SESSIONS}\", \"{\\\"browserName\\\": \\\"${SE_NODE_RELAY_BROWSER_NAME}\\\", \\\"platformName\\\": \\\"${SE_NODE_RELAY_PLATFORM_NAME}\\\", \\\"appium:platformVersion\\\": \\\"${SE_NODE_RELAY_PLATFORM_VERSION}\\\"}\"
+  ]
+  " >> "$FILENAME"
+fi

NodeBase/start-selenium-node.sh

@@ -98,6 +98,7 @@ fi
 if [ "$GENERATE_CONFIG" = true ]; then
   echo "Generating Selenium Config"
   /opt/bin/generate_config
+  /opt/bin/generate_relay_config
 fi
 
 EXTRA_LIBS=""

README.md

@@ -940,6 +940,35 @@ $ docker run -d \
   --shm-size="2g" selenium/node-chrome:4.20.0-20240505
 ```
 
+### Node configuration relay commands
+
+Relaying commands to a service endpoint that supports WebDriver.
+It is useful to connect an external service that supports WebDriver to Selenium Grid. An example of such service could be a cloud provider or an Appium server. 
+In this way, Grid can enable more coverage to platforms and versions not present locally.
+
+The following is an en example of configuration relay commands.
+
+[docker-compose-v3-test-node-relay.yml](tests/docker-compose-v3-test-node-relay.yml)
+
+If you want to relay commands only, `selenium/node-base` is suitable and lightweight for this purpose.
+In case you want to configure node with both browsers and relay commands, respective node images can be used.
+
+To use environment variables for generate relay configs, set `SE_NODE_RELAY_URL` and other variables as below
+
+```toml
+[relay]
+url = "${SE_NODE_RELAY_URL}"
+status-endpoint = "${SE_NODE_RELAY_STATUS_ENDPOINT}"
+protocol-version = "${SE_NODE_RELAY_PROTOCOL_VERSION}"
+configs = [ '${SE_NODE_RELAY_MAX_SESSIONS}', '{"browserName": "${SE_NODE_RELAY_BROWSER_NAME}", "platformName": "${SE_NODE_RELAY_PLATFORM_NAME}", "appium:platformVersion": "${SE_NODE_RELAY_PLATFORM_VERSION}"}' ]
+```
+
+To run a sample test with the relayed node, you can clone the project and try below command:
+
+```bash
+make test_node_relay
+```
+
 ### Setting Sub Path
 
 By default, Selenium is reachable at `http://127.0.0.1:4444/`. Selenium can be configured to use a custom subpath by specifying the `SE_SUB_PATH`