browser.cmd

@echo off
:: =============================================================================
:: Remote Browser Kit — Browser Farm Manager
:: =============================================================================
::   browser.cmd build                    Build the image (Chromium only by default, cached)
::   browser.cmd build clean              Build from scratch (--no-cache)
::   (set INCLUDE_FIREFOX/INCLUDE_EDGE/INCLUDE_WEBKIT=true in `env` to build in
::    additional browsers — see docs/browsers.md for the full build matrix)
::   browser.cmd start <N> [browser]      Start N containers (optional per-batch browser override)
::   browser.cmd stop                     Stop and remove ALL containers
::   browser.cmd restart <N> [browser]    Stop all, start N fresh ones
::   browser.cmd status                   Show running containers + ports
::   browser.cmd list                     Print Eggplant SUT connection table
::   browser.cmd logs <N>                 Tail logs for browser number N
::   browser.cmd shell <N>                Bash shell inside browser number N
::   browser.cmd health                   Health check all containers
:: =============================================================================
setlocal EnableDelayedExpansion

:: ---------------------------------------------------------------------------
:: SETTINGS — defaults. Override any of these by editing the `env` file
:: instead of this block (see "Configuration" in README.md).
:: ---------------------------------------------------------------------------
set VNC_BASE_PORT=5900
set NOVNC_BASE_PORT=6080
set CDP_BASE_PORT=9200
set PREFIX=rb
set IMAGE=remote-browser-kit:1.0
set BROWSER=chromium
set START_URL=https://demo.nopcommerce.com/
set VNC_PASS=changeme
set BROWSER_MODE=normal
set SCREEN_WIDTH=1920
set SCREEN_HEIGHT=1080
set SESSION_MODE=fresh
set BROWSER_ZOOM=1.0
set INCOGNITO=false
set MEMORY_LIMIT=1.5g
set CPU_LIMIT=1.5
set INCLUDE_FIREFOX=false
set INCLUDE_EDGE=false
set INCLUDE_WEBKIT=false
set ROOT=%~dp0

:: ---------------------------------------------------------------------------
:: Load overrides from the `env` file, if present. Blank lines and lines
:: starting with # are ignored. Anything set here wins over the defaults
:: above, so day-to-day changes belong in `env`, not in this script.
:: ---------------------------------------------------------------------------
if exist "%ROOT%env" (
    for /f "usebackq eol=# tokens=1,2 delims==" %%A in ("%ROOT%env") do (
        if not "%%A"=="" if not "%%B"=="" set "%%A=%%B"
    )
)

:: ---------------------------------------------------------------------------
set CMD=%~1
set ARG=%~2
set ARG3=%~3
if /i "%CMD%"=="build"   goto :cmd_build
if /i "%CMD%"=="start"   goto :cmd_start
if /i "%CMD%"=="stop"    goto :cmd_stop
if /i "%CMD%"=="restart" goto :cmd_restart
if /i "%CMD%"=="status"  goto :cmd_status
if /i "%CMD%"=="list"    goto :cmd_list
if /i "%CMD%"=="logs"    goto :cmd_logs
if /i "%CMD%"=="shell"   goto :cmd_shell
if /i "%CMD%"=="health"  goto :cmd_health

echo.
echo  Remote Browser Kit — Farm Manager
echo  ===================================
echo  browser.cmd build                    Build the image (Chromium only by default, cached)
echo  browser.cmd build clean              Build from scratch (--no-cache)
echo  ^(set INCLUDE_FIREFOX/INCLUDE_EDGE/INCLUDE_WEBKIT=true in env to add browsers^)
echo  browser.cmd start ^<N^> [browser]      Start N containers (chromium^|firefox^|edge^|webkit)
echo  browser.cmd stop                     Stop and remove all containers
echo  browser.cmd restart ^<N^> [browser]    Stop all then start N fresh
echo  browser.cmd status                   Show running containers + ports
echo  browser.cmd list                     Eggplant SUT connection table
echo  browser.cmd logs ^<N^>                 Tail logs for browser N
echo  browser.cmd shell ^<N^>                Bash shell inside browser N
echo  browser.cmd health                   Health check all containers
echo.
goto :eof

