[skip-changelog] Migrate tests from test_compile_part_2.py to compile_part_2_test.go (#1897)

* Migrate TestCompileWithOutputDirFlag from test_compile_part_2.py to compile_part_2_test.go

* Migrate TestCompileWithExportBinariesFlag from test_compile_part_2.py to compile_part_2_test.go

* Migrate TestCompileWithCustomBuildPath from test_compile_part_2.py to compile_part_2_test.go

* Migrate TestCompileWithInvalidUrl from test_compile_part_2.py to compile_part_2_test.go

* Migrate TestCompileWithExportBinariesEnvVar from test_compile_part_2.py to compile_part_2_test.go

* Migrate TestCompileWithExportBinariesConfig from test_compile_part_2.py
to compile_part_2_test.go

* Migrate TestCompileWithCustomLibraries from test_compile_part_2.py to compile_part_2_test.go

* Migrate TestCompileWithArchivesAndLongPaths from test_compile_part_2.py to compile_part_2_test.go

* Migrate TestCompileWithPrecompileLibrary to compile_part_2_test.go and delete test_compile_part_2.py

* Increase lapse before timeout by 5 minutes

Author: MatteoPologruto

Diff for: Taskfile.yml

@@ -102,7 +102,7 @@ tasks:
           -short \
           -p 1 \
           -run '{{default ".*" .GO_TEST_REGEX}}' \
-          {{default "-timeout 10m -coverpkg=./... -covermode=atomic" .GO_TEST_FLAGS}} \
+          {{default "-timeout 15m -coverpkg=./... -covermode=atomic" .GO_TEST_FLAGS}} \
           -coverprofile=coverage_unit.txt \
           {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}} \
           {{.TEST_LDFLAGS}}

Diff for: internal/integrationtest/compile/compile_part_2_test.go

@@ -0,0 +1,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")
+}

Diff for: test/testdata/sketch_with_multiple_custom_libraries/libraries1/Lib/lib1.h renamed to internal/integrationtest/testdata/sketch_with_multiple_custom_libraries/libraries1/Lib/lib1.h

@@ -1,8 +1,8 @@
-#include "lib1.h"
-#include "lib2.h"
-
-void setup() {
-}
-
-void loop() {
-}
+#include "lib1.h"
+#include "lib2.h"
+
+void setup() {
+}
+
+void loop() {
+}