Merge branch 'master' of github.com:arduino/arduino-cli

Author: d-a-v

.github/workflows/test.yaml

@@ -1,13 +1,17 @@
 name: test
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
   test-matrix:
 
     strategy:
       matrix:
-        operating-system: [ubuntu-18.04, windows-2019]
+        operating-system: [ubuntu-18.04, windows-2019, macOS-10.14]
 
     runs-on: ${{ matrix.operating-system }}
 
@@ -36,7 +40,9 @@ jobs:
         run: task check
 
       - name: Install protoc compiler
-        uses: Arduino/actions/setup-protoc@master
+        uses: arduino/[email protected]
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Check protocol buffers compile correctly
         run: task protoc
@@ -48,7 +54,8 @@ jobs:
         run: task test-unit
 
       - name: Run unit tests on the legacy package
-        if: matrix.operating-system != 'windows-2019'
+        # Run legacy tests on one platform only
+        if: matrix.operating-system == 'ubuntu-18.04'
         run: task test-legacy
 
       - name: Install Python
@@ -58,11 +65,6 @@ jobs:
           architecture: 'x64'
 
       - name: Run integration tests
-        # Since we are investigating issues emerged
-        # with python integration tests on windows
-        # this step is disabled for windows-2019
-        # platform ATM
-        if: matrix.operating-system != 'windows-2019'
         run: |
           pip install -r test/requirements.txt
           task test-integration
@@ -73,7 +75,7 @@ jobs:
         # Codecov whitelists GitHub, lifting the need
         # for a token.
         if: >
-          matrix.operating-system != 'windows-2019' &&
+          matrix.operating-system == 'ubuntu-18.04' &&
           github.event_name == 'push'
         uses: codecov/[email protected]
         with:
@@ -87,7 +89,7 @@ jobs:
         # Codecov whitelists GitHub, lifting the need
         # for a token.
         if: >
-          matrix.operating-system != 'windows-2019' &&
+          matrix.operating-system == 'ubuntu-18.04' &&
           github.event_name == 'push'
         uses: codecov/[email protected]
         with:
@@ -101,7 +103,7 @@ jobs:
         # Codecov whitelists GitHub, lifting the need
         # for a token.
         if: >
-          matrix.operating-system != 'windows-2019' &&
+          matrix.operating-system == 'ubuntu-18.04' &&
           github.event_name == 'push'
         uses: codecov/[email protected]
         with:

.goreleaser.yml

@@ -11,10 +11,10 @@ release:
 changelog:
   filters:
     exclude:
-      - '^\[skip changelog\].*'
-      - '^\[changelog skip\].*'
-      - '^\[skip ci\].*'
-      - '^\[ci skip\].*'
+      # [skip changelog], [skip-changelog], [changelog skip], [changelog-skip]
+      - '^(?i)\[(skip|changelog)[ ,-](skip|changelog)\].*'
+      # [skip ci], [skip-ci], [ci skip], [ci-skip]
+      - '^(?i)\[(skip|ci)[ ,-](skip|ci)\].*'
 
 # We have multiple builds in order to fine tune
 # cross compilations.

README.md

@@ -1,6 +1,7 @@
 # arduino-cli
 
