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
|
from __future__ import annotations
import hashlib
import json
import os
import shutil
import subprocess
import tempfile
import unittest
from pathlib import Path
REPO_ROOT = Path(__file__).resolve().parents[1]
INSTALLER = REPO_ROOT / "distribution" / "install.sh"
REQUIRED_COMMANDS = ("awk", "cat", "chmod", "cp", "mkdir", "mktemp", "mv", "rm")
@unittest.skipUnless(os.name == "posix", "Unix installer requires a POSIX host")
class UnixInstallerTests(unittest.TestCase):
def setUp(self) -> None:
self.temp_dir = tempfile.TemporaryDirectory(prefix="herdr-installer-test-")
self.root = Path(self.temp_dir.name)
self.bin_dir = self.root / "bin"
self.bin_dir.mkdir()
self.install_dir = self.root / "install"
self.payload = self.root / "payload"
self.payload.write_bytes(b"fake-herdr-binary\n")
self.expected_sha256 = hashlib.sha256(self.payload.read_bytes()).hexdigest()
for command in REQUIRED_COMMANDS:
path = shutil.which(command)
if path is None:
self.fail(f"test host is missing required command: {command}")
(self.bin_dir / command).symlink_to(path)
self._write_executable(
"uname",
"""#!/bin/sh
case "$1" in
-s) echo Linux ;;
-m) echo x86_64 ;;
-o)
[ "${FAKE_UNAME_OS_UNAVAILABLE:-}" != "1" ] || exit 1
echo "${FAKE_UNAME_OS:-GNU/Linux}"
;;
*) exit 1 ;;
esac
""",
)
self._write_executable(
"curl",
"""#!/bin/sh
: > "$FAKE_CURL_MARKER"
out=""
previous=""
for argument in "$@"; do
if [ "$previous" = "-o" ]; then
out="$argument"
break
fi
previous="$argument"
done
if [ -n "$out" ]; then
cp "$FAKE_PAYLOAD" "$out"
else
cat "$FAKE_MANIFEST"
fi
""",
)
def tearDown(self) -> None:
self.temp_dir.cleanup()
def _write_executable(self, name: str, content: str) -> None:
path = self.bin_dir / name
path.write_text(content, encoding="utf-8")
path.chmod(0o755)
def _select_checksum_tool(self, tool: str) -> None:
if tool == "sha256sum":
path = shutil.which("sha256sum")
if path is None:
self.fail("test host is missing sha256sum")
(self.bin_dir / "sha256sum").symlink_to(path)
return
if tool == "shasum":
sha256sum = shutil.which("sha256sum")
if sha256sum is None:
self.fail("test host is missing sha256sum for the shasum fixture")
self._write_executable(
"shasum",
f"""#!/bin/sh
[ "$1" = "-a" ] && [ "$2" = "256" ] || exit 2
shift 2
exec {sha256sum} "$@"
""",
)
return
if tool == "openssl":
path = shutil.which("openssl")
if path is None:
self.fail("test host is missing openssl")
(self.bin_dir / "openssl").symlink_to(path)
return
self.fail(f"unknown checksum tool fixture: {tool}")
def _write_manifest(self, checksum: str | None) -> Path:
manifest: dict[str, object] = {
"version": "9.9.9",
"assets": {
"linux-x86_64": "https://example.invalid/herdr-linux-x86_64"
},
}
if checksum is not None:
manifest["sha256"] = {"linux-x86_64": checksum}
path = self.root / "latest.json"
path.write_text(json.dumps(manifest, indent=2) + "\n", encoding="utf-8")
return path
def _run_installer(
self,
checksum: str | None,
tool: str = "sha256sum",
extra_env: dict[str, str] | None = None,
) -> subprocess.CompletedProcess[str]:
self._select_checksum_tool(tool)
manifest = self._write_manifest(checksum)
env = {
**os.environ,
"PATH": str(self.bin_dir),
"FAKE_MANIFEST": str(manifest),
"FAKE_PAYLOAD": str(self.payload),
"FAKE_CURL_MARKER": str(self.root / "curl-called"),
"HERDR_INSTALL_DIR": str(self.install_dir),
**(extra_env or {}),
}
return subprocess.run(
["/bin/sh", str(INSTALLER)],
env=env,
capture_output=True,
text=True,
check=False,
)
def test_valid_download_uses_each_supported_checksum_tool(self) -> None:
for tool in ("sha256sum", "shasum", "openssl"):
with self.subTest(tool=tool):
shutil.rmtree(self.install_dir, ignore_errors=True)
for name in ("sha256sum", "shasum", "openssl"):
(self.bin_dir / name).unlink(missing_ok=True)
result = self._run_installer(self.expected_sha256.upper(), tool)
self.assertEqual(result.returncode, 0, result.stderr)
self.assertEqual((self.install_dir / "herdr").read_bytes(), self.payload.read_bytes())
def test_android_is_rejected_before_replacing_existing_binary(self) -> None:
self.install_dir.mkdir()
installed = self.install_dir / "herdr"
installed.write_bytes(b"existing-herdr\n")
result = self._run_installer(
self.expected_sha256,
extra_env={"FAKE_UNAME_OS": "Android"},
)
self.assertNotEqual(result.returncode, 0)
self.assertIn("Android/Termux is not currently supported", result.stderr)
self.assertFalse((self.root / "curl-called").exists())
self.assertEqual(installed.read_bytes(), b"existing-herdr\n")
def test_missing_uname_operating_system_flag_keeps_linux_supported(self) -> None:
result = self._run_installer(
self.expected_sha256,
extra_env={"FAKE_UNAME_OS_UNAVAILABLE": "1"},
)
self.assertEqual(result.returncode, 0, result.stderr)
self.assertEqual((self.install_dir / "herdr").read_bytes(), self.payload.read_bytes())
def test_checksum_mismatch_does_not_replace_existing_binary(self) -> None:
self.install_dir.mkdir()
installed = self.install_dir / "herdr"
installed.write_bytes(b"existing-herdr\n")
result = self._run_installer("0" * 64)
self.assertNotEqual(result.returncode, 0)
self.assertIn("checksum did not match", result.stderr)
self.assertEqual(installed.read_bytes(), b"existing-herdr\n")
def test_missing_checksum_fails_without_replacing_existing_binary(self) -> None:
self.install_dir.mkdir()
installed = self.install_dir / "herdr"
installed.write_bytes(b"existing-herdr\n")
result = self._run_installer(None)
self.assertNotEqual(result.returncode, 0)
self.assertIn("valid SHA-256 checksum", result.stderr)
self.assertEqual(installed.read_bytes(), b"existing-herdr\n")
if __name__ == "__main__":
unittest.main()
|
