viewpoint-core 0.2.14

High-level browser automation API for Viewpoint
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
#![cfg(feature = "integration")]

//! Basic ARIA snapshot tests for viewpoint-core.
//!
//! These tests verify basic ARIA accessibility snapshot capture.

use std::sync::Once;
use std::time::Duration;

use viewpoint_core::Browser;

static TRACING_INIT: Once = Once::new();

/// Initialize tracing for tests.
fn init_tracing() {
    TRACING_INIT.call_once(|| {
        tracing_subscriber::fmt()
            .with_env_filter(
                tracing_subscriber::EnvFilter::from_default_env()
                    .add_directive(tracing::Level::INFO.into()),
            )
            .with_test_writer()
            .try_init()
            .ok();
    });
}

// =============================================================================
// Basic Aria Snapshot Tests
// =============================================================================

/// Test basic aria snapshot capture from a simple page.
#[tokio::test]
async fn test_aria_snapshot_simple_page() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <h1>Main Title</h1>
            <button>Click me</button>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    // Capture snapshot
    let snapshot = page.aria_snapshot().await.expect("Failed to get snapshot");

    // Convert to YAML for inspection
    let yaml = snapshot.to_yaml();
    println!("Snapshot YAML:\n{}", yaml);

    // Verify basic structure
    assert!(
        yaml.contains("heading") || yaml.contains("button"),
        "Snapshot should contain heading or button, got: {}",
        yaml
    );

    // Clean up
    browser.close().await.expect("Failed to close browser");
}

// =============================================================================
// Frame Boundary Detection Tests
// =============================================================================

/// Test that iframes are detected as frame boundaries.
#[tokio::test]
async fn test_aria_snapshot_iframe_boundary_detection() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <h1>Main Page</h1>
            <iframe name="myframe" title="Widget Frame" src="about:blank"></iframe>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    // Wait for iframe
    tokio::time::sleep(Duration::from_millis(200)).await;

    // Capture snapshot
    let snapshot = page.aria_snapshot().await.expect("Failed to get snapshot");
    let yaml = snapshot.to_yaml();
    println!("Snapshot with iframe:\n{}", yaml);

    // Verify iframe is marked as frame boundary
    assert!(
        yaml.contains("iframe") || yaml.contains("[frame-boundary]"),
        "Snapshot should contain iframe or frame-boundary marker, got: {}",
        yaml
    );

    // Clean up
    browser.close().await.expect("Failed to close browser");
}

/// Test that iframe_refs are collected.
#[tokio::test]
async fn test_aria_snapshot_iframe_refs_collection() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <h1>Multi-Frame Page</h1>
            <iframe name="frame1" src="about:blank"></iframe>
            <iframe name="frame2" src="about:blank"></iframe>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    // Wait for iframes
    tokio::time::sleep(Duration::from_millis(200)).await;

    // Capture snapshot
    let snapshot = page.aria_snapshot().await.expect("Failed to get snapshot");

    // Check that iframe_refs were collected
    println!("Collected iframe_refs: {:?}", snapshot.iframe_refs);

    // There should be 2 iframes detected
    assert!(
        snapshot.iframe_refs.len() >= 2,
        "Should have at least 2 iframe refs, got: {}",
        snapshot.iframe_refs.len()
    );

    // Clean up
    browser.close().await.expect("Failed to close browser");
}

// =============================================================================
// Frame Snapshot Tests
// =============================================================================

/// Test capturing snapshot from a specific frame.
#[tokio::test]
async fn test_frame_aria_snapshot() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <h1>Main Page</h1>
            <iframe name="contentframe" srcdoc="<html><body><h2>Frame Content</h2><button>Frame Button</button></body></html>"></iframe>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    // Wait for iframe to load
    tokio::time::sleep(Duration::from_millis(300)).await;

    // Get the iframe's frame
    let frames = page.frames().await.expect("Failed to get frames");
    assert!(
        frames.len() >= 2,
        "Should have at least 2 frames (main + iframe)"
    );

    // Find the content frame
    let content_frame = frames
        .iter()
        .find(|f| f.name() == "contentframe")
        .expect("Should find content frame");

    // Capture snapshot from the frame
    let frame_snapshot = content_frame
        .aria_snapshot()
        .await
        .expect("Failed to get frame snapshot");

    let yaml = frame_snapshot.to_yaml();
    println!("Frame snapshot:\n{}", yaml);

    // Verify frame content is captured
    assert!(
        yaml.contains("button") || yaml.contains("heading"),
        "Frame snapshot should contain button or heading, got: {}",
        yaml
    );

    // Clean up
    browser.close().await.expect("Failed to close browser");
}