:: ---------------------------------------------------------------------------
:: Validate a browser name against the supported set. Called both here
:: (fail fast, before wasting a `docker run`) and enforced again inside the
:: container by scripts/start.sh — belt and suspenders.
:: ---------------------------------------------------------------------------
:validate_browser
set "_b=%~1"
if /i "%_b%"=="chromium" exit /b 0
if /i "%_b%"=="firefox"  exit /b 0
if /i "%_b%"=="edge"     exit /b 0
if /i "%_b%"=="webkit"   exit /b 0
exit /b 1

:cmd_build
echo.
echo [BUILD] Browsers: Chromium ^(always^)  Firefox=%INCLUDE_FIREFOX%  Edge=%INCLUDE_EDGE%  WebKit=%INCLUDE_WEBKIT%
set BUILD_ARGS=--build-arg INCLUDE_FIREFOX=%INCLUDE_FIREFOX% --build-arg INCLUDE_EDGE=%INCLUDE_EDGE% --build-arg INCLUDE_WEBKIT=%INCLUDE_WEBKIT%
if /i "%ARG%"=="clean" (
    echo [BUILD] Building image %IMAGE% from scratch ^(--no-cache^) ...
    docker compose -f "%ROOT%docker-compose.yml" build --no-cache %BUILD_ARGS%
) else (
    echo [BUILD] Building image %IMAGE% ^(cached — use "browser.cmd build clean" to force a full rebuild^) ...
    docker compose -f "%ROOT%docker-compose.yml" build %BUILD_ARGS%
)
if errorlevel 1 ( echo [ERROR] Build failed. & exit /b 1 )
echo [BUILD] Done. Run:  browser.cmd start 3
echo.
goto :eof

:cmd_start
if "%ARG%"=="" ( echo [ERROR] Specify count. Example: browser.cmd start 5 & exit /b 1 )
set /a COUNT=%ARG%
if %COUNT% LSS 1 ( echo [ERROR] Count must be at least 1. & exit /b 1 )
if not "%ARG3%"=="" set BROWSER=%ARG3%
call :validate_browser "%BROWSER%"
if errorlevel 1 (
    echo [ERROR] Unsupported browser '%BROWSER%'. Supported: chromium, firefox, edge, webkit
    exit /b 1
)
echo.
echo [START] Launching %COUNT% %BROWSER% browser(s^)...
echo.
set /a STARTED=0
set /a I=1
:_start_loop
if %I% GTR %COUNT% goto :_start_done
set CNAME=%PREFIX%-%I%
set /a VPORT=%VNC_BASE_PORT%+%I%
set /a NPORT=%NOVNC_BASE_PORT%+%I%
set /a CPORT=%CDP_BASE_PORT%+%I%
docker inspect %CNAME% >nul 2>&1
if not errorlevel 1 (
    echo [SKIP]  %CNAME% already running
    set /a I+=1
    goto :_start_loop
)
mkdir "%ROOT%logs\%CNAME%"      >nul 2>&1
mkdir "%ROOT%downloads\%CNAME%" >nul 2>&1
mkdir "%ROOT%uploads"           >nul 2>&1
set "PROFILE_MOUNT="
if /i "%SESSION_MODE%"=="persistent" (
    mkdir "%ROOT%profiles\%CNAME%" >nul 2>&1
    set PROFILE_MOUNT=-v "%ROOT%profiles\%CNAME%:/data/profile"
)
docker run -d ^
  --name %CNAME% ^
  --restart on-failure:3 ^
  -p 127.0.0.1:%VPORT%:5900 ^
  -p 127.0.0.1:%NPORT%:6080 ^
  -p 127.0.0.1:%CPORT%:9222 ^
  -v "%ROOT%logs\%CNAME%:/logs" ^
  -v "%ROOT%downloads\%CNAME%:/downloads" ^
  -v "%ROOT%uploads:/uploads" ^
  !PROFILE_MOUNT! ^
  --shm-size=256m ^
  --cap-add SYS_ADMIN ^
  --memory=%MEMORY_LIMIT% ^
  --cpus=%CPU_LIMIT% ^
  -e BROWSER=%BROWSER% ^
  -e START_URL=%START_URL% ^
  -e VNC_PASS=%VNC_PASS% ^
  -e BROWSER_MODE=%BROWSER_MODE% ^
  -e SCREEN_WIDTH=%SCREEN_WIDTH% ^
  -e SCREEN_HEIGHT=%SCREEN_HEIGHT% ^
  -e SCREEN_DEPTH=24 ^
  -e SESSION_MODE=%SESSION_MODE% ^
  -e BROWSER_ZOOM=%BROWSER_ZOOM% ^
  -e INCOGNITO=%INCOGNITO% ^
  %IMAGE% >nul 2>&1
