ferridriver-test 0.4.0

E2E test runner for ferridriver. Playwright-compatible API, parallel workers, auto-retrying expect, fixtures, snapshots.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

#![allow(
  clippy::cast_precision_loss,
  clippy::cast_lossless,
  clippy::uninlined_format_args,
  clippy::implicit_clone
)]
//! Performance benchmark: measures ferridriver-test runner overhead and parallelism.
//!
//! This reports ferridriver-test's own numbers (per-test latency, throughput,
//! worker scaling). It does NOT assert any speedup against Playwright unless a
//! same-machine baseline is supplied via `FERRIDRIVER_PW_BASELINE_MS`. See
//! `BENCHMARKING.md` for the methodology and current honest numbers.

use std::sync::Arc;
use std::time::{Duration, Instant};

use ferridriver_test::config::{CliOverrides, ReporterConfig, TestConfig};
use ferridriver_test::model::*;
use ferridriver_test::runner::TestRunner;

fn data_url(html: &str) -> String {
  format!(
    "data:text/html,{}",
    html
      .bytes()
      .map(|b| match b {
        b'A'..=b'Z' | b'a'..=b'z' | b'0'..=b'9' | b'-' | b'_' | b'.' | b'~' => {
          (b as char).to_string()
        },
        _ => format!("%{b:02X}"),
      })
      .collect::<String>()
  )
}

