1#!/usr/bin/env python3
2
3import os
4import pathlib
5import plistlib
6import re
7
8import pytest
9from pytest_httpserver import HTTPServer
10
11from utils import save_safari_webarchive
12
13
14def test_creates_a_single_archive(out_path: pathlib.Path) -> None:
15    result = save_safari_webarchive(["https://example.com", out_path])
16
17    assert result["returncode"] == 0
18    assert result["stdout"] is not None
19    assert result["stderr"] is None
20    assert out_path.exists()
21
22    with open(out_path, "rb") as in_file:
23        webarchive = plistlib.load(in_file)
24
25    main_resource = webarchive["WebMainResource"]
26
27    assert main_resource["WebResourceURL"] == "https://example.com/"
28    assert (
29        main_resource["WebResourceData"]
30        == open("tests/fixtures/example.com.html", "rb").read()
31    )
32
33
34def test_does_not_overwrite_existing_archive(out_path: pathlib.Path) -> None:
35    out_path.write_text("This should still be here later")
36
37    result = save_safari_webarchive(["https://example.com", out_path])
38
39    assert result == {
40        "returncode": 1,
41        "stdout": None,
42        "stderr": (
43            "Unable to save webarchive file: "
44            "The file “example.webarchive” couldn’t be saved in the folder "
45            "“test_does_not_overwrite_existi0” because a file with "
46            "the same name already exists.\n"
47        ),
48    }
49
50    assert out_path.read_text() == "This should still be here later"
51
52
53@pytest.mark.parametrize(
54    "argv",
55    [
56        pytest.param([], id="no_arguments"),
57        pytest.param(["https://example.com"], id="not_enough_arguments"),
58        pytest.param(
59            ["https://example.com", "example.webarchive", "--debug"],
60            id="too_many_arguments",
61        ),
62    ],
63)
64def test_it_fails_if_you_supply_the_wrong_arguments(argv: list[str]) -> None:
65    result = save_safari_webarchive(argv)
66
67    assert result == {
68        "returncode": 1,
69        "stdout": None,
70        "stderr": "Usage: save_safari_webarchive.swift <URL> <OUTPUT_PATH>\n",
71    }
72
73
74@pytest.mark.parametrize("status_code", ["403", "404", "410", "500"])
75def test_it_fails_if_non_200_status_code(
76    httpserver: HTTPServer, status_code: str, out_path: pathlib.Path
77) -> None:
78    httpserver.expect_request("/error").respond_with_data(
79        "Boom!", status=int(status_code), content_type="text/plain"
80    )
81    url = f"http://localhost:{httpserver.port}/error"
82
83    result = save_safari_webarchive([url, out_path])
84
85    assert result == {
86        "returncode": 1,
87        "stdout": None,
88        "stderr": f"Failed to load {url}: got status code {status_code}\n",
89    }
90
91    assert not out_path.exists()
92
93
94def test_it_fails_if_cannot_load_domain(out_path: pathlib.Path) -> None:
95    result = save_safari_webarchive(["https://doesnotexist.tk/", out_path])
96
97    assert result == {
98        "returncode": 1,
99        "stdout": None,
100        "stderr": "Failed to load https://doesnotexist.tk/: A server with the specified hostname could not be found.\n",
101    }
102
103    assert not out_path.exists()
104
105
106# If I run this test in GitHub Actions, I get a warning to stderr but
107# the archive is saved correctly:
108#
109#     CFURLCopyResourcePropertyForKey failed because it was passed a URL which
110#     has no scheme
111#
112# This test passes locally; leave it for now -- I can come back to this.
113@pytest.mark.skipif(
114    os.getenv("CI") == "true",
115    reason="This test doesn’t work correctly in GitHub Actions",
116)
117def test_it_fails_if_url_is_invalid(out_path: pathlib.Path) -> None:
118    result = save_safari_webarchive([">", out_path])
119
120    assert result == {
121        "returncode": 1,
122        "stdout": None,
123        "stderr": "Unable to use > as a URL\n",
124    }
125
126    assert not out_path.exists()
127
128
129def test_prints_the_version() -> None:
130    result = save_safari_webarchive(["--version"])
131
132    assert result["returncode"] == 0
133    assert result["stderr"] is None
134    assert re.match(
135        r"^save_safari_webarchive.swift [0-9]+\.[0-9]+\.[0-9]+\n$", result["stdout"]
136    ), result["stdout"]