1
mirror of https://github.com/spf13/cobra.git synced 2024-12-27 22:11:11 -07:00

Compare commits

...

2 Commits

Author SHA1 Message Date
Sebastiaan van Stijn
e99cd6a9e8
Merge cc99a6875d into 02326d52c0 2024-12-01 00:16:29 +00:00
Sebastiaan van Stijn
cc99a6875d
Make detection for test-binary more universal
When running tests in verbose mode (or other options), tests involving
Cobra may fail if the test does not explicitly set Command.args to an
empty slice; in this case, Cobra defaults to using `os.Args`, which
will contain arguments passed to the test (such as `-v` (verbose)).

Commits e5762054c9 and 1ef0913976
implemented a workaround for this when running (unit) tests for Cobra
itself, but this check is specifig to Cobra (checking for `cobra.test`),
and don't work on Windows (which will have a `.exe` extension),

This patch implements a more universal check, so that users of Cobra
as a module also benefit from this workaround.

go1.21 and up provides a `testing.Testing()` utility ([1]); as the Cobra
module still supports Go1.16 and up, an alternative implementation was
added for older versions, based on golang.org/x/mod/lazyregexp [2].

[1]: https://pkg.go.dev/testing#Testing
[2]: https://cs.opensource.google/go/x/mod/+/refs/tags/v0.19.0:internal/lazyregexp/lazyre.go;l=66-78

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-07-16 18:15:54 +02:00
3 changed files with 55 additions and 2 deletions

View File

@ -23,7 +23,6 @@ import (
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strings"
@ -1079,7 +1078,7 @@ 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 c.args == nil && filepath.Base(os.Args[0]) != "cobra.test" {
if c.args == nil && !isTesting() {
args = os.Args[1:]
}

30
command_go120.go Normal file
View File

@ -0,0 +1,30 @@
// Copyright 2013-2023 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
var inTest = len(os.Args) > 0 && strings.HasSuffix(strings.TrimSuffix(os.Args[0], ".exe"), ".test")
func isTesting() bool {
return inTest
}

24
command_go121.go Normal file
View File

@ -0,0 +1,24 @@
// Copyright 2013-2023 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 {
return testing.Testing()
}