Removing stale libraries object files, resulting from previous compilations

Signed-off-by: Federico Fissore <[email protected]>

Author: Federico Fissore

Diff for: src/arduino.cc/builder/builder.go

@@ -94,6 +94,7 @@ func (s *Builder) Run(context map[string]interface{}) error {
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_SKETCH_POSTBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_LIBRARIES_PREBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
+		&UnusedCompiledLibrariesRemover{},
 		&phases.LibrariesBuilder{},
 		&RecipeByPrefixSuffixRunner{Prefix: constants.HOOKS_LIBRARIES_POSTBUILD, Suffix: constants.HOOKS_PATTERN_SUFFIX},
 

Diff for: src/arduino.cc/builder/test/builder_test.go

@@ -341,3 +341,32 @@ func TestBuilderSketchWithSubfolders(t *testing.T) {
 	err := command.Run(context)
 	NoError(t, err)
 }
+
+func TestBuilderSketchBuildPathContainsUnusedPreviouslyCompiledLibrary(t *testing.T) {
+	DownloadCoresAndToolsAndLibraries(t)
+
+	context := make(map[string]interface{})
+
+	buildPath := SetupBuildPath(t, context)
+	defer os.RemoveAll(buildPath)
+
+	NoError(t, os.MkdirAll(filepath.Join(buildPath, constants.FOLDER_LIBRARIES, "SPI"), os.FileMode(0755)))
+
+	context[constants.CTX_HARDWARE_FOLDERS] = []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware"}
+	context[constants.CTX_TOOLS_FOLDERS] = []string{"downloaded_tools"}
+	context[constants.CTX_FQBN] = "arduino:avr:leonardo"
+	context[constants.CTX_SKETCH_LOCATION] = filepath.Join("downloaded_libraries", "Bridge", "examples", "Bridge", "Bridge.ino")
+	context[constants.CTX_BUILT_IN_LIBRARIES_FOLDERS] = []string{"downloaded_libraries"}
+	context[constants.CTX_OTHER_LIBRARIES_FOLDERS] = []string{"libraries"}
+	context[constants.CTX_BUILD_PROPERTIES_RUNTIME_IDE_VERSION] = "10600"
+
+	command := builder.Builder{}
+	err := command.Run(context)
+	NoError(t, err)
+
+	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_LIBRARIES, "SPI"))
+	require.Error(t, err)
+	require.True(t, os.IsNotExist(err))
+	_, err = os.Stat(filepath.Join(buildPath, constants.FOLDER_LIBRARIES, "Bridge"))
+	NoError(t, err)
+}

Diff for: src/arduino.cc/builder/test/unused_compiled_libraries_remover_test.go

@@ -0,0 +1,77 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package test
+
+import (
+	"arduino.cc/builder"
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/types"
+	"github.com/stretchr/testify/require"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+func TestUnusedCompiledLibrariesRemover(t *testing.T) {
+	temp, err := ioutil.TempDir("", "test")
+	NoError(t, err)
+	defer os.RemoveAll(temp)
+
+	NoError(t, os.MkdirAll(filepath.Join(temp, "SPI"), os.FileMode(0755)))
+	NoError(t, os.MkdirAll(filepath.Join(temp, "Bridge"), os.FileMode(0755)))
+	NoError(t, ioutil.WriteFile(filepath.Join(temp, "dummy_file"), []byte{}, os.FileMode(0644)))
+
+	context := make(map[string]interface{})
+	context[constants.CTX_LIBRARIES_BUILD_PATH] = temp
+	context[constants.CTX_IMPORTED_LIBRARIES] = []*types.Library{&types.Library{Name: "Bridge"}}
+
+	cmd := builder.UnusedCompiledLibrariesRemover{}
+	err = cmd.Run(context)
+	NoError(t, err)
+
+	_, err = os.Stat(filepath.Join(temp, "SPI"))
+	require.Error(t, err)
+	require.True(t, os.IsNotExist(err))
+	_, err = os.Stat(filepath.Join(temp, "Bridge"))
+	NoError(t, err)
+	_, err = os.Stat(filepath.Join(temp, "dummy_file"))
+	NoError(t, err)
+}
+
+func TestUnusedCompiledLibrariesRemoverLibDoesNotExist(t *testing.T) {
+	context := make(map[string]interface{})
+	context[constants.CTX_LIBRARIES_BUILD_PATH] = filepath.Join(os.TempDir(), "test")
+	context[constants.CTX_IMPORTED_LIBRARIES] = []*types.Library{&types.Library{Name: "Bridge"}}
+
+	cmd := builder.UnusedCompiledLibrariesRemover{}
+	err := cmd.Run(context)
+	NoError(t, err)
+}

Diff for: src/arduino.cc/builder/unused_compiled_libraries_remover.go

@@ -0,0 +1,82 @@
+/*
+ * This file is part of Arduino Builder.
+ *
+ * Arduino Builder is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
+ */
+
+package builder
+
+import (
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/types"
+	"arduino.cc/builder/utils"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+)
+
+type UnusedCompiledLibrariesRemover struct{}
+
+func (s *UnusedCompiledLibrariesRemover) Run(context map[string]interface{}) error {
+	librariesBuildPath := context[constants.CTX_LIBRARIES_BUILD_PATH].(string)
+	libraries := context[constants.CTX_IMPORTED_LIBRARIES].([]*types.Library)
+
+	if len(libraries) == 0 {
+		return nil
+	}
+
+	_, err := os.Stat(librariesBuildPath)
+	if err != nil && os.IsNotExist(err) {
+		return nil
+	}
+
+	libraryNames := toLibraryNames(libraries)
+
+	files, err := ioutil.ReadDir(librariesBuildPath)
+	if err != nil {
+		return utils.WrapError(err)
+	}
+	for _, file := range files {
+		if file.IsDir() {
+			if !utils.SliceContains(libraryNames, file.Name()) {
+				err := os.RemoveAll(filepath.Join(librariesBuildPath, file.Name()))
+				if err != nil {
+					return utils.WrapError(err)
+				}
+			}
+		}
+	}
+
+	return nil
+}
+
+func toLibraryNames(libraries []*types.Library) []string {
+	libraryNames := []string{}
+	for _, library := range libraries {
+		libraryNames = append(libraryNames, library.Name)
+	}
+	return libraryNames
+}