add packager to coreInfo, cleanup & fixes

Author: umbynos

cmd/compile.go

@@ -6,6 +6,7 @@ package cmd
 
 import (
 	"encoding/json"
+	"os"
 	"os/exec"
 	"strings"
 
@@ -34,8 +35,9 @@ type BuilderResult struct {
 
 // Info contains information regarding the library or the core used during the compile process
 type Info struct {
-	Name    string `json:"name"`
-	Version string `json:"version"`
+	Packager string `json:"packager,omitempty"`
+	Name     string `json:"name"`
+	Version  string `json:"version"`
 }
 
 // returnJson contains information regarding the core and libraries used during the compile process
@@ -48,11 +50,11 @@ type ReturnJson struct {
 var compileCmd = &cobra.Command{
 	Use:   "compile",
 	Short: "Compiles Arduino sketches.",
-	Long: `Compiles Arduino sketches outputting an object file and a json file
-	The json contains information regarding libraries and core to use to build the full sketch`,
-	// Example: , // TODO
-	Args: cobra.ExactArgs(1), // the path of the sketch to build
-	Run:  compileSketch,
+	Long: `Compiles Arduino sketches outputting an object file and a json file in a build directory
+	The json contains information regarding libraries and core to use in order to build the sketch`,
+	Example: os.Args[0] + `compile -b arduino:avr:uno /home/umberto/Arduino/Blink`,
+	Args:    cobra.ExactArgs(1), // the path of the sketch to build
+	Run:     compileSketch,
 }
 
 func init() {
@@ -115,15 +117,15 @@ func compileSketch(cmd *cobra.Command, args []string) {
 }
 
 // parseOutput function takes cmdOutToParse as argument,
-// cmdOutToParse is the output captured from the command run
-// the function extract the paths of the .o files and
-// a ReturnJson object
+// cmdOutToParse is the json output captured from the command run
+// 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) {
 	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)
+		logrus.Fatalf("sketch compile was not successful: %s", compileOutput.CompilerErr)
 	}
 
 	compilerOutLines := strings.Split(compileOutput.CompilerOut, "\n")
@@ -144,7 +146,7 @@ func parseOutput(cmdOutToParse []byte) ([]*paths.Path, *ReturnJson) {
 	sketchFilesPaths, err := sketchDir.ReadDir()
 	if err != nil {
 		logrus.Fatal(err)
-	} else if sketchFilesPaths == nil {
+	} else if len(sketchFilesPaths) == 0 {
 		logrus.Fatalf("empty directory: %s", sketchDir)
 	}
 	var returnObjectFilesList []*paths.Path
@@ -159,25 +161,23 @@ func parseOutput(cmdOutToParse []byte) ([]*paths.Path, *ReturnJson) {
 		LibsInfo: compileOutput.BuilderResult.UsedLibraries,
 	}
 
-	// TODO add also the packager -> maybe ParseReference could be used from the cli
-	// TODO core could be calculated from fqbn
-
 	return returnObjectFilesList, &returnJson
 }
 
-// parseCoreLine takes the line containig info regarding the core and
-// returns a coreInfo object
+// parseCoreLine takes the line containing info regarding the core and
+// returns a Info object
 func parseCoreLine(coreLine string) *Info {
 	words := strings.Split(coreLine, " ")
 	strCorePath := words[len(words)-1] // last string has the path of the core
-	// maybe check if the path is legit before and logrus.Fatal if not
 	corePath := paths.New(strCorePath)
-	version := corePath.Base()
-	name := corePath.Parent().Base()
-	logrus.Debugf("core name: %s, core version: %s", name, version)
+	if !corePath.Exist() {
+		logrus.Fatalf("the path of the core does not exists: %s", corePath)
+	}
+	corePathParents := corePath.Parents()
 	coreInfo := &Info{
-		Name:    name,
-		Version: version,
+		Packager: corePathParents[3].Base(),
+		Name:     corePathParents[1].Base(),
+		Version:  corePathParents[0].Base(),
 	}
 	return coreInfo
 }

cmd/root.go

@@ -10,21 +10,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
-
-
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "cslt-tool",
-	Short: "A brief description of your application",
-	Long: `A longer description that spans multiple lines and likely contains
-examples and usage of using your application. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
-	// Uncomment the following line if your bare application
-	// has an action associated with it:
-	// Run: func(cmd *cobra.Command, args []string) { },
+	Short: "cslt-tool is a command-line tool that uses the Arduino CLI to generate objectfiles and a json file with info regarding core and libraries used",
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
@@ -35,17 +24,3 @@ func Execute() {
 		os.Exit(1)
 	}
 }
-
-func init() {
-	// Here you will define your flags and configuration settings.
-	// Cobra supports persistent flags, which, if defined here,
-	// will be global for your application.
-
-	// rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cslt-tool.yaml)")
-
-	// Cobra also supports local flags, which will only run
-	// when this action is called directly.
-	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
-}
-
-

go.mod

@@ -8,17 +8,12 @@ require (
 )
 
 require (
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/kr/pretty v0.2.1 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
 	golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )
 
 require (
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
 	github.com/sirupsen/logrus v1.8.1
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/stretchr/testify v1.7.0
 )

go.sum

@@ -241,10 +241,7 @@ github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
 github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
-github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
-github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
-github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/lyft/protoc-gen-star v0.5.3/go.mod h1:V0xaHgaf5oCCqmcxYcWiDfTiKsZsRc87/1qhoTACD8w=
 github.com/magiconair/properties v1.8.5/go.mod h1:y3VJvCyxH9uVvJTWEGAELF3aiYNyPKd5NZ3oSwXrF60=
@@ -748,7 +745,6 @@ google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ
 gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
 gopkg.in/ini.v1 v1.66.2/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=