Skip empty folders when precompiled library is used (#1134)

* Precompiled libraries: only select a folder if it contains files

* Restore precompiled tests

* slightly refactored directoryContainsFile function

* [skip changelog] Fix compile tests

* [skip changelog] Fix compile test

Co-authored-by: Cristian Maglie <[email protected]>
Co-authored-by: Silvano Cerza <[email protected]>

Author: 3 people

Diff for: legacy/builder/phases/libraries_builder.go

@@ -53,6 +53,14 @@ func (s *LibrariesBuilder) Run(ctx *types.Context) error {
 	return nil
 }
 
+func directoryContainsFile(folder *paths.Path) bool {
+	if files, err := folder.ReadDir(); err == nil {
+		files.FilterOutDirs()
+		return len(files) > 0
+	}
+	return false
+}
+
 func findExpectedPrecompiledLibFolder(ctx *types.Context, library *libraries.Library) *paths.Path {
 	mcu := ctx.BuildProperties.Get(constants.BUILD_PROPERTIES_BUILD_MCU)
 	// Add fpu specifications if they exist
@@ -86,15 +94,15 @@ func findExpectedPrecompiledLibFolder(ctx *types.Context, library *libraries.Lib
 	if len(fpuSpecs) > 0 {
 		fpuSpecs = strings.TrimRight(fpuSpecs, "-")
 		fullPrecompDir := library.SourceDir.Join(mcu).Join(fpuSpecs)
-		if fullPrecompDir.Exist() {
+		if fullPrecompDir.Exist() && directoryContainsFile(fullPrecompDir) {
 			logger.Fprintln(os.Stdout, constants.LOG_LEVEL_INFO, "Using precompiled library in {0}", fullPrecompDir)
 			return fullPrecompDir
 		}
 		logger.Fprintln(os.Stdout, constants.LOG_LEVEL_INFO, "Precompiled library in \"{0}\" not found", fullPrecompDir)
 	}
 
 	precompDir := library.SourceDir.Join(mcu)
-	if precompDir.Exist() {
+	if precompDir.Exist() && directoryContainsFile(precompDir) {
 		logger.Fprintln(os.Stdout, constants.LOG_LEVEL_INFO, "Using precompiled library in {0}", precompDir)
 		return precompDir
 	}

Diff for: test/test_compile.py

@@ -181,65 +181,39 @@ def test_compile_blacklisted_sketchname(run_command, data_dir):
     assert result.ok
 
 
-@pytest.mark.skip()
 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"
-    result = run_command("core update-index --additional-urls={}".format(url))
-    assert result.ok
-    # arduino:mbed 1.1.5 is incompatible with the Arduino_TensorFlowLite library
-    # see: https://github.com/arduino/ArduinoCore-nRF528x-mbedos/issues/93
-    result = run_command("core install arduino:[email protected] --additional-urls={}".format(url))
-    assert result.ok
-    result = run_command("core install arduino:[email protected] --additional-urls={}".format(url))
-    assert result.ok
-    result = run_command("core install adafruit:[email protected] --additional-urls={}".format(url))
-    assert result.ok
+    assert run_command(f"core update-index --additional-urls={url}")
+    assert run_command(f"core install arduino:[email protected] --additional-urls={url}")
 
-    # Install pre-release version of Arduino_TensorFlowLite (will be officially released
-    # via lib manager after https://github.com/arduino/arduino-builder/issues/353 is in)
-    import zipfile
+    # Precompiled version of Arduino_TensorflowLite
+    assert run_command("lib install Arduino_LSM9DS1")
+    assert run_command("lib install [email protected]")
 
-    with zipfile.ZipFile("test/testdata/Arduino_TensorFlowLite.zip", "r") as zip_ref:
-        zip_ref.extractall("{}/libraries/".format(data_dir))
-    result = run_command("lib install [email protected]")
-    assert result.ok
-    result = run_command(
-        "compile -b arduino:mbed:nano33ble {}/libraries/Arduino_TensorFlowLite/examples/magic_wand/".format(data_dir)
-    )
-    assert result.ok
-    result = run_command(
-        "compile -b adafruit:samd:adafruit_feather_m4 {}/libraries/Arduino_TensorFlowLite/examples/magic_wand/".format(
-            data_dir
-        )
-    )
-    assert result.ok
+    sketch_path = Path(data_dir, "libraries", "Arduino_TensorFlowLite", "examples", "hello_world")
+    assert run_command(f"compile -b arduino:mbed:nano33ble {sketch_path}")
+
+    assert run_command(f"core install arduino:[email protected] --additional-urls={url}")
+    assert run_command(f"core install adafruit:[email protected] --additional-urls={url}")
+    # should work on adafruit too after https://github.com/arduino/arduino-cli/pull/1134
+    assert run_command(f"compile -b adafruit:samd:adafruit_feather_m4 {sketch_path}")
 
     # Non-precompiled version of Arduino_TensorflowLite
-    result = run_command("lib install [email protected]")
-    assert result.ok
-    result = run_command(
-        "compile -b arduino:mbed:nano33ble {}/libraries/Arduino_TensorFlowLite/examples/magic_wand/".format(data_dir)
-    )
-    assert result.ok
-    result = run_command(
-        "compile -b adafruit:samd:adafruit_feather_m4 {}/libraries/Arduino_TensorFlowLite/examples/magic_wand/".format(
-            data_dir
-        )
-    )
-    assert result.ok
+    assert run_command("lib install [email protected]")
+    assert run_command(f"compile -b arduino:mbed:nano33ble {sketch_path}")
+    assert run_command(f"compile -b adafruit:samd:adafruit_feather_m4 {sketch_path}")
 
     # Bosch sensor library
-    result = run_command('lib install "BSEC Software [email protected]"')
-    assert result.ok
-    result = run_command(
-        "compile -b arduino:samd:mkr1000 {}/libraries/BSEC_Software_Library/examples/basic/".format(data_dir)
-    )
-    assert result.ok
-    result = run_command(
-        "compile -b arduino:mbed:nano33ble {}/libraries/BSEC_Software_Library/examples/basic/".format(data_dir)
-    )
-    assert result.ok
+    assert run_command('lib install "BSEC Software [email protected]"')
+    sketch_path = Path(data_dir, "libraries", "BSEC_Software_Library", "examples", "basic")
+    assert run_command(f"compile -b arduino:samd:mkr1000 {sketch_path}")
+    assert run_command(f"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(f"compile -b arduino:samd:mkrvidor4000 {sketch_path}")
 
 
 def test_compile_with_build_properties_flag(run_command, data_dir, copy_sketch):