Repository navigation
Expand file tree
/
Copy pathtest_cli_download.py
More file actions
354 lines (292 loc) · 15.2 KB
/
Copy pathtest_cli_download.py
File metadata and controls
354 lines (292 loc) · 15.2 KB
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
"""Tests for unified Copilot release-package provisioning."""
from __future__ import annotations
import hashlib
import io
import os
import tarfile
from concurrent.futures import ThreadPoolExecutor
from http.client import IncompleteRead
from threading import Barrier
from unittest.mock import MagicMock, patch
import pytest
from copilot import _cli_download, _cli_version, _ffi_runtime_host
@pytest.fixture(autouse=True)
def _clear_ambient_skip_download(monkeypatch):
monkeypatch.delenv("COPILOT_SKIP_CLI_DOWNLOAD", raising=False)
def _release_package(runtime_platform: str) -> bytes:
wrapper_name = "copilot-runtime.exe" if os.name == "nt" else "copilot-runtime"
members = {
f"package/prebuilds/{runtime_platform}/{wrapper_name}": b"wrapper",
f"package/prebuilds/{runtime_platform}/runtime.node": b"runtime",
f"package/ripgrep/bin/{runtime_platform}/rg": b"ripgrep",
"package/definitions/future.json": b"{}",
"package/app.js": b"excluded",
"package/cli-main.js": b"excluded",
"package/LICENSE.md": b"excluded",
}
buffer = io.BytesIO()
with tarfile.open(fileobj=buffer, mode="w:gz") as archive:
for name, content in members.items():
info = tarfile.TarInfo(name)
info.mode = 0o755 if name.endswith((wrapper_name, "/rg")) else 0o644
info.size = len(content)
archive.addfile(info, io.BytesIO(content))
return buffer.getvalue()
def test_fetch_url_bytes_retries_truncated_response():
truncated_response = MagicMock()
truncated_response.__enter__.return_value.read.side_effect = IncompleteRead(b"partial", 4)
complete_response = MagicMock()
complete_response.__enter__.return_value.read.return_value = b"complete"
with (
patch.object(
_cli_download,
"urlopen",
side_effect=[truncated_response, complete_response],
) as urlopen,
patch.object(_cli_download.time, "sleep") as sleep,
):
assert _cli_download._fetch_url_bytes("https://example/runtime", timeout=30) == b"complete"
assert urlopen.call_count == 2
sleep.assert_called_once_with(1)
def _release_fetches(version: str, runtime_platform: str, data: bytes):
asset_name = f"github-copilot-{version}-{runtime_platform}.tgz"
checksum = hashlib.sha256(data).hexdigest()
def fetch(url: str, *, timeout: int) -> bytes:
del timeout
if url.endswith("/SHA256SUMS.txt"):
return f"{checksum} {asset_name}\n".encode()
assert url.endswith(f"/{asset_name}")
return data
return fetch
def test_release_asset_uses_platform_package_name(monkeypatch):
monkeypatch.setenv("COPILOT_CLI_DOWNLOAD_BASE_URL", "https://mirror.example/releases/")
name = _cli_version.get_release_asset_name("1.2.3-4", "linux-x64")
assert name == "github-copilot-1.2.3-4-linux-x64.tgz"
assert (
_cli_version.get_download_url("1.2.3-4", name)
== "https://mirror.example/releases/v1.2.3-4/github-copilot-1.2.3-4-linux-x64.tgz"
)
@pytest.mark.parametrize(
("version", "repository", "tag"),
[
("1.2.3", "copilot-cli", "v1.2.3"),
("1.2.3-4", "copilot-cli", "v1.2.3-4"),
("1.2.3-unstable.r123.gabcdef0", "copilot-sdk", "runtime-1.2.3-unstable.r123.gabcdef0"),
("1.2.3-4.unstable.r123.gabcdef0", "copilot-sdk", "runtime-1.2.3-4.unstable.r123.gabcdef0"),
("0.0.0-0.unstable.r1.g0000000", "copilot-sdk", "runtime-0.0.0-0.unstable.r1.g0000000"),
("01.2.3-unstable.r123.gabcdef0", "copilot-cli", "v01.2.3-unstable.r123.gabcdef0"),
("1.02.3-unstable.r123.gabcdef0", "copilot-cli", "v1.02.3-unstable.r123.gabcdef0"),
("1.2.03-unstable.r123.gabcdef0", "copilot-cli", "v1.2.03-unstable.r123.gabcdef0"),
("1.2.3-04.unstable.r123.gabcdef0", "copilot-cli", "v1.2.3-04.unstable.r123.gabcdef0"),
],
)
def test_pinned_runtime_uses_matching_release_and_mirror(monkeypatch, version, repository, tag):
monkeypatch.delenv("COPILOT_CLI_DOWNLOAD_BASE_URL", raising=False)
asset = _cli_version.get_release_asset_name(version, "linux-x64")
expected = f"https://github.com/github/{repository}/releases/download/{tag}"
assert _cli_version.get_download_url(version, asset) == f"{expected}/{asset}"
assert _cli_version.get_checksums_url(version) == f"{expected}/SHA256SUMS.txt"
monkeypatch.setenv("COPILOT_CLI_DOWNLOAD_BASE_URL", "https://mirror.example/releases/")
assert (
_cli_version.get_checksums_url(version)
== f"https://mirror.example/releases/{tag}/SHA256SUMS.txt"
)
@pytest.mark.parametrize(
"member_name",
["package/../outside", r"package\..\outside"],
)
def test_hostless_runtime_path_rejects_traversal(member_name):
with pytest.raises(RuntimeError, match="Unsafe runtime package path"):
_cli_download._hostless_runtime_path(member_name, "linux-x64")
def test_rejects_release_package_checksum_mismatch(tmp_path):
runtime_platform = "linux-x64"
data = _release_package(runtime_platform)
asset_name = f"github-copilot-1.2.3-{runtime_platform}.tgz"
def fetch(url: str, *, timeout: int) -> bytes:
del timeout
if url.endswith("/SHA256SUMS.txt"):
return f"{'0' * 64} {asset_name}\n".encode()
return data
with (
patch.object(_cli_download, "get_cache_dir", return_value=tmp_path / "cache"),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
patch.object(_cli_download, "_fetch_url_bytes", side_effect=fetch),
):
with pytest.raises(RuntimeError, match="Checksum mismatch"):
_cli_download.ensure_runtime_wrapper(version="1.2.3")
def test_rejects_release_package_without_checksum(tmp_path):
runtime_platform = "linux-x64"
def fetch(url: str, *, timeout: int) -> bytes:
del timeout
assert url.endswith("/SHA256SUMS.txt")
return f"{'0' * 64} another-file.tgz\n".encode()
with (
patch.object(_cli_download, "get_cache_dir", return_value=tmp_path / "cache"),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
patch.object(_cli_download, "_fetch_url_bytes", side_effect=fetch),
):
with pytest.raises(RuntimeError, match="SHA256SUMS.txt does not contain"):
_cli_download.ensure_runtime_wrapper(version="1.2.3")
@pytest.mark.parametrize("version", ["1.2.3", "1.2.3-4.unstable.r123.gabcdef0"])
def test_cli_and_runtime_share_one_staged_bundle(tmp_path, monkeypatch, version):
runtime_platform = "linux-x64"
cli_name = "copilot.exe" if os.name == "nt" else "copilot"
wrapper_name = "copilot-runtime.exe" if os.name == "nt" else "copilot-runtime"
data = _release_package(runtime_platform)
cache_dir = tmp_path / "cache"
install_dir = cache_dir / "prebuilds" / runtime_platform
fetch = _release_fetches(version, runtime_platform, data)
with (
patch.object(_cli_download, "get_cache_dir", return_value=cache_dir),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
patch.object(_cli_download, "_fetch_url_bytes", side_effect=fetch) as fetch_mock,
):
cli = _cli_download.download_cli(version)
monkeypatch.setenv("COPILOT_SKIP_CLI_DOWNLOAD", "1")
wrapper = _cli_download.ensure_runtime_wrapper(version)
assert _cli_download.get_cached_cli_path(version) == str(install_dir / cli_name)
assert cli == str(install_dir / cli_name)
assert wrapper == str(install_dir / wrapper_name)
assert (install_dir / cli_name).read_bytes() == b"wrapper"
assert not (cache_dir / cli_name).exists()
assert not (cache_dir / "packages").exists()
assert (install_dir / wrapper_name).read_bytes() == b"wrapper"
assert (install_dir / "runtime.node").read_bytes() == b"runtime"
assert (install_dir / "ripgrep" / "bin" / runtime_platform / "rg").read_bytes() == b"ripgrep"
assert (install_dir / "definitions" / "future.json").read_bytes() == b"{}"
assert not (install_dir / "app.js").exists()
assert not (install_dir / "cli-main.js").exists()
assert (install_dir / ".hostless-runtime-assets-v2").is_file()
assert fetch_mock.call_count == 2
if os.name != "nt":
assert (install_dir / cli_name).stat().st_mode & 0o111
assert (install_dir / wrapper_name).stat().st_mode & 0o111
def test_concurrent_staging_materializes_one_complete_bundle(tmp_path):
version = "1.2.3"
runtime_platform = "linux-x64"
wrapper_name = "copilot-runtime.exe" if os.name == "nt" else "copilot-runtime"
data = _release_package(runtime_platform)
cache_dir = tmp_path / "cache"
fetch = _release_fetches(version, runtime_platform, data)
fetch_barrier = Barrier(2)
def concurrent_fetch(url: str, *, timeout: int) -> bytes:
fetch_barrier.wait(timeout=10)
return fetch(url, timeout=timeout)
with (
patch.object(_cli_download, "get_cache_dir", return_value=cache_dir),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
patch.object(_cli_download, "_fetch_url_bytes", side_effect=concurrent_fetch) as fetch_mock,
ThreadPoolExecutor(max_workers=2) as executor,
):
futures = [executor.submit(_cli_download.ensure_runtime_wrapper, version) for _ in range(2)]
wrappers = [future.result() for future in futures]
install_dir = cache_dir / "prebuilds" / runtime_platform
expected_wrapper = str(install_dir / wrapper_name)
assert wrappers == [expected_wrapper, expected_wrapper]
assert (install_dir / wrapper_name).read_bytes() == b"wrapper"
assert (install_dir / "runtime.node").read_bytes() == b"runtime"
assert (install_dir / ".hostless-runtime-assets-v2").is_file()
assert not list((cache_dir / "prebuilds").glob(".runtime-bundle-*"))
assert not (cache_dir / "packages").exists()
assert fetch_mock.call_count == 4
def test_force_restages_complete_bundle_and_compatibility_alias(tmp_path):
version = "1.2.3"
runtime_platform = "linux-x64"
cli_name = "copilot.exe" if os.name == "nt" else "copilot"
wrapper_name = "copilot-runtime.exe" if os.name == "nt" else "copilot-runtime"
data = _release_package(runtime_platform)
cache_dir = tmp_path / "cache"
install_dir = cache_dir / "prebuilds" / runtime_platform
install_dir.mkdir(parents=True)
(install_dir / cli_name).write_bytes(b"old-alias")
(install_dir / wrapper_name).write_bytes(b"old-wrapper")
(install_dir / "runtime.node").write_bytes(b"old-runtime")
(install_dir / ".hostless-runtime-assets-v2").write_text("1\n", encoding="ascii")
fetch = _release_fetches(version, runtime_platform, data)
with (
patch.object(_cli_download, "get_cache_dir", return_value=cache_dir),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
patch.object(_cli_download, "_fetch_url_bytes", side_effect=fetch) as fetch_mock,
):
cli = _cli_download.download_cli(version, force=True)
assert cli == str(install_dir / cli_name)
assert (install_dir / cli_name).read_bytes() == b"wrapper"
assert (install_dir / wrapper_name).read_bytes() == b"wrapper"
assert (install_dir / "runtime.node").read_bytes() == b"runtime"
assert fetch_mock.call_count == 2
def test_skip_download_returns_none_without_cached_bundle(tmp_path, monkeypatch):
monkeypatch.setenv("COPILOT_SKIP_CLI_DOWNLOAD", "true")
runtime_platform = "linux-x64"
with (
patch.object(_cli_download, "get_cache_dir", return_value=tmp_path / "cache"),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
patch.object(_cli_download, "_fetch_url_bytes") as fetch_mock,
):
assert _cli_download.get_or_download_cli("1.2.3") is None
fetch_mock.assert_not_called()
def test_cached_cli_rejects_alias_from_incomplete_bundle(tmp_path):
version = "1.2.3"
runtime_platform = "linux-x64"
cli_name = "copilot.exe" if os.name == "nt" else "copilot"
wrapper_name = "copilot-runtime.exe" if os.name == "nt" else "copilot-runtime"
cache_dir = tmp_path / "cache"
install_dir = cache_dir / "prebuilds" / runtime_platform
install_dir.mkdir(parents=True)
(install_dir / cli_name).write_bytes(b"stale-wrapper")
(install_dir / wrapper_name).write_bytes(b"wrapper")
with (
patch.object(_cli_download, "get_cache_dir", return_value=cache_dir),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
):
assert _cli_download.get_cached_cli_path(version) is None
with pytest.raises(RuntimeError, match="Incomplete Copilot runtime bundle"):
_cli_download.download_cli(version)
def test_explicit_cli_reuses_library_from_canonical_staged_bundle(tmp_path):
version = "1.2.3"
runtime_platform = "linux-x64"
data = _release_package(runtime_platform)
cache_dir = tmp_path / "cache"
cli_dir = tmp_path / "external"
cli_dir.mkdir()
cli_path = cli_dir / ("copilot.exe" if os.name == "nt" else "copilot")
cli_path.write_bytes(b"external")
fetch = _release_fetches(version, runtime_platform, data)
with (
patch.object(_cli_download, "get_cache_dir", return_value=cache_dir),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
patch.object(_cli_download, "_fetch_url_bytes", side_effect=fetch) as fetch_mock,
patch("copilot._ffi_runtime_host.resolve_library_path", return_value=None),
):
library = _cli_download.ensure_runtime_library(str(cli_path), version)
wrapper = _cli_download.ensure_runtime_wrapper(version)
assert library == str(cli_dir / _ffi_runtime_host._natural_library_name())
assert (cli_dir / _ffi_runtime_host._natural_library_name()).read_bytes() == b"runtime"
assert (cache_dir / "prebuilds" / runtime_platform / "runtime.node").read_bytes() == b"runtime"
assert not (cache_dir / "packages").exists()
assert wrapper.endswith(
os.path.join(
"prebuilds",
runtime_platform,
"copilot-runtime.exe" if os.name == "nt" else "copilot-runtime",
)
)
assert fetch_mock.call_count == 2
def test_resolve_library_path_accepts_adjacent_runtime_node(tmp_path):
wrapper = tmp_path / ("copilot-runtime.exe" if os.name == "nt" else "copilot-runtime")
wrapper.write_bytes(b"wrapper")
runtime_node = tmp_path / "runtime.node"
runtime_node.write_bytes(b"runtime")
assert _ffi_runtime_host.resolve_library_path(str(wrapper)) == str(runtime_node)
def test_rejects_cached_wrapper_without_runtime_node(tmp_path):
runtime_platform = "linux-x64"
wrapper_name = "copilot-runtime.exe" if os.name == "nt" else "copilot-runtime"
cache_dir = tmp_path / "cache"
install_dir = cache_dir / "prebuilds" / runtime_platform
install_dir.mkdir(parents=True)
(install_dir / wrapper_name).write_bytes(b"wrapper")
with (
patch.object(_cli_download, "get_cache_dir", return_value=cache_dir),
patch.object(_cli_download, "get_runtime_platform", return_value=runtime_platform),
):
with pytest.raises(RuntimeError, match="Incomplete Copilot runtime bundle"):
_cli_download.ensure_runtime_wrapper(version="1.2.3")