forked from arduino/arduino-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtest_lib.py
1082 lines (852 loc) · 40.6 KB
/
test_lib.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
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# 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 platform
import simplejson as json
import pytest
import shutil
from git import Repo
from pathlib import Path
import tempfile
import requests
import zipfile
import io
import re
# Util function to download library from URL
def download_lib(url, download_dir):
tmp = Path(tempfile.TemporaryDirectory().name)
tmp.mkdir(parents=True, exist_ok=True)
regex = re.compile(r"^(.*)-[0-9]+.[0-9]+.[0-9]")
response = requests.get(url)
# Download and unzips library removing version suffix
with zipfile.ZipFile(io.BytesIO(response.content)) as thezip:
for zipinfo in thezip.infolist():
with thezip.open(zipinfo) as f:
dest_dir = tmp / regex.sub("\\g<1>", zipinfo.filename)
if zipinfo.is_dir():
dest_dir.mkdir(parents=True, exist_ok=True)
else:
dest_dir.write_bytes(f.read())
# Recreates zip with folder without version suffix
z = zipfile.ZipFile(download_dir, "w")
for f in tmp.glob("**/*"):
z.write(f, arcname=f.relative_to(tmp))
z.close()
def test_list(run_command):
# Init the environment explicitly
run_command(["core", "update-index"])
# When output is empty, nothing is printed out, no matter the output format
result = run_command(["lib", "list"])
assert result.ok
assert "" == result.stderr
assert "No libraries installed." in result.stdout.strip()
result = run_command(["lib", "list", "--format", "json"], hide=True)
assert result.ok
assert "" == result.stderr
assert 0 == len(json.loads(result.stdout))
# Install something we can list at a version older than latest
result = run_command(["lib", "install", "[email protected]"])
assert result.ok
# Look at the plain text output
result = run_command(["lib", "list"])
assert result.ok
assert "" == result.stderr
lines = result.stdout.strip().splitlines()
assert 2 == len(lines)
toks = [t.strip() for t in lines[1].split(maxsplit=4)]
# Verifies the expected number of field
assert 5 == len(toks)
# be sure line contain the current version AND the available version
assert "" != toks[1]
assert "" != toks[2]
# Verifies library sentence
assert "An efficient and elegant JSON library..." == toks[4]
# Look at the JSON output
result = run_command(["lib", "list", "--format", "json"], hide=True)
assert result.ok
assert "" == result.stderr
data = json.loads(result.stdout)
assert 1 == len(data)
# be sure data contains the available version
assert "" != data[0]["release"]["version"]
# Install something we can list without provides_includes field given in library.properties
result = run_command(["lib", "install", "[email protected]"])
assert result.ok
# Look at the JSON output
result = run_command(["lib", "list", "Arduino_APDS9960", "--format", "json"])
assert result.ok
assert "" == result.stderr
data = json.loads(result.stdout)
assert 1 == len(data)
# be sure data contains the correct provides_includes field
assert "Arduino_APDS9960.h" == data[0]["library"]["provides_includes"][0]
def test_list_exit_code(run_command):
# Init the environment explicitly
assert run_command(["core", "update-index"])
assert run_command(["core", "list"])
# Verifies lib list doesn't fail when platform is not specified
result = run_command(["lib", "list"])
assert result.ok
assert result.stderr.strip() == ""
# Verify lib list command fails because specified platform is not installed
result = run_command(["lib", "list", "-b", "arduino:samd:mkr1000"])
assert result.failed
assert result.stderr.strip() == "Error listing Libraries: Unknown FQBN: platform arduino:samd is not installed"
assert run_command(["lib", "install", "AllThingsTalk LoRaWAN SDK"])
# Verifies lib list command keeps failing
result = run_command(["lib", "list", "-b", "arduino:samd:mkr1000"])
assert result.failed
assert result.stderr.strip() == "Error listing Libraries: Unknown FQBN: platform arduino:samd is not installed"
assert run_command(["core", "install", "arduino:samd"])
# Verifies lib list command now works since platform has been installed
result = run_command(["lib", "list", "-b", "arduino:samd:mkr1000"])
assert result.ok
assert result.stderr.strip() == ""
def test_list_with_fqbn(run_command):
# Init the environment explicitly
assert run_command(["core", "update-index"])
# Install core
assert run_command(["core", "install", "arduino:avr"])
# Install some library
assert run_command(["lib", "install", "ArduinoJson"])
assert run_command(["lib", "install", "wm8978-esp32"])
# Look at the plain text output
result = run_command(["lib", "list", "-b", "arduino:avr:uno"])
assert result.ok
assert "" == result.stderr
lines = result.stdout.strip().splitlines()
assert 2 == len(lines)
# Verifies library is compatible
toks = [t.strip() for t in lines[1].split(maxsplit=4)]
assert 5 == len(toks)
assert "ArduinoJson" == toks[0]
# Look at the JSON output
result = run_command(["lib", "list", "-b", "arduino:avr:uno", "--format", "json"], hide=True)
assert result.ok
assert "" == result.stderr
data = json.loads(result.stdout)
assert 1 == len(data)
# Verifies library is compatible
assert data[0]["library"]["name"] == "ArduinoJson"
assert data[0]["library"]["compatible_with"]["arduino:avr:uno"]
def test_list_provides_includes_fallback(run_command):
# Verifies "provides_includes" field is returned even if libraries don't declare
# the "includes" property in their "library.properties" file
assert run_command(["update"])
# Install core
assert run_command(["core", "install", "arduino:[email protected]"])
assert run_command(["lib", "install", "[email protected]"])
# List all libraries, even the ones installed with the above core
result = run_command(["lib", "list", "--all", "--fqbn", "arduino:avr:uno", "--format", "json"], hide=True)
assert result.ok
assert "" == result.stderr
data = json.loads(result.stdout)
assert 6 == len(data)
libs = {l["library"]["name"]: l["library"]["provides_includes"] for l in data}
assert ["SoftwareSerial.h"] == libs["SoftwareSerial"]
assert ["Wire.h"] == libs["Wire"]
assert ["EEPROM.h"] == libs["EEPROM"]
assert ["HID.h"] == libs["HID"]
assert ["SPI.h"] == libs["SPI"]
assert ["ArduinoJson.h", "ArduinoJson.hpp"] == libs["ArduinoJson"]
def test_lib_download(run_command, downloads_dir):
# Download a specific lib version
assert run_command(["lib", "download", "[email protected]"])
assert Path(downloads_dir, "libraries", "AudioZero-1.0.0.zip").exists()
# Wrong lib version
result = run_command(["lib", "download", "[email protected]"])
assert result.failed
# Wrong lib
result = run_command(["lib", "download", "AudioZ"])
assert result.failed
def test_install(run_command):
libs = ["AzureIoTProtocol_MQTT", "CMMC MQTT Connector", "WiFiNINA"]
# Should be safe to run install multiple times
assert run_command(["lib", "install"] + libs)
assert run_command(["lib", "install"] + libs)
# Test failing-install of library with wrong dependency
# (https://github.com/arduino/arduino-cli/issues/534)
res = run_command(["lib", "install", "[email protected]"])
assert res.failed
assert "No valid dependencies solution found: dependency 'MD_MAX72xx' is not available" in res.stderr
def test_install_library_with_dependencies(run_command):
assert run_command(["update"])
# Verifies libraries are not installed
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
installed_libraries = [l["library"]["name"] for l in data]
assert "MD_Parola" not in installed_libraries
assert "MD_MAX72XX" not in installed_libraries
# Install library
assert run_command(["lib", "install", "[email protected]"])
# Verifies library's dependencies are correctly installed
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
installed_libraries = [l["library"]["name"] for l in data]
assert "MD_Parola" in installed_libraries
assert "MD_MAX72XX" in installed_libraries
def test_install_no_deps(run_command):
assert run_command(["update"])
# Verifies libraries are not installed
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
installed_libraries = [l["library"]["name"] for l in data]
assert "MD_Parola" not in installed_libraries
assert "MD_MAX72XX" not in installed_libraries
# Install library skipping dependencies installation
assert run_command(["lib", "install", "[email protected]", "--no-deps"])
# Verifies library's dependencies are not installed
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
installed_libraries = [l["library"]["name"] for l in data]
assert "MD_Parola" in installed_libraries
assert "MD_MAX72XX" not in installed_libraries
def test_install_git_url_and_zip_path_flags_visibility(run_command, data_dir, downloads_dir):
# Verifies installation fail because flags are not found
git_url = "https://github.com/arduino-libraries/WiFi101.git"
res = run_command(["lib", "install", "--git-url", git_url])
assert res.failed
assert "--git-url and --zip-path are disabled by default, for more information see:" in res.stderr
# Download library
url = "https://github.com/arduino-libraries/AudioZero/archive/refs/tags/1.1.1.zip"
zip_path = Path(downloads_dir, "libraries", "AudioZero.zip")
zip_path.parent.mkdir(parents=True, exist_ok=True)
download_lib(url, zip_path)
res = run_command(["lib", "install", "--zip-path", zip_path])
assert res.failed
assert "--git-url and --zip-path are disabled by default, for more information see:" in res.stderr
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
# Verifies installation is successful when flags are enabled with env var
res = run_command(["lib", "install", "--git-url", git_url], custom_env=env)
assert res.ok
assert "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk." in res.stdout
res = run_command(["lib", "install", "--zip-path", zip_path], custom_env=env)
assert res.ok
assert "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk." in res.stdout
# Uninstall libraries to install them again
assert run_command(["lib", "uninstall", "WiFi101", "AudioZero"])
# Verifies installation is successful when flags are enabled with settings file
assert run_command(["config", "init", "--dest-dir", "."], custom_env=env)
res = run_command(["lib", "install", "--git-url", git_url])
assert res.ok
assert "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk." in res.stdout
res = run_command(["lib", "install", "--zip-path", zip_path])
assert res.ok
assert "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk." in res.stdout
def test_install_with_git_url(run_command, data_dir, downloads_dir):
# Initialize configs to enable --git-url flag
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
assert run_command(["config", "init", "--dest-dir", "."], custom_env=env)
lib_install_dir = Path(data_dir, "libraries", "WiFi101")
# Verifies library is not already installed
assert not lib_install_dir.exists()
git_url = "https://github.com/arduino-libraries/WiFi101.git"
# Test git-url library install
res = run_command(["lib", "install", "--git-url", git_url])
assert res.ok
assert "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk." in res.stdout
# Verifies library is installed in expected path
assert lib_install_dir.exists()
# Reinstall library
assert run_command(["lib", "install", "--git-url", git_url])
# Verifies library remains installed
assert lib_install_dir.exists()
def test_install_with_git_url_fragment_as_branch(run_command, data_dir, downloads_dir):
# Initialize configs to enable --git-url flag
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
assert run_command(["config", "init", "--dest-dir", "."], custom_env=env)
lib_install_dir = Path(data_dir, "libraries", "WiFi101")
# Verifies library is not already installed
assert not lib_install_dir.exists()
git_url = "https://github.com/arduino-libraries/WiFi101.git"
# Test that a bad ref fails
res = run_command(["lib", "install", "--git-url", git_url + "#x-ref-does-not-exist"])
assert res.failed
# Verifies library is installed in expected path
res = run_command(["lib", "install", "--git-url", git_url + "#0.16.0"])
assert res.ok
assert lib_install_dir.exists()
# Reinstall library at an existing ref
assert run_command(["lib", "install", "--git-url", git_url + "#master"])
assert res.ok
# Verifies library remains installed
assert lib_install_dir.exists()
def test_install_with_zip_path(run_command, data_dir, downloads_dir):
# Initialize configs to enable --zip-path flag
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
assert run_command(["config", "init", "--dest-dir", "."], custom_env=env)
# Download a specific lib version
# Download library
url = "https://github.com/arduino-libraries/AudioZero/archive/refs/tags/1.1.1.zip"
zip_path = Path(downloads_dir, "libraries", "AudioZero.zip")
zip_path.parent.mkdir(parents=True, exist_ok=True)
download_lib(url, zip_path)
lib_install_dir = Path(data_dir, "libraries", "AudioZero")
# Verifies library is not already installed
assert not lib_install_dir.exists()
# Test zip-path install
res = run_command(["lib", "install", "--zip-path", zip_path])
assert res.ok
assert "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk." in res.stdout
# Verifies library is installed in expected path
assert lib_install_dir.exists()
files = list(lib_install_dir.glob("**/*"))
assert lib_install_dir / "examples" / "SimpleAudioPlayerZero" / "SimpleAudioPlayerZero.ino" in files
assert lib_install_dir / "src" / "AudioZero.h" in files
assert lib_install_dir / "src" / "AudioZero.cpp" in files
assert lib_install_dir / "keywords.txt" in files
assert lib_install_dir / "library.properties" in files
assert lib_install_dir / "README.adoc" in files
# Reinstall library
assert run_command(["lib", "install", "--zip-path", zip_path])
# Verifies library remains installed
assert lib_install_dir.exists()
files = list(lib_install_dir.glob("**/*"))
assert lib_install_dir / "examples" / "SimpleAudioPlayerZero" / "SimpleAudioPlayerZero.ino" in files
assert lib_install_dir / "src" / "AudioZero.h" in files
assert lib_install_dir / "src" / "AudioZero.cpp" in files
assert lib_install_dir / "keywords.txt" in files
assert lib_install_dir / "library.properties" in files
assert lib_install_dir / "README.adoc" in files
def test_update_index(run_command):
result = run_command(["lib", "update-index"])
assert result.ok
lines = [l.strip() for l in result.stdout.splitlines()]
assert "Downloading index: library_index.json.gz downloaded" in lines
assert "Downloading index signature: library_index.json.sig downloaded" in lines
def test_uninstall(run_command):
libs = ["AzureIoTProtocol_MQTT", "WiFiNINA"]
assert run_command(["lib", "install"] + libs)
result = run_command(["lib", "uninstall"] + libs)
assert result.ok
def test_uninstall_spaces(run_command):
key = "LiquidCrystal I2C"
assert run_command(["lib", "install", key])
assert run_command(["lib", "uninstall", key])
result = run_command(["lib", "list", "--format", "json"])
assert result.ok
assert len(json.loads(result.stdout)) == 0
def test_lib_ops_caseinsensitive(run_command):
"""
This test is supposed to (un)install the following library,
As you can see the name is all caps:
Name: "PCM"
Author: David Mellis <[email protected]>, Michael Smith <[email protected]>
Maintainer: David Mellis <[email protected]>
Sentence: Playback of short audio samples.
Paragraph: These samples are encoded directly in the Arduino sketch as an array of numbers.
Website: http://highlowtech.org/?p=1963
Category: Signal Input/Output
Architecture: avr
Types: Contributed
Versions: [1.0.0]
"""
key = "pcm"
assert run_command(["lib", "install", key])
assert run_command(["lib", "uninstall", key])
result = run_command(["lib", "list", "--format", "json"])
assert result.ok
assert len(json.loads(result.stdout)) == 0
def test_search(run_command):
assert run_command(["update"])
result = run_command(["lib", "search", "--names"])
assert result.ok
lines = [l.strip() for l in result.stdout.strip().splitlines()]
assert "Downloading index: library_index.json.gz downloaded" in lines
assert "Downloading index signature: library_index.json.sig downloaded" in lines
libs = [l[6:].strip('"') for l in lines if "Name:" in l]
expected = {"WiFi101", "WiFi101OTA", "Firebase Arduino based on WiFi101"}
assert expected == {lib for lib in libs if "WiFi101" in lib}
result = run_command(["lib", "search", "--names", "--format", "json"])
assert result.ok
libs_json = json.loads(result.stdout)
assert len(libs) == len(libs_json.get("libraries"))
result = run_command(["lib", "search", "--names"])
assert result.ok
def run_search(search_args, expected_libraries):
res = run_command(["lib", "search", "--names", "--format", "json"] + search_args.split(" "))
assert res.ok
data = json.loads(res.stdout)
libraries = [l["name"] for l in data["libraries"]]
for l in expected_libraries:
assert l in libraries
run_search("Arduino_MKRIoTCarrier", ["Arduino_MKRIoTCarrier"])
run_search("Arduino mkr iot carrier", ["Arduino_MKRIoTCarrier"])
run_search("mkr iot carrier", ["Arduino_MKRIoTCarrier"])
run_search("mkriotcarrier", ["Arduino_MKRIoTCarrier"])
run_search(
"dht",
["DHT sensor library", "DHT sensor library for ESPx", "DHT12", "SimpleDHT", "TinyDHT sensor library", "SDHT"],
)
run_search("dht11", ["DHT sensor library", "DHT sensor library for ESPx", "SimpleDHT", "SDHT"])
run_search("dht12", ["DHT12", "DHT12 sensor library", "SDHT"])
run_search("dht22", ["DHT sensor library", "DHT sensor library for ESPx", "SimpleDHT", "SDHT"])
run_search("dht sensor", ["DHT sensor library", "DHT sensor library for ESPx", "SimpleDHT", "SDHT"])
run_search("sensor dht", [])
run_search("arduino json", ["ArduinoJson", "Arduino_JSON"])
run_search("arduinojson", ["ArduinoJson"])
run_search("json", ["ArduinoJson", "Arduino_JSON"])
def test_search_paragraph(run_command):
"""
Search for a string that's only present in the `paragraph` field
within the index file.
"""
assert run_command(["lib", "update-index"])
result = run_command(["lib", "search", "A simple and efficient JSON library", "--names", "--format", "json"])
assert result.ok
data = json.loads(result.stdout)
libraries = [l["name"] for l in data["libraries"]]
assert "ArduinoJson" in libraries
def test_lib_list_with_updatable_flag(run_command):
# Init the environment explicitly
run_command(["lib", "update-index"])
# No libraries to update
result = run_command(["lib", "list", "--updatable"])
assert result.ok
assert "" == result.stderr
assert "No updates available." in result.stdout.strip()
# No library to update in json
result = run_command(["lib", "list", "--updatable", "--format", "json"])
assert result.ok
assert "" == result.stderr
assert 0 == len(json.loads(result.stdout))
# Install outdated library
assert run_command(["lib", "install", "[email protected]"])
# Install latest version of library
assert run_command(["lib", "install", "WiFi101"])
res = run_command(["lib", "list", "--updatable"])
assert res.ok
assert "" == res.stderr
# lines = res.stdout.strip().splitlines()
lines = [l.strip().split(maxsplit=4) for l in res.stdout.strip().splitlines()]
assert 2 == len(lines)
assert ["Name", "Installed", "Available", "Location", "Description"] in lines
line = lines[1]
assert "ArduinoJson" == line[0]
assert "6.11.0" == line[1]
# Verifies available version is not equal to installed one and not empty
assert "6.11.0" != line[2]
assert "" != line[2]
assert "An efficient and elegant JSON library..." == line[4]
# Look at the JSON output
res = run_command(["lib", "list", "--updatable", "--format", "json"], hide=True)
assert res.ok
assert "" == res.stderr
data = json.loads(res.stdout)
assert 1 == len(data)
# be sure data contains the available version
assert "6.11.0" == data[0]["library"]["version"]
assert "6.11.0" != data[0]["release"]["version"]
assert "" != data[0]["release"]["version"]
def test_install_with_git_url_from_current_directory(run_command, downloads_dir, data_dir):
assert run_command(["update"])
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
lib_install_dir = Path(data_dir, "libraries", "WiFi101")
# Verifies library is not installed
assert not lib_install_dir.exists()
# Clone repository locally
git_url = "https://github.com/arduino-libraries/WiFi101.git"
repo_dir = Path(data_dir, "WiFi101")
assert Repo.clone_from(git_url, repo_dir)
assert run_command(["lib", "install", "--git-url", "."], custom_working_dir=repo_dir, custom_env=env)
# Verifies library is installed to correct folder
assert lib_install_dir.exists()
@pytest.mark.skipif(
platform.system() == "Windows",
reason="Using a file uri as git url doesn't work on Windows, "
+ "this must be removed when this issue is fixed: https://github.com/go-git/go-git/issues/247",
)
def test_install_with_git_url_local_file_uri(run_command, downloads_dir, data_dir):
assert run_command(["update"])
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
lib_install_dir = Path(data_dir, "libraries", "WiFi101")
# Verifies library is not installed
assert not lib_install_dir.exists()
# Clone repository locally
git_url = "https://github.com/arduino-libraries/WiFi101.git"
repo_dir = Path(data_dir, "WiFi101")
assert Repo.clone_from(git_url, repo_dir)
assert run_command(["lib", "install", "--git-url", repo_dir.as_uri()], custom_env=env)
# Verifies library is installed
assert lib_install_dir.exists()
def test_install_with_git_local_url(run_command, downloads_dir, data_dir):
assert run_command(["update"])
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
lib_install_dir = Path(data_dir, "libraries", "WiFi101")
# Verifies library is not installed
assert not lib_install_dir.exists()
# Clone repository locally
git_url = "https://github.com/arduino-libraries/WiFi101.git"
repo_dir = Path(data_dir, "WiFi101")
assert Repo.clone_from(git_url, repo_dir)
assert run_command(["lib", "install", "--git-url", repo_dir], custom_env=env)
# Verifies library is installed
assert lib_install_dir.exists()
def test_install_with_git_url_relative_path(run_command, downloads_dir, data_dir):
assert run_command(["update"])
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
lib_install_dir = Path(data_dir, "libraries", "WiFi101")
# Verifies library is not installed
assert not lib_install_dir.exists()
# Clone repository locally
git_url = "https://github.com/arduino-libraries/WiFi101.git"
repo_dir = Path(data_dir, "WiFi101")
assert Repo.clone_from(git_url, repo_dir)
assert run_command(["lib", "install", "--git-url", "./WiFi101"], custom_working_dir=data_dir, custom_env=env)
# Verifies library is installed
assert lib_install_dir.exists()
def test_install_with_git_url_does_not_create_git_repo(run_command, downloads_dir, data_dir):
assert run_command(["update"])
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
lib_install_dir = Path(data_dir, "libraries", "WiFi101")
# Verifies library is not installed
assert not lib_install_dir.exists()
# Clone repository locally
git_url = "https://github.com/arduino-libraries/WiFi101.git"
repo_dir = Path(data_dir, "WiFi101")
assert Repo.clone_from(git_url, repo_dir)
assert run_command(["lib", "install", "--git-url", repo_dir], custom_env=env)
# Verifies installed library is not a git repository
assert not Path(lib_install_dir, ".git").exists()
def test_install_with_git_url_multiple_libraries(run_command, downloads_dir, data_dir):
assert run_command(["update"])
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
wifi_install_dir = Path(data_dir, "libraries", "WiFi101")
ble_install_dir = Path(data_dir, "libraries", "ArduinoBLE")
# Verifies libraries are not installed
assert not wifi_install_dir.exists()
assert not ble_install_dir.exists()
wifi_url = "https://github.com/arduino-libraries/WiFi101.git"
ble_url = "https://github.com/arduino-libraries/ArduinoBLE.git"
assert run_command(["lib", "install", "--git-url", wifi_url, ble_url], custom_env=env)
# Verifies library are installed
assert wifi_install_dir.exists()
assert ble_install_dir.exists()
def test_install_with_zip_path_multiple_libraries(run_command, downloads_dir, data_dir):
assert run_command(["update"])
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
# Downloads zip to be installed later
wifi_zip_path = Path(downloads_dir, "libraries", "WiFi101-0.16.1.zip")
ble_zip_path = Path(downloads_dir, "libraries", "ArduinoBLE-1.1.3.zip")
download_lib("https://github.com/arduino-libraries/WiFi101/archive/refs/tags/0.16.1.zip", wifi_zip_path)
download_lib("https://github.com/arduino-libraries/ArduinoBLE/archive/refs/tags/1.1.3.zip", ble_zip_path)
wifi_install_dir = Path(data_dir, "libraries", "WiFi101")
ble_install_dir = Path(data_dir, "libraries", "ArduinoBLE")
# Verifies libraries are not installed
assert not wifi_install_dir.exists()
assert not ble_install_dir.exists()
assert run_command(["lib", "install", "--zip-path", wifi_zip_path, ble_zip_path], custom_env=env)
# Verifies library are installed
assert wifi_install_dir.exists()
assert ble_install_dir.exists()
def test_lib_examples(run_command, data_dir):
assert run_command(["update"])
assert run_command(["lib", "install", "[email protected]"])
res = run_command(["lib", "examples", "Arduino_JSON", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
assert len(data) == 1
examples = data[0]["examples"]
assert str(Path(data_dir, "libraries", "Arduino_JSON", "examples", "JSONArray")) in examples
assert str(Path(data_dir, "libraries", "Arduino_JSON", "examples", "JSONKitchenSink")) in examples
assert str(Path(data_dir, "libraries", "Arduino_JSON", "examples", "JSONObject")) in examples
def test_lib_examples_with_pde_file(run_command, data_dir):
assert run_command(["update"])
assert run_command(["lib", "install", "[email protected]"])
res = run_command(["lib", "examples", "Encoder", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
assert len(data) == 1
examples = data[0]["examples"]
assert str(Path(data_dir, "libraries", "Encoder", "examples", "Basic")) in examples
assert str(Path(data_dir, "libraries", "Encoder", "examples", "NoInterrupts")) in examples
assert str(Path(data_dir, "libraries", "Encoder", "examples", "SpeedTest")) in examples
assert str(Path(data_dir, "libraries", "Encoder", "examples", "TwoKnobs")) in examples
def test_lib_examples_with_case_mismatch(run_command, data_dir):
assert run_command(["update"])
assert run_command(["lib", "install", "[email protected]"])
res = run_command(["lib", "examples", "WiFiManager", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
assert len(data) == 1
examples = data[0]["examples"]
assert len(examples) == 14
examples_path = Path(data_dir, "libraries", "WiFiManager", "examples")
# Verifies sketches with correct casing are listed
assert str(examples_path / "Advanced") in examples
assert str(examples_path / "AutoConnect" / "AutoConnectWithFeedbackLED") in examples
assert str(examples_path / "AutoConnect" / "AutoConnectWithFSParameters") in examples
assert str(examples_path / "AutoConnect" / "AutoConnectWithFSParametersAndCustomIP") in examples
assert str(examples_path / "Basic") in examples
assert str(examples_path / "DEV" / "OnDemandConfigPortal") in examples
assert str(examples_path / "NonBlocking" / "AutoConnectNonBlocking") in examples
assert str(examples_path / "NonBlocking" / "AutoConnectNonBlockingwParams") in examples
assert str(examples_path / "Old_examples" / "AutoConnectWithFeedback") in examples
assert str(examples_path / "Old_examples" / "AutoConnectWithReset") in examples
assert str(examples_path / "Old_examples" / "AutoConnectWithStaticIP") in examples
assert str(examples_path / "Old_examples" / "AutoConnectWithTimeout") in examples
assert str(examples_path / "OnDemand" / "OnDemandConfigPortal") in examples
assert str(examples_path / "ParamsChildClass") in examples
# Verifies sketches with wrong casing are not returned
assert str(examples_path / "NonBlocking" / "OnDemandNonBlocking") not in examples
assert str(examples_path / "OnDemand" / "OnDemandWebPortal") not in examples
def test_lib_list_using_library_with_invalid_version(run_command, data_dir):
assert run_command(["update"])
# Install a library
assert run_command(["lib", "install", "[email protected]"])
# Verifies library is correctly returned
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
assert len(data) == 1
assert "0.16.1" == data[0]["library"]["version"]
# Changes the version of the currently installed library so that it's
# invalid
lib_path = Path(data_dir, "libraries", "WiFi101")
Path(lib_path, "library.properties").write_text("name=WiFi101\nversion=1.0001")
# Verifies version is now empty
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
assert len(data) == 1
assert "version" not in data[0]["library"]
def test_lib_upgrade_using_library_with_invalid_version(run_command, data_dir):
assert run_command(["update"])
# Install a library
assert run_command(["lib", "install", "[email protected]"])
# Verifies library is correctly returned
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
assert len(data) == 1
assert "0.16.1" == data[0]["library"]["version"]
# Changes the version of the currently installed library so that it's
# invalid
lib_path = Path(data_dir, "libraries", "WiFi101")
Path(lib_path, "library.properties").write_text("name=WiFi101\nversion=1.0001")
# Verifies version is now empty
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
assert len(data) == 1
assert "version" not in data[0]["library"]
# Upgrade library
assert run_command(["lib", "upgrade", "WiFi101"])
# Verifies library has been updated
res = run_command(["lib", "list", "--format", "json"])
assert res.ok
data = json.loads(res.stdout)
assert len(data) == 1
assert "" != data[0]["library"]["version"]
def test_install_zip_lib_with_macos_metadata(run_command, data_dir, downloads_dir):
# Initialize configs to enable --zip-path flag
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
assert run_command(["config", "init", "--dest-dir", "."], custom_env=env)
lib_install_dir = Path(data_dir, "libraries", "fake-lib")
# Verifies library is not already installed
assert not lib_install_dir.exists()
zip_path = Path(__file__).parent / "testdata" / "fake-lib.zip"
# Test zip-path install
res = run_command(["lib", "install", "--zip-path", zip_path])
assert res.ok
assert "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk." in res.stdout
# Verifies library is installed in expected path
assert lib_install_dir.exists()
files = list(lib_install_dir.glob("**/*"))
assert lib_install_dir / "library.properties" in files
assert lib_install_dir / "src" / "fake-lib.h" in files
# Reinstall library
assert run_command(["lib", "install", "--zip-path", zip_path])
# Verifies library remains installed
assert lib_install_dir.exists()
files = list(lib_install_dir.glob("**/*"))
assert lib_install_dir / "library.properties" in files
assert lib_install_dir / "src" / "fake-lib.h" in files
def test_install_zip_invalid_library(run_command, data_dir, downloads_dir):
# Initialize configs to enable --zip-path flag
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
assert run_command(["config", "init", "--dest-dir", "."], custom_env=env)
lib_install_dir = Path(data_dir, "libraries", "lib-without-header")
# Verifies library is not already installed
assert not lib_install_dir.exists()
zip_path = Path(__file__).parent / "testdata" / "lib-without-header.zip"
# Test zip-path install
res = run_command(["lib", "install", "--zip-path", zip_path])
assert res.failed
assert "library not valid" in res.stderr
lib_install_dir = Path(data_dir, "libraries", "lib-without-properties")
# Verifies library is not already installed
assert not lib_install_dir.exists()
zip_path = Path(__file__).parent / "testdata" / "lib-without-properties.zip"
# Test zip-path install
res = run_command(["lib", "install", "--zip-path", zip_path])
assert res.failed
assert "library not valid" in res.stderr
def test_install_git_invalid_library(run_command, data_dir, downloads_dir):
# Initialize configs to enable --zip-path flag
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_ENABLE_UNSAFE_LIBRARY_INSTALL": "true",
}
assert run_command(["config", "init", "--dest-dir", "."], custom_env=env)
# Create fake library repository
repo_dir = Path(data_dir, "lib-without-header")
with Repo.init(repo_dir) as repo:
lib_properties = Path(repo_dir, "library.properties")
lib_properties.touch()
repo.index.add([str(lib_properties)])
repo.index.commit("First commit")
lib_install_dir = Path(data_dir, "libraries", "lib-without-header")
# Verifies library is not already installed
assert not lib_install_dir.exists()
res = run_command(["lib", "install", "--git-url", repo_dir], custom_env=env)
assert res.failed
assert "library not valid" in res.stderr
assert not lib_install_dir.exists()