use sketch.Item

arduino/builder/sketch.go

@@ -19,12 +19,18 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"strings"
+
+	"github.com/arduino/arduino-cli/arduino/globals"
+	"github.com/arduino/arduino-cli/arduino/sketch"
 
 	"github.com/pkg/errors"
 )
 
-// SaveSketch saves a preprocessed .cpp sketch file on disk
-func SaveSketch(sketchName string, source string, buildPath string) error {
+// SaveSketchItemCpp saves a preprocessed .cpp sketch file on disk
+func SaveSketchItemCpp(item *sketch.Item, buildPath string) error {
+
+	sketchName := filepath.Base(item.Path)
 
 	if err := os.MkdirAll(buildPath, os.FileMode(0755)); err != nil {
 		return errors.Wrap(err, "unable to create a folder to save the sketch")
@@ -32,9 +38,85 @@ func SaveSketch(sketchName string, source string, buildPath string) error {
 
 	destFile := filepath.Join(buildPath, sketchName+".cpp")
 
-	if err := ioutil.WriteFile(destFile, []byte(source), os.FileMode(0644)); err != nil {
+	if err := ioutil.WriteFile(destFile, item.Source, os.FileMode(0644)); err != nil {
 		return errors.Wrap(err, "unable to save the sketch on disk")
 	}
 
 	return nil
 }
+
+// LoadSketch collects all the files composing a sketch.
+// The parameter `sketchPath` holds a path pointing to a single sketch file or a sketch folder,
+// the path must be absolute.
+func LoadSketch(sketchPath, buildPath string) (*sketch.Sketch, error) {
+	stat, err := os.Stat(sketchPath)
+	if err != nil {
+		return nil, errors.Wrap(err, "unable to stat Sketch location")
+	}
+
+	var sketchFolder, mainSketchFile string
+
+	// if a sketch folder was passed, save the parent and point sketchPath to the main .ino file
+	if stat.IsDir() {
+		sketchFolder = sketchPath
+		mainSketchFile = filepath.Join(sketchPath, stat.Name()+".ino")
+		// in the case a dir was passed, ensure the main file exists and is readable
+		f, err := os.Open(mainSketchFile)
+		if err != nil {
+			return nil, errors.Wrap(err, "unable to find the main sketch file")
+		}
+		f.Close()
+	} else {
+		sketchFolder = filepath.Dir(sketchPath)
+		mainSketchFile = sketchPath
+	}
+
+	// collect all the sketch files
+	var files []string
+	err = filepath.Walk(sketchFolder, func(path string, info os.FileInfo, err error) error {
+		// ignore hidden files and skip hidden directories
+		if strings.HasPrefix(info.Name(), ".") {
+			if info.IsDir() {
+				return filepath.SkipDir
+			}
+			return nil
+		}
+
+		// skip legacy SCM directories
+		if info.IsDir() && strings.HasPrefix(info.Name(), "CVS") || strings.HasPrefix(info.Name(), "RCS") {
+			return filepath.SkipDir
+		}
+
+		// ignore directory entries
+		if info.IsDir() {
+			return nil
+		}
+
+		// ignore if file extension doesn't match
+		ext := strings.ToLower(filepath.Ext(path))
+		_, isMain := globals.MainFileValidExtensions[ext]
+		_, isAdditional := globals.AdditionalFileValidExtensions[ext]
+		if !(isMain || isAdditional) {
+			return nil
+		}
+
+		// check if file is readable
+		f, err := os.Open(path)
+		if err != nil {
+			return nil
+		}
+		f.Close()
+
+		// collect the file
+		files = append(files, path)
+
+		// done
+		return nil
+	})
+
+	if err != nil {
+		return nil, errors.Wrap(err, "there was an error while collecting the sketch files")
+	}
+
+	return sketch.New(sketchFolder, mainSketchFile, buildPath, files)
+}

arduino/builder/sketch_test.go

@@ -22,6 +22,7 @@ import (
 	"testing"
 
 	"github.com/arduino/arduino-cli/arduino/builder"
+	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -36,7 +37,7 @@ func TestSaveSketch(t *testing.T) {
 		t.Fatalf("unable to read golden file %s: %v", sketchFile, err)
 	}
 
-	builder.SaveSketch(sketchName, string(source), tmp)
+	builder.SaveSketchItemCpp(&sketch.Item{Path: sketchName, Source: source}, tmp)
 
 	out, err := ioutil.ReadFile(filepath.Join(tmp, outName))
 	if err != nil {

go.sum

@@ -2,6 +2,7 @@ bou.ke/monkey v1.0.1 h1:zEMLInw9xvNakzUUPjfS4Ds6jYPqCFx3m7bRmG5NH2U=
 bou.ke/monkey v1.0.1/go.mod h1:FgHuK96Rv2Nlf+0u1OOVDpCMdsWyOFmeeketDHE7LIg=
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/arduino/arduino v0.0.0-20190521072917-00a7546fb43e h1:5TJufBg+nZAFruNEALBVHDPRMtMDbRg7Hox/WA4ZI40=
 github.com/arduino/board-discovery v0.0.0-20180823133458-1ba29327fb0c h1:agh2JT96G8egU7FEb13L4dq3fnCN7lxXhJ86t69+W7s=
 github.com/arduino/board-discovery v0.0.0-20180823133458-1ba29327fb0c/go.mod h1:HK7SpkEax/3P+0w78iRQx1sz1vCDYYw9RXwHjQTB5i8=
 github.com/arduino/go-paths-helper v0.0.0-20190214132331-c3c98d1bf2e1 h1:S0NpDSqjlkNA510vmRCP5Cq9mPgu3rWDSdeN4SI1Mwc=

legacy/builder/container_add_prototypes.go

@@ -31,6 +31,7 @@ package builder
 
 import (
 	bldr "github.com/arduino/arduino-cli/arduino/builder"
+	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/legacy/builder/constants"
 	"github.com/arduino/arduino-cli/legacy/builder/i18n"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
@@ -67,7 +68,7 @@ func (s *ContainerAddPrototypes) Run(ctx *types.Context) error {
 		}
 	}
 
-	if err := bldr.SaveSketch(ctx.Sketch.MainFile.Name.Base(), ctx.Source, ctx.SketchBuildPath.String()); err != nil {
+	if err := bldr.SaveSketchItemCpp(&sketch.Item{ctx.Sketch.MainFile.Name.String(), []byte(ctx.Source)}, ctx.SketchBuildPath.String()); err != nil {
 		return i18n.WrapError(err)
 	}
 

legacy/builder/container_merge_copy_sketch_files.go

@@ -31,6 +31,7 @@ package builder
 
 import (
 	bldr "github.com/arduino/arduino-cli/arduino/builder"
+	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/legacy/builder/i18n"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
 )
@@ -42,7 +43,7 @@ func (s *ContainerMergeCopySketchFiles) Run(ctx *types.Context) error {
 		return i18n.WrapError(err)
 	}
 
-	if err := bldr.SaveSketch(ctx.Sketch.MainFile.Name.Base(), ctx.Source, ctx.SketchBuildPath.String()); err != nil {
+	if err := bldr.SaveSketchItemCpp(&sketch.Item{ctx.Sketch.MainFile.Name.String(), []byte(ctx.Source)}, ctx.SketchBuildPath.String()); err != nil {
 		return i18n.WrapError(err)
 	}
 

legacy/builder/preprocess_sketch.go

@@ -38,6 +38,7 @@ import (
 	"strings"
 
 	bldr "github.com/arduino/arduino-cli/arduino/builder"
+	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/legacy/builder/constants"
 	"github.com/arduino/arduino-cli/legacy/builder/i18n"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
@@ -81,7 +82,7 @@ func (s *PreprocessSketchArduino) Run(ctx *types.Context) error {
 	if ctx.CodeCompleteAt != "" {
 		err = new(OutputCodeCompletions).Run(ctx)
 	} else {
-		err = bldr.SaveSketch(ctx.Sketch.MainFile.Name.Base(), ctx.Source, ctx.SketchBuildPath.String())
+		err = bldr.SaveSketchItemCpp(&sketch.Item{ctx.Sketch.MainFile.Name.String(), []byte(ctx.Source)}, ctx.SketchBuildPath.String())
 	}
 
 	return err