Enabeling more stereotypes per node via env variable

[parholmdahl]

We are using specialbuilt images, with firefox, edge and chrome instances in the same node.. For this we have had to have handmade config.toml files.

I added something to the "generate_config" file, so that it would be able to take more than one stereoptype in "SE_NODE_STEREOTYPE" environment variable:

#!/bin/bash

function short_version() {
	local __long_version=$1
	local __version_split=(${__long_version//./ })
	local __major=${__version_split[0]}
	local __minor=${__version_split[1]}
	echo "${__major}.${__minor:0:1}"
}

if [[ -z "$CONFIG_FILE" ]]; then
	FILENAME="/opt/selenium/config.toml"
else
	FILENAME="$CONFIG_FILE"
fi

echo "[events]
publish = \"tcp://${SE_EVENT_BUS_HOST}:${SE_EVENT_BUS_PUBLISH_PORT}\"
subscribe = \"tcp://${SE_EVENT_BUS_HOST}:${SE_EVENT_BUS_SUBSCRIBE_PORT}\"
" >"$FILENAME"

if [[ -z "${SE_NODE_HOST}" ]] && [[ -z "${SE_NODE_PORT}" ]]; then
	echo "Configuring server..."
else
	echo "[server]" >>"$FILENAME"
fi

if [[ -z "${SE_NODE_HOST}" ]]; then
	echo "Setting up SE_NODE_HOST..."
else
	echo "host = \"${SE_NODE_HOST}\"" >>"$FILENAME"
fi

if [[ -z "${SE_NODE_PORT}" ]]; then
	echo "Setting up SE_NODE_PORT..."
else
	echo "port = \"${SE_NODE_PORT}\"" >>"$FILENAME"
fi

echo "[node]" >>"$FILENAME"
# String, Url where the Grid can be reached
if [[ -z "${SE_NODE_GRID_URL}" ]]; then
	echo "Setting up SE_NODE_GRID_URL..."
else
	echo "grid-url = \"${SE_NODE_GRID_URL}\"" >>"$FILENAME"
fi
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}
" >>"$FILENAME"

if [ -f /opt/selenium/browser_name ]; then
	SE_NODE_BROWSER_NAME=$(cat /opt/selenium/browser_name)
fi
if [ -f /opt/selenium/browser_version ] && [ "${SE_NODE_BROWSER_VERSION,,}" = "stable" ]; then
	SE_NODE_BROWSER_VERSION=$(short_version $(cat /opt/selenium/browser_version))
fi
if [ -f /opt/selenium/browser_binary_location ] && [ -z "${SE_BROWSER_BINARY_LOCATION}" ]; then
	SE_BROWSER_BINARY_LOCATION=$(cat /opt/selenium/browser_binary_location)
fi
SE_NODE_CONTAINER_NAME="${SE_NODE_CONTAINER_NAME:-$(hostname)}"

# '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\": \"${SE_NODE_PLATFORM_NAME}\", ${SE_BROWSER_BINARY_LOCATION}, \"se:containerName\": \"${SE_NODE_CONTAINER_NAME}\", \"container:hostname\": \"$(hostname)\"}"
else
	SE_NODE_STEREOTYPE="${SE_NODE_STEREOTYPE}"
fi

# Process stereotypes using Python
if [[ -n "${SE_NODE_STEREOTYPE}" ]]; then
    # Process stereotypes with Python inline script
    PROCESSED_STEREOTYPES=$(python3 - "${SE_NODE_STEREOTYPE}" "${SE_NODE_STEREOTYPE_EXTRA}" <<'END_PYTHON'
import json
import sys

try:
    # Parse stereotype(s)
    stereotypes = json.loads(sys.argv[1])
    if not isinstance(stereotypes, list):
        stereotypes = [stereotypes]
    
    # Parse and merge extra properties if they exist
    if len(sys.argv) > 2 and sys.argv[2]:
        extra = json.loads(sys.argv[2])
        for s in stereotypes:
            s.update(extra)
    
    # Print each stereotype as a separate line for bash processing
    for s in stereotypes:
        print(json.dumps(s))
except Exception as e:
    print(f"Error processing stereotypes: {e}", file=sys.stderr)
    sys.exit(1)
END_PYTHON
)

    if [[ $? -ne 0 ]]; then
        echo "Failed to process stereotypes. Please check the format of the JSON strings."
        exit 1
    fi

    # Create driver configurations
    while IFS= read -r stereotype; do
        if [[ -n "${stereotype}" ]]; then
            BROWSER_NAME=$(python3 -c "import json,sys; print(json.loads(sys.stdin.read()).get('browserName', 'unknown'))" <<< "${stereotype}")
            
            echo "[[node.driver-configuration]]" >>"$FILENAME"
            echo "display-name = \"${BROWSER_NAME}\"" >>"$FILENAME"
            echo "stereotype = '${stereotype}'" >>"$FILENAME"
            echo "max-sessions = ${SE_NODE_MAX_SESSIONS}" >>"$FILENAME"
            echo "" >>"$FILENAME"
        fi
    done <<< "${PROCESSED_STEREOTYPES}"
fi

This enables me to have a config like this:

          - name: SE_NODE_STEREOTYPE
            value: "[{\"browserName\": \"firefox\"}, {\"browserName\": \"chrome\"}, {\"browserName\": \"MicrosoftEdge\"}]"

Maybe this is something to add, and usable for more people..
Also it would be nice to have one official image with more than one browser..

[VietND96]

Hi, thanks for your idea.
Regarding one official image with more than one browser, this looks like an anti-pattern against the current design we are trying to achieve. However, we are happy to implement it if the community has more feedback, which is nice to have.

[parholmdahl]

We use this because we have mtls login, and need one container per mtls cert (to my knowledge anyhow). There would be many pods if we would also have one pod per browser type..

[VietND96]

I understand. I also see a few open-source applications that deliver separate images for each component, and one more image is called all-in-one for a specific purpose. For example, the current Hub and distributed components image that we have.
I am thinking about the image name and tag convention for those images. A name in my mind will be node-all-in-one and standalone-all-in-one.
This is interesting to me. But wait for a while to get more feedback on this.

[diemol]

The main issue is that the image would be huge, probably around 5 or 6 GB, which many people want to avoid.

[parholmdahl]

You are correct..

This "magicnode" is a combination of firefox, chrome and edge and in relation to only chromium:

But also, to have them separated you would have 3 images with approx 2,83gig each?

[parholmdahl]

Even more actually? 11gig?