glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-04-04 22:09:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Revert "Make detection for test-binary more universal ()" ()

Browse source 
This reverts commit d1e9d85fcf.

Some programs set os.Args in their unit tests and this change would
break those tests.

Ref: https://github.com/spf13/cobra/pull/2173#issuecomment-2661544195
This commit is contained in:
Marc Khouzam 2025-02-16 18:42:04 -05:00 committed by GitHub
parent a97f9fd47b
commit 40b5bc1437
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 3 additions and 76 deletions

8
command.go
View file

@ -23,6 +23,7 @@ import (
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strings"
@ -1100,11 +1101,8 @@ func (c *Command) ExecuteC() (cmd *Command, err error) {
args := c.args
// 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() {
// Workaround FAIL with "go test -v" or "cobra.test -test.v", see #155
if c.args == nil && filepath.Base(os.Args[0]) != "cobra.test" {
args = os.Args[1:]
}

33
command_go120.go
View file

@ -1,33 +0,0 @@
// 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.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//go:build !go1.21
// +build !go1.21
package cobra
import (
"os"
"strings"
)
// 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 {
return inTest
}

25
command_go121.go
View file

@ -1,25 +0,0 @@
// 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.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//go:build go1.21
// +build go1.21
package cobra
import "testing"
func isTesting() bool {
// Only available starting with go 1.21
return testing.Testing()
}

13
command_test.go
View file

@ -2921,16 +2921,3 @@ 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)
}
}