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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

//! End-to-end integration test for the ferridriver test runner.
//!
//! Verifies: discovery, fixture injection, worker pool, expect assertions,
//! terminal reporter, and the full run lifecycle.
//!
//! This uses `harness = false` so we can run the test runner directly.

use std::sync::Arc;
use std::time::Duration;

use ferridriver_test::config::{CliOverrides, 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>()
  )
}

/// Test: basic page navigation and title check using fixtures.
fn make_navigation_test() -> TestCase {
  TestCase {
    id: TestId {
      file: "runner_e2e.rs".into(),
      suite: Some("navigation".into()),
      name: "basic_navigation".into(),
      line: None,
    },
    test_fn: Arc::new(|pool| {
      Box::pin(async move {
        let page: Arc<ferridriver::Page> = pool.get("page").await.map_err(TestFailure::from)?;
        let url = data_url("<title>Test Page</title><body><h1>Hello World</h1></body>");
        page.goto(&url, None).await.map_err(|e| TestFailure {
          message: format!("goto failed: {e}"),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        let title = page.title().await.map_err(|e| TestFailure {
          message: format!("title failed: {e}"),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        if !title.contains("Test Page") {
          return Err(TestFailure {
            message: format!("expected title to contain 'Test Page', got '{title}'"),
            stack: None,
            diff: Some(format!("- expected: \"Test Page\"\n+ received: \"{title}\"")),
            screenshot: None,
          });
        }
        Ok(())
      })
    }),
    fixture_requests: vec!["page".into()],
    annotations: Vec::new(),
    timeout: Some(Duration::from_secs(15)),
    retries: None,
    expected_status: ExpectedStatus::Pass,
    use_options: None,
  }
}

/// Test: locator click and text assertion.
fn make_click_test() -> TestCase {
  TestCase {
    id: TestId {
      file: "runner_e2e.rs".into(),
      suite: Some("interaction".into()),
      name: "click_button".into(),
      line: None,
    },
    test_fn: Arc::new(|pool| {
      Box::pin(async move {
        let page: Arc<ferridriver::Page> = pool.get("page").await.map_err(TestFailure::from)?;
        let url = data_url("<button id='btn' onclick=\"this.textContent='clicked'\">Click Me</button>");
        page.goto(&url, None).await.map_err(|e| TestFailure {
          message: format!("goto failed: {e}"),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        page.locator("#btn", None).click(None).await.map_err(|e| TestFailure {
          message: format!("click failed: {e}"),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        let text = page
          .locator("#btn", None)
          .text_content()
          .await
          .map_err(|e| TestFailure {
            message: format!("text_content failed: {e}"),
            stack: None,
            diff: None,
            screenshot: None,
          })?
          .unwrap_or_default();
        if text != "clicked" {
          return Err(TestFailure {
            message: format!("expected button text 'clicked', got '{text}'"),
            stack: None,
            diff: Some(format!("- expected: \"clicked\"\n+ received: \"{text}\"")),
            screenshot: None,
          });
        }
        Ok(())
      })
    }),
    fixture_requests: vec!["page".into()],
    annotations: Vec::new(),
    timeout: Some(Duration::from_secs(15)),
    retries: None,
    expected_status: ExpectedStatus::Pass,
    use_options: None,
  }
}

/// Test: fill input and read value.
fn make_fill_test() -> TestCase {
  TestCase {
    id: TestId {
      file: "runner_e2e.rs".into(),
      suite: Some("interaction".into()),
      name: "fill_input".into(),
      line: None,
    },
    test_fn: Arc::new(|pool| {
      Box::pin(async move {
        let page: Arc<ferridriver::Page> = pool.get("page").await.map_err(TestFailure::from)?;
        let url = data_url("<input id='inp' type='text' />");
        page.goto(&url, None).await.map_err(|e| TestFailure {
          message: format!("goto failed: {e}"),
          stack: None,
          diff: None,
          screenshot: None,
        })?;
        page
          .locator("#inp", None)
          .fill("hello world", None)
          .await
          .map_err(|e| TestFailure {
            message: format!("fill failed: {e}"),
            stack: None,
            diff: None,
            screenshot: None,
          })?;
        let val = page
          .locator("#inp", None)
          .input_value()
          .await
          .map_err(|e| TestFailure {
            message: format!("input_value failed: {e}"),
            stack: None,
            diff: None,
            screenshot: None,
          })?;
        if val != "hello world" {
          return Err(TestFailure {
            message: format!("expected input value 'hello world', got '{val}'"),
            stack: None,
            diff: None,
            screenshot: None,
          });
        }
        Ok(())
      })
    }),
    fixture_requests: vec!["page".into()],
    annotations: Vec::new(),
    timeout: Some(Duration::from_secs(15)),
    retries: None,
    expected_status: ExpectedStatus::Pass,
    use_options: None,
  }
}

/// Test: expect assertions (auto-retrying).
fn make_expect_test() -> TestCase {
  TestCase {
    id: TestId {
      file: "runner_e2e.rs".into(),
      suite: Some("expect".into()),
      name: "auto_retry_assertions".into(),
      line: None,
    },
    test_fn: Arc::new(|pool| {
      Box::pin(async move {
        let page: Arc<ferridriver::Page> = pool.get("page").await.map_err(TestFailure::from)?;
        let url = data_url(
          "<title>Expect Test</title>\
           <div id='msg'>Initial</div>\
           <button id='btn' onclick=\"setTimeout(() => document.getElementById('msg').textContent = 'Updated', 200)\">Go</button>",
        );
        page.goto(&url, None).await.map_err(|e| TestFailure {
          message: format!("goto failed: {e}"),
          stack: None,
          diff: None,
          screenshot: None,
        })?;

        // Test page title assertion.
        ferridriver_test::expect::expect(&page)
          .to_have_title("Expect Test")
          .await?;

        // Click button that updates text after 200ms delay.
        page.locator("#btn", None).click(None).await.map_err(|e| TestFailure {
          message: format!("click failed: {e}"),
          stack: None,
          diff: None,
          screenshot: None,
        })?;

        // Auto-retry assertion: should poll until text changes.
        ferridriver_test::expect::expect(&page.locator("#msg", None))
          .to_have_text("Updated")
          .await?;

        // Test negation: should NOT have old text.
        ferridriver_test::expect::expect(&page.locator("#msg", None))
          .not()
          .to_have_text("Initial")
          .await?;

        Ok(())
      })
    }),
    fixture_requests: vec!["page".into()],
    annotations: Vec::new(),
    timeout: Some(Duration::from_secs(15)),
    retries: None,
    expected_status: ExpectedStatus::Pass,
    use_options: None,
  }
}

/// Test that should be skipped.
fn make_skip_test() -> TestCase {
  TestCase {
    id: TestId {
      file: "runner_e2e.rs".into(),
      suite: None,
      name: "skipped_test".into(),
      line: None,
    },
    test_fn: Arc::new(|_pool| {
      Box::pin(async move {
        Err(TestFailure {
          message: "this should never run".into(),
          stack: None,
          diff: None,
          screenshot: None,
        })
      })
    }),
    fixture_requests: vec![],
    annotations: vec![TestAnnotation::Skip {
      reason: Some("testing skip".into()),
      condition: None,
    }],
    timeout: None,
    retries: None,
    expected_status: ExpectedStatus::Pass,
    use_options: None,
  }
}

#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
async fn test_runner_e2e() {
  // Build the test plan manually (normally done by #[ferritest] + discovery).
  let plan = TestPlan {
    suites: vec![
      TestSuite {
        name: "navigation".into(),
        file: "runner_e2e.rs".into(),
        tests: vec![make_navigation_test()],
        hooks: Hooks::default(),
        annotations: Vec::new(),
        mode: ferridriver_test::model::SuiteMode::default(),
      },
      TestSuite {
        name: "interaction".into(),
        file: "runner_e2e.rs".into(),
        tests: vec![make_click_test(), make_fill_test()],
        hooks: Hooks::default(),
        annotations: Vec::new(),
        mode: ferridriver_test::model::SuiteMode::default(),
      },
      TestSuite {
        name: "expect".into(),
        file: "runner_e2e.rs".into(),
        tests: vec![make_expect_test()],
        hooks: Hooks::default(),
        annotations: Vec::new(),
        mode: ferridriver_test::model::SuiteMode::default(),
      },
      TestSuite {
        name: "skip".into(),
        file: "runner_e2e.rs".into(),
        tests: vec![make_skip_test()],
        hooks: Hooks::default(),
        annotations: Vec::new(),
        mode: ferridriver_test::model::SuiteMode::default(),
      },
    ],
    total_tests: 5,
    shard: None,
  };

  let config = TestConfig {
    workers: 2,
    timeout: 15_000,
    expect_timeout: 5_000,
    ..Default::default()
  };

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

  let exit_code = runner.run(plan).await;
  assert_eq!(exit_code, 0, "test runner should pass all tests (exit code 0)");
}