viewpoint-test 0.3.5

Test framework for Viewpoint browser automation with Playwright-style assertions
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

//! Example: Test with `#[viewpoint::test]` Macro
//!
//! This example demonstrates the secondary API using the proc macro
//! for convenient test setup. The macro handles TestHarness creation
//! and cleanup automatically.
//!
//! Note: This file shows how tests would be written. Since examples
//! are run with `cargo run`, and the macro generates test functions,
//! this example primarily serves as documentation.
//!
//! In a real test file, you would use:
//! ```no_run
//! use viewpoint_core::page::Page;
//! use viewpoint_test::TestError;
//!
//! # /*
//! #[viewpoint_test::test]
//! async fn my_test(page: &Page) -> Result<(), TestError> {
//!     // test code
//!     Ok(())
//! }
//! # */
//! ```

use viewpoint_core::DocumentLoadState;
use viewpoint_test::{TestError, TestHarness, expect_page};

/// Example of what the macro expands to.
///
/// The `#[viewpoint_test::test]` macro would transform:
/// ```no_run
/// use viewpoint_core::page::Page;
/// use viewpoint_test::{expect_page, TestError};
///
/// # /*
/// #[viewpoint_test::test]
/// async fn example_test(page: &Page) -> Result<(), TestError> {
///     page.goto("https://example.com").goto().await?;
///     expect_page(page).to_have_title("Example Domain").await?;
///     Ok(())
/// }
/// # */
/// ```
///
/// Into something like:
/// ```no_run
/// use viewpoint_test::{expect_page, TestError, TestHarness};
///
/// # /*
/// #[tokio::test]
/// # */
/// async fn example_test() -> Result<(), TestError> {
///     let _harness = TestHarness::new().await?;
///     let page = _harness.page();
///     
///     // Original test body:
///     page.goto("https://example.com").goto().await?;
///     expect_page(page).to_have_title("Example Domain").await?;
///     Ok(())
/// }
/// ```
async fn expanded_test_example() -> Result<(), TestError> {
    let harness = TestHarness::new().await?;
    let page = harness.page();

    page.goto("https://example.com")
        .wait_until(DocumentLoadState::DomContentLoaded)
        .goto()
        .await
        .map_err(|e| TestError::Core(e.into()))?;

    expect_page(page)
        .to_have_title("Example Domain")
        .await
        .map_err(TestError::Assertion)?;

    Ok(())
}

/// Example with configuration options.
///
/// The macro supports various configuration options:
/// ```no_run
/// use viewpoint_core::page::Page;
/// use viewpoint_test::TestError;
///
/// # /*
/// #[viewpoint_test::test(headless = false, timeout = 60000)]
/// async fn visible_test(page: &Page) -> Result<(), TestError> {
///     // Test runs with visible browser and 60s timeout
///     Ok(())
/// }
/// # */
/// ```
async fn configured_test_example() -> Result<(), TestError> {
    use std::time::Duration;

    let harness = TestHarness::builder()
        .headless(false)
        .timeout(Duration::from_secs(60))
        .build()
        .await?;

    let page = harness.page();

    page.goto("https://example.com")
        .wait_until(DocumentLoadState::DomContentLoaded)
        .goto()
        .await
        .map_err(|e| TestError::Core(e.into()))?;

    Ok(())
}

/// Example with module-scoped browser.
///
/// For faster test suites, share a browser across tests:
/// ```no_run
/// use std::sync::OnceLock;
/// use viewpoint_core::browser::Browser;
/// use viewpoint_core::page::Page;
/// use viewpoint_test::TestError;
///
/// // In your test module:
/// static BROWSER: OnceLock<Browser> = OnceLock::new();
///
/// fn shared_browser() -> &'static Browser {
///     BROWSER.get_or_init(|| {
///         tokio::runtime::Runtime::new().unwrap()
///             .block_on(Browser::launch().headless(true).launch())
///             .unwrap()
///     })
/// }
///
/// # /*
/// #[viewpoint_test::test(scope = "browser", browser = "shared_browser")]
/// async fn fast_test_1(page: &Page) -> Result<(), TestError> {
///     // Uses shared browser, but fresh context and page
///     Ok(())
/// }
///
/// #[viewpoint_test::test(scope = "browser", browser = "shared_browser")]  
/// async fn fast_test_2(page: &Page) -> Result<(), TestError> {
///     // Also uses shared browser
///     Ok(())
/// }
/// # */
/// ```

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("=== Viewpoint Macro Example ===\n");

    println!("This example demonstrates the #[viewpoint_test::test] macro.\n");

    println!("Running expanded_test_example...");
    expanded_test_example().await?;
    println!("  Passed!\n");

    println!("Running configured_test_example (non-headless)...");
    configured_test_example().await?;
    println!("  Passed!\n");

    println!("=== All Examples Complete ===");

    Ok(())
}