loadtest-controller: add HTML output

Author: ivchicano

.gitignore

@@ -62,3 +62,5 @@ browser-emulator/qoe_scripts/__pycache__/
 browser-emulator/.awsconfig/
 
 docker/browser-emulator/browser-emulator/
+
+report.html

AGENTS.md

@@ -150,7 +150,6 @@ When implementing changes in this repository, agents MUST follow these rules:
 
 - **Browser-emulator changes**: Run `pnpm run test:unit` and `pnpm run test:integration` after modifications
 - **Loadtest-controller changes**: Run `mvn test` after Java modifications
-- **E2E affecting changes**: Run the smoke test via `./e2e-tests/scripts/run-smoke-test.sh`
 
 ### 2. Lint Requirements (Browser-emulator only)
 

README.md

@@ -77,7 +77,7 @@ The docker compose file will start two services:
 - **Browser-emulator**: The worker that launches Chrome browsers to connect to rooms
 - **Loadtest-controller**: Orchestrates the test by coordinating the browser-emulator
 
-OpenVidu loadtest will execute the test cases and output results at `results/results.txt`.
+OpenVidu loadtest will execute the test cases and output results at `results/results.html`, you can open this file in a browser to see the results. You can also check the console output for real-time logs.
 
 For more detailed instructions on how to configure tests, see [Configuration](#configuration).
 
@@ -265,6 +265,14 @@ Performance and retry settings.
 | `advanced.batches.maxConcurrentRequests` | No       | `CPU cores + 1` | Max concurrent requests when in batch mode                                                                                                                               |
 | `advanced.waitForCompletion`             | No       | `true`          | Wait for all participants in the batch to confirm insertion into the platform before inserting the next batch. Will wait for individual participants if `batches: false` |
 
+### Report Output Configuration
+
+Control which output formats are generated after test completion.
+
+| Property                | Required | Default | Description                               |
+| ----------------------- | -------- | ------- | ----------------------------------------- |
+| `advanced.reportOutput` | No       | `html`  | Comma-separated list: `html` and/or `txt` |
+
 ### Environment Variables
 
 All configuration values can be set via environment variables. Environment variables take precedence over config file values. Any configuration value can be overridden by an environment variable. Some examples are:

e2e-tests/README.md

@@ -33,6 +33,10 @@ Where:
 - `PLATFORM_APIKEY`: Optional. API key for authentication (defaults to "devkey")
 - `PLATFORM_APISECRET`: Optional. API secret for authentication (defaults to "secret")
 
+### Configuration File
+
+The smoke test uses the configuration file `config/smoke-test-config.yaml` which specifies `advanced.reportOutput: html,txt` to generate both text and HTML reports.
+
 ### Running the Smoke Test
 
 ```bash
@@ -59,12 +63,16 @@ The test should:
 - Start both loadtest-controller and browser-emulator services
 - Launch 2 Chrome browsers that connect to the OpenVidu instance
 - Create a single session with 2 participants in N:N topology
-- Generate results in the `results/` directory
+- Generate results in the `results/` directory:
+  - `results.txt` (text summary)
+  - `report.html` (HTML report, with user retry details if retries occurred)
 - Complete successfully and shut down cleanly
 
 ### Validation Checks
 
-The smoke test validates that the results.txt file contains:
+The smoke test validates that both `results.txt` and `report.html` files are generated and contain expected content.
+
+**results.txt validation:**
 
 - "Test Case Report"
 - "Number of sessions created: 1"
@@ -73,6 +81,17 @@ The smoke test validates that the results.txt file contains:
 - "User start times:"
 - User start time lines in the format: "Day Mon DD HH:MM:SS TZ YYYY | LoadTestSessionX | UserY"
 
+**report.html validation:**
+
+- "OpenVidu Load Test Report"
+- "Sessions Created"
+- "Total Participants"
+- "User Connections" (mandatory)
+- Table columns: User, Session, Join date (from successful connection), Disconnect Date (captured from ParticipantDisconnected websocket event), Retry Number (count of retries per user)
+- Two user rows (User1 and User2) present
+
+The smoke test configuration uses `advanced.reportOutput: html,txt` to generate both output formats. If validation fails, the result files are kept in the `results/` directory for debugging.
+
 ## Extending the Test Suite
 
 Additional test scenarios can be added by:

e2e-tests/config/smoke-test-config.yaml

@@ -10,4 +10,7 @@ workers:
   urls: browser-emulator
 
 distribution:
-  usersPerWorker: 2
+  usersPerWorker: 2
+
+advanced:
+  reportOutput: html,txt

e2e-tests/docker-compose.yml

@@ -31,7 +31,7 @@ services:
     restart: unless-stopped
     environment:
       RUNNING_IN_DOCKER: true
-      DOCKER_NETWORK_NAME: browseremulator
+      DOCKER_NETWORK_NAME: browseremulator-e2e
       DOCKER_BROWSER_EMULATOR_HOST: browser-emulator
       MEDIAFILES_HOST_DIR: ${MEDIAFILES_HOST_DIR:-${PWD}/../../browser-emulator/mediafiles}
       SCRIPTS_LOGS_HOST_DIR: ${SCRIPTS_LOGS_HOST_DIR:-${PWD}/../../browser-emulator/logs}
@@ -47,4 +47,4 @@ services:
 
 networks:
   browseremulator:
-    name: browseremulator
+    name: browseremulator-e2e

e2e-tests/scripts/run-smoke-test.sh

@@ -8,10 +8,11 @@
 set -e  # Exit on any error
 
 echo "Starting OpenVidu Load Test Smoke Test..."
+EXIT_CODE=0
 
-# Check if docker-compose is available
-if ! command -v docker-compose &> /dev/null; then
-    echo "docker-compose not found. Please install docker-compose."
+# Check if docker compose is available
+if ! command -v docker compose &> /dev/null; then
+    echo "docker compose not found. Please install docker compose."
     exit 1
 fi
 
@@ -33,25 +34,24 @@ E2E_TEST_DIR="$(dirname "$(realpath "$0")")/.."
 export LOCAL_CONFIG_DIR="$E2E_TEST_DIR/config" 
 export LOCAL_RESULTS_DIR="$E2E_TEST_DIR/results"
 export LOADTEST_CONFIG="/config/smoke-test-config.yaml"
-
 # Start services
-echo "Starting services with docker-compose..."
-docker-compose up --build -d
+echo "Starting services with docker compose..."
+docker compose up --build -d
 
 MAX_WAIT=120
 ELAPSED=0
 while [ $ELAPSED -lt $MAX_WAIT ]; do
-    # Check if loadtest-controller has finished (results file exists)
-    if [ -f "$LOCAL_RESULTS_DIR/results.txt" ]; then
-        echo "Results file found. Test appears to be complete."
+    # Check if loadtest-controller has finished (results and HTML report exist)
+    if [ -f "$LOCAL_RESULTS_DIR/results.txt" ] && [ -f "$LOCAL_RESULTS_DIR/report.html" ]; then
+        echo "Results and HTML report found. Test appears to be complete."
         break
     fi
 
     # Check if containers are still running
-    RUNNING_CONTAINERS=$(docker-compose ps -q)
+    RUNNING_CONTAINERS=$(docker compose ps -q)
     if [ -z "$RUNNING_CONTAINERS" ]; then
         echo "No running containers found. Something went wrong."
-        docker-compose logs
+        docker compose logs
         exit 1
     fi
 
@@ -62,13 +62,14 @@ done
 
 if [ $ELAPSED -ge $MAX_WAIT ]; then
     echo "Timeout waiting for test to complete after $MAX_WAIT seconds."
-    docker-compose ps
-    docker-compose logs
+    docker compose ps
+    docker compose logs
 fi
 
 # Stop services
+docker compose logs > $LOCAL_RESULTS_DIR/docker-compose.log 2>&1
 echo "Stopping services..."
-docker-compose down
+docker compose down
 
     # Check results
     echo "Checking test results..."
@@ -120,29 +121,96 @@ docker-compose down
             VALIDATION_PASSED=false
         fi
 
-        # Check for user start time lines (pattern: Day Mon DD HH:MM:SS TZ YYYY | LoadTestSession | UserX)
-        # Using a more flexible pattern that matches the expected format
-        if grep -E "[A-Za-z]{3} [A-Za-z]{3} [0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} [A-Z]+ [0-9]{4} \| LoadTestSession[0-9]+ \| User[0-9]+" "$LOCAL_RESULTS_DIR/results.txt"; then
+        # Check for user start time lines (pattern: Day Mon DD HH:MM:SS TZ YYYY | session | user)
+        # Using a flexible pattern that matches any session/user values (including empty)
+        if grep -E "[A-Za-z]{3} [A-Za-z]{3} [0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} [A-Z]+ [0-9]{4} \\| [^|]* \\| [^|]*" "$LOCAL_RESULTS_DIR/results.txt"; then
             echo "✓ Found user start time lines matching expected pattern"
         else
             echo "✗ Missing user start time lines matching expected pattern (e.g., 'Fri Mar 20 12:53:18 GMT 2026 | LoadTestSession1 | User1')"
             VALIDATION_PASSED=false
         fi
 
-        if [ "$VALIDATION_PASSED" = true ]; then
+        # HTML report validation
+        HTML_VALIDATION_PASSED=true
+        HTML_FILE="$LOCAL_RESULTS_DIR/report.html"
+        if [ -f "$HTML_FILE" ]; then
+            echo "✓ HTML report found"
+            
+            # Check for basic HTML structure
+            if grep -q "OpenVidu Load Test Report" "$HTML_FILE"; then
+                echo "✓ HTML contains 'OpenVidu Load Test Report'"
+            else
+                echo "✗ HTML missing 'OpenVidu Load Test Report'"
+                HTML_VALIDATION_PASSED=false
+            fi
+            
+            # Check for sessions created
+            if grep -q "Sessions Created" "$HTML_FILE"; then
+                echo "✓ HTML contains 'Sessions Created'"
+            else
+                echo "✗ HTML missing 'Sessions Created'"
+                HTML_VALIDATION_PASSED=false
+            fi
+            
+            # Check for total participants
+            if grep -q "Total Participants" "$HTML_FILE"; then
+                echo "✓ HTML contains 'Total Participants'"
+            else
+                echo "✗ HTML missing 'Total Participants'"
+                HTML_VALIDATION_PASSED=false
+            fi
+            
+            # Check for User Connections section (mandatory)
+            if grep -q "User Connections" "$HTML_FILE"; then
+                echo "✓ HTML contains 'User Connections'"
+                # Check for new column headers
+                if grep -q "Join date" "$HTML_FILE" && grep -q "Disconnect Date" "$HTML_FILE" && grep -q "Retry Number" "$HTML_FILE"; then
+                    echo "✓ HTML contains new table columns"
+                    # Check for two user rows (User1 and User2)
+                    if grep -q "User1" "$HTML_FILE" && grep -q "User2" "$HTML_FILE"; then
+                        echo "✓ HTML contains two user rows"
+                    else
+                        echo "✗ HTML missing user rows (expected User1 and User2)"
+                        HTML_VALIDATION_PASSED=false
+                    fi
+                else
+                    echo "✗ HTML missing new table columns"
+                    HTML_VALIDATION_PASSED=false
+                fi
+            else
+                echo "✗ HTML missing 'User Connections'"
+                HTML_VALIDATION_PASSED=false
+            fi
+            
+            # HTML file will be deleted later if validation passes
+        else
+            echo "✗ HTML report not found at $HTML_FILE"
+            HTML_VALIDATION_PASSED=false
+        fi
+        
+        # Combine validation results
+        if [ "$VALIDATION_PASSED" = true ] && [ "$HTML_VALIDATION_PASSED" = true ]; then
             echo "SUCCESS: All validation checks passed."
         else
             echo "FAILURE: One or more validation checks failed."
+            EXIT_CODE=1
         fi
 
-        # Delete results file after reading
-        echo "Deleting results file..."
-        rm -f "$LOCAL_RESULTS_DIR/results.txt"
+        # Delete result files only if validation passed
+        if [ $EXIT_CODE -eq 0 ]; then
+            echo "Deleting result files..."
+            rm -f "$LOCAL_RESULTS_DIR/results.txt"
+            rm -f "$HTML_FILE"
+            rm -f "$LOCAL_RESULTS_DIR/docker-compose.log"
+        else
+            echo "Keeping result files for debugging. Remember to remove them manually before re-running the test."
+        fi
 else
-    echo "ERROR: Results file not found at $LOCAL_RESULTS_DIR/results.txt"
-    exit 1
+    echo "ERROR: Results file or HTML report not found at $LOCAL_RESULTS_DIR/results.txt or report.html"
+    EXIT_CODE=1
 fi
 
-echo "Smoke test completed successfully!"
-
-exit 0
+if [ $EXIT_CODE -eq 0 ]; then
+    echo "Smoke test completed successfully!"
+fi
+exit $EXIT_CODE

loadtest-controller/src/main/java/io/openvidu/loadtest/config/LoadTestConfig.java

@@ -92,6 +92,8 @@ protected LoadTestConfig(Environment env) {
 
     private int retryTimes;
 
+    private List<String> reportOutput = new ArrayList<>(Arrays.asList("html"));
+
     private boolean qoeAnalysisRecordings;
 
     private boolean qoeAnalysisInSitu;
@@ -263,6 +265,16 @@ public int getRetryTimes() {
         return retryTimes;
     }
 
+
+
+    public List<String> getReportOutput() {
+        return reportOutput;
+    }
+
+    public void setReportOutput(List<String> reportOutput) {
+        this.reportOutput = reportOutput;
+    }
+
     public boolean isQoeAnalysisRecordings() {
         return qoeAnalysisRecordings;
     }
@@ -436,6 +448,12 @@ private void initBatchAndMiscConfig() {
         batches = !Boolean.FALSE.equals(batchesEnabled);
         Boolean waitCompleteEnabled = yamlConfig.getBooleanOrNull("advanced.waitForCompletion");
         waitCompletion = !Boolean.FALSE.equals(waitCompleteEnabled);
+        // Parse report output list
+        List<String> reportOutputList = asOptionalStringList("advanced.reportOutput");
+        if (!reportOutputList.isEmpty()) {
+            reportOutput = reportOutputList;
+        }
+        // default reportOutput already initialized to ["html"]
     }
 
     private String defaultIfEmpty(String value, String defaultValue) {