1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
// Copyright 2020 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package integration
import (
"context"
"flag"
"fmt"
"os"
"runtime"
"testing"
"time"
"golang.org/x/tools/gopls/internal/cache"
"golang.org/x/tools/gopls/internal/cmd"
"golang.org/x/tools/internal/drivertest"
"golang.org/x/tools/internal/gocommand"
"golang.org/x/tools/internal/memoize"
"golang.org/x/tools/internal/testenv"
"golang.org/x/tools/internal/tool"
)
var (
runSubprocessTests = flag.Bool("enable_gopls_subprocess_tests", false, "run integration tests against a gopls subprocess (default: in-process)")
goplsBinaryPath = flag.String("gopls_test_binary", "", "path to the gopls binary for use as a remote, for use with the -enable_gopls_subprocess_tests flag")
timeout = flag.Duration("timeout", defaultTimeout(), "if nonzero, default timeout for each integration test; defaults to GOPLS_INTEGRATION_TEST_TIMEOUT")
skipCleanup = flag.Bool("skip_cleanup", false, "whether to skip cleaning up temp directories")
printGoroutinesOnFailure = flag.Bool("print_goroutines", false, "whether to print goroutines info on failure")
printLogs = flag.Bool("print_logs", false, "whether to print LSP logs")
)
func defaultTimeout() time.Duration {
s := os.Getenv("GOPLS_INTEGRATION_TEST_TIMEOUT")
if s == "" {
return 0
}
d, err := time.ParseDuration(s)
if err != nil {
fmt.Fprintf(os.Stderr, "invalid GOPLS_INTEGRATION_TEST_TIMEOUT %q: %v\n", s, err)
os.Exit(2)
}
return d
}
var runner *Runner
func Run(t *testing.T, files string, f TestFunc) {
runner.Run(t, files, f)
}
func WithOptions(opts ...RunOption) configuredRunner {
return configuredRunner{opts: opts}
}
type configuredRunner struct {
opts []RunOption
}
func (r configuredRunner) Run(t *testing.T, files string, f TestFunc) {
// Print a warning if the test's temporary directory is not
// suitable as a workspace folder, as this may lead to
// otherwise-cryptic failures. This situation typically occurs
// when an arbitrary string (e.g. "foo.") is used as a subtest
// name, on a platform with filename restrictions (e.g. no
// trailing period on Windows).
tmp := t.TempDir()
if err := cache.CheckPathValid(tmp); err != nil {
t.Logf("Warning: testing.T.TempDir(%s) is not valid as a workspace folder: %s",
tmp, err)
}
runner.Run(t, files, f, r.opts...)
}
// RunMultiple runs a test multiple times, with different options.
// The runner should be constructed with [WithOptions].
//
// TODO(rfindley): replace Modes with selective use of RunMultiple.
type RunMultiple []struct {
Name string
Runner interface {
Run(t *testing.T, files string, f TestFunc)
}
}
func (r RunMultiple) Run(t *testing.T, files string, f TestFunc) {
for _, runner := range r {
t.Run(runner.Name, func(t *testing.T) {
runner.Runner.Run(t, files, f)
})
}
}
// DefaultModes returns the default modes to run for each regression test (they
// may be reconfigured by the tests themselves).
func DefaultModes() Mode {
modes := Default
if !testing.Short() {
// TODO(rfindley): we should just run a few select integration tests in
// "Forwarded" mode, and call it a day. No need to run every single test in
// two ways.
modes |= Forwarded
}
if *runSubprocessTests {
modes |= SeparateProcess
}
return modes
}
var runFromMain = false // true if Main has been called
// Main sets up and tears down the shared integration test state.
func Main(m *testing.M) (code int) {
// Provide an entrypoint for tests that use a fake go/packages driver.
drivertest.RunIfChild()
defer func() {
if runner != nil {
if err := runner.Close(); err != nil {
fmt.Fprintf(os.Stderr, "closing test runner: %v\n", err)
// Cleanup is broken in go1.12 and earlier, and sometimes flakes on
// Windows due to file locking, but this is OK for our CI.
//
// Fail on go1.13+, except for windows and android which have shutdown problems.
if testenv.Go1Point() >= 13 && runtime.GOOS != "windows" && runtime.GOOS != "android" {
if code == 0 {
code = 1
}
}
}
}
}()
runFromMain = true
// golang/go#54461: enable additional debugging around hanging Go commands.
gocommand.DebugHangingGoCommands = true
// If this magic environment variable is set, run gopls instead of the test
// suite. See the documentation for runTestAsGoplsEnvvar for more details.
if os.Getenv(runTestAsGoplsEnvvar) == "true" {
tool.Main(context.Background(), cmd.New(), os.Args[1:])
return 0
}
if !testenv.HasExec() {
fmt.Printf("skipping all tests: exec not supported on %s/%s\n", runtime.GOOS, runtime.GOARCH)
return 0
}
testenv.ExitIfSmallMachine()
flag.Parse()
// Disable GOPACKAGESDRIVER, as it can cause spurious test failures.
os.Setenv("GOPACKAGESDRIVER", "off")
if skipReason := checkBuilder(); skipReason != "" {
fmt.Printf("Skipping all tests: %s\n", skipReason)
return 0
}
if err := testenv.HasTool("go"); err != nil {
fmt.Println("Missing go command")
return 1
}
runner = &Runner{
DefaultModes: DefaultModes(),
Timeout: *timeout,
PrintGoroutinesOnFailure: *printGoroutinesOnFailure,
SkipCleanup: *skipCleanup,
store: memoize.NewStore(memoize.NeverEvict),
}
runner.goplsPath = *goplsBinaryPath
if runner.goplsPath == "" {
var err error
runner.goplsPath, err = os.Executable()
if err != nil {
panic(fmt.Sprintf("finding test binary path: %v", err))
}
}
dir, err := os.MkdirTemp("", "gopls-test-")
if err != nil {
panic(fmt.Errorf("creating temp directory: %v", err))
}
runner.tempDir = dir
return m.Run()
}
|
