Address comments

Signed-off-by: Marc Khouzam <marc.khouzam@gmail.com>
This commit is contained in:
Marc Khouzam 2024-12-28 16:48:47 -05:00
parent ac1ca097a3
commit fd4665affe
4 changed files with 23 additions and 3 deletions

View file

@ -1077,7 +1077,10 @@ func (c *Command) ExecuteC() (cmd *Command, err error) {
args := c.args 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() { if c.args == nil && !isTesting() {
args = os.Args[1:] args = os.Args[1:]
} }

View file

@ -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"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with 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 // 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") var inTest = len(os.Args) > 0 && strings.HasSuffix(strings.TrimSuffix(os.Args[0], ".exe"), ".test")
func isTesting() bool { func isTesting() bool {

View file

@ -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"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -20,5 +20,6 @@ package cobra
import "testing" import "testing"
func isTesting() bool { func isTesting() bool {
// Only available starting with go 1.21
return testing.Testing() return testing.Testing()
} }

View file

@ -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)
}
}