remove horrible parsing of the the CompilerOut to get the platform

This is possible thanks to arduino/arduino-cli#1608
It's mandatory to use a version of the cli that has that change > 0.20.2

Author: umbynos

README.md

@@ -5,6 +5,7 @@ The json contains information regarding libraries and core to use in order to bu
 
 ## Requisites
 In order to run this tool you have to install first the [arduino-cli](https://github.com/arduino/arduino-cli) and have `arduino-cli` binary in your path, otherwise `cslt-tool` won't work.
+Please use a version of the cli that has [this](https://github.com/arduino/arduino-cli/pull/1608) change, version > 0.20.2
 
 ## Build it
 In order to build it just use `go build`
@@ -15,7 +16,7 @@ In order to build it just use `go build`
 This is an example execution:
 ``` bash
 $ ./cslt-tool compile -b arduino:samd:mkrwan1310 /home/umberto/getdeveui
-INFO[0001] arduino-cli version: 0.20.2                  
+INFO[0001] arduino-cli version: git-snapshot                  
 INFO[0001] running: arduino-cli compile -b arduino:samd:mkrwan1310 /home/umberto/getdeveui -v --format json 
 INFO[0002] copied file to /home/umberto/Nextcloud/8tb/Lavoro/cslt-tool/build/getdeveui.ino.cpp.o 
 INFO[0002] created new file in: /home/umberto/Nextcloud/8tb/Lavoro/cslt-tool/build/result.json
@@ -30,8 +31,7 @@ And the content of `build/result.json` is:
 ```json
 {
  "coreInfo": {
-  "packager": "arduino",
-  "name": "samd",
+  "id": "arduino:samd",
   "version": "1.8.12"
  },
  "libsInfo": [

cmd/compile.go

@@ -8,42 +8,43 @@ import (
 	"encoding/json"
 	"os"
 	"os/exec"
-	"strings"
 
 	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
-var (
-	fqbn          string
-	compileOutput CompileOutput
-)
+var fqbn string
 
 // compileOutput represents the json returned by the arduino-cli compile command
 type CompileOutput struct {
-	CompilerOut   string         `json:"compiler_out"`
 	CompilerErr   string         `json:"compiler_err"`
 	BuilderResult *BuilderResult `json:"builder_result"`
 	Success       bool           `json:"success"`
 }
 
 type BuilderResult struct {
-	BuildPath     string  `json:"build_path"`
-	UsedLibraries []*Info `json:"used_libraries"`
+	BuildPath     string         `json:"build_path"`
+	UsedLibraries []*UsedLibrary `json:"used_libraries"`
+	BuildPlatform *BuildPlatform `json:"build_platform"`
+}
+
+// UsedLibrary contains information regarding the library used during the compile process
+type UsedLibrary struct {
+	Name    string `json:"name"`
+	Version string `json:"version"`
 }
 
-// Info contains information regarding the library or the core used during the compile process
-type Info struct {
-	Packager string `json:"packager,omitempty"`
-	Name     string `json:"name"`
-	Version  string `json:"version"`
+// BuildPlatform contains information regarding the platform used during the compile process
+type BuildPlatform struct {
+	Id      string `json:"id"`
+	Version string `json:"version"`
 }
 
 // returnJson contains information regarding the core and libraries used during the compile process
 type ReturnJson struct {
-	CoreInfo *Info   `json:"coreInfo"`
-	LibsInfo []*Info `json:"libsInfo"`
+	CoreInfo *BuildPlatform `json:"coreInfo"`
+	LibsInfo []*UsedLibrary `json:"libsInfo"`
 }
 
 // compileCmd represents the compile command
@@ -121,25 +122,14 @@ func compileSketch(cmd *cobra.Command, args []string) {
 // the function extracts and returns the paths of the .o files
 // (generated during the compile phase) and a ReturnJson object
 func parseOutput(cmdOutToParse []byte) ([]*paths.Path, *ReturnJson) {
+	var compileOutput CompileOutput
 	err := json.Unmarshal(cmdOutToParse, &compileOutput)
 	if err != nil {
 		logrus.Fatal(err)
 	} else if !compileOutput.Success {
 		logrus.Fatalf("sketch compile was not successful: %s", compileOutput.CompilerErr)
 	}
 
-	compilerOutLines := strings.Split(compileOutput.CompilerOut, "\n")
-	var platformPath *paths.Path
-	for _, compilerOutLine := range compilerOutLines {
-		logrus.Debug(compilerOutLine)
-		if platformPath = parsePlatformLine(compilerOutLine); platformPath != nil {
-			break
-		}
-	}
-	if platformPath == nil {
-		logrus.Fatal("cannot find platform used")
-	}
-
 	// this dir contains all the obj files we need (the sketch related ones and not the core or libs)
 	sketchDir := paths.New(compileOutput.BuilderResult.BuildPath).Join("sketch")
 	sketchFilesPaths, err := sketchDir.ReadDir()
@@ -156,40 +146,9 @@ func parseOutput(cmdOutToParse []byte) ([]*paths.Path, *ReturnJson) {
 	}
 
 	returnJson := ReturnJson{
-		CoreInfo: getCoreInfo(platformPath),
+		CoreInfo: compileOutput.BuilderResult.BuildPlatform,
 		LibsInfo: compileOutput.BuilderResult.UsedLibraries,
 	}
 
 	return returnObjectFilesList, &returnJson
 }
-
-// getCoreInfo takes the path of the platform used and
-// returns an Info object
-func getCoreInfo(platformPath *paths.Path) *Info {
-	if !platformPath.Exist() {
-		logrus.Fatalf("the path of the core does not exists: %s", platformPath)
-	}
-	corePathParents := platformPath.Parents()
-	coreInfo := &Info{
-		Packager: corePathParents[3].Base(),
-		Name:     corePathParents[1].Base(),
-		Version:  corePathParents[0].Base(),
-	}
-	return coreInfo
-}
-
-// parsePlatformLine takes compilerOutLine as input and tries to extract the path of the platform used
-// compilerOutLine should be something like:
-// - Using core 'arduino' from platform in folder: C:\\Users\\Umberto Baldi\\AppData\\Local\\Arduino15\\packages\\arduino\\hardware\\avr\\1.8.5\n
-// - Using core 'arduino' from platform in folder: /home/umberto/.arduino15/packages/arduino/hardware/avr/1.8.4
-
-func parsePlatformLine(compilerOutLine string) *paths.Path {
-	if matched := strings.Contains(compilerOutLine, "Using core"); matched {
-		// we use this approach to avoid path with spaces problem
-		if startIndex := strings.Index(compilerOutLine, "from platform in folder: "); startIndex != -1 {
-			startIndex = startIndex + len("from platform in folder: ")
-			return paths.New(compilerOutLine[startIndex:])
-		}
-	}
-	return nil
-}