// =============================================================================
// Multi-Frame Snapshot Tests
// =============================================================================

/// Test capturing snapshot with all frames stitched together.
#[tokio::test]
async fn test_aria_snapshot_with_frames() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <h1>Main Page Title</h1>
            <iframe name="widget" srcdoc="<html><body><button>Widget Button</button></body></html>"></iframe>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    // Wait for iframe to load
    tokio::time::sleep(Duration::from_millis(300)).await;

    // Capture snapshot with frames stitched in
    let snapshot = page
        .aria_snapshot_with_frames()
        .await
        .expect("Failed to get multi-frame snapshot");

    let yaml = snapshot.to_yaml();
    println!("Multi-frame snapshot:\n{}", yaml);

    // The snapshot should contain both main page and frame content
    // (though exact format depends on stitching)
    assert!(
        yaml.contains("heading") || yaml.contains("button"),
        "Multi-frame snapshot should contain page elements, got: {}",
        yaml
    );

    // Clean up
    browser.close().await.expect("Failed to close browser");
}

/// Test nested same-origin frames.
#[tokio::test]
async fn test_aria_snapshot_nested_frames() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    // Create a page with nested iframes using srcdoc
    page.set_content(
        r#"
        <html><body>
            <h1>Level 0</h1>
            <iframe name="level1" srcdoc="<html><body><h2>Level 1</h2><iframe name='level2' srcdoc='<html><body><h3>Level 2</h3></body></html>'></iframe></body></html>"></iframe>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    // Wait for nested iframes to load
    tokio::time::sleep(Duration::from_millis(500)).await;

    // Get all frames
    let frames = page.frames().await.expect("Failed to get frames");
    println!("Total frames: {}", frames.len());

    // Capture multi-frame snapshot
    let snapshot = page
        .aria_snapshot_with_frames()
        .await
        .expect("Failed to get snapshot");

    let yaml = snapshot.to_yaml();
    println!("Nested frames snapshot:\n{}", yaml);

    // Should have content from multiple levels
    assert!(
        yaml.contains("heading") || yaml.contains("Level"),
        "Snapshot should contain heading content"
    );

    // Clean up
    browser.close().await.expect("Failed to close browser");
}

// =============================================================================
// Locator Aria Snapshot Tests
// =============================================================================

// =============================================================================
// Name From Content Tests (W3C ARIA 1.2 "name from content" roles)
// =============================================================================

/// Test that headings correctly extract accessible name from text content.
#[tokio::test]
async fn test_aria_snapshot_heading_accessible_name() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <h1>Main Heading</h1>
            <h2>Secondary Heading</h2>
            <h3>Tertiary Heading</h3>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    let snapshot = page.aria_snapshot().await.expect("Failed to get snapshot");
    let yaml = snapshot.to_yaml();
    println!("Heading snapshot:\n{}", yaml);

    // Headings should have their text content as accessible name
    assert!(
        yaml.contains("\"Main Heading\""),
        "Snapshot should contain heading with name 'Main Heading', got: {}",
        yaml
    );
    assert!(
        yaml.contains("\"Secondary Heading\""),
        "Snapshot should contain heading with name 'Secondary Heading', got: {}",
        yaml
    );
    assert!(
        yaml.contains("\"Tertiary Heading\""),
        "Snapshot should contain heading with name 'Tertiary Heading', got: {}",
        yaml
    );

    browser.close().await.expect("Failed to close browser");
}

