From fd4665affe6d4b26ef60ff071985a6d2ed158136 Mon Sep 17 00:00:00 2001 From: Marc Khouzam Date: Sat, 28 Dec 2024 16:48:47 -0500 Subject: [PATCH] Address comments Signed-off-by: Marc Khouzam --- command.go | 5 ++++- command_go120.go | 5 ++++- command_go121.go | 3 ++- command_test.go | 13 +++++++++++++ 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/command.go b/command.go index e01ea553..19602946 100644 --- a/command.go +++ b/command.go @@ -1077,7 +1077,10 @@ func (c *Command) ExecuteC() (cmd *Command, err error) { args := c.args - // Workaround FAIL with "go test -v" or "cobra.test -test.v", see #155 + // If running unit tests, we don't want to take the os.Args, see #155 and #2173. + // For example, the following would fail: + // go test -c -o foo.test + // ./foo.test -test.run TestNoArgs if c.args == nil && !isTesting() { args = os.Args[1:] } diff --git a/command_go120.go b/command_go120.go index c3da72ec..23bc0feb 100644 --- a/command_go120.go +++ b/command_go120.go @@ -1,4 +1,4 @@ -// Copyright 2013-2023 The Cobra Authors +// Copyright 2013-2024 The Cobra Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -23,6 +23,9 @@ import ( ) // based on golang.org/x/mod/internal/lazyregexp: https://cs.opensource.google/go/x/mod/+/refs/tags/v0.19.0:internal/lazyregexp/lazyre.go;l=66 +// For a non-go-test program which still has a name ending with ".test[.exe]", it will need to either: +// 1- Use go >= 1.21, or +// 2- call "rootCmd.SetArgs(os.Args[1:])" before calling "rootCmd.Execute()" var inTest = len(os.Args) > 0 && strings.HasSuffix(strings.TrimSuffix(os.Args[0], ".exe"), ".test") func isTesting() bool { diff --git a/command_go121.go b/command_go121.go index 60f705bb..8b69f152 100644 --- a/command_go121.go +++ b/command_go121.go @@ -1,4 +1,4 @@ -// Copyright 2013-2023 The Cobra Authors +// Copyright 2013-2024 The Cobra Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -20,5 +20,6 @@ package cobra import "testing" func isTesting() bool { + // Only available starting with go 1.21 return testing.Testing() } diff --git a/command_test.go b/command_test.go index cd44992b..9d5066c9 100644 --- a/command_test.go +++ b/command_test.go @@ -2839,3 +2839,16 @@ func TestUnknownFlagShouldReturnSameErrorRegardlessOfArgPosition(t *testing.T) { }) } } + +// This tests verifies that when running unit tests, os.Args are not used. +// This is because we don't want to process any arguments that are provided +// by "go test"; instead, unit tests must set the arguments they need using +// rootCmd.SetArgs(). +func TestNoOSArgsWhenTesting(t *testing.T) { + root := &Command{Use: "root", Run: emptyRun} + os.Args = append(os.Args, "--unknown") + + if _, err := root.ExecuteC(); err != nil { + t.Errorf("error: %v", err) + } +}