AddgRPC interface to collect every sketch file (#926)

* Add gRPC interface to collect every sketch file * Rename SketchLoad to LoadSketch and fix some gRPC messages
arduino · Aug 31, 2020 · 21d2533 · 21d2533
1 parent 3c16c05
commit 21d2533
Show file tree

Hide file tree

Showing 17 changed files with 544 additions and 200 deletions.
diff --git a/client_example/go.sum b/client_example/go.sum
diff --git a/client_example/main.go b/client_example/main.go
@@ -70,6 +70,9 @@ func main() {
 	log.Println("calling Version")
 	callVersion(client)
 
+	log.Println("calling LoadSketch")
+	callLoadSketch(client)
+
 	// Use SetValue to configure the arduino-cli directories.
 	log.Println("calling SetValue")
 	callSetValue(settingsClient)
@@ -878,3 +881,18 @@ func waitForPrompt(debugStreamingOpenClient dbg.Debug_DebugClient, prompt string
 		}
 	}
 }
+
+func callLoadSketch(client rpc.ArduinoCoreClient) {
+	currDir, _ := os.Getwd()
+	sketch, err := client.LoadSketch(context.Background(), &rpc.LoadSketchReq{
+		SketchPath: filepath.Join(currDir, "hello"),
+	})
+	if err != nil {
+		log.Fatalf("Error getting version: %s", err)
+	}
+
+	log.Printf("Sketch main file: %s", sketch.GetMainFile())
+	log.Printf("Sketch location: %s", sketch.GetLocationPath())
+	log.Printf("Other sketch files: %v", sketch.GetOtherSketchFiles())
+	log.Printf("Sketch additional files: %v", sketch.GetAdditionalFiles())
+}
diff --git a/commands/daemon/daemon.go b/commands/daemon/daemon.go
@@ -154,6 +154,11 @@ func (s *ArduinoCoreServerImpl) Version(ctx context.Context, req *rpc.VersionReq
 	return &rpc.VersionResp{Version: s.VersionString}, nil
 }
 
+// LoadSketch FIXMEDOC
+func (s *ArduinoCoreServerImpl) LoadSketch(ctx context.Context, req *rpc.LoadSketchReq) (*rpc.LoadSketchResp, error) {
+	return commands.LoadSketch(ctx, req)
+}
+
 // Compile FIXMEDOC
 func (s *ArduinoCoreServerImpl) Compile(req *rpc.CompileReq, stream rpc.ArduinoCore_CompileServer) error {
 	resp, err := compile.Compile(

diff --git a/commands/instances.go b/commands/instances.go
@@ -23,6 +23,7 @@ import (
 	"net/url"
 	"path"
 
+	"github.com/arduino/arduino-cli/arduino/builder"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packageindex"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
@@ -676,3 +677,28 @@ func createInstance(ctx context.Context, getLibOnly bool) (*createInstanceResult
 
 	return res, nil
 }
+
+// LoadSketch collects and returns all files composing a sketch
+func LoadSketch(ctx context.Context, req *rpc.LoadSketchReq) (*rpc.LoadSketchResp, error) {
+	sketch, err := builder.SketchLoad(req.SketchPath, "")
+	if err != nil {
+		return nil, fmt.Errorf("Error loading sketch %v: %v", req.SketchPath, err)
+	}
+
+	otherSketchFiles := make([]string, len(sketch.OtherSketchFiles))
+	for i, file := range sketch.OtherSketchFiles {
+		otherSketchFiles[i] = file.Path
+	}
+
+	additionalFiles := make([]string, len(sketch.AdditionalFiles))
+	for i, file := range sketch.AdditionalFiles {
+		additionalFiles[i] = file.Path
+	}
+
+	return &rpc.LoadSketchResp{
+		MainFile:         sketch.MainFile.Path,
+		LocationPath:     sketch.LocationPath,
+		OtherSketchFiles: otherSketchFiles,
+		AdditionalFiles:  additionalFiles,
+	}, nil
+}
diff --git a/go.mod b/go.mod
@@ -20,7 +20,7 @@ require (
 	github.com/fluxio/iohelpers v0.0.0-20160419043813-3a4dd67a94d2 // indirect
 	github.com/fluxio/multierror v0.0.0-20160419044231-9c68d39025e5 // indirect
 	github.com/gofrs/uuid v3.2.0+incompatible
-	github.com/golang/protobuf v1.4.1
+	github.com/golang/protobuf v1.4.2
 	github.com/h2non/filetype v1.0.8 // indirect
 	github.com/imjasonmiller/godice v0.1.2
 	github.com/juju/loggo v0.0.0-20190526231331-6e530bcce5d8 // indirect

diff --git a/go.sum b/go.sum
@@ -85,6 +85,8 @@ github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:W
 github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0=
 github.com/golang/protobuf v1.4.1 h1:ZFgWrT+bLgsYPirOnRfKLYJLvssAegOj/hgyMFdJZe0=
 github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8=
+github.com/golang/protobuf v1.4.2 h1:+Z5KGCizgyZCbGh1KZqA0fcLLkwbsjIzS4aV2v7wJX0=
+github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI=
 github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
 github.com/google/go-cmp v0.2.0 h1:+dTQ8DZQJz0Mb/HjFlkptS1FeQ4cWSnN941F8aEG4SQ=
 github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
@@ -320,6 +322,7 @@ google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQ
 google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE=
 google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
 google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
+google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
 google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
 google.golang.org/protobuf v1.25.0 h1:Ejskq+SyPohKW+1uil0JJMtmHCgJPJ/qWTxr8qp+R4c=
 google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=

diff --git a/rpc/commands/board.pb.go b/rpc/commands/board.pb.go