Libraries in platforms were being chosen instead of those outside, keeping

users from customizing them. Fixes #38

Signed-off-by: Federico Fissore <f.fissore@arduino.cc>

Author: Federico Fissore

src/arduino.cc/builder/includes_to_include_folders.go

@@ -125,27 +125,14 @@ func resolveLibrary(header string, headerToLibraries map[string][]*types.Library
 		return
 	}
 
-	if markedLibrariesContainOneOfCandidate(markImportedLibrary, libraries) {
+	if markImportedLibraryContainsOneOfCandidates(markImportedLibrary, libraries) {
 		return
 	}
 
-	var library *types.Library
-
-	for _, platform := range platforms {
-		if platform != nil && library == nil {
-			librariesWithinSpecifiedPlatform := librariesWithinPlatform(libraries, platform)
-			library = findBestLibraryWithHeader(header, librariesWithinSpecifiedPlatform)
-		}
-	}
-
-	for _, platform := range platforms {
-		if platform != nil && library == nil {
-			library = findBestLibraryWithHeader(header, librariesCompatibleWithPlatform(libraries, platform))
-		}
-	}
+	library := findLibraryOutsideAnyPlatform(header, libraries, platforms)
 
 	if library == nil {
-		library = findBestLibraryWithHeader(header, libraries)
+		library = findLibraryInPlatforms(header, libraries, platforms)
 	}
 
 	if library == nil {
@@ -159,7 +146,57 @@ func resolveLibrary(header string, headerToLibraries map[string][]*types.Library
 	markImportedLibrary[library] = true
 }
 
-func markedLibrariesContainOneOfCandidate(markImportedLibrary map[*types.Library]bool, libraries []*types.Library) bool {
+func findLibraryInPlatforms(header string, libraries []*types.Library, platforms []*types.Platform) *types.Library {
+	for _, platform := range platforms {
+		if platform != nil {
+			librariesWithinSpecifiedPlatform := librariesWithinPlatform(libraries, platform)
+			library := findBestLibraryWithHeader(header, librariesWithinSpecifiedPlatform)
+			if library != nil {
+				return library
+			}
+		}
+	}
+
+	return nil
+}
+
+func findLibraryOutsideAnyPlatform(header string, libraries []*types.Library, platforms []*types.Platform) *types.Library {
+	librariesOutsidePlatforms := librariesOutsideAnyPlatform(libraries, platforms)
+
+	for _, platform := range platforms {
+		if platform != nil {
+			library := findBestLibraryWithHeader(header, librariesCompatibleWithPlatform(librariesOutsidePlatforms, platform))
+			if library != nil {
+				return library
+			}
+		}
+	}
+
+	return findBestLibraryWithHeader(header, librariesOutsidePlatforms)
+}
+
+func librariesOutsideAnyPlatform(libraries []*types.Library, platforms []*types.Platform) []*types.Library {
+	allLibsAsMap := make(map[*types.Library]bool)
+	for _, lib := range libraries {
+		allLibsAsMap[lib] = true
+	}
+	for _, platform := range platforms {
+		if platform != nil {
+			librariesWithinSpecifiedPlatform := librariesWithinPlatform(libraries, platform)
+			for _, libraryWithinPlatform := range librariesWithinSpecifiedPlatform {
+				delete(allLibsAsMap, libraryWithinPlatform)
+			}
+		}
+	}
+
+	librariesOutsidePlatforms := []*types.Library{}
+	for lib, _ := range allLibsAsMap {
+		librariesOutsidePlatforms = append(librariesOutsidePlatforms, lib)
+	}
+	return librariesOutsidePlatforms
+}
+
+func markImportedLibraryContainsOneOfCandidates(markImportedLibrary map[*types.Library]bool, libraries []*types.Library) bool {
 	for markedLibrary, _ := range markImportedLibrary {
 		for _, library := range libraries {
 			if markedLibrary == library {
@@ -211,7 +248,7 @@ func librariesCompatibleWithPlatform(libraries []*types.Library, platform *types
 }
 
 func librariesWithinPlatform(libraries []*types.Library, platform *types.Platform) []*types.Library {
-	var librariesWithinSpecifiedPlatform []*types.Library
+	librariesWithinSpecifiedPlatform := []*types.Library{}
 	for _, library := range libraries {
 		cleanPlatformFolder := filepath.Clean(platform.Folder)
 		cleanLibraryFolder := filepath.Clean(library.SrcFolder)

src/arduino.cc/builder/test/includes_to_include_folders_test.go

@@ -200,7 +200,7 @@ func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
 	context[constants.CTX_FQBN] = "my_avr_platform:avr:custom_yun"
 	context[constants.CTX_SKETCH_LOCATION] = filepath.Join("user_hardware", "my_avr_platform", "avr", "libraries", "SPI", "examples", "BarometricPressureSensor", "BarometricPressureSensor.ino")
 	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
-	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"libraries", "downloaded_libraries"}
+	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"downloaded_libraries"}
 	context[constants.CTX_VERBOSE] = false
 
 	commands := []types.Command{
@@ -225,6 +225,44 @@ func TestIncludesToIncludeFoldersDuplicateLibs(t *testing.T) {
 	require.Equal(t, Abs(t, filepath.Join("user_hardware", "my_avr_platform", "avr", "libraries", "SPI")), importedLibraries[0].SrcFolder)
 }
 
+func TestIncludesToIncludeFoldersDuplicateLibsWithConflictingLibsOutsideOfPlatform(t *testing.T) {
+	DownloadCoresAndToolsAndLibraries(t)
+
+	context := make(map[string]interface{})
+
+	buildPath := SetupBuildPath(t, context)
+	defer os.RemoveAll(buildPath)
+
+	context[constants.CTX_HARDWARE_FOLDERS] = []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware", "user_hardware"}
+	context[constants.CTX_TOOLS_FOLDERS] = []string{"downloaded_tools"}
+	context[constants.CTX_FQBN] = "my_avr_platform:avr:custom_yun"
+	context[constants.CTX_SKETCH_LOCATION] = filepath.Join("user_hardware", "my_avr_platform", "avr", "libraries", "SPI", "examples", "BarometricPressureSensor", "BarometricPressureSensor.ino")
+	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
+	context[constants.CTX_LIBRARIES_FOLDERS] = []string{"downloaded_libraries", "libraries"}
+	context[constants.CTX_VERBOSE] = true
+
+	commands := []types.Command{
+		&builder.SetupHumanLoggerIfMissing{},
+
+		&builder.ContainerSetupHardwareToolsLibsSketchAndProps{},
+
+		&builder.ContainerMergeCopySketchFiles{},
+
+		&builder.ContainerFindIncludes{},
+	}
+
+	for _, command := range commands {
+		err := command.Run(context)
+		NoError(t, err)
+	}
+
+	importedLibraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
+	sort.Sort(ByLibraryName(importedLibraries))
+	require.Equal(t, 1, len(importedLibraries))
+	require.Equal(t, "SPI", importedLibraries[0].Name)
+	require.Equal(t, Abs(t, filepath.Join("libraries", "SPI")), importedLibraries[0].SrcFolder)
+}
+
 func TestIncludesToIncludeFoldersDuplicateLibs2(t *testing.T) {
 	DownloadCoresAndToolsAndLibraries(t)