internal/lsp/cmd/test/call_hierarchy.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 cmdtest

import (
	"fmt"
	"sort"
	"strings"
	"testing"

	"golang.org/x/tools/internal/lsp/protocol"
	"golang.org/x/tools/internal/lsp/tests"
	"golang.org/x/tools/internal/span"
)

func (r *runner) CallHierarchy(t *testing.T, spn span.Span, expectedCalls *tests.CallHierarchyResult) {
	var result []string
	// TODO: add expectedCalls.OutgoingCalls to this array once implemented
	for _, call := range expectedCalls.IncomingCalls {
		mapper, err := r.data.Mapper(call.URI.SpanURI())
		if err != nil {
			t.Fatal(err)
		}
		callSpan, err := mapper.Span(protocol.Location{URI: call.URI, Range: call.Range})
		if err != nil {
			t.Fatal(err)
		}
		result = append(result, fmt.Sprint(callSpan))
	}
	result = append(result, fmt.Sprint(spn))

	sort.Strings(result) // to make tests deterministic
	expect := r.Normalize(strings.Join(result, "\n"))

	uri := spn.URI()
	filename := uri.Filename()
	target := filename + fmt.Sprintf(":%v:%v", spn.Start().Line(), spn.Start().Column())

	got, stderr := r.NormalizeGoplsCmd(t, "call_hierarchy", target)
	got = cleanCallHierarchyCmdResult(got)
	if stderr != "" {
		t.Errorf("call_hierarchy failed for %s: %s", target, stderr)
	} else if expect != got {
		t.Errorf("call_hierarchy failed for %s expected:\n%s\ngot:\n%s", target, expect, got)
	}
}

// removes all info except function URI and Range from printed output and sorts the result
// ex: "identifier: function d at .../callhierarchy/callhierarchy.go:19:6-7" -> ".../callhierarchy/callhierarchy.go:19:6-7"
func cleanCallHierarchyCmdResult(output string) string {
	var clean []string
	for _, out := range strings.Split(output, "\n") {
		if out == "" {
			continue
		}
		clean = append(clean, out[strings.LastIndex(out, " ")+1:])
	}
	sort.Strings(clean)
	return strings.Join(clean, "\n")
}