Create a new logger for the web

This logger saves all the output in a variable to deliver everything at onc

Signed-off-by: Matteo Suppo <matteo.suppo@gmail.com>

Create a api endpoint for compiling a sketch remotely

The api accepts a json body with the sketch and the fqbn
It returns a json object with the base64 encoded .elf and .hex files
as well as the output of the compilation

Signed-off-by: Matteo Suppo <matteo.suppo@gmail.com>

Return the correct files in the compile api

It only shows the existing binaries, ignoring the ones that don't exist

Signed-off-by: Matteo Suppo <matteo.suppo@gmail.com>

Add documentation regarding the web api

Signed-off-by: Matteo Suppo <matteo.suppo@gmail.com>

Use a build flag to choose wether to compile the api or not

Compile with -flags 'api' will add 6MB to the binary size,
which could be irritating if you don't need the api.

Signed-off-by: Matteo Suppo <matteo.suppo@gmail.com>

Author: matteosuppo

README.md

@@ -9,7 +9,7 @@ This tool generates function prototypes and gathers library paths, providing `gc
 
 ### Usage
 
-* `-compile` or `-dump-prefs` or `-preprocess`: Optional. If omitted, defaults to `-compile`. `-dump-prefs` will just print all build preferences used, `-compile` will use those preferences to run the actual compiler, `-preprocess` will only print preprocessed code to stdout.
+* `-compile` or `-dump-prefs` or `-preprocess` or `-listen:3000`: Optional. If omitted, defaults to `-compile`. `-dump-prefs` will just print all build preferences used, `-compile` will use those preferences to run the actual compiler, `-preprocess` will only print preprocessed code to stdout, `-listen:3000` opens a web server on the specified port. See the section web api below.
 
 * `-hardware`: Mandatory. Folder containing Arduino platforms. An example is the `hardware` folder shipped with the Arduino IDE, or the `packages` folder created by Arduino Boards Manager. Can be specified multiple times. If conflicting hardware definitions are specified, the last one wins.
 
@@ -41,7 +41,7 @@ This tool generates function prototypes and gathers library paths, providing `gc
 
 * `-vid-pid`: when specified, VID/PID specific build properties are used, if boards supports them.
 
-Final mandatory parameter is the sketch to compile (of course).
+Final mandatory parameter is the sketch to compile.
 
 ### What is and how to use build.options.json file
 
