-
-
Notifications
You must be signed in to change notification settings - Fork 398
/
Copy pathtest_core.py
297 lines (246 loc) · 12.9 KB
/
test_core.py
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
# This file is part of arduino-cli.
#
# Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
#
# This software is released under the GNU General Public License version 3,
# which covers the main part of arduino-cli.
# The terms of this license can be found at:
# https://www.gnu.org/licenses/gpl-3.0.en.html
#
# You can be released from the requirements of the above licenses by purchasing
# a commercial license. Buying such a license is mandatory if you want to modify or
# otherwise use the software for commercial activities involving the Arduino
# software without disclosing the source code of your own applications. To purchase
# a commercial license, send an email to [email protected].
import os
import platform
import pytest
import simplejson as json
from pathlib import Path
def test_core_search(run_command, httpserver):
# Set up the server to serve our custom index file
test_index = Path(__file__).parent / "testdata" / "test_index.json"
httpserver.expect_request("/test_index.json").respond_with_data(test_index.read_text())
url = httpserver.url_for("/test_index.json")
assert run_command(f"core update-index --additional-urls={url}")
# search a specific core
result = run_command("core search avr")
assert result.ok
assert 2 < len(result.stdout.splitlines())
result = run_command("core search avr --format json")
assert result.ok
data = json.loads(result.stdout)
assert 0 < len(data)
# additional URL
result = run_command("core search test_core --format json --additional-urls={}".format(url))
assert result.ok
data = json.loads(result.stdout)
assert 1 == len(data)
# show all versions
result = run_command("core search test_core --all --format json --additional-urls={}".format(url))
assert result.ok
data = json.loads(result.stdout)
assert 2 == len(data)
# Search all Retrokit platforms
result = run_command(f"core search retrokit --all --additional-urls={url}")
assert result.ok
lines = [l.strip().split() for l in result.stdout.strip().splitlines()]
assert 11 == len(lines)
assert ["Updating", "index:", "package_index.json", "downloaded"] in lines
assert ["Updating", "index:", "package_index.json.sig", "downloaded"] in lines
assert ["Retrokits-RK002:arm", "1.0.5", "RK002"] in lines
assert ["Retrokits-RK002:arm", "1.0.6", "RK002"] in lines
# Search using Retrokit Package Maintainer
result = run_command(f"core search Retrokits-RK002 --all --additional-urls={url}")
assert result.ok
lines = [l.strip().split() for l in result.stdout.strip().splitlines()]
assert 11 == len(lines)
assert ["Updating", "index:", "package_index.json", "downloaded"] in lines
assert ["Updating", "index:", "package_index.json.sig", "downloaded"] in lines
assert ["Retrokits-RK002:arm", "1.0.5", "RK002"] in lines
assert ["Retrokits-RK002:arm", "1.0.6", "RK002"] in lines
# Search using the Retrokit Platform name
result = run_command(f"core search rk002 --all --additional-urls={url}")
assert result.ok
assert 11 == len(lines)
assert ["Updating", "index:", "package_index.json", "downloaded"] in lines
assert ["Updating", "index:", "package_index.json.sig", "downloaded"] in lines
assert ["Retrokits-RK002:arm", "1.0.5", "RK002"] in lines
assert ["Retrokits-RK002:arm", "1.0.6", "RK002"] in lines
# Search using a board name
result = run_command(f"core search myboard --all --additional-urls={url}")
assert result.ok
assert 10 == len(result.stdout.strip().splitlines())
lines = [l.strip().split() for l in result.stdout.strip().splitlines()]
assert ["Updating", "index:", "package_index.json", "downloaded"] in lines
assert ["Updating", "index:", "package_index.json.sig", "downloaded"] in lines
assert ["Package:x86", "1.2.3", "Platform"] in lines
def test_core_search_no_args(run_command, httpserver):
"""
This tests `core search` with and without additional URLs in case no args
are passed (i.e. all results are shown).
"""
# Set up the server to serve our custom index file
test_index = Path(__file__).parent / "testdata" / "test_index.json"
httpserver.expect_request("/test_index.json").respond_with_data(test_index.read_text())
# update custom index and install test core (installed cores affect `core search`)
url = httpserver.url_for("/test_index.json")
assert run_command(f"core update-index --additional-urls={url}")
assert run_command(f"core install test:x86 --additional-urls={url}")
# list all with no additional urls, ensure the test core won't show up
result = run_command("core search")
assert result.ok
num_platforms = 0
lines = [l.strip().split() for l in result.stdout.strip().splitlines()]
# Index update output and the header are printed on the first lines
assert ["Updating", "index:", "package_index.json", "downloaded"] in lines[:6]
assert ["Updating", "index:", "package_index.json.sig", "downloaded"] in lines[:6]
assert ["ID", "Version", "Name"] == lines[5]
assert ["test:x86", "2.0.0", "test_core"] in lines[6:]
num_platforms = len(lines[6:])
# same thing in JSON format, also check the number of platforms found is the same
result = run_command("core search --format json")
assert result.ok
platforms = json.loads(result.stdout)
assert 1 == len([e for e in platforms if e.get("Name") == "test_core"])
assert len(platforms) == num_platforms
# list all with additional urls, check the test core is there
result = run_command(f"core search --additional-urls={url}")
assert result.ok
num_platforms = 0
lines = [l.strip().split() for l in result.stdout.strip().splitlines()]
# Index update output and the header are printed on the first lines
assert ["Updating", "index:", "package_index.json", "downloaded"] in lines[:9]
assert ["Updating", "index:", "package_index.json.sig", "downloaded"] in lines[:9]
assert ["ID", "Version", "Name"] == lines[8]
assert ["test:x86", "2.0.0", "test_core"] in lines[9:]
num_platforms = len(lines[9:])
# same thing in JSON format, also check the number of platforms found is the same
result = run_command(f"core search --format json --additional-urls={url}")
assert result.ok
platforms = json.loads(result.stdout)
assert 1 == len([e for e in platforms if e.get("Name") == "test_core"])
assert len(platforms) == num_platforms
def test_core_updateindex_invalid_url(run_command):
url = "http://www.invalid-domain-asjkdakdhadjkh.com/package_example_index.json"
result = run_command("core update-index --additional-urls={}".format(url))
assert result.failed
def test_core_install_without_updateindex(run_command):
# Missing "core update-index"
# Download samd core pinned to 1.8.6
result = run_command("core install arduino:[email protected]")
assert result.ok
assert "Updating index: package_index.json downloaded" in result.stdout
@pytest.mark.skipif(
platform.system() == "Windows", reason="core fails with fatal error: bits/c++config.h: No such file or directory",
)
def test_core_install_esp32(run_command, data_dir):
# update index
url = "https://dl.espressif.com/dl/package_esp32_index.json"
assert run_command("core update-index --additional-urls={}".format(url))
# install 3rd-party core
assert run_command("core install esp32:[email protected] --additional-urls={}".format(url))
# create a sketch and compile to double check the core was successfully installed
sketch_path = os.path.join(data_dir, "test_core_install_esp32")
assert run_command("sketch new {}".format(sketch_path))
assert run_command("compile -b esp32:esp32:esp32 {}".format(sketch_path))
# prevent regressions for https://github.com/arduino/arduino-cli/issues/163
assert os.path.exists(
os.path.join(sketch_path, "build/esp32.esp32.esp32/test_core_install_esp32.ino.partitions.bin",)
)
def test_core_download(run_command, downloads_dir):
assert run_command("core update-index")
# Download a specific core version
assert run_command("core download arduino:[email protected]")
assert os.path.exists(os.path.join(downloads_dir, "packages", "avr-1.6.16.tar.bz2"))
# Wrong core version
result = run_command("core download arduino:[email protected]")
assert result.failed
# Wrong core
result = run_command("core download bananas:avr")
assert result.failed
def _in(jsondata, name, version=None):
installed_cores = json.loads(jsondata)
for c in installed_cores:
if name == c.get("ID"):
if version is None:
return True
elif version == c.get("Installed"):
return True
return False
def test_core_install(run_command):
assert run_command("core update-index")
# Install a specific core version
assert run_command("core install arduino:[email protected]")
result = run_command("core list --format json")
assert result.ok
assert _in(result.stdout, "arduino:avr", "1.6.16")
# Replace it with a more recent one
assert run_command("core install arduino:[email protected]")
result = run_command("core list --format json")
assert result.ok
assert _in(result.stdout, "arduino:avr", "1.6.17")
# Confirm core is listed as "updatable"
result = run_command("core list --updatable --format json")
assert result.ok
assert _in(result.stdout, "arduino:avr", "1.6.17")
# Upgrade the core to latest version
assert run_command("core upgrade arduino:avr")
result = run_command("core list --format json")
assert result.ok
assert not _in(result.stdout, "arduino:avr", "1.6.17")
# double check the code isn't updatable anymore
result = run_command("core list --updatable --format json")
assert result.ok
assert not _in(result.stdout, "arduino:avr")
def test_core_uninstall(run_command):
assert run_command("core update-index")
assert run_command("core install arduino:avr")
result = run_command("core list --format json")
assert result.ok
assert _in(result.stdout, "arduino:avr")
assert run_command("core uninstall arduino:avr")
result = run_command("core list --format json")
assert result.ok
assert not _in(result.stdout, "arduino:avr")
def test_core_uninstall_tool_dependency_removal(run_command, data_dir):
# These platforms both have a dependency on the arduino:[email protected] tool
# arduino:[email protected] has a dependency on arduino:[email protected]
assert run_command("core install arduino:[email protected]")
# arduino:[email protected] has a dependency on arduino:[email protected]
assert run_command("core install arduino:[email protected]")
assert run_command("core uninstall arduino:avr")
arduino_tools_path = Path(data_dir, "packages", "arduino", "tools")
avr_gcc_binaries_path = arduino_tools_path.joinpath("avr-gcc", "7.3.0-atmel3.6.1-arduino5", "bin")
# The tool arduino:[email protected] that is a dep of another installed platform should remain
assert avr_gcc_binaries_path.joinpath("avr-gcc").exists() or avr_gcc_binaries_path.joinpath("avr-gcc.exe").exists()
avrdude_binaries_path = arduino_tools_path.joinpath("avrdude", "6.3.0-arduino17", "bin")
# The tool arduino:[email protected] that is only a dep of arduino:avr should have been removed
assert (
avrdude_binaries_path.joinpath("avrdude").exists() or avrdude_binaries_path.joinpath("avrdude.exe").exists()
) is False
def test_core_zipslip(run_command):
url = "https://raw.githubusercontent.com/arduino/arduino-cli/master/test/testdata/test_index.json"
assert run_command("core update-index --additional-urls={}".format(url))
# Install a core and check if malicious content has been extracted.
run_command("core install zipslip:x86 --additional-urls={}".format(url))
assert os.path.exists("/tmp/evil.txt") is False
def test_core_broken_install(run_command):
url = "https://raw.githubusercontent.com/arduino/arduino-cli/master/test/testdata/test_index.json"
assert run_command("core update-index --additional-urls={}".format(url))
assert not run_command("core install brokenchecksum:x86 --additional-urls={}".format(url))
def test_core_install_creates_installed_json(run_command, data_dir):
assert run_command("core update-index")
assert run_command("core install arduino:[email protected]")
installed_json_file = Path(data_dir, "packages", "arduino", "hardware", "avr", "1.6.23", "installed.json")
assert installed_json_file.exists()
installed_json = json.load(installed_json_file.open("r"))
expected_installed_json = json.load((Path(__file__).parent / "testdata" / "installed.json").open("r"))
def ordered(obj):
if isinstance(obj, dict):
return sorted({k: ordered(v) for k, v in obj.items()})
if isinstance(obj, list):
return sorted(ordered(x) for x in obj)
else:
return obj
assert ordered(installed_json) == ordered(expected_installed_json)