refactor: cleanup

Author: Luca Bianconi

buildcache/build_cache.go

@@ -21,17 +21,17 @@ import (
 	"github.com/arduino/go-paths-helper"
 )
 
-// UpdateLastUsedTime registers the last used time in the cache hold file
-func UpdateLastUsedTime(dir *paths.Path) error {
-	_, err := newLastUsedDirCache(dir.Parent().String(), time.Hour).
+// GetOrCreate registers the .last-used time in the directory
+func GetOrCreate(dir *paths.Path) error {
+	unusedTTL := time.Hour
+	_, err := newDirectoryCache(dir.Parent().String(), unusedTTL).
 		GetOrCreate(dir.Base(), time.Now())
 	return err
 }
 
 // Purge removes all cache directories within baseDir that have expired
 // To know how long ago a directory has been last used
-// it checks into the last used file. If the file does not exist
-// then the directory is purged.
+// it checks into the .last-used file.
 func Purge(baseDir *paths.Path, ttl time.Duration) {
-	newLastUsedDirCache(baseDir.String(), ttl).Purge()
+	newDirectoryCache(baseDir.String(), ttl).Purge()
 }

buildcache/build_cache_test.go

@@ -1,3 +1,18 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to [email protected].
+
 package buildcache
 
 import (
@@ -34,7 +49,7 @@ func Test_UpdateLastUsedFileExisting(t *testing.T) {
 }
 
 func requireCorrectUpdate(t *testing.T, dir *paths.Path, prevModTime time.Time) {
-	err := UpdateLastUsedTime(dir)
+	err := GetOrCreate(dir)
 	require.Nil(t, err)
 	expectedFile := dir.Join(lastUsedFileName)
 	fileInfo, err := os.Stat(expectedFile.String())

buildcache/directory_cache.go

@@ -1,3 +1,18 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to [email protected].
+
 package buildcache
 
 import (
@@ -72,7 +87,7 @@ func (dc *directoryCache) Purge() error {
 	return nil
 }
 
-func newLastUsedDirCache(baseDir string, ttl time.Duration) cache[string, time.Time] {
+func newDirectoryCache(baseDir string, ttl time.Duration) cache[string, time.Time] {
 	return &directoryCache{
 		baseDir: baseDir,
 		ttl:     ttl,

buildcache/interface.go

@@ -1,3 +1,18 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to [email protected].
+
 package buildcache
 
 type cache[K comparable, V any] interface {

commands/compile/compile.go

@@ -216,7 +216,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		r.UsedLibraries = importedLibs
 	}()
 
-	defer buildcache.UpdateLastUsedTime(builderCtx.BuildPath)
+	defer buildcache.GetOrCreate(builderCtx.BuildPath)
 
 	// if it's a regular build, go on...
 	if err := builder.RunBuilder(builderCtx); err != nil {

legacy/builder/phases/core_builder.go

@@ -123,7 +123,7 @@ func compileCore(ctx *types.Context, buildPath *paths.Path, buildCachePath *path
 
 	// archive core.a
 	if targetArchivedCore != nil && !ctx.OnlyUpdateCompilationDatabase {
-		defer buildcache.UpdateLastUsedTime(targetArchivedCore)
+		defer buildcache.GetOrCreate(targetArchivedCore)
 		targetArchivedCoreDir.MkdirAll()
 		err := archiveFile.CopyTo(targetArchivedCore)
 		if ctx.Verbose {

legacy/builder/test/builder_test.go

@@ -381,7 +381,7 @@ func TestBuilderCacheCoreAFile(t *testing.T) {
 	// Pick timestamp of cached core
 	coreFolder := paths.New("downloaded_hardware", "arduino", "avr")
 	coreFileName := phases.GetCachedCoreArchiveDirName(ctx.FQBN.String(), ctx.OptimizationFlags, coreFolder)
-	cachedCoreFile := ctx.CoreBuildCachePath.Join(coreFileName)
+	cachedCoreFile := ctx.CoreBuildCachePath.Join(coreFileName, "core.a")
 	coreStatBefore, err := cachedCoreFile.Stat()
 	require.NoError(t, err)