forked from arduino/arduino-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcompile_part_2_test.go
354 lines (286 loc) · 13.8 KB
/
compile_part_2_test.go
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
// This file is part of arduino-cli.
//
// Copyright 2022 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].
package compile_part_1_test
import (
"crypto/md5"
"encoding/hex"
"encoding/json"
"strings"
"testing"
"github.com/arduino/arduino-cli/internal/integrationtest"
"github.com/arduino/go-paths-helper"
"github.com/stretchr/testify/require"
"go.bug.st/testifyjson/requirejson"
)
func TestCompileWithOutputDirFlag(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Init the environment explicitly
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)
// Download latest AVR
_, _, err = cli.Run("core", "install", "arduino:avr")
require.NoError(t, err)
sketchName := "CompileWithOutputDir"
sketchPath := cli.SketchbookDir().Join(sketchName)
fqbn := "arduino:avr:uno"
// Create a test sketch
stdout, _, err := cli.Run("sketch", "new", sketchPath.String())
require.NoError(t, err)
require.Contains(t, string(stdout), "Sketch created in: "+sketchPath.String())
// Test the --output-dir flag with absolute path
outputDir := cli.SketchbookDir().Join("test_dir", "output_dir")
_, _, err = cli.Run("compile", "-b", fqbn, sketchPath.String(), "--output-dir", outputDir.String())
require.NoError(t, err)
// Verifies expected binaries have been built
md5 := md5.Sum(([]byte(sketchPath.String())))
sketchPathMd5 := strings.ToUpper(hex.EncodeToString(md5[:]))
require.NotEmpty(t, sketchPathMd5)
buildDir := paths.TempDir().Join("arduino-sketch-" + sketchPathMd5)
require.FileExists(t, buildDir.Join(sketchName+".ino.eep").String())
require.FileExists(t, buildDir.Join(sketchName+".ino.elf").String())
require.FileExists(t, buildDir.Join(sketchName+".ino.hex").String())
require.FileExists(t, buildDir.Join(sketchName+".ino.with_bootloader.bin").String())
require.FileExists(t, buildDir.Join(sketchName+".ino.with_bootloader.hex").String())
// Verifies binaries are exported when --output-dir flag is specified
require.DirExists(t, outputDir.String())
require.FileExists(t, outputDir.Join(sketchName+".ino.eep").String())
require.FileExists(t, outputDir.Join(sketchName+".ino.elf").String())
require.FileExists(t, outputDir.Join(sketchName+".ino.hex").String())
require.FileExists(t, outputDir.Join(sketchName+".ino.with_bootloader.bin").String())
require.FileExists(t, outputDir.Join(sketchName+".ino.with_bootloader.hex").String())
}
func TestCompileWithExportBinariesFlag(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Init the environment explicitly
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)
// Download latest AVR
_, _, err = cli.Run("core", "install", "arduino:avr")
require.NoError(t, err)
sketchName := "CompileWithExportBinariesFlag"
sketchPath := cli.SketchbookDir().Join(sketchName)
fqbn := "arduino:avr:uno"
// Create a test sketch
_, _, err = cli.Run("sketch", "new", sketchPath.String())
require.NoError(t, err)
// Test the --output-dir flag with absolute path
_, _, err = cli.Run("compile", "-b", fqbn, sketchPath.String(), "--export-binaries")
require.NoError(t, err)
require.DirExists(t, sketchPath.Join("build").String())
// Verifies binaries are exported when --export-binaries flag is set
fqbn = strings.ReplaceAll(fqbn, ":", ".")
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.eep").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.elf").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.hex").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.with_bootloader.bin").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.with_bootloader.hex").String())
}
func TestCompileWithCustomBuildPath(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Init the environment explicitly
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)
// Download latest AVR
_, _, err = cli.Run("core", "install", "arduino:avr")
require.NoError(t, err)
sketchName := "CompileWithBuildPath"
sketchPath := cli.SketchbookDir().Join(sketchName)
fqbn := "arduino:avr:uno"
// Create a test sketch
_, _, err = cli.Run("sketch", "new", sketchPath.String())
require.NoError(t, err)
// Test the --build-path flag with absolute path
buildPath := cli.DataDir().Join("test_dir", "build_dir")
_, _, err = cli.Run("compile", "-b", fqbn, sketchPath.String(), "--build-path", buildPath.String())
require.NoError(t, err)
// Verifies expected binaries have been built to build_path
require.DirExists(t, buildPath.String())
require.FileExists(t, buildPath.Join(sketchName+".ino.eep").String())
require.FileExists(t, buildPath.Join(sketchName+".ino.elf").String())
require.FileExists(t, buildPath.Join(sketchName+".ino.hex").String())
require.FileExists(t, buildPath.Join(sketchName+".ino.with_bootloader.bin").String())
require.FileExists(t, buildPath.Join(sketchName+".ino.with_bootloader.hex").String())
// Verifies there are no binaries in temp directory
md5 := md5.Sum(([]byte(sketchPath.String())))
sketchPathMd5 := strings.ToUpper(hex.EncodeToString(md5[:]))
require.NotEmpty(t, sketchPathMd5)
buildDir := paths.TempDir().Join("arduino-sketch-" + sketchPathMd5)
require.NoFileExists(t, buildDir.Join(sketchName+".ino.eep").String())
require.NoFileExists(t, buildDir.Join(sketchName+".ino.elf").String())
require.NoFileExists(t, buildDir.Join(sketchName+".ino.hex").String())
require.NoFileExists(t, buildDir.Join(sketchName+".ino.with_bootloader.bin").String())
require.NoFileExists(t, buildDir.Join(sketchName+".ino.with_bootloader.hex").String())
}
func TestCompileWithExportBinariesEnvVar(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Init the environment explicitly
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)
// Download latest AVR
_, _, err = cli.Run("core", "install", "arduino:avr")
require.NoError(t, err)
sketchName := "CompileWithExportBinariesEnvVar"
sketchPath := cli.SketchbookDir().Join(sketchName)
fqbn := "arduino:avr:uno"
// Create a test sketch
_, _, err = cli.Run("sketch", "new", sketchPath.String())
require.NoError(t, err)
envVar := cli.GetDefaultEnv()
envVar["ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES"] = "true"
// Test compilation with export binaries env var set
_, _, err = cli.RunWithCustomEnv(envVar, "compile", "-b", fqbn, sketchPath.String())
require.NoError(t, err)
require.DirExists(t, sketchPath.Join("build").String())
// Verifies binaries are exported when export binaries env var is set
fqbn = strings.ReplaceAll(fqbn, ":", ".")
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.eep").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.elf").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.hex").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.with_bootloader.bin").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.with_bootloader.hex").String())
}
func TestCompileWithExportBinariesConfig(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Init the environment explicitly
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)
// Download latest AVR
_, _, err = cli.Run("core", "install", "arduino:avr")
require.NoError(t, err)
sketchName := "CompileWithExportBinariesEnvVar"
sketchPath := cli.SketchbookDir().Join(sketchName)
fqbn := "arduino:avr:uno"
// Create a test sketch
_, _, err = cli.Run("sketch", "new", sketchPath.String())
require.NoError(t, err)
// Create settings with export binaries set to true
envVar := cli.GetDefaultEnv()
envVar["ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES"] = "true"
_, _, err = cli.RunWithCustomEnv(envVar, "config", "init", "--dest-dir", ".")
require.NoError(t, err)
// Test if arduino-cli config file written in the previous run has the `always_export_binaries` flag set.
stdout, _, err := cli.Run("config", "dump", "--format", "json")
require.NoError(t, err)
requirejson.Contains(t, stdout, `
{
"sketch": {
"always_export_binaries": "true"
}
}`)
// Test compilation with export binaries env var set
_, _, err = cli.Run("compile", "-b", fqbn, sketchPath.String())
require.NoError(t, err)
require.DirExists(t, sketchPath.Join("build").String())
// Verifies binaries are exported when export binaries env var is set
fqbn = strings.ReplaceAll(fqbn, ":", ".")
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.eep").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.elf").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.hex").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.with_bootloader.bin").String())
require.FileExists(t, sketchPath.Join("build", fqbn, sketchName+".ino.with_bootloader.hex").String())
}
func TestCompileWithInvalidUrl(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Init the environment explicitly
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)
// Download latest AVR
_, _, err = cli.Run("core", "install", "arduino:avr")
require.NoError(t, err)
sketchName := "CompileWithInvalidURL"
sketchPath := cli.SketchbookDir().Join(sketchName)
fqbn := "arduino:avr:uno"
// Create a test sketch
_, _, err = cli.Run("sketch", "new", sketchPath.String())
require.NoError(t, err)
_, _, err = cli.Run("config", "init", "--dest-dir", ".", "--additional-urls", "https://example.com/package_example_index.json")
require.NoError(t, err)
_, stderr, err := cli.Run("compile", "-b", fqbn, sketchPath.String())
require.NoError(t, err)
require.Contains(t, string(stderr), "Error initializing instance: Loading index file: loading json index file")
expectedIndexfile := cli.DataDir().Join("package_example_index.json")
require.Contains(t, string(stderr), "loading json index file "+expectedIndexfile.String()+": open "+expectedIndexfile.String()+":")
}
func TestCompileWithCustomLibraries(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Creates config with additional URL to install necessary core
url := "http://arduino.esp8266.com/stable/package_esp8266com_index.json"
_, _, err := cli.Run("config", "init", "--dest-dir", ".", "--additional-urls", url)
require.NoError(t, err)
// Init the environment explicitly
_, _, err = cli.Run("update")
require.NoError(t, err)
_, _, err = cli.Run("core", "install", "esp8266:esp8266")
require.NoError(t, err)
sketchName := "sketch_with_multiple_custom_libraries"
sketchPath := cli.CopySketch(sketchName)
fqbn := "esp8266:esp8266:nodemcu:xtal=80,vt=heap,eesz=4M1M,wipe=none,baud=115200"
firstLib := sketchPath.Join("libraries1")
secondLib := sketchPath.Join("libraries2")
_, _, err = cli.Run("compile", "--libraries", firstLib.String(), "--libraries", secondLib.String(), "-b", fqbn, sketchPath.String())
require.NoError(t, err)
}
func TestCompileWithArchivesAndLongPaths(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Creates config with additional URL to install necessary core
url := "http://arduino.esp8266.com/stable/package_esp8266com_index.json"
_, _, err := cli.Run("config", "init", "--dest-dir", ".", "--additional-urls", url)
require.NoError(t, err)
// Init the environment explicitly
_, _, err = cli.Run("update")
require.NoError(t, err)
// Install core to compile
_, _, err = cli.Run("core", "install", "esp8266:[email protected]")
require.NoError(t, err)
// Install test library
_, _, err = cli.Run("lib", "install", "ArduinoIoTCloud")
require.NoError(t, err)
stdout, _, err := cli.Run("lib", "examples", "ArduinoIoTCloud", "--format", "json")
require.NoError(t, err)
var libOutput []map[string]interface{}
err = json.Unmarshal(stdout, &libOutput)
require.NoError(t, err)
sketchPath := paths.New(libOutput[0]["library"].(map[string]interface{})["install_dir"].(string))
sketchPath = sketchPath.Join("examples", "ArduinoIoTCloud-Advanced")
_, _, err = cli.Run("compile", "-b", "esp8266:esp8266:huzzah", sketchPath.String())
require.NoError(t, err)
}
func TestCompileWithPrecompileLibrary(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
_, _, err := cli.Run("update")
require.NoError(t, err)
_, _, err = cli.Run("core", "install", "arduino:[email protected]")
require.NoError(t, err)
fqbn := "arduino:samd:mkrzero"
// Install precompiled library
// For more information see:
// https://arduino.github.io/arduino-cli/latest/library-specification/#precompiled-binaries
_, _, err = cli.Run("lib", "install", "BSEC Software [email protected]")
require.NoError(t, err)
sketchFolder := cli.SketchbookDir().Join("libraries", "BSEC_Software_Library", "examples", "basic")
// Compile and verify dependencies detection for fully precompiled library is not skipped
stdout, _, err := cli.Run("compile", "-b", fqbn, sketchFolder.String(), "-v")
require.NoError(t, err)
require.NotContains(t, string(stdout), "Skipping dependencies detection for precompiled library BSEC Software Library")
}