return different exit codes in the upload command

Author: alessio-perugini

internal/cli/upload/upload.go

@@ -92,7 +92,7 @@ func runUploadCommand(command *cobra.Command, args []string) {
 
 	sk, err := sketch.New(sketchPath)
 	if err != nil && importDir == "" && importFile == "" {
-		feedback.Fatal(tr("Error during Upload: %v", err), feedback.ErrGeneric)
+		feedback.Fatal(tr("Error during Upload: %v", err), feedback.ErrSketchError)
 	}
 
 	instance, profile := instance.CreateAndInitWithProfile(profileArg.Get(), sketchPath)
@@ -136,7 +136,7 @@ func runUploadCommand(command *cobra.Command, args []string) {
 				msg += tr("Platform %s is not found in any known index\nMaybe you need to add a 3rd party URL?", platformErr.Platform)
 			}
 		}
-		feedback.Fatal(msg, feedback.ErrGeneric)
+		feedback.Fatal(msg, feedback.ErrBoardUpload)
 	}
 
 	fields := map[string]string{}
@@ -169,7 +169,7 @@ func runUploadCommand(command *cobra.Command, args []string) {
 		UserFields: fields,
 	}
 	if err := upload.Upload(context.Background(), req, stdOut, stdErr); err != nil {
-		feedback.FatalError(err, feedback.ErrGeneric)
+		feedback.FatalError(err, feedback.ErrBoardUpload)
 	}
 	feedback.PrintResult(stdIOResult())
 }

internal/integrationtest/assert/assert.go

@@ -0,0 +1,30 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2023 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package assert
+
+import (
+	"os/exec"
+	"testing"
+
+	"github.com/arduino/arduino-cli/internal/cli/feedback"
+	"github.com/stretchr/testify/require"
+)
+
+func CmdExitCode(t *testing.T, expected feedback.ExitCode, err error) {
+	var cmdErr *exec.ExitError
+	require.ErrorAs(t, err, &cmdErr)
+	require.Equal(t, expected, feedback.ExitCode(cmdErr.ExitCode()))
+}

internal/integrationtest/compile_1/compile_test.go

