go/internal/lsp/lsprpc/definition_test.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 lsprpc

import (
	"fmt"
	"path"
	"testing"
	"time"

	"golang.org/x/tools/internal/lsp/fake"
)

const internalDefinition = `
-- go.mod --
module mod

go 1.12
-- main.go --
package main

import "fmt"

func main() {
	fmt.Println(message)
}
-- const.go --
package main

const message = "Hello World."
`

func TestGoToInternalDefinition(t *testing.T) {
	t.Parallel()
	ctx, env, cleanup := setupEnv(t, internalDefinition)
	defer cleanup()

	if err := env.editor.OpenFile(ctx, "main.go"); err != nil {
		t.Fatal(err)
	}
	name, pos, err := env.editor.GoToDefinition(ctx, "main.go", fake.Pos{Line: 5, Column: 13})
	if err != nil {
		t.Fatal(err)
	}
	if want := "const.go"; name != want {
		t.Errorf("GoToDefinition: got file %q, want %q", name, want)
	}
	if want := (fake.Pos{Line: 2, Column: 6}); pos != want {
		t.Errorf("GoToDefinition: got position %v, want %v", pos, want)
	}
}

const stdlibDefinition = `
-- go.mod --
module mod

go 1.12
-- main.go --
package main

import (
	"fmt"
	"time"
)

func main() {
	fmt.Println(time.Now())
}`

func TestGoToStdlibDefinition(t *testing.T) {
	t.Parallel()
	ctx, env, cleanup := setupEnv(t, stdlibDefinition)
	defer cleanup()

	if err := env.editor.OpenFile(ctx, "main.go"); err != nil {
		t.Fatal(err)
	}
	name, pos, err := env.editor.GoToDefinition(ctx, "main.go", fake.Pos{Line: 8, Column: 19})
	if err != nil {
		t.Fatal(err)
	}
	fmt.Println(time.Now())
	if got, want := path.Base(name), "time.go"; got != want {
		t.Errorf("GoToDefinition: got file %q, want %q", name, want)
	}

	// Test that we can jump to definition from outside our workspace.
	// See golang.org/issues/37045.
	newName, newPos, err := env.editor.GoToDefinition(ctx, name, pos)
	if err != nil {
		t.Fatal(err)
	}
	if newName != name {
		t.Errorf("GoToDefinition is not idempotent: got %q, want %q", newName, name)
	}
	if newPos != pos {
		t.Errorf("GoToDefinition is not idempotent: got %v, want %v", newPos, pos)
	}
}