-![Workflow Status](https://github.com/Arduino/arduino-cli/workflows/test/badge.svg)
+[![Tests passing](https://github.com/Arduino/arduino-cli/workflows/test/badge.svg)](https://github.com/Arduino/arduino-cli/actions?workflow=test)
+[![Nightly build](https://github.com/Arduino/arduino-cli/workflows/nightly/badge.svg)](https://github.com/Arduino/arduino-cli/actions?workflow=nightly)
 [![codecov](https://codecov.io/gh/arduino/arduino-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/arduino/arduino-cli)
 
 `arduino-cli` is an all-in-one solution that provides builder, boards/library manager, uploader,
@@ -16,12 +17,28 @@ Contributions are welcome!
 Please read the document [How to contribute](CONTRIBUTING.md) which will guide you through how to
 build the source code, run the tests, and contribute your changes to the project.
 
+:sparkles: Thanks to all our [contributors](https://github.com/arduino/arduino-cli/graphs/contributors)! :sparkles:
+
 ## How to install
 
 ### Get the latest package
 
-The easiest way to get the latest version of `arduino-cli` on any supported platform is using the
-`install.sh` script:
+You have several options to install the latest version of the Arduino CLI
+on your system.
+
+#### Install via Homebrew (macOS/Linux)
+
+The Arduino CLI is available as a Homebrew formula since version `0.5.0`:
+
+```console
+brew update
+brew install arduino-cli
+```
+
+#### Use the install script
+
+The easiest way to get the latest version of `arduino-cli` on any supported
+platform is using the `install.sh` script:
 
 ```console
 curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
@@ -34,18 +51,36 @@ for example `~/local/bin`, set the `BINDIR` environment variable like this:
 curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/local/bin sh
 ```
 
+#### Download the latest packages from Arduino CDN
+
+In order to get the latest stable release for your platform you can use the
+following links:
+
+- [Linux 64 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_64bit.tar.gz)
+- [Linux 32 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_32bit.tar.gz)
+- [Linux ARM 64 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_ARM64.tar.gz)
+- [Linux ARM 32 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_ARMv7.tar.gz)
+- [Windows 64 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Windows_64bit.zip)
+- [Windows 32 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Windows_32bit.zip)
+- [Mac OSX](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_macOS_64bit.tar.gz)
+
+These links return a `302: Found` response, redirecting to latest generated builds by replacing `latest` with the latest
+available stable release. Once downloaded, place the executable `arduino-cli` into a directory which is in your `PATH`.
+
 **Deprecation notice:** Links in the form `http://downloads.arduino.cc/arduino-cli/arduino-cli-latest-<platform>.tar.bz2`
 won't be further updated. That URL will provide arduino-cli 0.3.7-alpha.preview, regardless of further releases.
 
-Alternatively you can download one of the pre-built binaries for the supported platforms from the
-[release page](https://github.com/arduino/arduino-cli/releases). Once downloaded, place the executable
-`arduino-cli` into a directory which is in your `PATH`.
+#### Download the latest package from the release page on GitHub
 
-### Download a nightly build
+Alternatively you can download one of the pre-built binaries for the supported
+platforms from the
+[release page](https://github.com/arduino/arduino-cli/releases). Once downloaded,
+place the executable `arduino-cli` into a directory which is in your `PATH`.
 
-These builds are generated once a day from `master` branch starting at 01:00 GMT
+### Get a nightly build
 
-In order to get the latest nightly build for your platform use the following links:
+These builds are generated once a day from `master` branch starting at 01:00 GMT.
+In order to get the latest nightly build for your platform, use the following links:
 
 - [Linux 64 bit](https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_64bit.tar.gz)
 - [Linux 32 bit](https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_32bit.tar.gz)
@@ -58,16 +93,16 @@ In order to get the latest nightly build for your platform use the following lin
 These links return a `302: Found` response, redirecting to latest generated builds by replacing `latest` with the latest
 available build date, using the format YYYYMMDD (i.e for 2019/Aug/06 `latest` is replaced with `20190806` )
 
-Checksums for the nightly builds are available at 
+Checksums for the nightly builds are available at
 `https://downloads.arduino.cc/arduino-cli/nightly/nightly-<DATE>-checksums.txt`
 
 Once downloaded, place the executable `arduino-cli` into a directory which is in your `PATH`.
 
-### Build from source with Docker
+### Build from source using Docker
 
-If you don't have a working Golang environment or if you want to build `arduino-cli` targeting
-different platforms, you can use Docker to get a binary directly from sources. From the project
-folder run:
+If you don't have a working Golang environment or if you want to build
+`arduino-cli` targeting different platforms, you can use Docker to get a binary
+directly from sources. From the project folder run:
 
 ```console
 docker run -v $PWD:/arduino-cli -w /arduino-cli -e PACKAGE_NAME_PREFIX='snapshot' arduino/arduino-cli:builder-1 goreleaser --rm-dist --snapshot --skip-publish
@@ -106,7 +141,7 @@ void loop() {
 
 ### Step 2. Modify your sketch
 
-Use your favourite file editor or IDE to modify the .ino file, in this example 
+Use your favourite file editor or IDE to modify the .ino file, in this example
 under: `$HOME/MyFirstSketch/MyFirstSketch.ino`
 and change the file to look like this one:
 

arduino/builder/builder.go

@@ -19,18 +19,22 @@ import (
 	"crypto/md5"
 	"encoding/hex"
 	"os"
-	"path/filepath"
 	"strings"
 
+	"github.com/arduino/go-paths-helper"
 	"github.com/pkg/errors"
 )
 
-// GenBuildPath generates a suitable name for the build folder
-func GenBuildPath(sketchPath string) string {
-	md5SumBytes := md5.Sum([]byte(sketchPath))
+// GenBuildPath generates a suitable name for the build folder.
+// The sketchPath, if not nil, is also used to furhter differentiate build paths.
+func GenBuildPath(sketchPath *paths.Path) *paths.Path {
+	path := ""
+	if sketchPath != nil {
+		path = sketchPath.String()
+	}
+	md5SumBytes := md5.Sum([]byte(path))
 	md5Sum := strings.ToUpper(hex.EncodeToString(md5SumBytes[:]))
-
-	return filepath.Join(os.TempDir(), "arduino-sketch-"+md5Sum)
+	return paths.TempDir().Join("arduino-sketch-" + md5Sum)
 }
 
 // EnsureBuildPathExists creates the build path if doesn't already exists.

arduino/builder/builder_test.go

@@ -23,6 +23,7 @@ import (
 	"testing"
 
 	"github.com/arduino/arduino-cli/arduino/builder"
+	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -36,7 +37,10 @@ func tmpDirOrDie() string {
 
 func TestGenBuildPath(t *testing.T) {
 	want := filepath.Join(os.TempDir(), "arduino-sketch-ACBD18DB4CC2F85CEDEF654FCCC4A4D8")
-	assert.Equal(t, want, builder.GenBuildPath("foo"))
+	assert.Equal(t, want, builder.GenBuildPath(paths.New("foo")).String())
+
+	want = filepath.Join(os.TempDir(), "arduino-sketch-D41D8CD98F00B204E9800998ECF8427E")
+	assert.Equal(t, want, builder.GenBuildPath(nil).String())
 }
 
 func TestEnsureBuildPathExists(t *testing.T) {

cli/board/attach.go

@@ -27,6 +27,8 @@ import (
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/board"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	"github.com/arduino/go-paths-helper"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -52,18 +54,37 @@ var attachFlags struct {
 
 func runAttachCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateInstance()
-	var path string
-	if len(args) > 0 {
-		path = args[1]
+
+	var path *paths.Path
+	if len(args) > 1 {
+		path = paths.New(args[1])
+	} else {
+		path = initSketchPath(path)
 	}
+
 	_, err := board.Attach(context.Background(), &rpc.BoardAttachReq{
 		Instance:      instance,
 		BoardUri:      args[0],
-		SketchPath:    path,
+		SketchPath:    path.String(),
 		SearchTimeout: attachFlags.searchTimeout,
 	}, output.TaskProgress())
 	if err != nil {
 		feedback.Errorf("Attach board error: %v", err)
 		os.Exit(errorcodes.ErrGeneric)
 	}
 }
+
+// initSketchPath returns the current working directory
+func initSketchPath(sketchPath *paths.Path) *paths.Path {
+	if sketchPath != nil {
+		return sketchPath
+	}
+
+	wd, err := paths.Getwd()
+	if err != nil {
+		feedback.Errorf("Couldn't get current working directory: %v", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	logrus.Infof("Reading sketch from dir: %s", wd)
+	return wd
+}

cli/board/details.go

@@ -54,7 +54,7 @@ func runDetailsCommand(cmd *cobra.Command, args []string) {
 	feedback.PrintResult(detailsResult{details: res})
 }
 
-// ouput from this command requires special formatting, let's create a dedicated
+// output from this command requires special formatting, let's create a dedicated
 // feedback.Result implementation
 type detailsResult struct {
 	details *rpc.BoardDetailsResp

cli/board/list.go

@@ -26,7 +26,6 @@ import (
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
-	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/board"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
@@ -68,27 +67,33 @@ func runListCommand(cmd *cobra.Command, args []string) {
 		os.Exit(errorcodes.ErrNetwork)
 	}
 
-	if globals.OutputFormat == "json" {
-		feedback.PrintJSON(ports)
-	} else {
-		outputListResp(ports)
-	}
+	feedback.PrintResult(result{ports})
+}
+
+// output from this command requires special formatting, let's create a dedicated
+// feedback.Result implementation
+type result struct {
+	ports []*rpc.DetectedPort
 }
 
-func outputListResp(ports []*rpc.DetectedPort) {
-	if len(ports) == 0 {
-		feedback.Print("No boards found.")
-		return
+func (dr result) Data() interface{} {
+	return dr.ports
+}
+
+func (dr result) String() string {
+	if len(dr.ports) == 0 {
+		return "No boards found."
 	}
-	sort.Slice(ports, func(i, j int) bool {
-		x, y := ports[i], ports[j]
+
+	sort.Slice(dr.ports, func(i, j int) bool {
+		x, y := dr.ports[i], dr.ports[j]
 		return x.GetProtocol() < y.GetProtocol() ||
 			(x.GetProtocol() == y.GetProtocol() && x.GetAddress() < y.GetAddress())
 	})
 
 	t := table.New()
 	t.SetHeader("Port", "Type", "Board Name", "FQBN", "Core")
-	for _, port := range ports {
+	for _, port := range dr.ports {
 		address := port.GetProtocol() + "://" + port.GetAddress()
 		if port.GetProtocol() == "serial" {
 			address = port.GetAddress()
@@ -123,5 +128,5 @@ func outputListResp(ports []*rpc.DetectedPort) {
 			t.AddRow(address, protocol, board, fqbn, coreName)
 		}
 	}
-	feedback.Print(t.Render())
+	return t.Render()
 }