Improve error message when port or fqbn flags are not set (arduino#523)

federicobond · Massimiliano Pippi · commit 49897ef2b776 · 2019-12-27T10:19:32.000+01:00
* Improve error message when port or fqbn flags are missing

* Redirect stderr for integration tests too
diff --git a/cli/cli_test.go b/cli/cli_test.go
@@ -30,6 +30,7 @@ import (
 
 	"github.com/spf13/viper"
 
+	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 
 	"bou.ke/monkey"
@@ -42,26 +43,28 @@ var (
 	// Redirecting stdOut so we can analyze output line by
 	// line and check with what we want.
 	stdOut = os.Stdout
+	stdErr = os.Stderr
 
 	currDownloadDir string
 	currDataDir     string
 	currUserDir     string
 )
 
-type stdOutRedirect struct {
+type outputRedirect struct {
 	tempFile *os.File
 }
 
-func (grabber *stdOutRedirect) Open() {
+func (grabber *outputRedirect) Open() {
 	tempFile, err := ioutil.TempFile(os.TempDir(), "test")
 	if err != nil {
 		panic("Opening temp output file")
 	}
 	os.Stdout = tempFile
+	os.Stderr = tempFile
 	grabber.tempFile = tempFile
 }
 
-func (grabber *stdOutRedirect) GetOutput() []byte {
+func (grabber *outputRedirect) GetOutput() []byte {
 	_, err := grabber.tempFile.Seek(0, 0)
 	if err != nil {
 		panic("Rewinding temp output file")
@@ -75,13 +78,14 @@ func (grabber *stdOutRedirect) GetOutput() []byte {
 	return output
 }
 
-func (grabber *stdOutRedirect) Close() {
+func (grabber *outputRedirect) Close() {
 	grabber.tempFile.Close()
 	err := os.Remove(grabber.tempFile.Name())
 	if err != nil {
 		panic("Removing temp output file")
 	}
 	os.Stdout = stdOut
+	os.Stderr = stdErr
 }
 
 func TestMain(m *testing.M) {
@@ -136,7 +140,7 @@ func executeWithArgs(args ...string) (int, []byte) {
 
 	// This closure is here because we won't that the defer are executed after the end of the "executeWithArgs" method
 	func() {
-		redirect := &stdOutRedirect{}
+		redirect := &outputRedirect{}
 		redirect.Open()
 		// re-init feedback so it'll write to our grabber
 		feedback.SetDefaultFeedback(feedback.New(os.Stdout, os.Stdout, feedback.Text))
@@ -170,7 +174,9 @@ func executeWithArgs(args ...string) (int, []byte) {
 		ArduinoCli.ResetFlags()
 		createCliCommandTree(ArduinoCli)
 		ArduinoCli.SetArgs(args)
-		ArduinoCli.Execute()
+		if err := ArduinoCli.Execute(); err != nil {
+			exitCode = errorcodes.ErrGeneric
+		}
 	}()
 
 	return exitCode, output
@@ -307,7 +313,7 @@ func TestCompileCommandsIntegration(t *testing.T) {
 	// Build sketch without FQBN
 	exitCode, d = executeWithArgs("compile", sketchPath)
 	require.NotZero(t, exitCode)
-	require.Contains(t, string(d), "no FQBN provided")
+	require.Contains(t, string(d), "required flag(s) \"fqbn\" not set")
 
 	// Build sketch for arduino:avr:uno
 	exitCode, d = executeWithArgs("compile", "-b", "arduino:avr:uno", sketchPath)
diff --git a/cli/compile/compile.go b/cli/compile/compile.go
@@ -80,6 +80,8 @@ func NewCommand() *cobra.Command {
 	command.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
 	command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if boards supports them.")
 
+	command.MarkFlagRequired("fqbn")
+
 	return command
 }
 
diff --git a/cli/upload/upload.go b/cli/upload/upload.go
@@ -56,6 +56,9 @@ func NewCommand() *cobra.Command {
 	uploadCommand.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
 	uploadCommand.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
 
+	uploadCommand.MarkFlagRequired("fqbn")
+	uploadCommand.MarkFlagRequired("port")
+
 	return uploadCommand
 }
 

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,8 @@ func NewCommand() *cobra.Command {`
`80`	`80`	`command.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")`
`81`	`81`	`command.Flags().StringVar(&vidPid, "vid-pid", "", "When specified, VID/PID specific build properties are used, if boards supports them.")`
`82`	`82`
	`83`	`+ command.MarkFlagRequired("fqbn")`
	`84`	`+`
`83`	`85`	`return command`
`84`	`86`	`}`
`85`	`87`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,9 @@ func NewCommand() *cobra.Command {`
`56`	`56`	`uploadCommand.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")`
`57`	`57`	`uploadCommand.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")`
`58`	`58`
	`59`	`+ uploadCommand.MarkFlagRequired("fqbn")`
	`60`	`+ uploadCommand.MarkFlagRequired("port")`
	`61`	`+`
`59`	`62`	`return uploadCommand`
`60`	`63`	`}`
`61`	`64`