/// Test that list items correctly extract accessible name from text content.
#[tokio::test]
async fn test_aria_snapshot_listitem_accessible_name() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <ul>
                <li>First Item</li>
                <li>Second Item</li>
                <li>Third Item</li>
            </ul>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    let snapshot = page.aria_snapshot().await.expect("Failed to get snapshot");
    let yaml = snapshot.to_yaml();
    println!("List item snapshot:\n{}", yaml);

    // List items should have their text content as accessible name
    assert!(
        yaml.contains("\"First Item\""),
        "Snapshot should contain listitem with name 'First Item', got: {}",
        yaml
    );
    assert!(
        yaml.contains("\"Second Item\""),
        "Snapshot should contain listitem with name 'Second Item', got: {}",
        yaml
    );

    browser.close().await.expect("Failed to close browser");
}

/// Test that table cells correctly extract accessible name from text content.
#[tokio::test]
async fn test_aria_snapshot_table_cell_accessible_name() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <table>
                <thead>
                    <tr>
                        <th>Header 1</th>
                        <th>Header 2</th>
                    </tr>
                </thead>
                <tbody>
                    <tr>
                        <td>Cell A</td>
                        <td>Cell B</td>
                    </tr>
                </tbody>
            </table>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    let snapshot = page.aria_snapshot().await.expect("Failed to get snapshot");
    let yaml = snapshot.to_yaml();
    println!("Table cell snapshot:\n{}", yaml);

    // Table headers and cells should have their text content as accessible name
    assert!(
        yaml.contains("\"Header 1\""),
        "Snapshot should contain columnheader with name 'Header 1', got: {}",
        yaml
    );
    assert!(
        yaml.contains("\"Cell A\""),
        "Snapshot should contain cell with name 'Cell A', got: {}",
        yaml
    );

    browser.close().await.expect("Failed to close browser");
}

/// Test that options in select elements extract accessible name from text content.
#[tokio::test]
async fn test_aria_snapshot_option_accessible_name() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <select>
                <option>Option A</option>
                <option>Option B</option>
                <option>Option C</option>
            </select>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    let snapshot = page.aria_snapshot().await.expect("Failed to get snapshot");
    let yaml = snapshot.to_yaml();
    println!("Option snapshot:\n{}", yaml);

    // Select options should have their text content as accessible name
    // Note: the select dropdown may show as combobox with options
    assert!(
        yaml.contains("combobox") || yaml.contains("option"),
        "Snapshot should contain combobox or option, got: {}",
        yaml
    );

    browser.close().await.expect("Failed to close browser");
}

/// Test that menu items extract accessible name from text content.
#[tokio::test]
async fn test_aria_snapshot_menuitem_accessible_name() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <nav role="menu">
                <button role="menuitem">File</button>
                <button role="menuitem">Edit</button>
                <button role="menuitem">View</button>
            </nav>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    let snapshot = page.aria_snapshot().await.expect("Failed to get snapshot");
    let yaml = snapshot.to_yaml();
    println!("Menu item snapshot:\n{}", yaml);

    // Menu items should have their text content as accessible name
    assert!(
        yaml.contains("\"File\""),
        "Snapshot should contain menuitem with name 'File', got: {}",
        yaml
    );
    assert!(
        yaml.contains("\"Edit\""),
        "Snapshot should contain menuitem with name 'Edit', got: {}",
        yaml
    );

    browser.close().await.expect("Failed to close browser");
}

// =============================================================================
// Locator Aria Snapshot Tests
// =============================================================================

/// Test aria_snapshot on a specific locator.
#[tokio::test]
async fn test_locator_aria_snapshot() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content(
        r#"
        <html><body>
            <form id="myform">
                <label for="name">Name:</label>
                <input id="name" type="text" />
                <button type="submit">Submit</button>
            </form>
        </body></html>
    "#,
    )
    .set()
    .await
    .expect("Failed to set content");

    // Capture snapshot of just the form
    let form_snapshot = page
        .locator("#myform")
        .aria_snapshot()
        .await
        .expect("Failed to get form snapshot");

    let yaml = form_snapshot.to_yaml();
    println!("Form snapshot:\n{}", yaml);

    // Should contain form elements
    assert!(
        yaml.contains("form") || yaml.contains("textbox") || yaml.contains("button"),
        "Form snapshot should contain form, textbox, or button, got: {}",
        yaml
    );

    // Clean up
    browser.close().await.expect("Failed to close browser");
}