@@ -26,7 +26,9 @@ import (
 	"time"
 
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
+	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	"github.com/arduino/arduino-cli/internal/integrationtest"
+	"github.com/arduino/arduino-cli/internal/integrationtest/assert"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
 	"go.bug.st/testifyjson/requirejson"
@@ -91,21 +93,26 @@ func compileErrorMessage(t *testing.T, env *integrationtest.Environment, cli *in
 	_, stderr, err := cli.Run("compile", "-b", "arduino:avr:uno", abcdef.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "no such file or directory:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 	_, stderr, err = cli.Run("compile", "-b", "arduino:avr:uno", abcdef.Join("ABCDEF.ino").String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "no such file or directory:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 	_, stderr, err = cli.Run("compile", "-b", "arduino:avr:uno", abcdef.Join("QWERTY").String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "no such file or directory:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 
 	err = abcdef.Mkdir()
 	require.NoError(t, err)
 	_, stderr, err = cli.Run("compile", "-b", "arduino:avr:uno", abcdef.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "main file missing from sketch:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 	_, stderr, err = cli.Run("compile", "-b", "arduino:avr:uno", abcdef.Join("ABCDEF.ino").String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "no such file or directory:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 
 	qwertyIno := abcdef.Join("QWERTY.ino")
 	f, err := qwertyIno.Create()
@@ -114,6 +121,7 @@ func compileErrorMessage(t *testing.T, env *integrationtest.Environment, cli *in
 	_, stderr, err = cli.Run("compile", "-b", "arduino:avr:uno", qwertyIno.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "main file missing from sketch:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 }
 
 func compileWithSimpleSketch(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
@@ -228,6 +236,7 @@ func compileWithSketchWithSymlinkSelfloop(t *testing.T, env *integrationtest.Env
 		// returning a different error detailed message
 		require.Contains(t, string(stderr), "Can't open sketch:")
 		require.Error(t, err)
+		assert.CmdExitCode(t, feedback.ErrSketchError, err)
 	}
 	{
 		sketchName := "CompileIntegrationTestSymlinkDirLoop"
@@ -254,6 +263,7 @@ func compileWithSketchWithSymlinkSelfloop(t *testing.T, env *integrationtest.Env
 		// returning a different error detailed message
 		require.Contains(t, string(stderr), "Can't open sketch:")
 		require.Error(t, err)
+		assert.CmdExitCode(t, feedback.ErrSketchError, err)
 	}
 }
 
@@ -349,6 +359,7 @@ func compileWithMultipleBuildPropertyFlags(t *testing.T, env *integrationtest.En
 		sketchPath.String(), "--verbose", "--clean",
 	)
 	require.Error(t, err)
+	assert.CmdExitCode(t, feedback.ErrCompilation, err)
 
 	// Compile using multiple build properties separated by a space and properly quoted
 	stdout, _, err := cli.Run(
@@ -366,6 +377,7 @@ func compileWithMultipleBuildPropertyFlags(t *testing.T, env *integrationtest.En
 		sketchPath.String(), "--verbose", "--clean",
 	)
 	require.Error(t, err)
+	assert.CmdExitCode(t, feedback.ErrCompilation, err)
 
 	stdout, _, err = cli.Run(
 		"compile", "-b", fqbn,
@@ -376,6 +388,7 @@ func compileWithMultipleBuildPropertyFlags(t *testing.T, env *integrationtest.En
 	require.Error(t, err)
 	require.NotContains(t, string(stdout), "-DPIN=2")
 	require.Contains(t, string(stdout), "-DSSID=\\\"This is a String\\\"")
+	assert.CmdExitCode(t, feedback.ErrCompilation, err)
 
 	stdout, _, err = cli.Run(
 		"compile", "-b", fqbn,
@@ -621,16 +634,19 @@ func compileWithMultipleMainFiles(t *testing.T, env *integrationtest.Environment
 	_, stderr, err := cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Can't open sketch: multiple main sketch files found")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 
 	// Build sketch from .ino file
 	_, stderr, err = cli.Run("compile", "--clean", "-b", fqbn, sketchFileIno.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Can't open sketch: multiple main sketch files found")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 
 	// Build sketch from .pde file
 	_, stderr, err = cli.Run("compile", "--clean", "-b", fqbn, sketchFilePde.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Can't open sketch: multiple main sketch files found")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 }
 
 func compileCaseMismatchFails(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
@@ -653,16 +669,19 @@ func compileCaseMismatchFails(t *testing.T, env *integrationtest.Environment, cl
 	_, stderr, err := cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Can't open sketch:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 	// * Compiling with sketch main file
 	_, stderr, err = cli.Run("compile", "--clean", "-b", fqbn, sketchMainFile.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Can't open sketch:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 	// * Compiling in sketch path
 	cli.SetWorkingDir(sketchPath)
 	defer cli.SetWorkingDir(env.RootDir())
 	_, stderr, err = cli.Run("compile", "--clean", "-b", fqbn)
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Can't open sketch:")
+	assert.CmdExitCode(t, feedback.ErrSketchError, err)
 }
 
 func compileOnlyCompilationDatabaseFlag(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
@@ -721,6 +740,7 @@ func compileUsingPlatformLocalTxt(t *testing.T, env *integrationtest.Environment
 	_, stderr, err := cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "my-compiler-that-does-not-exist")
+	assert.CmdExitCode(t, feedback.ErrCompilation, err)
 }
 
 func compileUsingBoardsLocalTxt(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
@@ -737,6 +757,7 @@ func compileUsingBoardsLocalTxt(t *testing.T, env *integrationtest.Environment,
 	_, stderr, err := cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Error during build: Invalid FQBN: board arduino:avr:nessuno not found")
+	assert.CmdExitCode(t, feedback.ErrCompilation, err)
 
 	// Use custom boards.local.txt with made arduino:avr:nessuno board
 	boardsLocalTxt := cli.DataDir().Join("packages", "arduino", "hardware", "avr", "1.8.5", "boards.local.txt")
@@ -999,6 +1020,7 @@ func TestCompileManuallyInstalledPlatformUsingPlatformLocalTxt(t *testing.T) {
 	_, stderr, err := cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "my-compiler-that-does-not-exist")
+	assert.CmdExitCode(t, feedback.ErrCompilation, err)
 }
 
 func compileWithInvalidBuildOptionJson(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
@@ -1134,6 +1156,7 @@ func compileWithFakeSecureBootCore(t *testing.T, env *integrationtest.Environmen
 	)
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Flag --sign-key is mandatory when used in conjunction with: --keys-keychain, --sign-key, --encrypt-key")
+	assert.CmdExitCode(t, feedback.ErrBadArgument, err)
 
 	// Verifies compilation works with secure boot enabled and when overriding the sign key and encryption key used
 	keysDir := cli.SketchbookDir().Join("keys_dir")