tools/gopls: add cmd support for prepare_rename

Updates golang/go#32875

internal/lsp/cmd/cmd.go

@@ -146,6 +146,7 @@ func (app *Application) commands() []tool.Application {
 		&format{app: app},
 		&links{app: app},
 		&imports{app: app},
+		&prepareRename{app: app},
 		&query{app: app},
 		&references{app: app},
 		&rename{app: app},

internal/lsp/cmd/prepare_rename.go

@@ -0,0 +1,83 @@
+// Copyright 2019 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 cmd
+
+import (
+	"context"
+	"flag"
+	"fmt"
+
+	"golang.org/x/tools/internal/lsp/protocol"
+	"golang.org/x/tools/internal/span"
+	"golang.org/x/tools/internal/tool"
+	errors "golang.org/x/xerrors"
+)
+
+// prepareRename implements the prepare_rename verb for gopls.
+type prepareRename struct {
+	app *Application
+}
+
+func (r *prepareRename) Name() string      { return "prepare_rename" }
+func (r *prepareRename) Usage() string     { return "<position>" }
+func (r *prepareRename) ShortHelp() string { return "test validity of a rename operation at location" }
+func (r *prepareRename) DetailedHelp(f *flag.FlagSet) {
+	fmt.Fprint(f.Output(), `
+Example:
+
+	$ # 1-indexed location (:line:column or :#offset) of the target identifier
+	$ gopls prepare_rename helper/helper.go:8:6
+	$ gopls prepare_rename helper/helper.go:#53
+
+	gopls prepare_rename flags are:
+`)
+	f.PrintDefaults()
+}
+
+func (r *prepareRename) Run(ctx context.Context, args ...string) error {
+	if len(args) != 1 {
+		return tool.CommandLineErrorf("prepare_rename expects 1 argument (file)")
+	}
+
+	conn, err := r.app.connect(ctx)
+	if err != nil {
+		return err
+	}
+	defer conn.terminate(ctx)
+
+	from := span.Parse(args[0])
+	file := conn.AddFile(ctx, from.URI())
+	if file.err != nil {
+		return file.err
+	}
+	loc, err := file.mapper.Location(from)
+	if err != nil {
+		return err
+	}
+	p := protocol.PrepareRenameParams{
+		TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+			TextDocument: protocol.TextDocumentIdentifier{URI: loc.URI},
+			Position:     loc.Range.Start,
+		},
+	}
+	result, err := conn.PrepareRename(ctx, &p)
+	if err != nil {
+		fmt.Printf("err: %v\n", err)
+		return err
+	}
+	if result == nil {
+		fmt.Printf("request is not valid at the given position\n")
+		return errors.Errorf("request is not valid at the given position")
+	}
+
+	fmt.Printf("%v:%v-%v:%v\n",
+		result.Start.Line+1,
+		result.Start.Character+1,
+		result.End.Line+1,
+		result.End.Character+1,
+	)
+
+	return nil
+}

internal/lsp/cmd/test/cmdtest.go

@@ -69,10 +69,6 @@ func (r *runner) Highlight(t *testing.T, name string, locations []span.Span) {
 	//TODO: add command line highlight tests when it works
 }
 
-func (r *runner) PrepareRename(t *testing.T, src span.Span, want *source.PrepareItem) {
-	//TODO: add command line prepare rename tests when it works
-}
-
 func (r *runner) Implementation(t *testing.T, spn span.Span, imp tests.Implementations) {
 	//TODO: add implements tests when it works
 }

internal/lsp/cmd/test/prepare_rename.go

@@ -0,0 +1,50 @@
+// Copyright 2019 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 cmdtest
+
+import (
+	"fmt"
+	"testing"
+
+	"golang.org/x/tools/internal/lsp/cmd"
+	"golang.org/x/tools/internal/lsp/protocol"
+	"golang.org/x/tools/internal/lsp/source"
+	"golang.org/x/tools/internal/span"
+	"golang.org/x/tools/internal/tool"
+)
+
+func (r *runner) PrepareRename(t *testing.T, src span.Span, want *source.PrepareItem) {
+	filename := fmt.Sprintf("%v", src)
+	args := []string{"prepare_rename", filename}
+	app := cmd.New("gopls-test", r.data.Config.Dir, r.data.Exported.Config.Env, r.options)
+	got := CaptureStdOut(t, func() {
+		_ = tool.Run(r.ctx, app, args)
+	})
+
+	if want.Text == "" {
+		expect := "request is not valid at the given position\n"
+		if got != expect {
+			t.Errorf("prepare_rename failed for %s,\nexpected:\n`%v`\ngot:\n`%v`", filename, expect, got)
+		}
+		return
+	}
+
+	var parsedRange protocol.Range
+	fmt.Sscanf(got, "%v:%v-%v:%v\n",
+		&parsedRange.Start.Line,
+		&parsedRange.Start.Character,
+		&parsedRange.End.Line,
+		&parsedRange.End.Character)
+
+	// The expectation is 0-indexed, but command-line results are 1-indexed.
+	// Decrement here to compare correctly in tests.
+	parsedRange.Start.Line--
+	parsedRange.Start.Character--
+	parsedRange.End.Line--
+	parsedRange.End.Character--
+	if protocol.CompareRange(want.Range, parsedRange) != 0 {
+		t.Errorf("prepare_rename failed for %s, expected:\n`%v`\ngot:\n`%v`", filename, want.Range, parsedRange)
+	}
+}