Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make detection for test-binary more universal #2173

Merged
merged 2 commits into from
Dec 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions command.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import (
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strings"

Expand Down Expand Up @@ -1078,8 +1077,11 @@ 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 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:]
}

Expand Down
33 changes: 33 additions & 0 deletions command_go120.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// 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")
marckhouzam marked this conversation as resolved.
Show resolved Hide resolved

func isTesting() bool {
return inTest
}
25 changes: 25 additions & 0 deletions command_go121.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// 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 changes: 13 additions & 0 deletions command_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}
}
Loading