fn make_nav_test(i: usize) -> TestCase {
  TestCase {
    id: TestId {
      file: "bench.rs".into(),
      suite: Some("nav".into()),
      name: format!("nav_{i:03}"),
      line: None,
    },
    test_fn: Arc::new(move |pool| {
      Box::pin(async move {
        let page: Arc<ferridriver::Page> = pool.get("page").await.map_err(TestFailure::from)?;
        let html = format!("<title>Test {i}</title><body><h1>Page {i}</h1></body>");
        page.goto(&data_url(&html), None).await.map_err(|e| TestFailure {
          message: e.to_string(),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        let title = page.title().await.map_err(|e| TestFailure {
          message: e.to_string(),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        assert!(title.contains(&format!("Test {i}")));
        Ok(())
      })
    }),
    fixture_requests: vec!["page".into()],
    annotations: Vec::new(),
    timeout: Some(Duration::from_secs(10)),
    retries: None,
    expected_status: ExpectedStatus::Pass,
    use_options: None,
  }
}

fn make_interaction_test(i: usize) -> TestCase {
  TestCase {
    id: TestId {
      file: "bench.rs".into(),
      suite: Some("click".into()),
      name: format!("interact_{i:03}"),
      line: None,
    },
    test_fn: Arc::new(move |pool| {
      Box::pin(async move {
        let page: Arc<ferridriver::Page> = pool.get("page").await.map_err(TestFailure::from)?;
        let html = format!("<button id='btn' onclick=\"this.textContent='done {i}'\">Click {i}</button>");
        page.goto(&data_url(&html), None).await.map_err(|e| TestFailure {
          message: e.to_string(),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        page.locator("#btn", None).click(None).await.map_err(|e| TestFailure {
          message: e.to_string(),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        let text = page
          .locator("#btn", None)
          .text_content()
          .await
          .map_err(|e| TestFailure {
            message: e.to_string(),
            stack: None,
            diff: None,
            screenshot: None,
          })?
          .unwrap_or_default();
        assert!(text.contains(&format!("done {i}")));
        Ok(())
      })
    }),
    fixture_requests: vec!["page".into()],
    annotations: Vec::new(),
    timeout: Some(Duration::from_secs(10)),
    retries: None,
    expected_status: ExpectedStatus::Pass,
    use_options: None,
  }
}

fn make_tests(n: usize) -> Vec<TestCase> {
  (0..n)
    .map(|i| {
      if i % 2 == 0 {
        make_nav_test(i)
      } else {
        make_interaction_test(i)
      }
    })
    .collect()
}

async fn run_bench(label: &str, num_tests: usize, num_workers: u32) -> Duration {
  let plan = TestPlan {
    suites: vec![TestSuite {
      name: "bench".into(),
      file: "bench.rs".into(),
      tests: make_tests(num_tests),
      hooks: Hooks::default(),
      annotations: Vec::new(),
      mode: SuiteMode::Parallel,
    }],
    total_tests: num_tests,
    shard: None,
  };

  let config = TestConfig {
    workers: num_workers,
    timeout: 10_000,
    reporter: vec![ReporterConfig {
      name: "none".into(),
      options: std::collections::BTreeMap::new(),
    }],
    ..Default::default()
  };

  let mut runner = TestRunner::new(config, CliOverrides::default());

  let start = Instant::now();
  let exit_code = runner.run(plan).await;
  let elapsed = start.elapsed();

  let per_test = elapsed.as_millis() as f64 / num_tests as f64;
  let tests_per_sec = num_tests as f64 / elapsed.as_secs_f64();

  println!(
    "  {label:<30} {num_tests:>3} tests, {num_workers} workers => {elapsed:>6.0?} total, {per_test:>5.1}ms/test, {tests_per_sec:>5.1} tests/sec",
  );

  assert_eq!(exit_code, 0, "{label}: all tests should pass");
  elapsed
}

#[tokio::test(flavor = "multi_thread", worker_threads = 8)]
#[ignore = "benchmark, not for CI"]
async fn bench_parallel_scaling() {
  println!("\n============================================================");
  println!("  ferridriver-test performance benchmark");
  println!("============================================================\n");

  // Warm up: single test to launch browser.
  Box::pin(run_bench("warmup (browser launch)", 1, 1)).await;
  println!();

  // Worker scaling: 20 tests.
  let t1 = Box::pin(run_bench("20 tests, 1 worker", 20, 1)).await;
  let t2 = Box::pin(run_bench("20 tests, 2 workers", 20, 2)).await;
  let t4 = Box::pin(run_bench("20 tests, 4 workers", 20, 4)).await;

  println!();
  println!("  Speedup 1→2: {:.2}x", t1.as_secs_f64() / t2.as_secs_f64());
  println!("  Speedup 1→4: {:.2}x", t1.as_secs_f64() / t4.as_secs_f64());
  println!();

  // Throughput: 50 tests (same workload size used for the optional Playwright baseline).
  let t50_4 = Box::pin(run_bench("50 tests, 4 workers", 50, 4)).await;
  let t50_6 = Box::pin(run_bench("50 tests, 6 workers", 50, 6)).await;

  println!();
  println!("  ferridriver-test (50 tests, 4w): {}ms", t50_4.as_millis());
  println!("  ferridriver-test (50 tests, 6w): {}ms", t50_6.as_millis());
  // No Playwright baseline is asserted here. A speedup figure is only
  // defensible against a baseline measured on the SAME machine in the SAME
  // run with the SAME 50-test workload. To produce that comparison, set
  // FERRIDRIVER_PW_BASELINE_MS to a Playwright Test number you measured
  // locally; absent that env var we refuse to print a ratio rather than
  // cite a hardcoded self-reported figure. See BENCHMARKING.md.
  if let Some(baseline_ms) = std::env::var("FERRIDRIVER_PW_BASELINE_MS")
    .ok()
    .and_then(|v| v.parse::<f64>().ok())
  {
    println!("  Playwright baseline (50 tests, measured): {baseline_ms:.0}ms");
    println!(
      "  Speedup vs Playwright (4w): {:.2}x",
      baseline_ms / t50_4.as_millis() as f64
    );
    println!(
      "  Speedup vs Playwright (6w): {:.2}x",
      baseline_ms / t50_6.as_millis() as f64
    );
  } else {
    println!("  Playwright baseline: NOT MEASURED (set FERRIDRIVER_PW_BASELINE_MS to compare)");
    println!("  Refusing to print a speedup ratio without a same-machine baseline. See BENCHMARKING.md.");
  }
  println!();

  // Large scale: 100 tests.
  Box::pin(run_bench("100 tests, 4 workers", 100, 4)).await;
  Box::pin(run_bench("100 tests, 6 workers", 100, 6)).await;

  println!("\n============================================================\n");
}