-
-
Notifications
You must be signed in to change notification settings - Fork 398
/
Copy pathtest_compile.py
1254 lines (975 loc) · 49 KB
/
test_compile.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 os
import platform
import tempfile
import hashlib
import shutil
from git import Repo
from pathlib import Path
import simplejson as json
import pytest
from .common import running_on_ci
def test_compile_without_fqbn(run_command):
# Init the environment explicitly
run_command(["core", "update-index"])
# Install Arduino AVR Boards
run_command(["core", "install", "arduino:[email protected]"])
# Build sketch without FQBN
result = run_command(["compile"])
assert result.failed
def test_compile_with_simple_sketch(run_command, data_dir, working_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Download latest AVR
run_command(["core", "install", "arduino:avr"])
sketch_name = "CompileIntegrationTest"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
result = run_command(["sketch", "new", sketch_path])
assert result.ok
assert f"Sketch created in: {sketch_path}" in result.stdout
# Build sketch for arduino:avr:uno
result = run_command(["compile", "-b", fqbn, sketch_path])
assert result.ok
# Build sketch for arduino:avr:uno with json output
result = run_command(["compile", "-b", fqbn, sketch_path, "--format", "json"])
assert result.ok
# check is a valid json and contains requested data
compile_output = json.loads(result.stdout)
assert compile_output["compiler_out"] != ""
assert compile_output["compiler_err"] == ""
# Verifies expected binaries have been built
sketch_path_md5 = hashlib.md5(bytes(sketch_path)).hexdigest().upper()
build_dir = Path(tempfile.gettempdir(), f"arduino-sketch-{sketch_path_md5}")
assert (build_dir / f"{sketch_name}.ino.eep").exists()
assert (build_dir / f"{sketch_name}.ino.elf").exists()
assert (build_dir / f"{sketch_name}.ino.hex").exists()
assert (build_dir / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert (build_dir / f"{sketch_name}.ino.with_bootloader.hex").exists()
# Verifies binaries are not exported by default to Sketch folder
sketch_build_dir = Path(sketch_path, "build", fqbn.replace(":", "."))
assert not (sketch_build_dir / f"{sketch_name}.ino.eep").exists()
assert not (sketch_build_dir / f"{sketch_name}.ino.elf").exists()
assert not (sketch_build_dir / f"{sketch_name}.ino.hex").exists()
assert not (sketch_build_dir / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert not (sketch_build_dir / f"{sketch_name}.ino.with_bootloader.hex").exists()
@pytest.mark.skipif(
running_on_ci() and platform.system() == "Windows",
reason="Test disabled on Github Actions Win VM until tmpdir inconsistent behavior bug is fixed",
)
def test_output_flag_default_path(run_command, data_dir, working_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Install Arduino AVR Boards
run_command(["core", "install", "arduino:[email protected]"])
# Create a test sketch
sketch_path = os.path.join(data_dir, "test_output_flag_default_path")
fqbn = "arduino:avr:uno"
result = run_command(["sketch", "new", sketch_path])
assert result.ok
# Test the --output-dir flag defaulting to current working dir
result = run_command(["compile", "-b", fqbn, sketch_path, "--output-dir", "test"])
assert result.ok
target = os.path.join(working_dir, "test")
assert os.path.exists(target) and os.path.isdir(target)
def test_compile_with_sketch_with_symlink_selfloop(run_command, data_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Install Arduino AVR Boards
run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompileIntegrationTestSymlinkSelfLoop"
sketch_path = os.path.join(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
result = run_command(["sketch", "new", sketch_path])
assert result.ok
assert "Sketch created in: {}".format(sketch_path) in result.stdout
# create a symlink that loops on himself
loop_file_path = os.path.join(sketch_path, "loop")
os.symlink(loop_file_path, loop_file_path)
# Build sketch for arduino:avr:uno
result = run_command(["compile", "-b", fqbn, sketch_path])
# The assertion is a bit relaxed in this case because win behaves differently from macOs and linux
# returning a different error detailed message
assert "Error during build: Can't open sketch:" in result.stderr
assert not result.ok
sketch_name = "CompileIntegrationTestSymlinkDirLoop"
sketch_path = os.path.join(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
result = run_command(["sketch", "new", sketch_path])
assert result.ok
assert "Sketch created in: {}".format(sketch_path) in result.stdout
# create a symlink that loops on the upper level
loop_dir_path = os.path.join(sketch_path, "loop_dir")
os.mkdir(loop_dir_path)
loop_dir_symlink_path = os.path.join(loop_dir_path, "loop_dir_symlink")
os.symlink(loop_dir_path, loop_dir_symlink_path)
# Build sketch for arduino:avr:uno
result = run_command(["compile", "-b", fqbn, sketch_path])
# The assertion is a bit relaxed in this case because win behaves differently from macOs and linux
# returning a different error detailed message
assert "Error during build: Can't open sketch:" in result.stderr
assert not result.ok
def test_compile_blacklisted_sketchname(run_command, data_dir):
"""
Compile should ignore folders named `RCS`, `.git` and the likes, but
it should be ok for a sketch to be named like RCS.ino
"""
# Init the environment explicitly
run_command(["core", "update-index"])
# Install Arduino AVR Boards
run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "RCS"
sketch_path = os.path.join(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
result = run_command(["sketch", "new", sketch_path])
assert result.ok
assert "Sketch created in: {}".format(sketch_path) in result.stdout
# Build sketch for arduino:avr:uno
result = run_command(["compile", "-b", fqbn, sketch_path])
assert result.ok
def test_compile_without_precompiled_libraries(run_command, data_dir):
# Init the environment explicitly
url = "https://adafruit.github.io/arduino-board-index/package_adafruit_index.json"
assert run_command(["core", "update-index", f"--additional-urls={url}"])
assert run_command(["core", "install", "arduino:[email protected]", f"--additional-urls={url}"])
# Precompiled version of Arduino_TensorflowLite
assert run_command(["lib", "install", "Arduino_LSM9DS1"])
assert run_command(["lib", "install", "[email protected]"])
sketch_path = Path(data_dir, "libraries", "Arduino_TensorFlowLite", "examples", "hello_world")
assert run_command(["compile", "-b", "arduino:mbed:nano33ble", sketch_path])
assert run_command(["core", "install", "arduino:[email protected]", f"--additional-urls={url}"])
assert run_command(["core", "install", "adafruit:[email protected]", f"--additional-urls={url}"])
# should work on adafruit too after https://github.com/arduino/arduino-cli/pull/1134
assert run_command(["compile", "-b", "adafruit:samd:adafruit_feather_m4", sketch_path])
# Non-precompiled version of Arduino_TensorflowLite
assert run_command(["lib", "install", "[email protected]"])
assert run_command(["compile", "-b", "arduino:mbed:nano33ble", sketch_path])
assert run_command(["compile", "-b", "adafruit:samd:adafruit_feather_m4", sketch_path])
# Bosch sensor library
assert run_command(["lib", "install", "BSEC Software [email protected]"])
sketch_path = Path(data_dir, "libraries", "BSEC_Software_Library", "examples", "basic")
assert run_command(["compile", "-b", "arduino:samd:mkr1000", sketch_path])
assert run_command(["compile", "-b", "arduino:mbed:nano33ble", sketch_path])
# USBBlaster library
assert run_command(["lib", "install", "[email protected]"])
sketch_path = Path(data_dir, "libraries", "USBBlaster", "examples", "USB_Blaster")
assert run_command(["compile", "-b", "arduino:samd:mkrvidor4000", sketch_path])
def test_compile_with_build_properties_flag(run_command, data_dir, copy_sketch):
# Init the environment explicitly
assert run_command(["core", "update-index"])
# Install Arduino AVR Boards
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_path = copy_sketch("sketch_with_single_string_define")
fqbn = "arduino:avr:uno"
# Compile using a build property with quotes
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-properties="build.extra_flags=\\"-DMY_DEFINE=\\"hello world\\"\\""',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.failed
assert "Flag --build-properties has been deprecated, please use --build-property instead." not in res.stderr
# Try again with quotes
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-properties="build.extra_flags=-DMY_DEFINE=\\"hello\\""',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.failed
assert "Flag --build-properties has been deprecated, please use --build-property instead." not in res.stderr
# Try without quotes
sketch_path = copy_sketch("sketch_with_single_int_define")
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-properties="build.extra_flags=-DMY_DEFINE=1"',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.ok
assert "Flag --build-properties has been deprecated, please use --build-property instead." in res.stderr
assert "-DMY_DEFINE=1" in res.stdout
sketch_path = copy_sketch("sketch_with_multiple_int_defines")
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-properties="build.extra_flags=-DFIRST_PIN=1,compiler.cpp.extra_flags=-DSECOND_PIN=2"',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.ok
assert "Flag --build-properties has been deprecated, please use --build-property instead." in res.stderr
assert "-DFIRST_PIN=1" in res.stdout
assert "-DSECOND_PIN=2" in res.stdout
def test_compile_with_build_property_containing_quotes(run_command, data_dir, copy_sketch):
# Init the environment explicitly
assert run_command(["core", "update-index"])
# Install Arduino AVR Boards
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_path = copy_sketch("sketch_with_single_string_define")
fqbn = "arduino:avr:uno"
# Compile using a build property with quotes
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-property=build.extra_flags=\\"-DMY_DEFINE=\\"hello world\\"\\"',
sketch_path,
"--verbose",
]
)
assert res.ok
assert '-DMY_DEFINE=\\"hello world\\"' in res.stdout
def test_compile_with_multiple_build_property_flags(run_command, data_dir, copy_sketch, working_dir):
# Init the environment explicitly
assert run_command(["core", "update-index"])
# Install Arduino AVR Boards
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_path = copy_sketch("sketch_with_multiple_defines")
fqbn = "arduino:avr:uno"
# Compile using multiple build properties separated by a space
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-property=compiler.cpp.extra_flags=\\"-DPIN=2 -DSSID=\\"This is a String\\"\\"',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.failed
# Compile using multiple build properties separated by a space and properly quoted
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-property=compiler.cpp.extra_flags=-DPIN=2 \\"-DSSID=\\"This is a String\\"\\"',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.ok
assert '-DPIN=2 "-DSSID=\\"This is a String\\""' in res.stdout
# Tries compilation using multiple build properties separated by a comma
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-property=compiler.cpp.extra_flags=\\"-DPIN=2,-DSSID=\\"This is a String\\"\\"',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.failed
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-property=compiler.cpp.extra_flags=\\"-DPIN=2\\"',
'--build-property=compiler.cpp.extra_flags=\\"-DSSID=\\"This is a String\\"\\"',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.failed
assert "-DPIN=2" not in res.stdout
assert '-DSSID=\\"This is a String\\"' in res.stdout
res = run_command(
[
"compile",
"-b",
fqbn,
'--build-property=compiler.cpp.extra_flags=\\"-DPIN=2\\"',
'--build-property=build.extra_flags=\\"-DSSID=\\"hello world\\"\\"',
sketch_path,
"--verbose",
"--clean",
]
)
assert res.ok
assert "-DPIN=2" in res.stdout
assert '-DSSID=\\"hello world\\"' in res.stdout
def test_compile_with_output_dir_flag(run_command, data_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Download latest AVR
run_command(["core", "install", "arduino:avr"])
sketch_name = "CompileWithOutputDir"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
result = run_command(["sketch", "new", sketch_path])
assert result.ok
assert f"Sketch created in: {sketch_path}" in result.stdout
# Test the --output-dir flag with absolute path
output_dir = Path(data_dir, "test_dir", "output_dir")
result = run_command(["compile", "-b", fqbn, sketch_path, "--output-dir", output_dir])
assert result.ok
# Verifies expected binaries have been built
sketch_path_md5 = hashlib.md5(bytes(sketch_path)).hexdigest().upper()
build_dir = Path(tempfile.gettempdir(), f"arduino-sketch-{sketch_path_md5}")
assert (build_dir / f"{sketch_name}.ino.eep").exists()
assert (build_dir / f"{sketch_name}.ino.elf").exists()
assert (build_dir / f"{sketch_name}.ino.hex").exists()
assert (build_dir / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert (build_dir / f"{sketch_name}.ino.with_bootloader.hex").exists()
# Verifies binaries are exported when --output-dir flag is specified
assert output_dir.exists()
assert output_dir.is_dir()
assert (output_dir / f"{sketch_name}.ino.eep").exists()
assert (output_dir / f"{sketch_name}.ino.elf").exists()
assert (output_dir / f"{sketch_name}.ino.hex").exists()
assert (output_dir / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert (output_dir / f"{sketch_name}.ino.with_bootloader.hex").exists()
def test_compile_with_export_binaries_flag(run_command, data_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Download latest AVR
run_command(["core", "install", "arduino:avr"])
sketch_name = "CompileWithExportBinariesFlag"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
assert run_command(["sketch", "new", sketch_path])
# Test the --output-dir flag with absolute path
result = run_command(["compile", "-b", fqbn, sketch_path, "--export-binaries"])
assert result.ok
assert Path(sketch_path, "build").exists()
assert Path(sketch_path, "build").is_dir()
# Verifies binaries are exported when --export-binaries flag is set
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.eep").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.elf").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.hex").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.with_bootloader.hex").exists()
def test_compile_with_custom_build_path(run_command, data_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Download latest AVR
run_command(["core", "install", "arduino:avr"])
sketch_name = "CompileWithBuildPath"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
result = run_command(["sketch", "new", sketch_path])
assert result.ok
assert f"Sketch created in: {sketch_path}" in result.stdout
# Test the --build-path flag with absolute path
build_path = Path(data_dir, "test_dir", "build_dir")
result = run_command(["compile", "-b", fqbn, sketch_path, "--build-path", build_path])
print(result.stderr)
assert result.ok
# Verifies expected binaries have been built to build_path
assert build_path.exists()
assert build_path.is_dir()
assert (build_path / f"{sketch_name}.ino.eep").exists()
assert (build_path / f"{sketch_name}.ino.elf").exists()
assert (build_path / f"{sketch_name}.ino.hex").exists()
assert (build_path / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert (build_path / f"{sketch_name}.ino.with_bootloader.hex").exists()
# Verifies there are no binaries in temp directory
sketch_path_md5 = hashlib.md5(bytes(sketch_path)).hexdigest().upper()
build_dir = Path(tempfile.gettempdir(), f"arduino-sketch-{sketch_path_md5}")
assert not (build_dir / f"{sketch_name}.ino.eep").exists()
assert not (build_dir / f"{sketch_name}.ino.elf").exists()
assert not (build_dir / f"{sketch_name}.ino.hex").exists()
assert not (build_dir / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert not (build_dir / f"{sketch_name}.ino.with_bootloader.hex").exists()
def test_compile_with_export_binaries_env_var(run_command, data_dir, downloads_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Download latest AVR
run_command(["core", "install", "arduino:avr"])
sketch_name = "CompileWithExportBinariesEnvVar"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
assert run_command(["sketch", "new", sketch_path])
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES": "true",
}
# Test compilation with export binaries env var set
result = run_command(["compile", "-b", fqbn, sketch_path], custom_env=env)
assert result.ok
assert Path(sketch_path, "build").exists()
assert Path(sketch_path, "build").is_dir()
# Verifies binaries are exported when export binaries env var is set
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.eep").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.elf").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.hex").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.with_bootloader.hex").exists()
def test_compile_with_export_binaries_config(run_command, data_dir, downloads_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Download latest AVR
run_command(["core", "install", "arduino:avr"])
sketch_name = "CompileWithExportBinariesConfig"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
assert run_command(["sketch", "new", sketch_path])
# Create settings with export binaries set to true
env = {
"ARDUINO_DATA_DIR": data_dir,
"ARDUINO_DOWNLOADS_DIR": downloads_dir,
"ARDUINO_SKETCHBOOK_DIR": data_dir,
"ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES": "true",
}
assert run_command(["config", "init", "--dest-dir", "."], custom_env=env)
# Test compilation with export binaries env var set
result = run_command(["compile", "-b", fqbn, sketch_path])
assert result.ok
assert Path(sketch_path, "build").exists()
assert Path(sketch_path, "build").is_dir()
# Verifies binaries are exported when export binaries env var is set
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.eep").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.elf").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.hex").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.with_bootloader.bin").exists()
assert (sketch_path / "build" / fqbn.replace(":", ".") / f"{sketch_name}.ino.with_bootloader.hex").exists()
def test_compile_with_invalid_url(run_command, data_dir):
# Init the environment explicitly
run_command(["core", "update-index"])
# Download latest AVR
run_command(["core", "install", "arduino:avr"])
sketch_name = "CompileWithInvalidURL"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
assert run_command(["sketch", "new", sketch_path])
# Create settings with custom invalid URL
assert run_command(
["config", "init", "--dest-dir", ".", "--additional-urls", "https://example.com/package_example_index.json"]
)
# Verifies compilation fails cause of missing local index file
res = run_command(["compile", "-b", fqbn, sketch_path])
assert res.ok
lines = [l.strip() for l in res.stderr.splitlines()]
assert "Error initializing instance: Loading index file: loading json index file" in lines[0]
expected_index_file = Path(data_dir, "package_example_index.json")
assert f"loading json index file {expected_index_file}: " + f"open {expected_index_file}:" in lines[-1]
def test_compile_with_custom_libraries(run_command, copy_sketch):
# Creates config with additional URL to install necessary core
url = "http://arduino.esp8266.com/stable/package_esp8266com_index.json"
assert run_command(["config", "init", "--dest-dir", ".", "--additional-urls", url])
# Init the environment explicitly
assert run_command(["update"])
# Install core to compile
assert run_command(["core", "install", "esp8266:esp8266"])
sketch_path = copy_sketch("sketch_with_multiple_custom_libraries")
fqbn = "esp8266:esp8266:nodemcu:xtal=80,vt=heap,eesz=4M1M,wipe=none,baud=115200"
first_lib = Path(sketch_path, "libraries1")
second_lib = Path(sketch_path, "libraries2")
# This compile command has been taken from this issue:
# https://github.com/arduino/arduino-cli/issues/973
assert run_command(["compile", "--libraries", first_lib, "--libraries", second_lib, "-b", fqbn, sketch_path])
def test_compile_with_archives_and_long_paths(run_command):
# Creates config with additional URL to install necessary core
url = "http://arduino.esp8266.com/stable/package_esp8266com_index.json"
assert run_command(["config", "init", "--dest-dir", ".", "--additional-urls", url])
# Init the environment explicitly
assert run_command(["update"])
# Install core to compile
assert run_command(["core", "install", "esp8266:[email protected]"])
# Install test library
assert run_command(["lib", "install", "ArduinoIoTCloud"])
result = run_command(["lib", "examples", "ArduinoIoTCloud", "--format", "json"])
assert result.ok
lib_output = json.loads(result.stdout)
sketch_path = Path(lib_output[0]["library"]["install_dir"], "examples", "ArduinoIoTCloud-Advanced")
assert run_command(["compile", "-b", "esp8266:esp8266:huzzah", sketch_path])
def test_compile_with_precompiled_library(run_command, data_dir):
assert run_command(["update"])
assert run_command(["core", "install", "arduino:[email protected]"])
fqbn = "arduino:samd:mkrzero"
# Install precompiled library
# For more information see:
# https://arduino.github.io/arduino-cli/latest/library-specification/#precompiled-binaries
assert run_command(["lib", "install", "BSEC Software [email protected]"])
sketch_folder = Path(data_dir, "libraries", "BSEC_Software_Library", "examples", "basic")
# Compile and verify dependencies detection for fully precompiled library is not skipped
result = run_command(["compile", "-b", fqbn, sketch_folder, "-v"])
assert result.ok
assert "Skipping dependencies detection for precompiled library BSEC Software Library" not in result.stdout
def test_compile_with_fully_precompiled_library(run_command, data_dir):
assert run_command(["update"])
assert run_command(["core", "install", "arduino:[email protected]"])
fqbn = "arduino:mbed:nano33ble"
# Install fully precompiled library
# For more information see:
# https://arduino.github.io/arduino-cli/latest/library-specification/#precompiled-binaries
assert run_command(["lib", "install", "[email protected]"])
sketch_folder = Path(data_dir, "libraries", "Arduino_TensorFlowLite", "examples", "hello_world")
# Install example dependency
# assert run_command("lib install Arduino_LSM9DS1")
# Compile and verify dependencies detection for fully precompiled library is skipped
result = run_command(["compile", "-b", fqbn, sketch_folder, "-v"])
assert result.ok
assert "Skipping dependencies detection for precompiled library Arduino_TensorFlowLite" in result.stdout
def test_compile_sketch_with_pde_extension(run_command, data_dir):
# Init the environment explicitly
assert run_command(["update"])
# Install core to compile
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompilePdeSketch"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
assert run_command(["sketch", "new", sketch_path])
# Renames sketch file to pde
sketch_file = Path(sketch_path, f"{sketch_name}.ino").rename(sketch_path / f"{sketch_name}.pde")
# Build sketch from folder
res = run_command(["compile", "--clean", "-b", fqbn, sketch_path])
assert res.ok
assert "Sketches with .pde extension are deprecated, please rename the following files to .ino:" in res.stderr
assert str(sketch_file) in res.stderr
# Build sketch from file
res = run_command(["compile", "--clean", "-b", fqbn, sketch_file])
assert res.ok
assert "Sketches with .pde extension are deprecated, please rename the following files to .ino" in res.stderr
assert str(sketch_file) in res.stderr
def test_compile_sketch_with_multiple_main_files(run_command, data_dir):
# Init the environment explicitly
assert run_command(["update"])
# Install core to compile
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompileSketchMultipleMainFiles"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create a test sketch
assert run_command(["sketch", "new", sketch_path])
# Copy .ino sketch file to .pde
sketch_ino_file = Path(sketch_path, f"{sketch_name}.ino")
sketch_pde_file = Path(sketch_path / f"{sketch_name}.pde")
shutil.copyfile(sketch_ino_file, sketch_pde_file)
# Build sketch from folder
res = run_command(["compile", "--clean", "-b", fqbn, sketch_path])
assert res.failed
assert "Error during build: Can't open sketch: multiple main sketch files found" in res.stderr
# Build sketch from .ino file
res = run_command(["compile", "--clean", "-b", fqbn, sketch_ino_file])
assert res.failed
assert "Error during build: Can't open sketch: multiple main sketch files found" in res.stderr
# Build sketch from .pde file
res = run_command(["compile", "--clean", "-b", fqbn, sketch_pde_file])
assert res.failed
assert "Error during build: Can't open sketch: multiple main sketch files found" in res.stderr
def test_compile_sketch_case_mismatch_fails(run_command, data_dir):
# Init the environment explicitly
assert run_command(["update"])
# Install core to compile
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompileSketchCaseMismatch"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
assert run_command(["sketch", "new", sketch_path])
# Rename main .ino file so casing is different from sketch name
sketch_main_file = Path(sketch_path, f"{sketch_name}.ino").rename(sketch_path / f"{sketch_name.lower()}.ino")
# Verifies compilation fails when:
# * Compiling with sketch path
res = run_command(["compile", "--clean", "-b", fqbn, sketch_path])
assert res.failed
assert "Error during build: Can't open sketch: no valid sketch found" in res.stderr
# * Compiling with sketch main file
res = run_command(["compile", "--clean", "-b", fqbn, sketch_main_file])
assert res.failed
assert "Error during build: Can't open sketch: no valid sketch found" in res.stderr
# * Compiling in sketch path
res = run_command(["compile", "--clean", "-b", fqbn], custom_working_dir=sketch_path)
assert res.failed
assert "Error during build: Can't open sketch: no valid sketch found" in res.stderr
def test_compile_with_only_compilation_database_flag(run_command, data_dir):
assert run_command(["update"])
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompileSketchOnlyCompilationDatabaseFlag"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
assert run_command(["sketch", "new", sketch_path])
# Verifies no binaries exist
build_path = Path(sketch_path, "build")
assert not build_path.exists()
# Compile with both --export-binaries and --only-compilation-database flags
assert run_command(
["compile", "--export-binaries", "--only-compilation-database", "--clean", "-b", fqbn, sketch_path]
)
# Verifies no binaries are exported
assert not build_path.exists()
# Verifies no binaries exist
build_path = Path(data_dir, "export-dir")
assert not build_path.exists()
# Compile by setting the --output-dir flag and --only-compilation-database flags
assert run_command(
["compile", "--output-dir", build_path, "--only-compilation-database", "--clean", "-b", fqbn, sketch_path]
)
# Verifies no binaries are exported
assert not build_path.exists()
def test_compile_using_platform_local_txt(run_command, data_dir):
assert run_command(["update"])
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompileSketchUsingPlatformLocalTxt"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
assert run_command(["sketch", "new", sketch_path])
# Verifies compilation works without issues
assert run_command(["compile", "--clean", "-b", fqbn, sketch_path])
# Overrides default platform compiler with an unexisting one
platform_local_txt = Path(data_dir, "packages", "arduino", "hardware", "avr", "1.8.3", "platform.local.txt")
platform_local_txt.write_text("compiler.c.cmd=my-compiler-that-does-not-exist")
# Verifies compilation now fails because compiler is not found
res = run_command(["compile", "--clean", "-b", fqbn, sketch_path])
assert res.failed
assert "my-compiler-that-does-not-exist" in res.stderr
def test_compile_using_boards_local_txt(run_command, data_dir):
assert run_command(["update"])
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompileSketchUsingBoardsLocalTxt"
sketch_path = Path(data_dir, sketch_name)
# Use a made up board
fqbn = "arduino:avr:nessuno"
assert run_command(["sketch", "new", sketch_path])
# Verifies compilation fails because board doesn't exist
res = run_command(["compile", "--clean", "-b", fqbn, sketch_path])
assert res.failed
assert "Error during build: Error resolving FQBN: board arduino:avr:nessuno not found" in res.stderr
# Use custom boards.local.txt with made arduino:avr:nessuno board
boards_local_txt = Path(data_dir, "packages", "arduino", "hardware", "avr", "1.8.3", "boards.local.txt")
shutil.copyfile(Path(__file__).parent / "testdata" / "boards.local.txt", boards_local_txt)
assert run_command(["compile", "--clean", "-b", fqbn, sketch_path])
def test_compile_manually_installed_platform(run_command, data_dir):
assert run_command(["update"])
sketch_name = "CompileSketchManuallyInstalledPlatformUsingPlatformLocalTxt"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino-beta-development:avr:uno"
assert run_command(["sketch", "new", sketch_path])
# Manually installs a core in sketchbooks hardware folder
git_url = "https://github.com/arduino/ArduinoCore-avr.git"
repo_dir = Path(data_dir, "hardware", "arduino-beta-development", "avr")
assert Repo.clone_from(git_url, repo_dir, multi_options=["-b 1.8.3"])
# Installs also the same core via CLI so all the necessary tools are installed
assert run_command(["core", "install", "arduino:[email protected]"])
# Verifies compilation works without issues
assert run_command(["compile", "--clean", "-b", fqbn, sketch_path])
def test_compile_manually_installed_platform_using_platform_local_txt(run_command, data_dir):
assert run_command(["update"])
sketch_name = "CompileSketchManuallyInstalledPlatformUsingPlatformLocalTxt"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino-beta-development:avr:uno"
assert run_command(["sketch", "new", sketch_path])
# Manually installs a core in sketchbooks hardware folder
git_url = "https://github.com/arduino/ArduinoCore-avr.git"
repo_dir = Path(data_dir, "hardware", "arduino-beta-development", "avr")
assert Repo.clone_from(git_url, repo_dir, multi_options=["-b 1.8.3"])
# Installs also the same core via CLI so all the necessary tools are installed
assert run_command(["core", "install", "arduino:[email protected]"])
# Verifies compilation works without issues
assert run_command(["compile", "--clean", "-b", fqbn, sketch_path])
# Overrides default platform compiler with an unexisting one
platform_local_txt = Path(repo_dir, "platform.local.txt")
platform_local_txt.write_text("compiler.c.cmd=my-compiler-that-does-not-exist")
# Verifies compilation now fails because compiler is not found
res = run_command(["compile", "--clean", "-b", fqbn, sketch_path])
assert res.failed
assert "my-compiler-that-does-not-exist" in res.stderr
def test_compile_manually_installed_platform_using_boards_local_txt(run_command, data_dir):
assert run_command(["update"])
sketch_name = "CompileSketchManuallyInstalledPlatformUsingBoardsLocalTxt"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino-beta-development:avr:nessuno"
assert run_command(["sketch", "new", sketch_path])
# Manually installs a core in sketchbooks hardware folder
git_url = "https://github.com/arduino/ArduinoCore-avr.git"
repo_dir = Path(data_dir, "hardware", "arduino-beta-development", "avr")
assert Repo.clone_from(git_url, repo_dir, multi_options=["-b 1.8.3"])
# Installs also the same core via CLI so all the necessary tools are installed
assert run_command(["core", "install", "arduino:[email protected]"])
# Verifies compilation fails because board doesn't exist
res = run_command(["compile", "--clean", "-b", fqbn, sketch_path])
assert res.failed
assert (
"Error during build: Error resolving FQBN: board arduino-beta-development:avr:nessuno not found" in res.stderr
)
# Use custom boards.local.txt with made arduino:avr:nessuno board
boards_local_txt = Path(repo_dir, "boards.local.txt")
shutil.copyfile(Path(__file__).parent / "testdata" / "boards.local.txt", boards_local_txt)
assert run_command(["compile", "--clean", "-b", fqbn, sketch_path])
def test_compile_with_library(run_command, data_dir):
assert run_command(["update"])
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompileSketchWithWiFi101Dependency"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Create new sketch and add library include
assert run_command(["sketch", "new", sketch_path])
sketch_file = sketch_path / f"{sketch_name}.ino"
lines = []
with open(sketch_file, "r") as f:
lines = f.readlines()
lines = ["#include <WiFi101.h>\n"] + lines
with open(sketch_file, "w") as f:
f.writelines(lines)
# Manually installs a library
git_url = "https://github.com/arduino-libraries/WiFi101.git"
lib_path = Path(data_dir, "my-libraries", "WiFi101")
assert Repo.clone_from(git_url, lib_path, multi_options=["-b 0.16.1"])
res = run_command(["compile", "-b", fqbn, sketch_path, "--library", lib_path, "-v"])
assert res.ok
assert "WiFi101" in res.stdout
def test_compile_with_library_priority(run_command, data_dir):
assert run_command(["update"])
assert run_command(["core", "install", "arduino:[email protected]"])
sketch_name = "CompileSketchWithLibraryPriority"
sketch_path = Path(data_dir, sketch_name)
fqbn = "arduino:avr:uno"
# Manually installs a library
git_url = "https://github.com/arduino-libraries/WiFi101.git"
manually_install_lib_path = Path(data_dir, "my-libraries", "WiFi101")
assert Repo.clone_from(git_url, manually_install_lib_path, multi_options=["-b 0.16.1"])
# Install the same library we installed manually
assert run_command(["lib", "install", "WiFi101"])