earl-protocol-browser 0.6.4

Browser automation protocol for earl (chromiumoxide)
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399

//! Use-case tests: web scraping — extracting content from pages.
//!
//! Each test serves a controlled local HTTP page so assertions are deterministic.
//! Chrome-dependent tests skip gracefully when Chrome is not found.

mod common;
use common::{execute, skip_if_no_chrome};

use earl_protocol_browser::PreparedBrowserCommand;
use earl_protocol_browser::schema::BrowserStep;
use std::collections::HashMap;

/// Test 1.1 — Extract static text via evaluate.
///
/// Serve a page with a static `<h1>` heading and use `evaluate` to read its
/// text content.
#[tokio::test]
async fn extract_static_text_via_evaluate() {
    if skip_if_no_chrome() {
        return;
    }

    let _guard = common::chrome_lock().await;

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        common::server::Response::html("<h1>Product: Acme Widget</h1>"),
    );
    let server = common::server::spawn(routes).await;

    let data = PreparedBrowserCommand {
        session_id: None,
        headless: true,
        timeout_ms: 30_000,
        on_failure_screenshot: false,
        steps: vec![
            BrowserStep::Navigate {
                url: server.url("/"),
                expected_status: None,
                timeout_ms: None,
                optional: false,
            },
            BrowserStep::Evaluate {
                function: "() => document.querySelector('h1').textContent".to_string(),
                r#ref: None,
                timeout_ms: None,
                optional: false,
            },
        ],
    };

    let result = execute(data).await.expect("execute should succeed");

    assert_eq!(
        result["value"],
        serde_json::Value::String("Product: Acme Widget".to_string()),
        "evaluate should return the h1 text content; got: {result}"
    );
}

/// Test 1.2 — Extract dynamically-rendered text using wait_for.
///
/// The page uses `setTimeout` to inject a `<p>` element after 300ms.  The
/// `wait_for` step must observe the text before `evaluate` reads it.
#[tokio::test]
async fn extract_dynamic_text_with_wait_for() {
    if skip_if_no_chrome() {
        return;
    }

    let _guard = common::chrome_lock().await;

    let body = r#"<html><body>
<script>
setTimeout(function() {
  var p = document.createElement('p');
  p.id = 'loaded';
  p.textContent = 'Data loaded';
  document.body.appendChild(p);
}, 300);
</script>
</body></html>"#;

    let mut routes = HashMap::new();
    routes.insert("GET /".to_string(), common::server::Response::html(body));
    let server = common::server::spawn(routes).await;

    let data = PreparedBrowserCommand {
        session_id: None,
        headless: true,
        timeout_ms: 30_000,
        on_failure_screenshot: false,
        steps: vec![
            BrowserStep::Navigate {
                url: server.url("/"),
                expected_status: None,
                timeout_ms: None,
                optional: false,
            },
            BrowserStep::WaitFor {
                time: None,
                text: Some("Data loaded".to_string()),
                text_gone: None,
                timeout_ms: Some(5_000),
                optional: false,
            },
            BrowserStep::Evaluate {
                function: "() => document.getElementById('loaded').textContent".to_string(),
                r#ref: None,
                timeout_ms: None,
                optional: false,
            },
        ],
    };

    let result = execute(data).await.expect("execute should succeed");

    assert_eq!(
        result["value"],
        serde_json::Value::String("Data loaded".to_string()),
        "evaluate should return the dynamically-injected text; got: {result}"
    );
}

/// Test 1.3 — wait_for times out when content never appears.
///
/// A blank page is served and `wait_for` looks for text that is never added.
/// The execution must return an error.
#[tokio::test]
async fn wait_for_times_out_when_content_absent() {
    if skip_if_no_chrome() {
        return;
    }

    let _guard = common::chrome_lock().await;

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        common::server::Response::html("<html><body></body></html>"),
    );
    let server = common::server::spawn(routes).await;

    let data = PreparedBrowserCommand {
        session_id: None,
        headless: true,
        timeout_ms: 30_000,
        on_failure_screenshot: false,
        steps: vec![
            BrowserStep::Navigate {
                url: server.url("/"),
                expected_status: None,
                timeout_ms: None,
                optional: false,
            },
            BrowserStep::WaitFor {
                time: None,
                text: Some("content that will never appear".to_string()),
                text_gone: None,
                timeout_ms: Some(500),
                optional: false,
            },
        ],
    };

    let err = execute(data)
        .await
        .expect_err("execute should fail with a timeout error");
    let msg = err.to_string();
    assert!(
        msg.to_lowercase().contains("wait_for")
            || msg.to_lowercase().contains("timed out")
            || msg.to_lowercase().contains("timeout"),
        "error should mention a timeout or wait_for; got: {msg}"
    );
}

