viewpoint-core 0.4.3

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

#![cfg(feature = "integration")]

//! PDF content and output tests for viewpoint-core.
//!
//! These tests verify PDF generation content options including
//! headers, footers, page ranges, backgrounds, and file saving.

mod common;

use std::time::Duration;
use tempfile::TempDir;

use viewpoint_core::{Browser, Margins, PaperFormat};

use common::init_tracing;

// =============================================================================
// Test HTML Templates
// =============================================================================

const SIMPLE_HTML: &str = r"
<!DOCTYPE html>
<html>
<head>
    <title>Test PDF Document</title>
    <style>
        body { font-family: Arial, sans-serif; margin: 40px; }
        h1 { color: #333; }
        p { line-height: 1.6; }
    </style>
</head>
<body>
    <h1>PDF Generation Test</h1>
    <p>This is a test document for PDF generation.</p>
    <p>It contains multiple paragraphs of text to test formatting.</p>
</body>
</html>
";

const MULTI_PAGE_HTML: &str = r#"
<!DOCTYPE html>
<html>
<head>
    <title>Multi-Page Document</title>
    <style>
        body { font-family: Arial, sans-serif; margin: 40px; }
        .page { page-break-after: always; min-height: 100vh; }
        .page:last-child { page-break-after: auto; }
    </style>
</head>
<body>
    <div class="page"><h1>Page 1</h1><p>Content of first page.</p></div>
    <div class="page"><h1>Page 2</h1><p>Content of second page.</p></div>
    <div class="page"><h1>Page 3</h1><p>Content of third page.</p></div>
    <div class="page"><h1>Page 4</h1><p>Content of fourth page.</p></div>
    <div class="page"><h1>Page 5</h1><p>Content of fifth page.</p></div>
</body>
</html>
"#;

const BACKGROUND_HTML: &str = r"
<!DOCTYPE html>
<html>
<head>
    <title>Background Test</title>
    <style>
        body { 
            font-family: Arial, sans-serif; 
            background-color: #f0f0f0;
            background-image: linear-gradient(to right, #f0f0f0, #e0e0e0);
        }
        h1 { color: #333; background-color: #yellow; padding: 10px; }
    </style>
</head>
<body>
    <h1>Background Graphics Test</h1>
    <p>This document has background colors and gradients.</p>
</body>
</html>
";

// =============================================================================
// Header and Footer Tests
// =============================================================================

/// Test generating a PDF with header template.
#[tokio::test]
async fn test_pdf_header_template() {
    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(SIMPLE_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(100)).await;

    let header = r#"<div style="font-size: 10px; text-align: center; width: 100%;">Header - <span class="title"></span></div>"#;

    let pdf_data = page
        .pdf()
        .header_template(header)
        .generate()
        .await
        .expect("Failed to generate PDF");

    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

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

/// Test generating a PDF with footer template.
#[tokio::test]
async fn test_pdf_footer_template() {
    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(SIMPLE_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(100)).await;

    let footer = r#"<div style="font-size: 10px; text-align: center; width: 100%;">Page <span class="pageNumber"></span> of <span class="totalPages"></span></div>"#;

    let pdf_data = page
        .pdf()
        .footer_template(footer)
        .generate()
        .await
        .expect("Failed to generate PDF");

    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

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

/// Test generating a PDF with both header and footer.
#[tokio::test]
async fn test_pdf_header_footer_combined() {
    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(SIMPLE_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(100)).await;

    let header = r#"<div style="font-size: 10px;">Document Header</div>"#;
    let footer = r#"<div style="font-size: 10px;">Page <span class="pageNumber"></span></div>"#;

    let pdf_data = page
        .pdf()
        .header_template(header)
        .footer_template(footer)
        .generate()
        .await
        .expect("Failed to generate PDF");

    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

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

// =============================================================================
// Page Range Tests
// =============================================================================

/// Test generating a PDF with specific page ranges.
#[tokio::test]
async fn test_pdf_page_ranges() {
    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(MULTI_PAGE_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(200)).await;

    // Generate PDF with only pages 1-3
    let pdf_data = page
        .pdf()
        .page_ranges("1-3")
        .generate()
        .await
        .expect("Failed to generate PDF");

    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

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

/// Test generating a PDF with non-contiguous page ranges.
#[tokio::test]
async fn test_pdf_page_ranges_non_contiguous() {
    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(MULTI_PAGE_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(200)).await;

    // Generate PDF with pages 1-2 and 5
    let pdf_data = page
        .pdf()
        .page_ranges("1-2, 5")
        .generate()
        .await
        .expect("Failed to generate PDF");

    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

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

// =============================================================================
// Background Graphics Tests
// =============================================================================

/// Test generating a PDF with background graphics.
#[tokio::test]
async fn test_pdf_background_graphics() {
    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(BACKGROUND_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(100)).await;

    let pdf_data = page
        .pdf()
        .print_background(true)
        .generate()
        .await
        .expect("Failed to generate PDF");

    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

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

/// Test generating a PDF without background graphics.
#[tokio::test]
async fn test_pdf_no_background_graphics() {
    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(BACKGROUND_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(100)).await;

    let pdf_data = page
        .pdf()
        .print_background(false)
        .generate()
        .await
        .expect("Failed to generate PDF");

    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

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

// =============================================================================
// Save to File Tests
// =============================================================================

/// Test saving PDF to file.
#[tokio::test]
async fn test_pdf_save_to_file() {
    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(SIMPLE_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(100)).await;

    // Create a temp directory for the PDF
    let temp_dir = TempDir::new().expect("Failed to create temp dir");
    let pdf_path = temp_dir.path().join("test-output.pdf");

    let pdf_data = page
        .pdf()
        .path(&pdf_path)
        .generate()
        .await
        .expect("Failed to generate PDF");

    // Verify data was returned
    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

    // Verify file was created
    assert!(pdf_path.exists(), "PDF file should exist");

    // Verify file content
    let file_content = std::fs::read(&pdf_path).expect("Failed to read PDF file");
    assert_eq!(
        file_content, pdf_data,
        "File content should match returned data"
    );

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

// =============================================================================
// Combined Options Tests
// =============================================================================

/// Test generating a PDF with multiple options combined.
#[tokio::test]
async fn test_pdf_combined_options() {
    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(MULTI_PAGE_HTML)
        .set()
        .await
        .expect("Failed to set content");
    tokio::time::sleep(Duration::from_millis(200)).await;

    let header = r#"<div style="font-size: 10px;">My Document</div>"#;
    let footer = r#"<div style="font-size: 10px;">Page <span class="pageNumber"></span></div>"#;

    let pdf_data = page
        .pdf()
        .format(PaperFormat::A4)
        .landscape(true)
        .margins(Margins::new(1.0, 0.75, 1.0, 0.75))
        .print_background(true)
        .header_template(header)
        .footer_template(footer)
        .page_ranges("1-3")
        .scale(0.8)
        .generate()
        .await
        .expect("Failed to generate PDF");

    assert!(!pdf_data.is_empty());
    assert!(pdf_data.starts_with(b"%PDF-"));

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

// =============================================================================
// Error Handling Tests
// =============================================================================

/// Test PDF generation on closed page returns error.
#[tokio::test]
async fn test_pdf_on_closed_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 mut page = context.new_page().await.expect("Failed to create page");

    page.set_content(SIMPLE_HTML)
        .set()
        .await
        .expect("Failed to set content");

    // Close the page
    page.close().await.expect("Failed to close page");
    assert!(page.is_closed());

    // Try to generate PDF on closed page
    let result = page.pdf().generate().await;
    assert!(result.is_err(), "PDF generation on closed page should fail");

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