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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
// Copyright 2022 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 template
import (
"strings"
"testing"
"golang.org/x/tools/gopls/internal/hooks"
"golang.org/x/tools/gopls/internal/lsp/protocol"
. "golang.org/x/tools/gopls/internal/lsp/regtest"
"golang.org/x/tools/internal/bug"
)
func TestMain(m *testing.M) {
bug.PanicOnBugs = true
Main(m, hooks.Options)
}
func TestMultilineTokens(t *testing.T) {
// 51731: panic: runtime error: slice bounds out of range [38:3]
const files = `
-- go.mod --
module mod.com
go 1.17
-- hi.tmpl --
{{if (foÜx .X.Y)}}😀{{$A :=
"hi"
}}{{.Z $A}}{{else}}
{{$A.X 12}}
{{foo (.X.Y) 23 ($A.Z)}}
{{end}}
`
WithOptions(
Settings{
"templateExtensions": []string{"tmpl"},
"semanticTokens": true,
},
).Run(t, files, func(t *testing.T, env *Env) {
var p protocol.SemanticTokensParams
p.TextDocument.URI = env.Sandbox.Workdir.URI("hi.tmpl")
toks, err := env.Editor.Server.SemanticTokensFull(env.Ctx, &p)
if err != nil {
t.Errorf("semantic token failed: %v", err)
}
if toks == nil || len(toks.Data) == 0 {
t.Errorf("got no semantic tokens")
}
})
}
func TestTemplatesFromExtensions(t *testing.T) {
const files = `
-- go.mod --
module mod.com
go 1.12
-- hello.tmpl --
{{range .Planets}}
Hello {{}} <-- missing body
{{end}}
`
WithOptions(
Settings{
"templateExtensions": []string{"tmpl"},
"semanticTokens": true,
},
).Run(t, files, func(t *testing.T, env *Env) {
// TODO: can we move this diagnostic onto {{}}?
env.Await(env.DiagnosticAtRegexp("hello.tmpl", "()Hello {{}}"))
d := env.Awaiter.DiagnosticsFor("hello.tmpl").Diagnostics // issue 50786: check for Source
if len(d) != 1 {
t.Errorf("expected 1 diagnostic, got %d", len(d))
return
}
if d[0].Source != "template" {
t.Errorf("expected Source 'template', got %q", d[0].Source)
}
// issue 50801 (even broken templates could return some semantic tokens)
var p protocol.SemanticTokensParams
p.TextDocument.URI = env.Sandbox.Workdir.URI("hello.tmpl")
toks, err := env.Editor.Server.SemanticTokensFull(env.Ctx, &p)
if err != nil {
t.Errorf("semantic token failed: %v", err)
}
if toks == nil || len(toks.Data) == 0 {
t.Errorf("got no semantic tokens")
}
env.WriteWorkspaceFile("hello.tmpl", "{{range .Planets}}\nHello {{.}}\n{{end}}")
env.Await(EmptyDiagnostics("hello.tmpl"))
})
}
func TestTemplatesObserveDirectoryFilters(t *testing.T) {
const files = `
-- go.mod --
module mod.com
go 1.12
-- a/a.tmpl --
A {{}} <-- missing body
-- b/b.tmpl --
B {{}} <-- missing body
`
WithOptions(
Settings{
"directoryFilters": []string{"-b"},
"templateExtensions": []string{"tmpl"},
},
).Run(t, files, func(t *testing.T, env *Env) {
env.Await(
OnceMet(env.DiagnosticAtRegexp("a/a.tmpl", "()A")),
NoDiagnostics("b/b.tmpl"),
)
})
}
func TestTemplatesFromLangID(t *testing.T) {
const files = `
-- go.mod --
module mod.com
go 1.12
`
Run(t, files, func(t *testing.T, env *Env) {
env.CreateBuffer("hello.tmpl", "")
env.Await(
OnceMet(
env.DoneWithOpen(),
EmptyDiagnostics("hello.tmpl"), // Don't get spurious errors for empty templates.
),
)
env.SetBufferContent("hello.tmpl", "{{range .Planets}}\nHello {{}}\n{{end}}")
env.Await(env.DiagnosticAtRegexp("hello.tmpl", "()Hello {{}}"))
env.RegexpReplace("hello.tmpl", "{{}}", "{{.}}")
env.Await(EmptyOrNoDiagnostics("hello.tmpl"))
})
}
func TestClosingTemplatesMakesDiagnosticsDisappear(t *testing.T) {
const files = `
-- go.mod --
module mod.com
go 1.12
-- hello.tmpl --
{{range .Planets}}
Hello {{}} <-- missing body
{{end}}
`
Run(t, files, func(t *testing.T, env *Env) {
env.OpenFile("hello.tmpl")
env.Await(env.DiagnosticAtRegexp("hello.tmpl", "()Hello {{}}"))
// Since we don't have templateExtensions configured, closing hello.tmpl
// should make its diagnostics disappear.
env.CloseBuffer("hello.tmpl")
env.Await(EmptyDiagnostics("hello.tmpl"))
})
}
func TestMultipleSuffixes(t *testing.T) {
const files = `
-- go.mod --
module mod.com
go 1.12
-- b.gotmpl --
{{define "A"}}goo{{end}}
-- a.tmpl --
{{template "A"}}
`
WithOptions(
Settings{
"templateExtensions": []string{"tmpl", "gotmpl"},
},
).Run(t, files, func(t *testing.T, env *Env) {
env.OpenFile("a.tmpl")
x := env.RegexpSearch("a.tmpl", `A`)
file, pos := env.GoToDefinition("a.tmpl", x)
refs := env.References(file, pos)
if len(refs) != 2 {
t.Fatalf("got %v reference(s), want 2", len(refs))
}
// make sure we got one from b.gotmpl
want := env.Sandbox.Workdir.URI("b.gotmpl")
if refs[0].URI != want && refs[1].URI != want {
t.Errorf("failed to find reference to %s", shorten(want))
for i, r := range refs {
t.Logf("%d: URI:%s %v", i, shorten(r.URI), r.Range)
}
}
content, npos := env.Hover(file, pos)
if pos != npos {
t.Errorf("pos? got %v, wanted %v", npos, pos)
}
if content.Value != "template A defined" {
t.Errorf("got %s, wanted 'template A defined", content.Value)
}
})
}
// shorten long URIs
func shorten(fn protocol.DocumentURI) string {
if len(fn) <= 20 {
return string(fn)
}
pieces := strings.Split(string(fn), "/")
if len(pieces) < 2 {
return string(fn)
}
j := len(pieces)
return pieces[j-2] + "/" + pieces[j-1]
}
// Hover needs tests
|