/// Test 1.4 — Navigate to a second page; the last snapshot reflects the second page.
///
/// Two routes are served.  After navigating to each in sequence, a `Snapshot`
/// is taken and its `"text"` field must contain content from the second page.
#[tokio::test]
async fn multi_navigate_snapshot_reflects_last_page() {
    if skip_if_no_chrome() {
        return;
    }

    let _guard = common::chrome_lock().await;

    let mut routes = HashMap::new();
    routes.insert(
        "GET /page1".to_string(),
        common::server::Response::html(
            "<html><head><title>Page One</title></head><body><p>Page One content</p></body></html>",
        ),
    );
    routes.insert(
        "GET /page2".to_string(),
        common::server::Response::html(
            "<html><head><title>Page Two</title></head><body><p>Page Two content</p></body></html>",
        ),
    );
    let server = common::server::spawn(routes).await;

    let data = PreparedBrowserCommand {
        session_id: None,
        headless: true,
        timeout_ms: 30_000,
        on_failure_screenshot: false,
        steps: vec![
            BrowserStep::Navigate {
                url: server.url("/page1"),
                expected_status: None,
                timeout_ms: None,
                optional: false,
            },
            BrowserStep::Navigate {
                url: server.url("/page2"),
                expected_status: None,
                timeout_ms: None,
                optional: false,
            },
            BrowserStep::Snapshot {
                timeout_ms: None,
                optional: false,
            },
        ],
    };

    let result = execute(data).await.expect("execute should succeed");

    let text = result["text"]
        .as_str()
        .expect("snapshot result should have a 'text' string field");
    assert!(
        text.contains("Page Two"),
        "snapshot text should contain 'Page Two' (the second page); got: {text}"
    );
}

/// Test S4 — wait_for with text_gone waits until the text disappears and new
/// text appears.
///
/// Serves a page that initially shows "Loading..." and after 200 ms replaces
/// its content with "Done".  The `WaitFor` step uses both `text_gone` and
/// `text` together so it resolves only after the transition completes.
#[tokio::test]
async fn wait_for_text_gone_waits_until_text_disappears() {
    if skip_if_no_chrome() {
        return;
    }

    let _guard = common::chrome_lock().await;

    let body = r#"<html><body>
<div id="status">Loading...</div>
<script>
setTimeout(function() {
  document.getElementById('status').textContent = 'Done';
}, 200);
</script>
</body></html>"#;

    let mut routes = HashMap::new();
    routes.insert("GET /".to_string(), common::server::Response::html(body));
    let server = common::server::spawn(routes).await;

    let data = PreparedBrowserCommand {
        session_id: None,
        headless: true,
        timeout_ms: 30_000,
        on_failure_screenshot: false,
        steps: vec![
            BrowserStep::Navigate {
                url: server.url("/"),
                expected_status: None,
                timeout_ms: None,
                optional: false,
            },
            // Wait for "Loading..." to disappear AND "Done" to appear.
            BrowserStep::WaitFor {
                time: None,
                text: Some("Done".to_string()),
                text_gone: Some("Loading...".to_string()),
                timeout_ms: Some(5_000),
                optional: false,
            },
            BrowserStep::Evaluate {
                function: "() => document.body.innerText".to_string(),
                r#ref: None,
                timeout_ms: None,
                optional: false,
            },
        ],
    };

    let result = execute(data).await.expect("execute should succeed");

    let text = result["value"]
        .as_str()
        .expect("evaluate should return a string value");
    assert!(
        text.contains("Done"),
        "page text should contain 'Done' after transition; got: {text}"
    );
    assert!(
        !text.contains("Loading"),
        "page text should no longer contain 'Loading' after transition; got: {text}"
    );
}

/// Test S3a — Navigate with `expected_status` succeeds when the server returns
/// that exact status code.
///
/// Registers a `/missing` route that returns HTTP 404 and navigates with
/// `expected_status: Some(404)`.  The command must succeed because the status
/// matches.
#[tokio::test]
async fn navigate_expected_status_succeeds_on_match() {
    if skip_if_no_chrome() {
        return;
    }

    let _guard = common::chrome_lock().await;

    let mut routes = HashMap::new();
    routes.insert(
        "GET /missing".to_string(),
        common::server::Response {
            status: 404,
            content_type: "text/plain",
            body: "gone".to_string(),
            extra_headers: vec![],
        },
    );
    let server = common::server::spawn(routes).await;

    let data = PreparedBrowserCommand {
        session_id: None,
        headless: true,
        timeout_ms: 30_000,
        on_failure_screenshot: false,
        steps: vec![BrowserStep::Navigate {
            url: server.url("/missing"),
            expected_status: Some(404),
            timeout_ms: None,
            optional: false,
        }],
    };

    execute(data)
        .await
        .expect("execute should succeed when expected_status matches the actual status");
}

/// Test S3b — Navigate with `expected_status` fails when the server returns a
/// different status code.
///
/// Navigates to a page that returns HTTP 200 but specifies
/// `expected_status: Some(404)`.  The command must return an error and the
/// error message must mention the status code.
#[tokio::test]
async fn navigate_expected_status_mismatch_fails() {
    if skip_if_no_chrome() {
        return;
    }

    let _guard = common::chrome_lock().await;

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        common::server::Response::html("<html><body>OK</body></html>"),
    );
    let server = common::server::spawn(routes).await;

    let data = PreparedBrowserCommand {
        session_id: None,
        headless: true,
        timeout_ms: 30_000,
        on_failure_screenshot: false,
        steps: vec![BrowserStep::Navigate {
            url: server.url("/"),
            expected_status: Some(404),
            timeout_ms: None,
            optional: false,
        }],
    };

    let err = execute(data)
        .await
        .expect_err("should fail when status doesn't match expected");
    let msg = err.to_string();
    assert!(
        msg.contains("404") || msg.contains("200") || msg.to_lowercase().contains("status"),
        "error message should mention status code; got: {msg}"
    );
}