github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-02-16 20:31:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

tpl: Improve the Execute panic error message

Browse source 
See #5327
This commit is contained in:
Bjørn Erik Pedersen 2018-10-17 08:24:45 +02:00
parent 1f42e47e47
commit 0fe4ff1875
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
2 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
hugolib/hugo_sites_build_errors_test.go
View file

@ -109,6 +109,18 @@ func TestSiteBuildErrors(t *testing.T) {
a.assertLineNumber(2, err) a.assertLineNumber(2, err)
}, },
},*/ },*/
{
name: "Panic in template Execute",
fileType: single,
fileFixer: func(content string) string {
return strings.Replace(content, ".Title", ".Parent.Parent.Parent", 1)
},
assertBuildError: func(a testSiteBuildErrorAsserter, err error) {
assert.Error(err)
assert.Contains(err.Error(), "layouts/_default/single.html")
},
},
} }
for _, test := range tests { for _, test := range tests {

17
tpl/template.go
View file

@ -115,8 +115,9 @@ func extractBaseOf(err string) string {
func (t *TemplateAdapter) Execute(w io.Writer, data interface{}) (execErr error) { func (t *TemplateAdapter) Execute(w io.Writer, data interface{}) (execErr error) {
defer func() { defer func() {
// Panics in templates are a little bit too common (nil pointers etc.) // Panics in templates are a little bit too common (nil pointers etc.)
// See https://github.com/gohugoio/hugo/issues/5327
if r := recover(); r != nil { if r := recover(); r != nil {
execErr = t.addFileContext(t.Name(), fmt.Errorf("panic in Execute: %s", r)) execErr = t.addFileContext(t.Name(), fmt.Errorf(`panic in Execute: %s. See "https://github.com/gohugoio/hugo/issues/5327" for the reason why we cannot provide a better error message for this.`, r))
} }
}() }()
@ -152,7 +153,7 @@ func (t *TemplateAdapter) addFileContext(name string, inerr error) error {
master, hasMaster := t.NameBaseTemplateName[name] master, hasMaster := t.NameBaseTemplateName[name]
ferr := errors.Wrapf(inerr, "execute of template %q failed", realFilename) ferr1 := errors.Wrapf(inerr, "execute of template %q failed", realFilename)
// Since this can be a composite of multiple template files (single.html + baseof.html etc.) // Since this can be a composite of multiple template files (single.html + baseof.html etc.)
// we potentially need to look in both -- and cannot rely on line number alone. // we potentially need to look in both -- and cannot rely on line number alone.
@ -175,7 +176,7 @@ func (t *TemplateAdapter) addFileContext(name string, inerr error) error {
} }
// TODO(bep) 2errors text vs HTML // TODO(bep) 2errors text vs HTML
fe, ok := herrors.WithFileContext(ferr, f, "go-html-template", lineMatcher) fe, ok := herrors.WithFileContext(ferr1, f, "go-html-template", lineMatcher)
if ok || !hasMaster { if ok || !hasMaster {
return fe return fe
} }
@ -187,8 +188,14 @@ func (t *TemplateAdapter) addFileContext(name string, inerr error) error {
} }
defer f.Close() defer f.Close()
ferr = errors.Wrapf(inerr, "execute of template %q failed", realFilename) ferr2 := errors.Wrapf(inerr, "execute of template %q failed", realFilename)
fe, _ = herrors.WithFileContext(ferr, f, "go-html-template", lineMatcher) fe, ok = herrors.WithFileContext(ferr2, f, "go-html-template", lineMatcher)
if !ok {
// Return the most specific.
return ferr1
}
return fe return fe
} }