mirror of https://github.com/golang/go.git
1162 lines
26 KiB
Go
1162 lines
26 KiB
Go
// 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 workspace
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"path/filepath"
|
|
"sort"
|
|
"strings"
|
|
"testing"
|
|
|
|
"golang.org/x/tools/gopls/internal/hooks"
|
|
. "golang.org/x/tools/internal/lsp/regtest"
|
|
"golang.org/x/tools/internal/lsp/source"
|
|
|
|
"golang.org/x/tools/internal/lsp/command"
|
|
"golang.org/x/tools/internal/lsp/fake"
|
|
"golang.org/x/tools/internal/lsp/protocol"
|
|
"golang.org/x/tools/internal/testenv"
|
|
)
|
|
|
|
func TestMain(m *testing.M) {
|
|
Main(m, hooks.Options)
|
|
}
|
|
|
|
const workspaceProxy = `
|
|
-- example.com@v1.2.3/go.mod --
|
|
module example.com
|
|
|
|
go 1.12
|
|
-- example.com@v1.2.3/blah/blah.go --
|
|
package blah
|
|
|
|
func SaySomething() {
|
|
fmt.Println("something")
|
|
}
|
|
-- random.org@v1.2.3/go.mod --
|
|
module random.org
|
|
|
|
go 1.12
|
|
-- random.org@v1.2.3/bye/bye.go --
|
|
package bye
|
|
|
|
func Goodbye() {
|
|
println("Bye")
|
|
}
|
|
`
|
|
|
|
// TODO: Add a replace directive.
|
|
const workspaceModule = `
|
|
-- pkg/go.mod --
|
|
module mod.com
|
|
|
|
go 1.14
|
|
|
|
require (
|
|
example.com v1.2.3
|
|
random.org v1.2.3
|
|
)
|
|
-- pkg/go.sum --
|
|
example.com v1.2.3 h1:Yryq11hF02fEf2JlOS2eph+ICE2/ceevGV3C9dl5V/c=
|
|
example.com v1.2.3/go.mod h1:Y2Rc5rVWjWur0h3pd9aEvK5Pof8YKDANh9gHA2Maujo=
|
|
random.org v1.2.3 h1:+JE2Fkp7gS0zsHXGEQJ7hraom3pNTlkxC4b2qPfA+/Q=
|
|
random.org v1.2.3/go.mod h1:E9KM6+bBX2g5ykHZ9H27w16sWo3QwgonyjM44Dnej3I=
|
|
-- pkg/main.go --
|
|
package main
|
|
|
|
import (
|
|
"example.com/blah"
|
|
"mod.com/inner"
|
|
"random.org/bye"
|
|
)
|
|
|
|
func main() {
|
|
blah.SaySomething()
|
|
inner.Hi()
|
|
bye.Goodbye()
|
|
}
|
|
-- pkg/main2.go --
|
|
package main
|
|
|
|
import "fmt"
|
|
|
|
func _() {
|
|
fmt.Print("%s")
|
|
}
|
|
-- pkg/inner/inner.go --
|
|
package inner
|
|
|
|
import "example.com/blah"
|
|
|
|
func Hi() {
|
|
blah.SaySomething()
|
|
}
|
|
-- goodbye/bye/bye.go --
|
|
package bye
|
|
|
|
func Bye() {}
|
|
-- goodbye/go.mod --
|
|
module random.org
|
|
|
|
go 1.12
|
|
`
|
|
|
|
// Confirm that find references returns all of the references in the module,
|
|
// regardless of what the workspace root is.
|
|
func TestReferences(t *testing.T) {
|
|
for _, tt := range []struct {
|
|
name, rootPath string
|
|
}{
|
|
{
|
|
name: "module root",
|
|
rootPath: "pkg",
|
|
},
|
|
{
|
|
name: "subdirectory",
|
|
rootPath: "pkg/inner",
|
|
},
|
|
} {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
opts := []RunOption{ProxyFiles(workspaceProxy)}
|
|
if tt.rootPath != "" {
|
|
opts = append(opts, WorkspaceFolders(tt.rootPath))
|
|
}
|
|
WithOptions(opts...).Run(t, workspaceModule, func(t *testing.T, env *Env) {
|
|
f := "pkg/inner/inner.go"
|
|
env.OpenFile(f)
|
|
locations := env.References(f, env.RegexpSearch(f, `SaySomething`))
|
|
want := 3
|
|
if got := len(locations); got != want {
|
|
t.Fatalf("expected %v locations, got %v", want, got)
|
|
}
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
// make sure that directory filters work
|
|
func TestFilters(t *testing.T) {
|
|
for _, tt := range []struct {
|
|
name, rootPath string
|
|
}{
|
|
{
|
|
name: "module root",
|
|
rootPath: "pkg",
|
|
},
|
|
} {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
opts := []RunOption{ProxyFiles(workspaceProxy)}
|
|
if tt.rootPath != "" {
|
|
opts = append(opts, WorkspaceFolders(tt.rootPath))
|
|
}
|
|
f := func(o *source.Options) {
|
|
o.DirectoryFilters = append(o.DirectoryFilters, "-inner")
|
|
}
|
|
opts = append(opts, Options(f))
|
|
WithOptions(opts...).Run(t, workspaceModule, func(t *testing.T, env *Env) {
|
|
syms := env.WorkspaceSymbol("Hi")
|
|
sort.Slice(syms, func(i, j int) bool { return syms[i].ContainerName < syms[j].ContainerName })
|
|
for i, s := range syms {
|
|
if strings.Contains(s.ContainerName, "/inner") {
|
|
t.Errorf("%s %v %s %s %d\n", s.Name, s.Kind, s.ContainerName, tt.name, i)
|
|
}
|
|
}
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
// Make sure that analysis diagnostics are cleared for the whole package when
|
|
// the only opened file is closed. This test was inspired by the experience in
|
|
// VS Code, where clicking on a reference result triggers a
|
|
// textDocument/didOpen without a corresponding textDocument/didClose.
|
|
func TestClearAnalysisDiagnostics(t *testing.T) {
|
|
WithOptions(
|
|
ProxyFiles(workspaceProxy),
|
|
WorkspaceFolders("pkg/inner"),
|
|
).Run(t, workspaceModule, func(t *testing.T, env *Env) {
|
|
env.OpenFile("pkg/main.go")
|
|
env.Await(
|
|
env.DiagnosticAtRegexp("pkg/main2.go", "fmt.Print"),
|
|
)
|
|
env.CloseBuffer("pkg/main.go")
|
|
env.Await(
|
|
EmptyDiagnostics("pkg/main2.go"),
|
|
)
|
|
})
|
|
}
|
|
|
|
// This test checks that gopls updates the set of files it watches when a
|
|
// replace target is added to the go.mod.
|
|
func TestWatchReplaceTargets(t *testing.T) {
|
|
WithOptions(
|
|
ProxyFiles(workspaceProxy),
|
|
WorkspaceFolders("pkg"),
|
|
).Run(t, workspaceModule, func(t *testing.T, env *Env) {
|
|
// Add a replace directive and expect the files that gopls is watching
|
|
// to change.
|
|
dir := env.Sandbox.Workdir.URI("goodbye").SpanURI().Filename()
|
|
goModWithReplace := fmt.Sprintf(`%s
|
|
replace random.org => %s
|
|
`, env.ReadWorkspaceFile("pkg/go.mod"), dir)
|
|
env.WriteWorkspaceFile("pkg/go.mod", goModWithReplace)
|
|
env.Await(
|
|
env.DoneWithChangeWatchedFiles(),
|
|
UnregistrationMatching("didChangeWatchedFiles"),
|
|
RegistrationMatching("didChangeWatchedFiles"),
|
|
)
|
|
})
|
|
}
|
|
|
|
const workspaceModuleProxy = `
|
|
-- example.com@v1.2.3/go.mod --
|
|
module example.com
|
|
|
|
go 1.12
|
|
-- example.com@v1.2.3/blah/blah.go --
|
|
package blah
|
|
|
|
func SaySomething() {
|
|
fmt.Println("something")
|
|
}
|
|
-- b.com@v1.2.3/go.mod --
|
|
module b.com
|
|
|
|
go 1.12
|
|
-- b.com@v1.2.3/b/b.go --
|
|
package b
|
|
|
|
func Hello() {}
|
|
`
|
|
|
|
func TestAutomaticWorkspaceModule_Interdependent(t *testing.T) {
|
|
const multiModule = `
|
|
-- moda/a/go.mod --
|
|
module a.com
|
|
|
|
require b.com v1.2.3
|
|
-- moda/a/go.sum --
|
|
b.com v1.2.3 h1:tXrlXP0rnjRpKNmkbLYoWBdq0ikb3C3bKK9//moAWBI=
|
|
b.com v1.2.3/go.mod h1:D+J7pfFBZK5vdIdZEFquR586vKKIkqG7Qjw9AxG5BQ8=
|
|
-- moda/a/a.go --
|
|
package a
|
|
|
|
import (
|
|
"b.com/b"
|
|
)
|
|
|
|
func main() {
|
|
var x int
|
|
_ = b.Hello()
|
|
}
|
|
-- modb/go.mod --
|
|
module b.com
|
|
|
|
-- modb/b/b.go --
|
|
package b
|
|
|
|
func Hello() int {
|
|
var x int
|
|
}
|
|
`
|
|
WithOptions(
|
|
ProxyFiles(workspaceModuleProxy),
|
|
Modes(Experimental),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
env.Await(
|
|
env.DiagnosticAtRegexp("moda/a/a.go", "x"),
|
|
env.DiagnosticAtRegexp("modb/b/b.go", "x"),
|
|
env.NoDiagnosticAtRegexp("moda/a/a.go", `"b.com/b"`),
|
|
)
|
|
})
|
|
}
|
|
|
|
func TestMultiModuleWithExclude(t *testing.T) {
|
|
testenv.NeedsGo1Point(t, 16)
|
|
|
|
const proxy = `
|
|
-- c.com@v1.2.3/go.mod --
|
|
module c.com
|
|
|
|
go 1.12
|
|
|
|
require b.com v1.2.3
|
|
-- c.com@v1.2.3/blah/blah.go --
|
|
package blah
|
|
|
|
func SaySomething() {
|
|
fmt.Println("something")
|
|
}
|
|
-- b.com@v1.2.3/go.mod --
|
|
module b.com
|
|
|
|
go 1.12
|
|
-- b.com@v1.2.4/b/b.go --
|
|
package b
|
|
|
|
func Hello() {}
|
|
-- b.com@v1.2.4/go.mod --
|
|
module b.com
|
|
|
|
go 1.12
|
|
-- b.com@v1.2.4/b/b.go --
|
|
package b
|
|
|
|
func Hello() {}
|
|
`
|
|
const multiModule = `
|
|
-- go.mod --
|
|
module a.com
|
|
|
|
require c.com v1.2.3
|
|
|
|
exclude b.com v1.2.3
|
|
-- go.sum --
|
|
c.com v1.2.3 h1:n07Dz9fYmpNqvZMwZi5NEqFcSHbvLa9lacMX+/g25tw=
|
|
c.com v1.2.3/go.mod h1:/4TyYgU9Nu5tA4NymP5xyqE8R2VMzGD3TbJCwCOvHAg=
|
|
-- main.go --
|
|
package a
|
|
|
|
func main() {
|
|
var x int
|
|
}
|
|
`
|
|
WithOptions(
|
|
ProxyFiles(proxy),
|
|
Modes(Experimental),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
env.Await(
|
|
env.DiagnosticAtRegexp("main.go", "x"),
|
|
)
|
|
})
|
|
}
|
|
|
|
// This change tests that the version of the module used changes after it has
|
|
// been deleted from the workspace.
|
|
func TestDeleteModule_Interdependent(t *testing.T) {
|
|
t.Skip("Skipping due to golang/go#46375: race due to orphaned file reloading")
|
|
|
|
const multiModule = `
|
|
-- moda/a/go.mod --
|
|
module a.com
|
|
|
|
require b.com v1.2.3
|
|
-- moda/a/go.sum --
|
|
b.com v1.2.3 h1:tXrlXP0rnjRpKNmkbLYoWBdq0ikb3C3bKK9//moAWBI=
|
|
b.com v1.2.3/go.mod h1:D+J7pfFBZK5vdIdZEFquR586vKKIkqG7Qjw9AxG5BQ8=
|
|
-- moda/a/a.go --
|
|
package a
|
|
|
|
import (
|
|
"b.com/b"
|
|
)
|
|
|
|
func main() {
|
|
var x int
|
|
_ = b.Hello()
|
|
}
|
|
-- modb/go.mod --
|
|
module b.com
|
|
|
|
-- modb/b/b.go --
|
|
package b
|
|
|
|
func Hello() int {
|
|
var x int
|
|
}
|
|
`
|
|
WithOptions(
|
|
ProxyFiles(workspaceModuleProxy),
|
|
Modes(Experimental),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
env.OpenFile("moda/a/a.go")
|
|
env.Await(env.DoneWithOpen())
|
|
|
|
original, _ := env.GoToDefinition("moda/a/a.go", env.RegexpSearch("moda/a/a.go", "Hello"))
|
|
if want := "modb/b/b.go"; !strings.HasSuffix(original, want) {
|
|
t.Errorf("expected %s, got %v", want, original)
|
|
}
|
|
env.CloseBuffer(original)
|
|
env.Await(env.DoneWithClose())
|
|
|
|
env.RemoveWorkspaceFile("modb/b/b.go")
|
|
env.RemoveWorkspaceFile("modb/go.mod")
|
|
env.Await(
|
|
env.DoneWithChangeWatchedFiles(),
|
|
)
|
|
|
|
d := protocol.PublishDiagnosticsParams{}
|
|
env.Await(
|
|
OnceMet(
|
|
env.DiagnosticAtRegexpWithMessage("moda/a/go.mod", "require b.com v1.2.3", "b.com@v1.2.3 has not been downloaded"),
|
|
ReadDiagnostics("moda/a/go.mod", &d),
|
|
),
|
|
)
|
|
env.ApplyQuickFixes("moda/a/go.mod", d.Diagnostics)
|
|
env.Await(env.DoneWithChangeWatchedFiles())
|
|
got, _ := env.GoToDefinition("moda/a/a.go", env.RegexpSearch("moda/a/a.go", "Hello"))
|
|
if want := "b.com@v1.2.3/b/b.go"; !strings.HasSuffix(got, want) {
|
|
t.Errorf("expected %s, got %v", want, got)
|
|
}
|
|
})
|
|
}
|
|
|
|
// Tests that the version of the module used changes after it has been added
|
|
// to the workspace.
|
|
func TestCreateModule_Interdependent(t *testing.T) {
|
|
const multiModule = `
|
|
-- moda/a/go.mod --
|
|
module a.com
|
|
|
|
require b.com v1.2.3
|
|
-- moda/a/go.sum --
|
|
b.com v1.2.3 h1:tXrlXP0rnjRpKNmkbLYoWBdq0ikb3C3bKK9//moAWBI=
|
|
b.com v1.2.3/go.mod h1:D+J7pfFBZK5vdIdZEFquR586vKKIkqG7Qjw9AxG5BQ8=
|
|
-- moda/a/a.go --
|
|
package a
|
|
|
|
import (
|
|
"b.com/b"
|
|
)
|
|
|
|
func main() {
|
|
var x int
|
|
_ = b.Hello()
|
|
}
|
|
`
|
|
WithOptions(
|
|
Modes(Experimental),
|
|
ProxyFiles(workspaceModuleProxy),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
env.OpenFile("moda/a/a.go")
|
|
original, _ := env.GoToDefinition("moda/a/a.go", env.RegexpSearch("moda/a/a.go", "Hello"))
|
|
if want := "b.com@v1.2.3/b/b.go"; !strings.HasSuffix(original, want) {
|
|
t.Errorf("expected %s, got %v", want, original)
|
|
}
|
|
env.CloseBuffer(original)
|
|
env.WriteWorkspaceFiles(map[string]string{
|
|
"modb/go.mod": "module b.com",
|
|
"modb/b/b.go": `package b
|
|
|
|
func Hello() int {
|
|
var x int
|
|
}
|
|
`,
|
|
})
|
|
env.Await(
|
|
OnceMet(
|
|
env.DoneWithChangeWatchedFiles(),
|
|
env.DiagnosticAtRegexp("modb/b/b.go", "x"),
|
|
),
|
|
)
|
|
got, _ := env.GoToDefinition("moda/a/a.go", env.RegexpSearch("moda/a/a.go", "Hello"))
|
|
if want := "modb/b/b.go"; !strings.HasSuffix(got, want) {
|
|
t.Errorf("expected %s, got %v", want, original)
|
|
}
|
|
})
|
|
}
|
|
|
|
// This test confirms that a gopls workspace can recover from initialization
|
|
// with one invalid module.
|
|
func TestOneBrokenModule(t *testing.T) {
|
|
const multiModule = `
|
|
-- moda/a/go.mod --
|
|
module a.com
|
|
|
|
require b.com v1.2.3
|
|
|
|
-- moda/a/a.go --
|
|
package a
|
|
|
|
import (
|
|
"b.com/b"
|
|
)
|
|
|
|
func main() {
|
|
var x int
|
|
_ = b.Hello()
|
|
}
|
|
-- modb/go.mod --
|
|
modul b.com // typo here
|
|
|
|
-- modb/b/b.go --
|
|
package b
|
|
|
|
func Hello() int {
|
|
var x int
|
|
}
|
|
`
|
|
WithOptions(
|
|
ProxyFiles(workspaceModuleProxy),
|
|
Modes(Experimental),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
env.OpenFile("modb/go.mod")
|
|
env.Await(
|
|
OnceMet(
|
|
env.DoneWithOpen(),
|
|
DiagnosticAt("modb/go.mod", 0, 0),
|
|
),
|
|
)
|
|
env.RegexpReplace("modb/go.mod", "modul", "module")
|
|
env.SaveBufferWithoutActions("modb/go.mod")
|
|
env.Await(
|
|
env.DiagnosticAtRegexp("modb/b/b.go", "x"),
|
|
)
|
|
})
|
|
}
|
|
|
|
func TestUseGoplsMod(t *testing.T) {
|
|
// This test validates certain functionality related to using a gopls.mod
|
|
// file to specify workspace modules.
|
|
testenv.NeedsGo1Point(t, 14)
|
|
const multiModule = `
|
|
-- moda/a/go.mod --
|
|
module a.com
|
|
|
|
require b.com v1.2.3
|
|
-- moda/a/go.sum --
|
|
b.com v1.2.3 h1:tXrlXP0rnjRpKNmkbLYoWBdq0ikb3C3bKK9//moAWBI=
|
|
b.com v1.2.3/go.mod h1:D+J7pfFBZK5vdIdZEFquR586vKKIkqG7Qjw9AxG5BQ8=
|
|
-- moda/a/a.go --
|
|
package a
|
|
|
|
import (
|
|
"b.com/b"
|
|
)
|
|
|
|
func main() {
|
|
var x int
|
|
_ = b.Hello()
|
|
}
|
|
-- modb/go.mod --
|
|
module b.com
|
|
|
|
require example.com v1.2.3
|
|
-- modb/go.sum --
|
|
example.com v1.2.3 h1:Yryq11hF02fEf2JlOS2eph+ICE2/ceevGV3C9dl5V/c=
|
|
example.com v1.2.3/go.mod h1:Y2Rc5rVWjWur0h3pd9aEvK5Pof8YKDANh9gHA2Maujo=
|
|
-- modb/b/b.go --
|
|
package b
|
|
|
|
func Hello() int {
|
|
var x int
|
|
}
|
|
-- gopls.mod --
|
|
module gopls-workspace
|
|
|
|
require (
|
|
a.com v0.0.0-goplsworkspace
|
|
b.com v1.2.3
|
|
)
|
|
|
|
replace a.com => $SANDBOX_WORKDIR/moda/a
|
|
`
|
|
WithOptions(
|
|
ProxyFiles(workspaceModuleProxy),
|
|
Modes(Experimental),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
// Initially, the gopls.mod should cause only the a.com module to be
|
|
// loaded. Validate this by jumping to a definition in b.com and ensuring
|
|
// that we go to the module cache.
|
|
env.OpenFile("moda/a/a.go")
|
|
env.Await(env.DoneWithOpen())
|
|
|
|
// To verify which modules are loaded, we'll jump to the definition of
|
|
// b.Hello.
|
|
checkHelloLocation := func(want string) error {
|
|
location, _ := env.GoToDefinition("moda/a/a.go", env.RegexpSearch("moda/a/a.go", "Hello"))
|
|
if !strings.HasSuffix(location, want) {
|
|
return fmt.Errorf("expected %s, got %v", want, location)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Initially this should be in the module cache, as b.com is not replaced.
|
|
if err := checkHelloLocation("b.com@v1.2.3/b/b.go"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// Now, modify the gopls.mod file on disk to activate the b.com module in
|
|
// the workspace.
|
|
workdir := env.Sandbox.Workdir.RootURI().SpanURI().Filename()
|
|
env.WriteWorkspaceFile("gopls.mod", fmt.Sprintf(`module gopls-workspace
|
|
|
|
require (
|
|
a.com v1.9999999.0-goplsworkspace
|
|
b.com v1.9999999.0-goplsworkspace
|
|
)
|
|
|
|
replace a.com => %s/moda/a
|
|
replace b.com => %s/modb
|
|
`, workdir, workdir))
|
|
env.Await(env.DoneWithChangeWatchedFiles())
|
|
// Check that go.mod diagnostics picked up the newly active mod file.
|
|
// The local version of modb has an extra dependency we need to download.
|
|
env.OpenFile("modb/go.mod")
|
|
env.Await(env.DoneWithOpen())
|
|
|
|
var d protocol.PublishDiagnosticsParams
|
|
env.Await(
|
|
OnceMet(
|
|
env.DiagnosticAtRegexpWithMessage("modb/go.mod", `require example.com v1.2.3`, "has not been downloaded"),
|
|
ReadDiagnostics("modb/go.mod", &d),
|
|
),
|
|
)
|
|
env.ApplyQuickFixes("modb/go.mod", d.Diagnostics)
|
|
env.Await(env.DiagnosticAtRegexp("modb/b/b.go", "x"))
|
|
// Jumping to definition should now go to b.com in the workspace.
|
|
if err := checkHelloLocation("modb/b/b.go"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// Now, let's modify the gopls.mod *overlay* (not on disk), and verify that
|
|
// this change is only picked up once it is saved.
|
|
env.OpenFile("gopls.mod")
|
|
env.Await(env.DoneWithOpen())
|
|
env.SetBufferContent("gopls.mod", fmt.Sprintf(`module gopls-workspace
|
|
|
|
require (
|
|
a.com v0.0.0-goplsworkspace
|
|
)
|
|
|
|
replace a.com => %s/moda/a
|
|
`, workdir))
|
|
|
|
// Editing the gopls.mod removes modb from the workspace modules, and so
|
|
// should clear outstanding diagnostics...
|
|
env.Await(OnceMet(
|
|
env.DoneWithChange(),
|
|
EmptyDiagnostics("modb/go.mod"),
|
|
))
|
|
// ...but does not yet cause a workspace reload, so we should still jump to modb.
|
|
if err := checkHelloLocation("modb/b/b.go"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// Saving should reload the workspace.
|
|
env.SaveBufferWithoutActions("gopls.mod")
|
|
if err := checkHelloLocation("b.com@v1.2.3/b/b.go"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestUseGoWork(t *testing.T) {
|
|
// This test validates certain functionality related to using a go.work
|
|
// file to specify workspace modules.
|
|
testenv.NeedsGo1Point(t, 14)
|
|
const multiModule = `
|
|
-- moda/a/go.mod --
|
|
module a.com
|
|
|
|
require b.com v1.2.3
|
|
-- moda/a/go.sum --
|
|
b.com v1.2.3 h1:tXrlXP0rnjRpKNmkbLYoWBdq0ikb3C3bKK9//moAWBI=
|
|
b.com v1.2.3/go.mod h1:D+J7pfFBZK5vdIdZEFquR586vKKIkqG7Qjw9AxG5BQ8=
|
|
-- moda/a/a.go --
|
|
package a
|
|
|
|
import (
|
|
"b.com/b"
|
|
)
|
|
|
|
func main() {
|
|
var x int
|
|
_ = b.Hello()
|
|
}
|
|
-- modb/go.mod --
|
|
module b.com
|
|
|
|
require example.com v1.2.3
|
|
-- modb/go.sum --
|
|
example.com v1.2.3 h1:Yryq11hF02fEf2JlOS2eph+ICE2/ceevGV3C9dl5V/c=
|
|
example.com v1.2.3/go.mod h1:Y2Rc5rVWjWur0h3pd9aEvK5Pof8YKDANh9gHA2Maujo=
|
|
-- modb/b/b.go --
|
|
package b
|
|
|
|
func Hello() int {
|
|
var x int
|
|
}
|
|
-- go.work --
|
|
go 1.17
|
|
|
|
directory (
|
|
./moda/a
|
|
)
|
|
`
|
|
WithOptions(
|
|
ProxyFiles(workspaceModuleProxy),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
// Initially, the gopls.mod should cause only the a.com module to be
|
|
// loaded. Validate this by jumping to a definition in b.com and ensuring
|
|
// that we go to the module cache.
|
|
env.OpenFile("moda/a/a.go")
|
|
env.Await(env.DoneWithOpen())
|
|
|
|
// To verify which modules are loaded, we'll jump to the definition of
|
|
// b.Hello.
|
|
checkHelloLocation := func(want string) error {
|
|
location, _ := env.GoToDefinition("moda/a/a.go", env.RegexpSearch("moda/a/a.go", "Hello"))
|
|
if !strings.HasSuffix(location, want) {
|
|
return fmt.Errorf("expected %s, got %v", want, location)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Initially this should be in the module cache, as b.com is not replaced.
|
|
if err := checkHelloLocation("b.com@v1.2.3/b/b.go"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// Now, modify the gopls.mod file on disk to activate the b.com module in
|
|
// the workspace.
|
|
env.WriteWorkspaceFile("go.work", `
|
|
go 1.17
|
|
|
|
directory (
|
|
./moda/a
|
|
./modb
|
|
)
|
|
`)
|
|
env.Await(env.DoneWithChangeWatchedFiles())
|
|
// Check that go.mod diagnostics picked up the newly active mod file.
|
|
// The local version of modb has an extra dependency we need to download.
|
|
env.OpenFile("modb/go.mod")
|
|
env.Await(env.DoneWithOpen())
|
|
|
|
var d protocol.PublishDiagnosticsParams
|
|
env.Await(
|
|
OnceMet(
|
|
env.DiagnosticAtRegexpWithMessage("modb/go.mod", `require example.com v1.2.3`, "has not been downloaded"),
|
|
ReadDiagnostics("modb/go.mod", &d),
|
|
),
|
|
)
|
|
env.ApplyQuickFixes("modb/go.mod", d.Diagnostics)
|
|
env.Await(env.DiagnosticAtRegexp("modb/b/b.go", "x"))
|
|
// Jumping to definition should now go to b.com in the workspace.
|
|
if err := checkHelloLocation("modb/b/b.go"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// Now, let's modify the gopls.mod *overlay* (not on disk), and verify that
|
|
// this change is only picked up once it is saved.
|
|
env.OpenFile("go.work")
|
|
env.Await(env.DoneWithOpen())
|
|
env.SetBufferContent("go.work", `go 1.17
|
|
|
|
directory (
|
|
./moda/a
|
|
)`)
|
|
|
|
// Editing the gopls.mod removes modb from the workspace modules, and so
|
|
// should clear outstanding diagnostics...
|
|
env.Await(OnceMet(
|
|
env.DoneWithChange(),
|
|
EmptyDiagnostics("modb/go.mod"),
|
|
))
|
|
// ...but does not yet cause a workspace reload, so we should still jump to modb.
|
|
if err := checkHelloLocation("modb/b/b.go"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// Saving should reload the workspace.
|
|
env.SaveBufferWithoutActions("go.work")
|
|
if err := checkHelloLocation("b.com@v1.2.3/b/b.go"); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestNonWorkspaceFileCreation(t *testing.T) {
|
|
testenv.NeedsGo1Point(t, 13)
|
|
|
|
const files = `
|
|
-- go.mod --
|
|
module mod.com
|
|
|
|
go 1.12
|
|
-- x.go --
|
|
package x
|
|
`
|
|
|
|
const code = `
|
|
package foo
|
|
import "fmt"
|
|
var _ = fmt.Printf
|
|
`
|
|
Run(t, files, func(t *testing.T, env *Env) {
|
|
env.CreateBuffer("/tmp/foo.go", "")
|
|
env.EditBuffer("/tmp/foo.go", fake.NewEdit(0, 0, 0, 0, code))
|
|
env.GoToDefinition("/tmp/foo.go", env.RegexpSearch("/tmp/foo.go", `Printf`))
|
|
})
|
|
}
|
|
|
|
func TestMultiModuleV2(t *testing.T) {
|
|
const multiModule = `
|
|
-- moda/a/go.mod --
|
|
module a.com
|
|
|
|
require b.com/v2 v2.1.9
|
|
-- moda/a/a.go --
|
|
package a
|
|
|
|
import (
|
|
"b.com/v2/b"
|
|
)
|
|
|
|
func main() {
|
|
var x int
|
|
_ = b.Hi()
|
|
}
|
|
-- modb/go.mod --
|
|
module b.com
|
|
|
|
-- modb/b/b.go --
|
|
package b
|
|
|
|
func Hello() int {
|
|
var x int
|
|
}
|
|
-- modb/v2/go.mod --
|
|
module b.com/v2
|
|
|
|
-- modb/v2/b/b.go --
|
|
package b
|
|
|
|
func Hi() int {
|
|
var x int
|
|
}
|
|
-- modc/go.mod --
|
|
module gopkg.in/yaml.v1 // test gopkg.in versions
|
|
-- modc/main.go --
|
|
package main
|
|
|
|
func main() {
|
|
var x int
|
|
}
|
|
`
|
|
WithOptions(
|
|
Modes(Experimental),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
env.Await(
|
|
env.DiagnosticAtRegexp("moda/a/a.go", "x"),
|
|
env.DiagnosticAtRegexp("modb/b/b.go", "x"),
|
|
env.DiagnosticAtRegexp("modb/v2/b/b.go", "x"),
|
|
env.DiagnosticAtRegexp("modc/main.go", "x"),
|
|
)
|
|
})
|
|
}
|
|
|
|
func TestWorkspaceDirAccess(t *testing.T) {
|
|
const multiModule = `
|
|
-- moda/a/go.mod --
|
|
module a.com
|
|
|
|
go 1.15
|
|
-- moda/a/a.go --
|
|
package main
|
|
|
|
func main() {
|
|
fmt.Println("Hello")
|
|
}
|
|
-- modb/go.mod --
|
|
module b.com
|
|
|
|
go 1.16
|
|
-- modb/b/b.go --
|
|
package main
|
|
|
|
func main() {
|
|
fmt.Println("World")
|
|
}
|
|
`
|
|
WithOptions(
|
|
Modes(Experimental),
|
|
SendPID(),
|
|
).Run(t, multiModule, func(t *testing.T, env *Env) {
|
|
params := &protocol.ExecuteCommandParams{
|
|
Command: command.WorkspaceMetadata.ID(),
|
|
Arguments: []json.RawMessage{json.RawMessage("{}")},
|
|
}
|
|
var result command.WorkspaceMetadataResult
|
|
env.ExecuteCommand(params, &result)
|
|
|
|
if n := len(result.Workspaces); n != 1 {
|
|
env.T.Fatalf("got %d workspaces, want 1", n)
|
|
}
|
|
// Don't factor this out of Server.addFolders. vscode-go expects this
|
|
// directory.
|
|
modPath := filepath.Join(result.Workspaces[0].ModuleDir, "go.mod")
|
|
gotb, err := ioutil.ReadFile(modPath)
|
|
if err != nil {
|
|
t.Fatalf("reading expected workspace modfile: %v", err)
|
|
}
|
|
got := string(gotb)
|
|
for _, want := range []string{"go 1.16", "a.com v1.9999999.0-goplsworkspace", "b.com v1.9999999.0-goplsworkspace"} {
|
|
if !strings.Contains(got, want) {
|
|
// want before got here, since the go.mod is multi-line
|
|
t.Fatalf("workspace go.mod missing %q. got:\n%s", want, got)
|
|
}
|
|
}
|
|
workdir := env.Sandbox.Workdir.RootURI().SpanURI().Filename()
|
|
env.WriteWorkspaceFile("gopls.mod", fmt.Sprintf(`
|
|
module gopls-workspace
|
|
|
|
require (
|
|
a.com v1.9999999.0-goplsworkspace
|
|
)
|
|
|
|
replace a.com => %s/moda/a
|
|
`, workdir))
|
|
env.Await(env.DoneWithChangeWatchedFiles())
|
|
gotb, err = ioutil.ReadFile(modPath)
|
|
if err != nil {
|
|
t.Fatalf("reading expected workspace modfile: %v", err)
|
|
}
|
|
got = string(gotb)
|
|
want := "b.com v1.9999999.0-goplsworkspace"
|
|
if strings.Contains(got, want) {
|
|
t.Fatalf("workspace go.mod contains unexpected %q. got:\n%s", want, got)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestDirectoryFiltersLoads(t *testing.T) {
|
|
// exclude, and its error, should be excluded from the workspace.
|
|
const files = `
|
|
-- go.mod --
|
|
module example.com
|
|
|
|
go 1.12
|
|
-- exclude/exclude.go --
|
|
package exclude
|
|
|
|
const _ = Nonexistant
|
|
`
|
|
cfg := EditorConfig{
|
|
DirectoryFilters: []string{"-exclude"},
|
|
}
|
|
WithOptions(cfg).Run(t, files, func(t *testing.T, env *Env) {
|
|
env.Await(NoDiagnostics("exclude/x.go"))
|
|
})
|
|
}
|
|
|
|
func TestDirectoryFiltersTransitiveDep(t *testing.T) {
|
|
// Even though exclude is excluded from the workspace, it should
|
|
// still be importable as a non-workspace package.
|
|
const files = `
|
|
-- go.mod --
|
|
module example.com
|
|
|
|
go 1.12
|
|
-- include/include.go --
|
|
package include
|
|
import "example.com/exclude"
|
|
|
|
const _ = exclude.X
|
|
-- exclude/exclude.go --
|
|
package exclude
|
|
|
|
const _ = Nonexistant // should be ignored, since this is a non-workspace package
|
|
const X = 1
|
|
`
|
|
|
|
cfg := EditorConfig{
|
|
DirectoryFilters: []string{"-exclude"},
|
|
}
|
|
WithOptions(cfg).Run(t, files, func(t *testing.T, env *Env) {
|
|
env.Await(
|
|
NoDiagnostics("exclude/exclude.go"), // filtered out
|
|
NoDiagnostics("include/include.go"), // successfully builds
|
|
)
|
|
})
|
|
}
|
|
|
|
func TestDirectoryFiltersWorkspaceModules(t *testing.T) {
|
|
// Define a module include.com which should be in the workspace, plus a
|
|
// module exclude.com which should be excluded and therefore come from
|
|
// the proxy.
|
|
const files = `
|
|
-- include/go.mod --
|
|
module include.com
|
|
|
|
go 1.12
|
|
|
|
require exclude.com v1.0.0
|
|
|
|
-- include/go.sum --
|
|
exclude.com v1.0.0 h1:Q5QSfDXY5qyNCBeUiWovUGqcLCRZKoTs9XdBeVz+w1I=
|
|
exclude.com v1.0.0/go.mod h1:hFox2uDlNB2s2Jfd9tHlQVfgqUiLVTmh6ZKat4cvnj4=
|
|
|
|
-- include/include.go --
|
|
package include
|
|
|
|
import "exclude.com"
|
|
|
|
var _ = exclude.X // satisfied only by the workspace version
|
|
-- exclude/go.mod --
|
|
module exclude.com
|
|
|
|
go 1.12
|
|
-- exclude/exclude.go --
|
|
package exclude
|
|
|
|
const X = 1
|
|
`
|
|
const proxy = `
|
|
-- exclude.com@v1.0.0/go.mod --
|
|
module exclude.com
|
|
|
|
go 1.12
|
|
-- exclude.com@v1.0.0/exclude.go --
|
|
package exclude
|
|
`
|
|
cfg := EditorConfig{
|
|
DirectoryFilters: []string{"-exclude"},
|
|
}
|
|
WithOptions(cfg, Modes(Experimental), ProxyFiles(proxy)).Run(t, files, func(t *testing.T, env *Env) {
|
|
env.Await(env.DiagnosticAtRegexp("include/include.go", `exclude.(X)`))
|
|
})
|
|
}
|
|
|
|
// Confirm that a fix for a tidy module will correct all modules in the
|
|
// workspace.
|
|
func TestMultiModule_OneBrokenModule(t *testing.T) {
|
|
testenv.NeedsGo1Point(t, 15)
|
|
|
|
const mod = `
|
|
-- a/go.mod --
|
|
module a.com
|
|
|
|
go 1.12
|
|
-- a/main.go --
|
|
package main
|
|
-- b/go.mod --
|
|
module b.com
|
|
|
|
go 1.12
|
|
|
|
require (
|
|
example.com v1.2.3
|
|
)
|
|
-- b/go.sum --
|
|
-- b/main.go --
|
|
package b
|
|
|
|
import "example.com/blah"
|
|
|
|
func main() {
|
|
blah.Hello()
|
|
}
|
|
`
|
|
WithOptions(
|
|
ProxyFiles(workspaceProxy),
|
|
Modes(Experimental),
|
|
).Run(t, mod, func(t *testing.T, env *Env) {
|
|
params := &protocol.PublishDiagnosticsParams{}
|
|
env.OpenFile("b/go.mod")
|
|
env.Await(
|
|
OnceMet(
|
|
env.GoSumDiagnostic("b/go.mod", `example.com v1.2.3`),
|
|
ReadDiagnostics("b/go.mod", params),
|
|
),
|
|
)
|
|
for _, d := range params.Diagnostics {
|
|
if !strings.Contains(d.Message, "go.sum is out of sync") {
|
|
continue
|
|
}
|
|
actions := env.GetQuickFixes("b/go.mod", []protocol.Diagnostic{d})
|
|
if len(actions) != 2 {
|
|
t.Fatalf("expected 2 code actions, got %v", len(actions))
|
|
}
|
|
env.ApplyQuickFixes("b/go.mod", []protocol.Diagnostic{d})
|
|
}
|
|
env.Await(
|
|
EmptyDiagnostics("b/go.mod"),
|
|
)
|
|
})
|
|
}
|
|
|
|
// Sometimes users may have their module cache within the workspace.
|
|
// We shouldn't consider any module in the module cache to be in the workspace.
|
|
func TestGOMODCACHEInWorkspace(t *testing.T) {
|
|
const mod = `
|
|
-- a/go.mod --
|
|
module a.com
|
|
|
|
go 1.12
|
|
-- a/a.go --
|
|
package a
|
|
|
|
func _() {}
|
|
-- a/c/c.go --
|
|
package c
|
|
-- gopath/src/b/b.go --
|
|
package b
|
|
-- gopath/pkg/mod/example.com/go.mod --
|
|
module example.com
|
|
|
|
go 1.12
|
|
-- gopath/pkg/mod/example.com/main.go --
|
|
package main
|
|
`
|
|
WithOptions(
|
|
EditorConfig{Env: map[string]string{
|
|
"GOPATH": filepath.FromSlash("$SANDBOX_WORKDIR/gopath"),
|
|
}},
|
|
Modes(Singleton),
|
|
).Run(t, mod, func(t *testing.T, env *Env) {
|
|
env.Await(
|
|
// Confirm that the build configuration is seen as valid,
|
|
// even though there are technically multiple go.mod files in the
|
|
// worskpace.
|
|
LogMatching(protocol.Info, ".*valid build configuration = true.*", 1, false),
|
|
)
|
|
})
|
|
}
|
|
|
|
func TestAddGoWork(t *testing.T) {
|
|
const nomod = `
|
|
-- a/go.mod --
|
|
module a.com
|
|
|
|
go 1.16
|
|
-- a/main.go --
|
|
package main
|
|
|
|
func main() {}
|
|
-- b/go.mod --
|
|
module b.com
|
|
|
|
go 1.16
|
|
-- b/main.go --
|
|
package main
|
|
|
|
func main() {}
|
|
`
|
|
WithOptions(
|
|
Modes(Singleton),
|
|
).Run(t, nomod, func(t *testing.T, env *Env) {
|
|
env.OpenFile("a/main.go")
|
|
env.OpenFile("b/main.go")
|
|
env.Await(
|
|
DiagnosticAt("a/main.go", 0, 0),
|
|
DiagnosticAt("b/main.go", 0, 0),
|
|
)
|
|
env.WriteWorkspaceFile("go.work", `go 1.16
|
|
|
|
directory (
|
|
a
|
|
b
|
|
)
|
|
`)
|
|
env.Await(
|
|
EmptyDiagnostics("a/main.go"),
|
|
EmptyDiagnostics("b/main.go"),
|
|
)
|
|
})
|
|
}
|