Skip to main content

UI Test Suites

Group multiple UI tests into a suite for batch execution against an environment.

Creating a Suite​

POST /api/ui-test-suites
{
  "name": "User Service UI Smoke",
  "projectId": 2,
  "items": [
    {"uiTestId": 1, "sortOrder": 1},
    {"uiTestId": 2, "sortOrder": 2},
    {"uiTestId": 3, "sortOrder": 3}
  ]
}

Executing a Suite​

POST /api/ui-test-suites/{id}/run
{
  "target": "https://app.proofarc.ai",
  "environmentId": 7,
  "tag": "smoke-v1"
}

The suite executes each test in order against the selected environment. Each test uses the environment's target URL and auth configuration. Credentials are auto-resolved from the environment's default credential — see Credential Injection.

Cross-Engine Execution​

The same suite can run on multiple browser engines in one call by passing drivers in the run body:

POST /api/ui-test-suites/{id}/run
{
  "target": "https://app.proofarc.ai",
  "environmentId": 7,
  "drivers": ["WEBDRIVER", "PLAYWRIGHT"]
}

For each test in the suite, one ScanJob is dispatched per engine — both share the same suiteRunId so the suite-execution view groups them. Without drivers, each test falls back to its own driver field (WEBDRIVER or PLAYWRIGHT).

The supported engines:

  • Selenium WebDriver (via ui-test-agent) — Chromium
  • Playwright (via playwright-agent) — Chromium, WebKit, Firefox

Running the same suite on both detects browser compatibility issues — if a test passes on Chromium-Selenium but fails on WebKit-Playwright, that's a rendering-engine bug. Proofarc's CrossEngineComparator computes per-step parity automatically.

Suite Results​

Results show per-test pass/fail:

Suite: User Service UI Smoke
  ✓ Login Page Test — PASSED (3 steps, 2.1s)
  ✓ Dashboard Navigation — PASSED (5 steps, 4.3s)
  ✗ Profile Edit — FAILED (step 3: element not found)

Screenshots are captured on failure for debugging.

Managing Suites in the UI​

Navigate to UI Tests → Suites tab:

  • View suites with test counts
  • Execute suites against any environment
  • View run history with pass/fail per test