Pass Context to ObjFileIsUpToDate

This does not use the passed variable yet, but prepares for a future
commit.

Signed-off-by: Matthijs Kooijman <matthijs@stdin.nl>

Author: matthijskooijman

builder_utils/utils.go

@@ -206,7 +206,7 @@ func compileFileWithRecipe(ctx *types.Context, sourcePath string, source string,
 		return "", i18n.WrapError(err)
 	}
 
-	objIsUpToDate, err := ObjFileIsUpToDate(properties[constants.BUILD_PROPERTIES_SOURCE_FILE], properties[constants.BUILD_PROPERTIES_OBJECT_FILE], filepath.Join(buildPath, relativeSource+".d"))
+	objIsUpToDate, err := ObjFileIsUpToDate(ctx, properties[constants.BUILD_PROPERTIES_SOURCE_FILE], properties[constants.BUILD_PROPERTIES_OBJECT_FILE], filepath.Join(buildPath, relativeSource+".d"))
 	if err != nil {
 		return "", i18n.WrapError(err)
 	}
@@ -223,7 +223,7 @@ func compileFileWithRecipe(ctx *types.Context, sourcePath string, source string,
 	return properties[constants.BUILD_PROPERTIES_OBJECT_FILE], nil
 }
 
-func ObjFileIsUpToDate(sourceFile, objectFile, dependencyFile string) (bool, error) {
+func ObjFileIsUpToDate(ctx *types.Context, sourceFile, objectFile, dependencyFile string) (bool, error) {
 	sourceFile = filepath.Clean(sourceFile)
 	objectFile = filepath.Clean(objectFile)
 	dependencyFile = filepath.Clean(dependencyFile)

container_find_includes.go

@@ -306,7 +306,7 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile t
 	// TODO: This reads the dependency file, but the actual building
 	// does it again. Should the result be somehow cached? Perhaps
 	// remove the object file if it is found to be stale?
-	unchanged, err := builder_utils.ObjFileIsUpToDate(sourcePath, sourceFile.ObjectPath(ctx), sourceFile.DepfilePath(ctx))
+	unchanged, err := builder_utils.ObjFileIsUpToDate(ctx, sourcePath, sourceFile.ObjectPath(ctx), sourceFile.DepfilePath(ctx))
 	if err != nil {
 		return i18n.WrapError(err)
 	}

test/builder_utils_test.go

@@ -30,13 +30,15 @@
 package test
 
 import (
-	"github.com/arduino/arduino-builder/builder_utils"
-	"github.com/arduino/arduino-builder/utils"
-	"github.com/stretchr/testify/require"
 	"io/ioutil"
 	"os"
 	"testing"
 	"time"
+
+	"github.com/arduino/arduino-builder/builder_utils"
+	"github.com/arduino/arduino-builder/types"
+	"github.com/arduino/arduino-builder/utils"
+	"github.com/stretchr/testify/require"
 )
 
 func sleep(t *testing.T) {
@@ -52,27 +54,33 @@ func tempFile(t *testing.T, prefix string) string {
 }
 
 func TestObjFileIsUpToDateObjMissing(t *testing.T) {
+	ctx := &types.Context{}
+
 	sourceFile := tempFile(t, "source")
 	defer os.RemoveAll(sourceFile)
 
-	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, "", "")
+	upToDate, err := builder_utils.ObjFileIsUpToDate(ctx, sourceFile, "", "")
 	NoError(t, err)
 	require.False(t, upToDate)
 }
 
 func TestObjFileIsUpToDateDepMissing(t *testing.T) {
+	ctx := &types.Context{}
+
 	sourceFile := tempFile(t, "source")
 	defer os.RemoveAll(sourceFile)
 
 	objFile := tempFile(t, "obj")
 	defer os.RemoveAll(objFile)
 
-	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, "")
+	upToDate, err := builder_utils.ObjFileIsUpToDate(ctx, sourceFile, objFile, "")
 	NoError(t, err)
 	require.False(t, upToDate)
 }
 
 func TestObjFileIsUpToDateObjOlder(t *testing.T) {
+	ctx := &types.Context{}
+
 	objFile := tempFile(t, "obj")
 	defer os.RemoveAll(objFile)
 	depFile := tempFile(t, "dep")
@@ -83,12 +91,14 @@ func TestObjFileIsUpToDateObjOlder(t *testing.T) {
 	sourceFile := tempFile(t, "source")
 	defer os.RemoveAll(sourceFile)
 
-	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	upToDate, err := builder_utils.ObjFileIsUpToDate(ctx, sourceFile, objFile, depFile)
 	NoError(t, err)
 	require.False(t, upToDate)
 }
 
 func TestObjFileIsUpToDateObjNewer(t *testing.T) {
+	ctx := &types.Context{}
+
 	sourceFile := tempFile(t, "source")
 	defer os.RemoveAll(sourceFile)
 
@@ -99,12 +109,14 @@ func TestObjFileIsUpToDateObjNewer(t *testing.T) {
 	depFile := tempFile(t, "dep")
 	defer os.RemoveAll(depFile)
 
-	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	upToDate, err := builder_utils.ObjFileIsUpToDate(ctx, sourceFile, objFile, depFile)
 	NoError(t, err)
 	require.True(t, upToDate)
 }
 
 func TestObjFileIsUpToDateDepIsNewer(t *testing.T) {
+	ctx := &types.Context{}
+
 	sourceFile := tempFile(t, "source")
 	defer os.RemoveAll(sourceFile)
 
@@ -122,12 +134,14 @@ func TestObjFileIsUpToDateDepIsNewer(t *testing.T) {
 
 	utils.WriteFile(depFile, objFile+": \\\n\t"+sourceFile+" \\\n\t"+headerFile)
 
-	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	upToDate, err := builder_utils.ObjFileIsUpToDate(ctx, sourceFile, objFile, depFile)
 	NoError(t, err)
 	require.False(t, upToDate)
 }
 
 func TestObjFileIsUpToDateDepIsOlder(t *testing.T) {
+	ctx := &types.Context{}
+
 	sourceFile := tempFile(t, "source")
 	defer os.RemoveAll(sourceFile)
 
@@ -143,12 +157,14 @@ func TestObjFileIsUpToDateDepIsOlder(t *testing.T) {
 
 	utils.WriteFile(depFile, objFile+": \\\n\t"+sourceFile+" \\\n\t"+headerFile)
 
-	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	upToDate, err := builder_utils.ObjFileIsUpToDate(ctx, sourceFile, objFile, depFile)
 	NoError(t, err)
 	require.True(t, upToDate)
 }
 
 func TestObjFileIsUpToDateDepIsWrong(t *testing.T) {
+	ctx := &types.Context{}
+
 	sourceFile := tempFile(t, "source")
 	defer os.RemoveAll(sourceFile)
 
@@ -166,7 +182,7 @@ func TestObjFileIsUpToDateDepIsWrong(t *testing.T) {
 
 	utils.WriteFile(depFile, sourceFile+": \\\n\t"+sourceFile+" \\\n\t"+headerFile)
 
-	upToDate, err := builder_utils.ObjFileIsUpToDate(sourceFile, objFile, depFile)
+	upToDate, err := builder_utils.ObjFileIsUpToDate(ctx, sourceFile, objFile, depFile)
 	NoError(t, err)
 	require.False(t, upToDate)
 }