petrify 0.2.0

Petrify live websites into static offline copies
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

use petrify::config::Config;
use petrify::engine::Petrifier;
use std::fs;
use tempfile::TempDir;
use wiremock::matchers::{method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

const INDEX_HTML: &str = r#"<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta property="og:image" content="/og.png">
<meta name="twitter:image" content="/og.png">
</head>
<body>
<img src="logo.png" alt="logo">
<div style="background-image: url(/hero.jpg);"></div>
<img class="uk-invisible" src="" alt="">
<a href="/#section">Section</a>
<a href="about.html">About</a>
<script src="script.js"></script>
<link rel="preload" href="/fonts/brand.woff2" as="font" type="font/woff2">
</body>
</html>"#;

const ABOUT_HTML: &str = r#"<!DOCTYPE html><html><body>
<p>About</p>
<a href="https://cdn.example.com/remote.png">remote</a>
<img src="https://cdn.example.com/remote.png" alt="remote">
<link rel="stylesheet" href="style.css">
</body></html>"#;

fn tiny_png() -> Vec<u8> {
    let img = image::RgbaImage::from_pixel(1, 1, image::Rgba([0, 128, 255, 255]));
    let mut buf = Vec::new();
    img.write_to(&mut std::io::Cursor::new(&mut buf), image::ImageFormat::Png)
        .unwrap();
    buf
}

fn tiny_jpeg() -> Vec<u8> {
    let img = image::RgbImage::from_pixel(1, 1, image::Rgb([255, 0, 0]));
    let mut buf = Vec::new();
    img.write_to(
        &mut std::io::Cursor::new(&mut buf),
        image::ImageFormat::Jpeg,
    )
    .unwrap();
    buf
}

async fn mount_test_site(server: &MockServer) {
    Mock::given(method("GET"))
        .and(path("/"))
        .respond_with(ResponseTemplate::new(200).set_body_string(INDEX_HTML))
        .mount(server)
        .await;
    Mock::given(method("GET"))
        .and(path("/style.css"))
        .respond_with(ResponseTemplate::new(200).set_body_string(
            "@font-face { font-family: Brand; src: url(/fonts/brand.woff2); } body { color: black; }",
        ))
        .mount(server)
        .await;
    Mock::given(method("GET"))
        .and(path("/script.js"))
        .respond_with(ResponseTemplate::new(200).set_body_string("console.log('petrify');"))
        .mount(server)
        .await;
    Mock::given(method("GET"))
        .and(path("/logo.png"))
        .respond_with(ResponseTemplate::new(200).set_body_bytes(tiny_png()))
        .mount(server)
        .await;
    Mock::given(method("GET"))
        .and(path("/og.png"))
        .respond_with(ResponseTemplate::new(200).set_body_bytes(tiny_png()))
        .mount(server)
        .await;
    Mock::given(method("GET"))
        .and(path("/hero.jpg"))
        .respond_with(ResponseTemplate::new(200).set_body_bytes(tiny_jpeg()))
        .mount(server)
        .await;
    Mock::given(method("GET"))
        .and(path("/fonts/brand.woff2"))
        .respond_with(
            ResponseTemplate::new(200)
                .set_body_bytes(b"wOFF2fake")
                .insert_header("content-type", "font/woff2"),
        )
        .mount(server)
        .await;
    Mock::given(method("GET"))
        .and(path("/about.html"))
        .respond_with(ResponseTemplate::new(200).set_body_string(ABOUT_HTML))
        .mount(server)
        .await;
}

fn test_config(server_uri: &str, output: &str) -> Config {
    let mut config = Config::new();
    config.url = server_uri.to_string();
    config.output = output.to_string();
    config.max_concurrent = 2;
    config.convert_to_webp = false;
    config.timeout = 10;
    config
}

#[tokio::test]
async fn run_petrifies_site_end_to_end() {
    let server = MockServer::start().await;
    mount_test_site(&server).await;

    let dir = TempDir::new().unwrap();
    let output = dir.path().join("out").to_string_lossy().to_string();
    let mut config = test_config(&server.uri(), &output);
    config.max_pages = 0;

    let mut petrifier = Petrifier::new(config).await.unwrap();
    petrifier.run().await.unwrap();

    let index = dir.path().join("out/index.html");
    assert!(index.exists(), "index.html should be written");
    let index_body = fs::read_to_string(index).unwrap();
    assert!(index_body.contains("/static/css/style.css"));
    assert!(index_body.contains("/static/js/script.js"));
    assert!(index_body.contains("</body>"));
    assert!(!index_body.contains("//static/"));

    assert!(dir.path().join("out/static/css/style.css").exists());
    assert!(dir.path().join("out/static/js/script.js").exists());
    assert!(dir.path().join("out/static/images/logo.png").exists());
    assert!(dir.path().join("out/about.html").exists());
}

#[tokio::test]
async fn run_respects_max_pages_limit() {
    let server = MockServer::start().await;
    mount_test_site(&server).await;

    let dir = TempDir::new().unwrap();
    let output = dir.path().join("out").to_string_lossy().to_string();
    let mut config = test_config(&server.uri(), &output);
    config.max_pages = 1;

    let mut petrifier = Petrifier::new(config).await.unwrap();
    petrifier.run().await.unwrap();

    assert!(dir.path().join("out/index.html").exists());
    // about.html should not be processed when page limit is 1
    assert!(!dir.path().join("out/about.html").exists());
}

#[tokio::test]
async fn run_honors_download_only_filter() {
    let server = MockServer::start().await;
    mount_test_site(&server).await;

    let dir = TempDir::new().unwrap();
    let output = dir.path().join("out").to_string_lossy().to_string();
    let mut config = test_config(&server.uri(), &output);
    config.max_pages = 1;
    config.download_only = vec!["html".to_string()];

    let mut petrifier = Petrifier::new(config).await.unwrap();
    petrifier.run().await.unwrap();

    assert!(dir.path().join("out/index.html").exists());
    assert!(!dir.path().join("out/static/css/style.css").exists());
    assert!(!dir.path().join("out/static/js/script.js").exists());
}

#[tokio::test]
async fn run_converts_images_to_webp_when_enabled() {
    let server = MockServer::start().await;
    mount_test_site(&server).await;

    let dir = TempDir::new().unwrap();
    let output = dir.path().join("out").to_string_lossy().to_string();
    let mut config = test_config(&server.uri(), &output);
    config.max_pages = 1;
    config.convert_to_webp = true;
    config.download_only = vec!["html".to_string(), "images".to_string()];

    let mut petrifier = Petrifier::new(config).await.unwrap();
    petrifier.run().await.unwrap();

    assert!(dir.path().join("out/static/images/logo.webp").exists());
    assert!(!dir.path().join("out/static/images/logo.png").exists());

    let index_body = fs::read_to_string(dir.path().join("out/index.html")).unwrap();
    assert!(
        index_body.contains("/static/images/logo.webp"),
        "HTML should reference the converted webp path"
    );
    assert!(!index_body.contains("logo.png"));
}

#[tokio::test]
async fn run_downloads_seo_meta_and_style_background_images() {
    let server = MockServer::start().await;
    mount_test_site(&server).await;

    let dir = TempDir::new().unwrap();
    // Trailing slash previously produced //static/... protocol-relative URLs.
    let output = dir.path().join("out").to_string_lossy().to_string() + "/";
    let mut config = test_config(&server.uri(), &output);
    config.max_pages = 1;
    config.convert_to_webp = true;

    let mut petrifier = Petrifier::new(config).await.unwrap();
    petrifier.run().await.unwrap();

    let index_body = fs::read_to_string(dir.path().join("out/index.html")).unwrap();
    assert!(index_body.contains(r#"content="/static/images/og.webp""#));
    assert!(index_body.contains("url(/static/images/hero.webp)"));
    assert!(index_body.contains(r#"href="/index.html#section""#));
    assert!(!index_body.contains("%23"));
    assert!(!index_body.contains("//static/"));
    assert!(index_body.contains("</body>"));
    assert!(
        index_body.contains(r#"src="""#),
        "empty src should be preserved"
    );

    assert!(dir.path().join("out/static/images/og.webp").exists());
    assert!(dir.path().join("out/static/images/hero.webp").exists());
}

#[tokio::test]
async fn run_downloads_fonts_by_default() {
    let server = MockServer::start().await;
    mount_test_site(&server).await;

    let dir = TempDir::new().unwrap();
    let output = dir.path().join("out").to_string_lossy().to_string();
    let mut config = test_config(&server.uri(), &output);
    config.max_pages = 1;
    // Use Config::new() defaults for download_only (includes fonts).
    assert!(
        config.download_only.iter().any(|t| t == "fonts"),
        "fonts should be in the default download list"
    );

    let mut petrifier = Petrifier::new(config).await.unwrap();
    petrifier.run().await.unwrap();

    assert!(
        dir.path().join("out/static/fonts/brand.woff2").exists(),
        "font file should be downloaded with default filters"
    );
    let index_body = fs::read_to_string(dir.path().join("out/index.html")).unwrap();
    assert!(index_body.contains("/static/fonts/brand.woff2"));
}

#[tokio::test]
async fn run_mirrors_absolute_same_host_images_as_site_root_webp() {
    let server = MockServer::start().await;

    let about_with_abs = format!(
        r#"<!DOCTYPE html><html><body>
<img src="{}/cdn/remote.png" alt="remote">
</body></html>"#,
        server.uri()
    );

    Mock::given(method("GET"))
        .and(path("/about.html"))
        .respond_with(ResponseTemplate::new(200).set_body_string(about_with_abs))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/cdn/remote.png"))
        .respond_with(ResponseTemplate::new(200).set_body_bytes(tiny_png()))
        .mount(&server)
        .await;

    let dir = TempDir::new().unwrap();
    let output = dir.path().join("out").to_string_lossy().to_string();
    let mut config = test_config(&server.uri(), &output);
    config.url = format!("{}/about.html", server.uri());
    config.max_pages = 1;
    config.convert_to_webp = true;
    config.download_only = vec!["html".to_string(), "images".to_string()];

    let mut petrifier = Petrifier::new(config).await.unwrap();
    petrifier.run().await.unwrap();

    assert!(dir.path().join("out/about.html").exists());
    assert!(dir.path().join("out/static/images/remote.webp").exists());
    let about_body = fs::read_to_string(dir.path().join("out/about.html")).unwrap();
    assert!(about_body.contains(r#"src="/static/images/remote.webp""#));
    assert!(!about_body.contains("/cdn/remote.png"));
}