A better implementation of ObjFileIsUpToDate, ported from OldCompiler

Fixes #19

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

Author: Federico Fissore

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

@@ -141,17 +141,12 @@ func compileFileWithRecipe(sourcePath string, source string, buildPath string, b
 		return "", utils.WrapError(err)
 	}
 
-	sourceFileStat, err := os.Stat(properties[constants.BUILD_PROPERTIES_SOURCE_FILE])
+	objIsUpToDate, err := ObjFileIsUpToDate(properties[constants.BUILD_PROPERTIES_SOURCE_FILE], properties[constants.BUILD_PROPERTIES_OBJECT_FILE], filepath.Join(buildPath, relativeSource+".d"))
 	if err != nil {
 		return "", utils.WrapError(err)
 	}
 
-	objectFileStat, err := os.Stat(properties[constants.BUILD_PROPERTIES_OBJECT_FILE])
-	if err != nil && !os.IsNotExist(err) {
-		return "", utils.WrapError(err)
-	}
-
-	if !objFileIsUpToDateWithSourceFile(sourceFileStat, objectFileStat) {
+	if !objIsUpToDate {
 		_, err = ExecRecipe(properties, recipe, false, verbose, verbose, logger)
 		if err != nil {
 			return "", utils.WrapError(err)
@@ -163,8 +158,99 @@ func compileFileWithRecipe(sourcePath string, source string, buildPath string, b
 	return properties[constants.BUILD_PROPERTIES_OBJECT_FILE], nil
 }
 
-func objFileIsUpToDateWithSourceFile(sourceFileStat, objectFileStat os.FileInfo) bool {
-	return objectFileStat != nil && sourceFileStat.ModTime().Before(objectFileStat.ModTime())
+func ObjFileIsUpToDate(sourceFile, objectFile, dependencyFile string) (bool, error) {
+	sourceFile = filepath.Clean(sourceFile)
+	objectFile = filepath.Clean(objectFile)
+	dependencyFile = filepath.Clean(dependencyFile)
+
+	sourceFileStat, err := os.Stat(sourceFile)
+	if err != nil {
+		return false, utils.WrapError(err)
+	}
+
+	objectFileStat, err := os.Stat(objectFile)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return false, nil
+		} else {
+			return false, utils.WrapError(err)
+		}
+	}
+
+	dependencyFileStat, err := os.Stat(dependencyFile)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return false, nil
+		} else {
+			return false, utils.WrapError(err)
+		}
+	}
+
+	if sourceFileStat.ModTime().After(objectFileStat.ModTime()) {
+		return false, nil
+	}
+	if sourceFileStat.ModTime().After(dependencyFileStat.ModTime()) {
+		return false, nil
+	}
+
+	rows, err := utils.ReadFileToRows(dependencyFile)
+	if err != nil {
+		return false, utils.WrapError(err)
+	}
+
+	rows = utils.Map(rows, removeEndingBackSlash)
+	rows = utils.Map(rows, strings.TrimSpace)
+	rows = utils.Map(rows, unescapeDep)
+	rows = utils.Filter(rows, nonEmptyString)
+
+	if len(rows) == 0 {
+		return true, nil
+	}
+
+	firstRow := rows[0]
+	if !strings.HasSuffix(firstRow, ":") {
+		return false, nil
+	}
+	objFileInDepFile := firstRow[:len(firstRow)-1]
+	if objFileInDepFile != objectFile {
+		return false, nil
+	}
+
+	rows = rows[1:]
+	for _, row := range rows {
+		depStat, err := os.Stat(row)
+		if err != nil && !os.IsNotExist(err) {
+			return false, utils.WrapError(err)
+		}
+		if os.IsNotExist(err) {
+			return false, nil
+		}
+		if depStat.ModTime().After(objectFileStat.ModTime()) {
+			return false, nil
+		}
+	}
+
+	return true, nil
+}
+
+func unescapeDep(s string) string {
+	s = strings.Replace(s, "\\ ", " ", -1)
+	s = strings.Replace(s, "\\\t", "\t", -1)
+	s = strings.Replace(s, "\\#", "#", -1)
+	s = strings.Replace(s, "$$", "$", -1)
+	s = strings.Replace(s, "\\\\", "\\", -1)
+	return s
+}
+
+func removeEndingBackSlash(s string) string {
+	if strings.HasSuffix(s, "\\") {
+		s = s[:len(s)-1]
+	}
+	return s
+}
+
+func nonEmptyString(s string) bool {
+	return s != constants.EMPTY_STRING
 }
 
 func ArchiveCompiledFiles(buildPath string, archiveFile string, objectFiles []string, buildProperties map[string]string, verbose bool, logger i18n.Logger) (string, error) {

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

@@ -0,0 +1,142 @@
+package test
+
+import (
+	"arduino.cc/builder/builder_utils"
+	"github.com/stretchr/testify/require"
+	"io/ioutil"
+	"os"
+	"testing"
+	"time"
+)
+
+func sleep(t *testing.T) {
+	dur, err := time.ParseDuration("300ms")
+	NoError(t, err)
+	time.Sleep(dur)
+}
+
+func tempFile(t *testing.T, prefix string) string {
+	file, err := ioutil.TempFile("", prefix)
+	NoError(t, err)
+	return file.Name()
+}
+
+func TestObjFileIsUpToDateObjMissing(t *testing.T) {
+	sourceFile := tempFile(t, "source")
+	defer os.RemoveAll(sourceFile)
+
+	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, "", "")
+	NoError(t, err)
+	require.False(t, upToDate)
+}
+
+func TestObjFileIsUpToDateDepMissing(t *testing.T) {
+	sourceFile := tempFile(t, "source")
+	defer os.RemoveAll(sourceFile)
+
+	objFile := tempFile(t, "obj")
+	defer os.RemoveAll(objFile)
+
+	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, "")
+	NoError(t, err)
+	require.False(t, upToDate)
+}
+
+func TestObjFileIsUpToDateObjOlder(t *testing.T) {
+	objFile := tempFile(t, "obj")
+	defer os.RemoveAll(objFile)
+	depFile := tempFile(t, "dep")
+	defer os.RemoveAll(depFile)
+
+	sleep(t)
+
+	sourceFile := tempFile(t, "source")
+	defer os.RemoveAll(sourceFile)
+
+	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	NoError(t, err)
+	require.False(t, upToDate)
+}
+
+func TestObjFileIsUpToDateObjNewer(t *testing.T) {
+	sourceFile := tempFile(t, "source")
+	defer os.RemoveAll(sourceFile)
+
+	sleep(t)
+
+	objFile := tempFile(t, "obj")
+	defer os.RemoveAll(objFile)
+	depFile := tempFile(t, "dep")
+	defer os.RemoveAll(depFile)
+
+	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	NoError(t, err)
+	require.True(t, upToDate)
+}
+
+func TestObjFileIsUpToDateDepIsNewer(t *testing.T) {
+	sourceFile := tempFile(t, "source")
+	defer os.RemoveAll(sourceFile)
+
+	sleep(t)
+
+	objFile := tempFile(t, "obj")
+	defer os.RemoveAll(objFile)
+	depFile := tempFile(t, "dep")
+	defer os.RemoveAll(depFile)
+
+	sleep(t)
+
+	headerFile := tempFile(t, "header")
+	defer os.RemoveAll(headerFile)
+
+	ioutil.WriteFile(depFile, []byte(objFile+": \\\n\t"+sourceFile+" \\\n\t"+headerFile), os.FileMode(0644))
+
+	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	NoError(t, err)
+	require.False(t, upToDate)
+}
+
+func TestObjFileIsUpToDateDepIsOlder(t *testing.T) {
+	sourceFile := tempFile(t, "source")
+	defer os.RemoveAll(sourceFile)
+
+	headerFile := tempFile(t, "header")
+	defer os.RemoveAll(headerFile)
+
+	sleep(t)
+
+	objFile := tempFile(t, "obj")
+	defer os.RemoveAll(objFile)
+	depFile := tempFile(t, "dep")
+	defer os.RemoveAll(depFile)
+
+	ioutil.WriteFile(depFile, []byte(objFile+": \\\n\t"+sourceFile+" \\\n\t"+headerFile), os.FileMode(0644))
+
+	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	NoError(t, err)
+	require.True(t, upToDate)
+}
+
+func TestObjFileIsUpToDateDepIsWrong(t *testing.T) {
+	sourceFile := tempFile(t, "source")
+	defer os.RemoveAll(sourceFile)
+
+	sleep(t)
+
+	objFile := tempFile(t, "obj")
+	defer os.RemoveAll(objFile)
+	depFile := tempFile(t, "dep")
+	defer os.RemoveAll(depFile)
+
+	sleep(t)
+
+	headerFile := tempFile(t, "header")
+	defer os.RemoveAll(headerFile)
+
+	ioutil.WriteFile(depFile, []byte(sourceFile+": \\\n\t"+sourceFile+" \\\n\t"+headerFile), os.FileMode(0644))
+
+	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	NoError(t, err)
+	require.False(t, upToDate)
+}

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

@@ -206,6 +206,18 @@ func Map(slice []string, fn mapFunc) []string {
 	return newSlice
 }
 
+type filterFunc func(string) bool
+
+func Filter(slice []string, fn filterFunc) []string {
+	newSlice := []string{}
+	for _, elem := range slice {
+		if fn(elem) {
+			newSlice = append(newSlice, elem)
+		}
+	}
+	return newSlice
+}
+
 func WrapWithHyphenI(value string) string {
 	return "\"-I" + value + "\""
 }