Env Flag Filtering

changelog/16683.txt

@@ -0,0 +1,3 @@
+```release-note:improvement
+cli: CLI commands will not print a warning if environmental flags are passed after positional arguments.
+```

command/base_helpers.go

@@ -296,13 +296,26 @@ func parseFlagFile(raw string) (string, error) {
 func generateFlagWarnings(args []string) string {
 	var trailingFlags []string
 	for _, arg := range args {
-		if strings.HasPrefix(arg, "-") {
-			trailingFlags = append(trailingFlags, arg)
+		if !strings.HasPrefix(arg, "-") {
+			continue
 		}
+
+		isEnvFlag := false
+		trimmedArg, _, _ := strings.Cut(strings.TrimLeft(arg, "-"), "=")
+		for _, flag := range envFlags {
+			if trimmedArg == flag {
+				isEnvFlag = true
+			}
+		}
+		if isEnvFlag {
+			continue
+		}
+
+		trailingFlags = append(trailingFlags, arg)
 	}
 
 	if len(trailingFlags) > 0 {
-		return fmt.Sprintf("Flags must be provided before positional arguments. "+
+		return fmt.Sprintf("Command flags must be provided before positional arguments. "+
 			"The following arguments will not be parsed as flags: [%s]", strings.Join(trailingFlags, ","))
 	} else {
 		return ""

command/base_helpers_test.go

@@ -242,6 +242,22 @@ func TestArgWarnings(t *testing.T) {
 			[]string{"-a", "b"},
 			"-a",
 		},
+		{
+			[]string{envFlagDetailed},
+			"",
+		},
+		{
+			[]string{"-" + envFlagOutputCurlString + "=true"},
+			"",
+		},
+		{
+			[]string{"-x" + envFlagDetailed},
+			"-x" + envFlagDetailed,
+		},
+		{
+			[]string{"--x=" + envFlagDetailed},
+			"--x=" + envFlagDetailed,
+		},
 	}
 
 	for _, tc := range cases {

command/main.go

@@ -24,6 +24,17 @@ type VaultUI struct {
 	detailed bool
 }
 
+const (
+	envFlagOutputCurlString = "output-curl-string"
+	envFlagOutputPolicy     = "output-policy"
+	envFlagFormat           = "format"
+	envFlagDetailed         = "detailed"
+)
+
+var envFlags = []string{
+	envFlagOutputCurlString, envFlagOutputPolicy, envFlagFormat, envFlagDetailed,
+}
+
 // setupEnv parses args and may replace them and sets some env vars to known
 // values based on format options
 func setupEnv(args []string) (retArgs []string, format string, detailed bool, outputCurlString bool, outputPolicy bool) {
@@ -47,46 +58,36 @@ func setupEnv(args []string) (retArgs []string, format string, detailed bool, ou
 			break
 		}
 
-		if arg == "-output-curl-string" || arg == "--output-curl-string" {
+		if isEnvFlag(arg, envFlagOutputCurlString) {
 			outputCurlString = true
 			continue
 		}
 
-		if arg == "-output-policy" || arg == "--output-policy" {
+		if isEnvFlag(arg, envFlagOutputPolicy) {
 			outputPolicy = true
 			continue
 		}
 
 		// Parse a given flag here, which overrides the env var
-		if strings.HasPrefix(arg, "--format=") {
-			format = strings.TrimPrefix(arg, "--format=")
-		}
-		if strings.HasPrefix(arg, "-format=") {
-			format = strings.TrimPrefix(arg, "-format=")
+		if isEnvFlagWithValue(arg, envFlagFormat) {
+			format = getEnvFlagValue(arg)
 		}
 		// For backwards compat, it could be specified without an equal sign
-		if arg == "-format" || arg == "--format" {
+		if isEnvFlag(arg, envFlagFormat) {
 			nextArgFormat = true
 		}
 
 		// Parse a given flag here, which overrides the env var
-		if strings.HasPrefix(arg, "--detailed=") {
-			detailed, err = strconv.ParseBool(strings.TrimPrefix(arg, "--detailed="))
-			if err != nil {
-				detailed = false
-			}
-			haveDetailed = true
-		}
-		if strings.HasPrefix(arg, "-detailed=") {
-			detailed, err = strconv.ParseBool(strings.TrimPrefix(arg, "-detailed="))
+		if isEnvFlagWithValue(arg, envFlagDetailed) {
+			detailed, err = strconv.ParseBool(getEnvFlagValue(envFlagDetailed))
 			if err != nil {
 				detailed = false
 			}
 			haveDetailed = true
 		}
 		// For backwards compat, it could be specified without an equal sign to enable
 		// detailed output.
-		if arg == "-detailed" || arg == "--detailed" {
+		if isEnvFlag(arg, envFlagDetailed) {
 			detailed = true
 			haveDetailed = true
 		}
@@ -115,6 +116,20 @@ func setupEnv(args []string) (retArgs []string, format string, detailed bool, ou
 	return args, format, detailed, outputCurlString, outputPolicy
 }
 
+func isEnvFlag(arg string, flag string) bool {
+	return arg == "-"+flag || arg == "--"+flag
+}
+
+func isEnvFlagWithValue(arg string, flag string) bool {
+	return strings.HasPrefix(arg, "--"+flag+"=") || strings.HasPrefix(arg, "-"+flag+"=")
+}
+
+func getEnvFlagValue(arg string) string {
+	_, value, _ := strings.Cut(arg, "=")
+
+	return value
+}
+
 type RunOptions struct {
 	TokenHelper token.TokenHelper
 	Stdout      io.Writer