@@ -72,6 +72,60 @@ go get golang.org/x/tools/cmd/vet
 go build
 ```
 
+### Web Api
+
+You can choose to compile the builder with the -api option:
+
+```bash
+go build -tags 'api'
+```
+
+Then if you launch it with the option `listen=3000` the builder will open a web server listening for requests to the /compile endpoint.
+
+Here's how to request the compilation of the simplest sketch possible:
+
+```
+POST /compile HTTP/1.1
+Host: localhost:3000
+Content-Type: application/json
+
+{
+    "fqbn": "arduino:avr:uno",
+    "sketch": {
+        "main_file": {
+            "name": "sketch.ino",
+            "source": "void setup() {\n  // initialize digital pin 13 as an output.\n  pinMode(13, OUTPUT);\n}\n// the loop function runs over and over again forever\nvoid loop() {\n  digitalWrite(13, HIGH);   // turn the LED on (HIGH is the voltage level)\n  delay(1000);              // wait for a second\n  digitalWrite(13, LOW);    // turn the LED off by making the voltage LOW\n  delay(1000);              // wait for a second\n}"
+        }
+    }
+}
+```
+
+And here's the response (the actual response will be much bigger, but the structure is the same):
+
+```
+{
+    "binaries": {
+        "elf": "f0VMRgEBAQAAAAAAAAAAAAIAUwABAAAAAAAAADQAAACILAAAhQAAAA...",
+        "hex": "OjEwMDAwMDAwMEM5NDVDMDAwQzk0NkUwMDBDOTQ2RTAwMEM5NDZFMD..."
+    },
+    "out": [
+        {
+            "Level": "warn",
+            "Message": "Board Intel:i586:izmir_fd doesn't define a 'build.board' preference. Auto-set to: I586_IZMIR_FD"
+        },
+        {
+            "Level": "info",
+            "Message": "\"/opt/tools/avr-gcc/4.8.1-arduino5/bin/avr-g++\" -c -g -Os -w -std=gnu++11 -fno-exceptions -ffunction-sections -fdata-sections -fno-threadsafe-statics  -w -x c++ -E -CC -mmcu=atmega328p -DF_CPU=16000000L -DARDUINO=10608 -DARDUINO_AVR_UNO -DARDUINO_ARCH_AVR   \"-I/opt/cores/arduino/avr/cores/arduino\" \"-I/opt/cores/arduino/avr/variants/standard\" \"/tmp/build/sketch/sketch.ino.cpp\" -o \"/dev/null\""
+        },
+        {
+            "Level": "info",
+            "Message": "\"/opt/tools/avr-gcc/4.8.1-arduino5/bin/avr-g++\" -c -g -Os -w -std=gnu++11 -fno-exceptions -ffunction-sections -fdata-sections -fno-threadsafe-statics  -w -x c++ -E -CC -mmcu=atmega328p -DF_CPU=16000000L -DARDUINO=10608 -DARDUINO_AVR_UNO -DARDUINO_ARCH_AVR   \"-I/opt/cores/arduino/avr/cores/arduino\" \"-I/opt/cores/arduino/avr/variants/standard\" \"/tmp/build/sketch/sketch.ino.cpp\" -o \"/dev/null\""
+        },
+        ...
+    ]
+}
+```
+
 ### TDD
 
 In order to run the tests, type:

api.go

@@ -0,0 +1,70 @@
+// +build api
+
+package main
+
+import (
+	"io/ioutil"
+	"path/filepath"
+
+	"arduino.cc/builder"
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/i18n"
+	"arduino.cc/builder/types"
+	"github.com/gin-gonic/gin"
+)
+
+func listen(context map[string]interface{}) {
+	router := gin.Default()
+
+	router.POST("/compile", func(c *gin.Context) {
+		logger := i18n.WebLogger{}
+		logger.Init()
+		context[constants.CTX_LOGGER] = &logger
+
+		var json struct {
+			Sketch types.Sketch `json:"sketch"`
+			Fqbn   string       `json:"fqbn"`
+		}
+
+		err := c.BindJSON(&json)
+
+		if err != nil {
+			c.JSON(400, gin.H{"error": "Malformed JSON", "message": err.Error()})
+			return
+		}
+
+		if json.Fqbn == "" {
+			c.JSON(400, gin.H{"error": "Malformed JSON", "message": "Missing fqbn property"})
+			return
+		}
+
+		context[constants.CTX_SKETCH] = &json.Sketch
+		context[constants.CTX_FQBN] = json.Fqbn
+
+		err = builder.RunBuilder(context)
+
+		if err != nil {
+			c.JSON(500, gin.H{"out": logger.Out(), "error": err.Error()})
+			return
+		}
+
+		binaries := struct {
+			Elf []byte `json:"elf,omitempty"`
+			Bin []byte `json:"bin,omitempty"`
+			Hex []byte `json:"hex,omitempty"`
+		}{}
+
+		elfPath := filepath.Join(*buildPathFlag, json.Sketch.MainFile.Name+".elf")
+		binaries.Elf, _ = ioutil.ReadFile(elfPath)
+
+		binPath := filepath.Join(*buildPathFlag, json.Sketch.MainFile.Name+".bin")
+		binaries.Bin, _ = ioutil.ReadFile(binPath)
+
+		hexPath := filepath.Join(*buildPathFlag, json.Sketch.MainFile.Name+".hex")
+		binaries.Hex, _ = ioutil.ReadFile(hexPath)
+
+		c.JSON(200, gin.H{"out": logger.Out(), "binaries": binaries})
+	})
+
+	router.Run(":" + *listenFlag)
+}

main.go

@@ -76,6 +76,7 @@ const FLAG_LOGGER_HUMAN = "human"
 const FLAG_LOGGER_MACHINE = "machine"
 const FLAG_VERSION = "version"
 const FLAG_VID_PID = "vid-pid"
+const FLAG_LISTEN = "listen"
 
 type slice []string
 
@@ -119,6 +120,7 @@ var warningsLevelFlag *string
 var loggerFlag *string
 var versionFlag *bool
 var vidPidFlag *string
+var listenFlag *string
 
 func init() {
 	compileFlag = flag.Bool(FLAG_ACTION_COMPILE, false, "compiles the given sketch")
@@ -141,6 +143,7 @@ func init() {
 	loggerFlag = flag.String(FLAG_LOGGER, FLAG_LOGGER_HUMAN, "Sets type of logger. Available values are '"+FLAG_LOGGER_HUMAN+"', '"+FLAG_LOGGER_MACHINE+"'")
 	versionFlag = flag.Bool(FLAG_VERSION, false, "prints version and exits")
 	vidPidFlag = flag.String(FLAG_VID_PID, "", "specify to use vid/pid specific build properties, as defined in boards.txt")
+	listenFlag = flag.String(FLAG_LISTEN, "", "specify to listen for web request at a certain host")
 }
 
 func main() {
@@ -310,6 +313,8 @@ func main() {
 		err = builder.RunParseHardwareAndDumpBuildProperties(context)
 	} else if *preprocessFlag {
 		err = builder.RunPreprocess(context)
+	} else if *listenFlag != "" {
+		listen(context)
 	} else {
 		if flag.NArg() == 0 {
 			fmt.Fprintln(os.Stderr, "Last parameter must be the sketch to compile")

not_api.go

@@ -0,0 +1,9 @@
+// +build !api
+
+package main
+
+import "fmt"
+
+func listen(context map[string]interface{}) {
+	fmt.Println("To use this feature you must compile the builder with the -api flag")
+}

src/arduino.cc/builder/builder_utils/utils.go

@@ -30,16 +30,16 @@
 package builder_utils
 
 import (
-	"arduino.cc/builder/constants"
-	"arduino.cc/builder/i18n"
-	"arduino.cc/builder/props"
-	"arduino.cc/builder/utils"
 	"bytes"
-	"fmt"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"strings"
+
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/i18n"
+	"arduino.cc/builder/props"
+	"arduino.cc/builder/utils"
 )
 
 func CompileFilesRecursive(objectFiles []string, sourcePath string, buildPath string, buildProperties props.PropertiesMap, includes []string, verbose bool, warningsLevel string, logger i18n.Logger) ([]string, error) {
@@ -321,7 +321,7 @@ func PrepareCommandForRecipe(properties props.PropertiesMap, recipe string, remo
 	}
 
 	if echoCommandLine {
-		fmt.Println(commandLine)
+		logger.Println("info", commandLine)
 	}
 
 	return command, nil

src/arduino.cc/builder/i18n/i18n.go

@@ -98,6 +98,37 @@ func (s MachineLogger) Name() string {
 	return "machine"
 }
 
+type message struct {
+	Level   string
+	Message string
+}
+
+// I tried keeping this inside the WebLogger but it didn't work
+var out = make([]message, 0)
+
+type WebLogger struct {
+}
+
+func (s WebLogger) Init() {
+	out = make([]message, 0)
+}
+
+func (s WebLogger) Out() []message {
+	return out
+}
+
+func (s WebLogger) Fprintln(w io.Writer, level string, format string, a ...interface{}) {
+	out = append(out, message{Level: level, Message: Format(format, a...)})
+}
+
+func (s WebLogger) Println(level string, format string, a ...interface{}) {
+	out = append(out, message{Level: level, Message: Format(format, a...)})
+}
+
+func (s WebLogger) Name() string {
+	return "web"
+}
+
 func FromJavaToGoSyntax(s string) string {
 	submatches := PLACEHOLDER.FindAllStringSubmatch(s, -1)
 	for _, submatch := range submatches {

src/arduino.cc/builder/types/types.go

@@ -30,15 +30,16 @@
 package types
 
 import (
-	"arduino.cc/builder/constants"
-	"arduino.cc/builder/props"
 	"path/filepath"
 	"strconv"
+
+	"arduino.cc/builder/constants"
+	"arduino.cc/builder/props"
 )
 
 type SketchFile struct {
-	Name   string
-	Source string
+	Name   string `json:"name"`
+	Source string `json:"source"`
 }
 
 type SketchFileSortByName []SketchFile
@@ -56,9 +57,9 @@ func (s SketchFileSortByName) Less(i, j int) bool {
 }
 
 type Sketch struct {
-	MainFile         SketchFile
-	OtherSketchFiles []SketchFile
-	AdditionalFiles  []SketchFile
+	MainFile         SketchFile   `json:"main_file"`
+	OtherSketchFiles []SketchFile `json:"other_sketch_files"`
+	AdditionalFiles  []SketchFile `json:"additional_files"`
 }
 
 type Packages struct {