update tests

app.go

@@ -10,6 +10,9 @@ import (
 	"time"
 )
 
+// printerFunc is the function signature for fmt.Fprintln
+type printerFunc func(io.Writer, ...interface{}) (int, error)
+
 var (
 	changeLogURL                    = "https://github.com/urfave/cli/blob/master/CHANGELOG.md"
 	appActionDeprecationURL         = fmt.Sprintf("%s#deprecated-cli-app-action-signature", changeLogURL)
@@ -20,6 +23,8 @@ var (
 	errInvalidActionType = NewExitError("ERROR invalid Action type. "+
 		fmt.Sprintf("Must be `func(*Context`)` or `func(*Context) error).  %s", contactSysadmin)+
 		fmt.Sprintf("See %s", appActionDeprecationURL), 2)
+
+	showFlagError printerFunc = fmt.Fprintln
 )
 
 // App is the main structure of a cli application. It is recommended that
@@ -195,7 +200,6 @@ func (a *App) Run(arguments []string) (err error) {
 	set.SetOutput(ioutil.Discard)
 	err = set.Parse(arguments[1:])
 	nerr := normalizeFlags(a.Flags, set)
-	cerr := checkRequiredFlags(a.Flags, set)
 	context := NewContext(a, set, nil)
 
 	if nerr != nil {
@@ -230,8 +234,9 @@ func (a *App) Run(arguments []string) (err error) {
 		return nil
 	}
 
+	cerr := checkRequiredFlags(a.Flags, set)
 	if cerr != nil {
-		fmt.Fprintln(a.Writer, cerr)
+		showFlagError(a.Writer, cerr)
 		ShowAppHelp(context)
 		return cerr
 	}

app_test.go

@@ -877,56 +877,127 @@ func TestAppNoHelpFlag(t *testing.T) {
 	}
 }
 
-func TestAppHelpPrinter(t *testing.T) {
+func TestRequiredFlagAppRunBehavior(t *testing.T) {
 	tdata := []struct {
-		testCase    string
+		testCase                 string
-		flags       []Flag
+		flags                    []Flag
-		appRunInput []string
+		appRunInput              []string
+		expectedHelpPrinter      bool
+		expectedAnError          bool
+		expectedFlagErrorPrinter bool
 	}{
 		{
-			testCase:    "prints_help_case_one",
+			// expectations:
-			appRunInput: []string{""},
+			//  - empty input shows the help message
+			// 	- empty input explicitly does not error
+			testCase:            "empty_input",
+			appRunInput:         []string{""},
+			expectedHelpPrinter: true,
+			expectedAnError:     false, // explicit false for readability (this is the default value)
 		},
 		{
-			testCase:    "prints_help_case_two",
+			// expectations:
-			appRunInput: []string{"-h"},
+			//  - empty input, when a required flag is present, shows the help message
+			// 	- empty input, when a required flag is present, errors
+			// 	- empty input, when a required flag is present, show the flag error message
+			testCase:                 "empty_input_with_required_flag",
+			appRunInput:              []string{""},
+			flags:                    []Flag{StringFlag{Name: "requiredFlag", Required: true}},
+			expectedHelpPrinter:      true,
+			expectedAnError:          true,
+			expectedFlagErrorPrinter: true,
 		},
 		{
-			testCase:    "prints_help_case_three",
+			// expectations:
-			appRunInput: []string{"testCommand", "-h"},
+			//  - --help input, when a required flag is present, shows the help message
+			// 	- --help input, when a required flag is present, explicitly does not error
+			// 	- --help input, when a required flag is present, explicitly does not show the flag error message
+			testCase:                 "help_input_with_required_flag",
+			appRunInput:              []string{"command", "--help"},
+			flags:                    []Flag{StringFlag{Name: "requiredFlag", Required: true}},
+			expectedHelpPrinter:      true,
+			expectedAnError:          false, // explicit false for readability (this is the default value)
+			expectedFlagErrorPrinter: false, // explicit false for readability (this is the default value)
 		},
 		{
-			testCase:    "prints_help_when_required_flag_is_present",
+			// expectations:
-			flags:       []Flag{StringFlag{Name: "flag", Required: true}},
+			//  - optional input, when a required flag is present, shows the help message
-			appRunInput: []string{"testCommand", "-h"},
+			// 	- optional input, when a required flag is present, errors
+			// 	- optional input, when a required flag is present, shows the flag error message
+			testCase:                 "optional_input_with_required_flag",
+			appRunInput:              []string{"command", "--optional", "cats"},
+			flags:                    []Flag{StringFlag{Name: "requiredFlag", Required: true}, StringFlag{Name: "optional"}},
+			expectedHelpPrinter:      true,
+			expectedAnError:          true,
+			expectedFlagErrorPrinter: true,
 		},
 	}
 	for _, test := range tdata {
 		t.Run(test.testCase, func(t *testing.T) {
+			// setup - undo showFlagError mock when finished
+			oldShowError := showFlagError
+			defer func() {
+				showFlagError = oldShowError
+			}()
+			// setup - mock showFlagError
+			var showErrorWasCalled = false
+			showFlagError = func(writer io.Writer, err ...interface{}) (int, error) {
+				showErrorWasCalled = true
+				return 0, nil
+			}
+			// setup - undo HelpPrinter mock when finished
 			oldPrinter := HelpPrinter
 			defer func() {
 				HelpPrinter = oldPrinter
 			}()
-
+			// setup - mock HelpPrinter
-			var wasCalled = false
+			var helpPrinterWasCalled = false
 			HelpPrinter = func(w io.Writer, template string, data interface{}) {
-				wasCalled = true
+				helpPrinterWasCalled = true
 			}
-
+			// setup - app
 			app := NewApp()
 			app.Flags = test.flags
+
+			// logic under test
 			err := app.Run(test.appRunInput)
 
-			if wasCalled == false {
+			// assertions
-				t.Errorf("Help printer expected to be called, but was not")
+			if test.expectedHelpPrinter && helpPrinterWasCalled == false {
+				t.Errorf("HelpPrinter expected to be called, but was not")
 			}
-			if err != nil {
+			if test.expectedFlagErrorPrinter && showErrorWasCalled == false {
+				t.Errorf("showFlagError expected to be called, but was not")
+			}
+			if test.expectedAnError && err == nil {
+				t.Errorf("expected an error, but there was none")
+			}
+			if !test.expectedAnError && err != nil {
 				t.Errorf("did not expected an error, but there was one: %s", err)
 			}
 		})
 	}
 }
 
+func TestAppHelpPrinter(t *testing.T) {
+	oldPrinter := HelpPrinter
+	defer func() {
+		HelpPrinter = oldPrinter
+	}()
+
+	var wasCalled = false
+	HelpPrinter = func(w io.Writer, template string, data interface{}) {
+		wasCalled = true
+	}
+
+	app := NewApp()
+	app.Run([]string{"-h"})
+
+	if wasCalled == false {
+		t.Errorf("Help printer expected to be called, but was not")
+	}
+}
+
 func TestApp_VersionPrinter(t *testing.T) {
 	oldPrinter := VersionPrinter
 	defer func() {