// 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 regtest import ( "fmt" "testing" "golang.org/x/tools/internal/lsp" ) 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/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{WithProxyFiles(workspaceProxy)} if tt.rootPath != "" { opts = append(opts, WithRootPath(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 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(WithProxyFiles(workspaceProxy), WithRootPath("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(WithProxyFiles(workspaceProxy), WithRootPath("pkg")).run(t, workspaceModule, func(t *testing.T, env *Env) { env.Await( CompletedWork(lsp.DiagnosticWorkTitle(lsp.FromInitialWorkspaceLoad), 1), ) // 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( CompletedWork(lsp.DiagnosticWorkTitle(lsp.FromDidChangeWatchedFiles), 1), UnregistrationMatching("didChangeWatchedFiles"), RegistrationMatching("didChangeWatchedFiles"), ) }) }