1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
// 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 debug_test
// Provide 'static type checking' of the templates. This guards against changes in various
// gopls datastructures causing template execution to fail. The checking is done by
// the github.com/jba/templatecheck package. Before that is run, the test checks that
// its list of templates and their arguments corresponds to the arguments in
// calls to render(). The test assumes that all uses of templates are done through render().
import (
"go/ast"
"html/template"
"os"
"runtime"
"sort"
"strings"
"testing"
"github.com/jba/templatecheck"
"golang.org/x/tools/go/packages"
"golang.org/x/tools/gopls/internal/cache"
"golang.org/x/tools/gopls/internal/debug"
"golang.org/x/tools/gopls/internal/file"
"golang.org/x/tools/internal/testenv"
)
var templates = map[string]struct {
tmpl *template.Template
data interface{} // a value of the needed type
}{
"MainTmpl": {debug.MainTmpl, &debug.Instance{}},
"DebugTmpl": {debug.DebugTmpl, nil},
"RPCTmpl": {debug.RPCTmpl, &debug.Rpcs{}},
"TraceTmpl": {debug.TraceTmpl, debug.TraceResults{}},
"CacheTmpl": {debug.CacheTmpl, &cache.Cache{}},
"SessionTmpl": {debug.SessionTmpl, &cache.Session{}},
"ClientTmpl": {debug.ClientTmpl, &debug.Client{}},
"ServerTmpl": {debug.ServerTmpl, &debug.Server{}},
"FileTmpl": {debug.FileTmpl, *new(interface {
file.Handle
Kind() file.Kind // (overlay files only)
})},
"InfoTmpl": {debug.InfoTmpl, "something"},
"MemoryTmpl": {debug.MemoryTmpl, runtime.MemStats{}},
"AnalysisTmpl": {debug.AnalysisTmpl, new(debug.State).Analysis()},
}
func TestTemplates(t *testing.T) {
testenv.NeedsGoPackages(t)
testenv.NeedsLocalXTools(t)
cfg := &packages.Config{
Mode: packages.NeedTypes | packages.NeedSyntax | packages.NeedTypesInfo,
}
cfg.Env = os.Environ()
cfg.Env = append(cfg.Env,
"GOPACKAGESDRIVER=off",
"GOWORK=off", // necessary for -mod=mod below
"GOFLAGS=-mod=mod",
)
pkgs, err := packages.Load(cfg, "golang.org/x/tools/gopls/internal/debug")
if err != nil {
t.Fatal(err)
}
if len(pkgs) != 1 {
t.Fatalf("expected a single package, but got %d", len(pkgs))
}
p := pkgs[0]
if len(p.Errors) != 0 {
t.Fatalf("compiler error, e.g. %v", p.Errors[0])
}
// find the calls to render in serve.go
tree := treeOf(p, "serve.go")
if tree == nil {
t.Fatalf("found no syntax tree for %s", "serve.go")
}
renders := callsOf(tree, "render")
if len(renders) == 0 {
t.Fatalf("found no calls to render")
}
var found = make(map[string]bool)
for _, r := range renders {
if len(r.Args) != 2 {
// template, func
t.Fatalf("got %d args, expected 2", len(r.Args))
}
t0, ok := p.TypesInfo.Types[r.Args[0]]
if !ok || !t0.IsValue() || t0.Type.String() != "*html/template.Template" {
t.Fatalf("no type info for template")
}
if id, ok := r.Args[0].(*ast.Ident); !ok {
t.Errorf("expected *ast.Ident, got %T", r.Args[0])
} else {
found[id.Name] = true
}
}
// make sure found and templates have the same templates
for k := range found {
if _, ok := templates[k]; !ok {
t.Errorf("code has template %s, but test does not", k)
}
}
for k := range templates {
if _, ok := found[k]; !ok {
t.Errorf("test has template %s, code does not", k)
}
}
// now check all the known templates, in alphabetic order, for determinacy
keys := []string{}
for k := range templates {
keys = append(keys, k)
}
sort.Strings(keys)
for _, k := range keys {
v := templates[k]
// the FuncMap is an annoyance; should not be necessary
if err := templatecheck.CheckHTML(v.tmpl, v.data); err != nil {
t.Errorf("%s: %v", k, err)
continue
}
t.Logf("%s ok", k)
}
}
func callsOf(tree *ast.File, name string) []*ast.CallExpr {
var ans []*ast.CallExpr
f := func(n ast.Node) bool {
x, ok := n.(*ast.CallExpr)
if !ok {
return true
}
if y, ok := x.Fun.(*ast.Ident); ok {
if y.Name == name {
ans = append(ans, x)
}
}
return true
}
ast.Inspect(tree, f)
return ans
}
func treeOf(p *packages.Package, fname string) *ast.File {
for _, tree := range p.Syntax {
loc := tree.Package
pos := p.Fset.PositionFor(loc, false)
if strings.HasSuffix(pos.Filename, fname) {
return tree
}
}
return nil
}
|
