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

//! Use-case tests: multi-step assertion steps (Group 9).
mod common;
use common::{Response, execute, skip_if_no_chrome, spawn};
use earl_protocol_browser::PreparedBrowserCommand;
use earl_protocol_browser::schema::BrowserStep;
use std::collections::HashMap;

/// Test 9.1 — verify_text_visible passes when text is present.
#[tokio::test]
async fn verify_text_visible_passes_when_text_present() {
    if skip_if_no_chrome() {
        return;
    }

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

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        Response::html("<html><body><p>Order confirmed</p></body></html>"),
    );
    let 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::VerifyTextVisible {
                text: "Order confirmed".to_string(),
                optional: false,
            },
        ],
    };

    execute(data).await.expect(
        "VerifyTextVisible should succeed when the text 'Order confirmed' is present in the DOM",
    );
}

/// Test 9.2 — verify_text_visible fails when text is absent.
#[tokio::test]
async fn verify_text_visible_fails_when_text_absent() {
    if skip_if_no_chrome() {
        return;
    }

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

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        Response::html("<html><body><p>Nothing here</p></body></html>"),
    );
    let 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::VerifyTextVisible {
                text: "Order confirmed".to_string(),
                optional: false,
            },
        ],
    };

    let result = execute(data).await;
    assert!(
        result.is_err(),
        "VerifyTextVisible should fail with an error when 'Order confirmed' is not present; got Ok: {:?}",
        result.ok()
    );
}

/// Test 9.3 — verify_element_visible passes when element exists.
#[tokio::test]
async fn verify_element_visible_passes_when_element_exists() {
    if skip_if_no_chrome() {
        return;
    }

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

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        Response::html(
            r#"<html><body><button role="button" aria-label="Submit">Submit</button></body></html>"#,
        ),
    );
    let 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::VerifyElementVisible {
                role: Some("button".to_string()),
                accessible_name: Some("Submit".to_string()),
                optional: false,
            },
        ],
    };

    execute(data).await.expect(
        "VerifyElementVisible should succeed when a button with aria-label 'Submit' is present",
    );
}

/// Test 9.4 — verify_element_visible fails when the element is absent (Issue I4).
#[tokio::test]
async fn verify_element_visible_fails_when_element_absent() {
    if skip_if_no_chrome() {
        return;
    }

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

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        Response::html("<html><body><p>No ghost here</p></body></html>"),
    );
    let 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::VerifyElementVisible {
                role: Some("button".to_string()),
                accessible_name: Some("ghost".to_string()),
                optional: false,
            },
        ],
    };

    let err = execute(data)
        .await
        .expect_err("should fail when element is absent");
    let msg = err.to_string().to_lowercase();
    assert!(
        msg.contains("ghost") || msg.contains("not found") || msg.contains("visible"),
        "error message should mention 'ghost', 'not found', or 'visible'; got: {err}"
    );
}

/// Test 9.5 — verify_list_visible passes when all items are present (Issue I5).
#[tokio::test]
async fn verify_list_visible_passes_when_all_items_present() {
    if skip_if_no_chrome() {
        return;
    }

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

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        Response::html(
            "<html><body><ul><li>Apple</li><li>Banana</li><li>Cherry</li></ul></body></html>",
        ),
    );
    let 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::VerifyListVisible {
                r#ref: None,
                items: vec![
                    "Apple".to_string(),
                    "Banana".to_string(),
                    "Cherry".to_string(),
                ],
                optional: false,
            },
        ],
    };

    execute(data)
        .await
        .expect("VerifyListVisible should succeed when all items are present in the DOM");
}

/// Test 9.6 — verify_list_visible fails when an item is missing (Issue I5).
#[tokio::test]
async fn verify_list_visible_fails_when_item_missing() {
    if skip_if_no_chrome() {
        return;
    }

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

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        Response::html(
            "<html><body><ul><li>Apple</li><li>Banana</li><li>Cherry</li></ul></body></html>",
        ),
    );
    let 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::VerifyListVisible {
                r#ref: None,
                items: vec![
                    "Apple".to_string(),
                    "Banana".to_string(),
                    "Durian".to_string(),
                ],
                optional: false,
            },
        ],
    };

    execute(data)
        .await
        .expect_err("should fail when item 'Durian' is missing from the page");
}

/// Test 9.7 — verify_value matches the value attribute of a focused input field (Issue I5).
#[tokio::test]
async fn verify_value_matches_input_field_value() {
    if skip_if_no_chrome() {
        return;
    }

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

    let mut routes = HashMap::new();
    routes.insert(
        "GET /".to_string(),
        Response::html(r#"<html><body><input id="price" value="42.00"></body></html>"#),
    );
    let 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,
            },
            // Focus the input so that step_verify_value picks it up via document.activeElement.
            BrowserStep::Evaluate {
                function: "() => { document.getElementById('price').focus(); return true; }"
                    .to_string(),
                r#ref: None,
                timeout_ms: None,
                optional: false,
            },
            BrowserStep::VerifyValue {
                r#ref: None,
                value: "42.00".to_string(),
                optional: false,
            },
        ],
    };

    let result = execute(data)
        .await
        .expect("VerifyValue should succeed when the focused input has value '42.00'");
    assert_eq!(
        result["ok"],
        serde_json::Value::Bool(true),
        "VerifyValue result should be {{\"ok\": true}}; got: {result}"
    );
}