if errorlevel 1 (
    echo [ERROR] Failed to start %CNAME% — port %VPORT% may be in use
) else (
    echo [OK]    %CNAME%   [%BROWSER%]   VNC=localhost:%VPORT%   noVNC=http://localhost:%NPORT%/vnc.html   CDP=localhost:%CPORT% ^(chromium/edge only^)
    set /a STARTED+=1
)
set /a I+=1
goto :_start_loop
:_start_done
echo.
echo [DONE]  %STARTED%/%COUNT% container(s^) started.
echo         Run:  browser.cmd list   for Eggplant SUT details
echo.
goto :eof

:cmd_stop
echo.
echo [STOP] Removing all %PREFIX%-* containers...
set /a REMOVED=0
for /f "tokens=*" %%C in ('docker ps -a --filter "name=^%PREFIX%-" --format "{{.Names}}" 2^>nul') do (
    echo [STOP] Removing %%C
    docker rm -f %%C >nul 2>&1
    set /a REMOVED+=1
)
if %REMOVED%==0 ( echo [INFO] No containers found. ) else ( echo [DONE] %REMOVED% container(s^) removed. )
echo.
goto :eof

:cmd_restart
if "%ARG%"=="" ( echo [ERROR] Example: browser.cmd restart 5 & exit /b 1 )
echo [RESTART] Stopping all...
for /f "tokens=*" %%C in ('docker ps -a --filter "name=^%PREFIX%-" --format "{{.Names}}" 2^>nul') do (
    docker rm -f %%C >nul 2>&1
)
echo [RESTART] Starting %ARG% fresh containers...
goto :cmd_start

:cmd_status
echo.
echo [STATUS] Running browser containers:
echo.
docker ps --filter "name=%PREFIX%-" --format "table {{.Names}}\t{{.Status}}\t{{.Ports}}"
echo.
set /a TOTAL=0
for /f %%C in ('docker ps --filter "name=%PREFIX%-" -q 2^>nul') do set /a TOTAL+=1
echo [INFO] Total running: %TOTAL%
echo.
goto :eof

:cmd_list
echo.
echo  Eggplant SUT Connection Details
echo  =================================
echo  Host: localhost   Password: %VNC_PASS%   Resolution: %SCREEN_WIDTH%x%SCREEN_HEIGHT%
echo.
echo  CONTAINER    VNC PORT    NOVNC URL
echo  ---------------------------------------------------------------
for /f "tokens=*" %%C in ('docker ps --filter "name=%PREFIX%-" --format "{{.Names}}" 2^>nul') do (
    set CN=%%C
    set IDX=!CN:%PREFIX%-=!
    set /a VP=%VNC_BASE_PORT%+!IDX!
    set /a NP=%NOVNC_BASE_PORT%+!IDX!
    echo  %%C       !VP!       http://localhost:!NP!/vnc.html
)
echo.
goto :eof

:cmd_logs
if "%ARG%"=="" ( echo [ERROR] Example: browser.cmd logs 3 & exit /b 1 )
docker logs -f %PREFIX%-%ARG%
goto :eof

:cmd_shell
if "%ARG%"=="" ( echo [ERROR] Example: browser.cmd shell 2 & exit /b 1 )
docker exec -it %PREFIX%-%ARG% bash
goto :eof

:cmd_health
echo.
for /f "tokens=*" %%C in ('docker ps --filter "name=%PREFIX%-" --format "{{.Names}}" 2^>nul') do (
    for /f "tokens=*" %%H in ('docker inspect %%C --format "{{.State.Health.Status}}" 2^>nul') do (
        echo  %%C  →  %%H
    )
)
echo.
goto :eof

endlocal