| // Copyright 2011 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 html |
| |
| import ( |
| "bytes" |
| "strings" |
| "template" |
| "testing" |
| ) |
| |
| func TestEscape(t *testing.T) { |
| var data = struct { |
| F, T bool |
| C, G, H string |
| A, E []string |
| }{ |
| F: false, |
| T: true, |
| C: "<Cincinatti>", |
| G: "<Goodbye>", |
| H: "<Hello>", |
| A: []string{"<a>", "<b>"}, |
| E: []string{}, |
| } |
| |
| var testCases = []struct { |
| name string |
| input string |
| output string |
| }{ |
| { |
| "if", |
| "{{if .T}}Hello{{end}}, {{.C}}!", |
| "Hello, <Cincinatti>!", |
| }, |
| { |
| "else", |
| "{{if .F}}{{.H}}{{else}}{{.G}}{{end}}!", |
| "<Goodbye>!", |
| }, |
| { |
| "overescaping", |
| "Hello, {{.C | html}}!", |
| "Hello, <Cincinatti>!", |
| }, |
| { |
| "assignment", |
| "{{if $x := .H}}{{$x}}{{end}}", |
| "<Hello>", |
| }, |
| { |
| "withBody", |
| "{{with .H}}{{.}}{{end}}", |
| "<Hello>", |
| }, |
| { |
| "withElse", |
| "{{with .E}}{{.}}{{else}}{{.H}}{{end}}", |
| "<Hello>", |
| }, |
| { |
| "rangeBody", |
| "{{range .A}}{{.}}{{end}}", |
| "<a><b>", |
| }, |
| { |
| "rangeElse", |
| "{{range .E}}{{.}}{{else}}{{.H}}{{end}}", |
| "<Hello>", |
| }, |
| { |
| "nonStringValue", |
| "{{.T}}", |
| "true", |
| }, |
| { |
| // TODO: Make sure the URL escaper escapes single quotes so it can |
| // be embedded in single quoted URI attributes and CSS url(...) |
| // constructs. Single quotes are reserved in URLs, but are only used |
| // in the obsolete "mark" rule in an appendix in RFC 3986 so can be |
| // safely encoded. |
| "constant", |
| `<a href="/search?q={{"'a<b'"}}">`, |
| `<a href="/search?q='a%3Cb'">`, |
| }, |
| { |
| "multipleAttrs", |
| "<a b=1 c={{.H}}>", |
| "<a b=1 c=<Hello>>", |
| }, |
| { |
| "urlStartRel", |
| `<a href='{{"/foo/bar?a=b&c=d"}}'>`, |
| `<a href='/foo/bar?a=b&c=d'>`, |
| }, |
| { |
| "urlStartAbsOk", |
| `<a href='{{"http://example.com/foo/bar?a=b&c=d"}}'>`, |
| `<a href='http://example.com/foo/bar?a=b&c=d'>`, |
| }, |
| { |
| "protocolRelativeURLStart", |
| `<a href='{{"//example.com:8000/foo/bar?a=b&c=d"}}'>`, |
| `<a href='//example.com:8000/foo/bar?a=b&c=d'>`, |
| }, |
| { |
| "pathRelativeURLStart", |
| `<a href="{{"/javascript:80/foo/bar"}}">`, |
| `<a href="/javascript:80/foo/bar">`, |
| }, |
| { |
| "dangerousURLStart", |
| `<a href='{{"javascript:alert(%22pwned%22)"}}'>`, |
| `<a href='#ZgotmplZ'>`, |
| }, |
| { |
| "urlPath", |
| `<a href='http://{{"javascript:80"}}/foo'>`, |
| `<a href='http://javascript:80/foo'>`, |
| }, |
| { |
| "urlQuery", |
| `<a href='/search?q={{.H}}'>`, |
| `<a href='/search?q=%3CHello%3E'>`, |
| }, |
| { |
| "urlFragment", |
| `<a href='/faq#{{.H}}'>`, |
| `<a href='/faq#%3CHello%3E'>`, |
| }, |
| { |
| "urlBranch", |
| `<a href="{{if .F}}/foo?a=b{{else}}/bar{{end}}">`, |
| `<a href="/bar">`, |
| }, |
| { |
| "urlBranchConflictMoot", |
| `<a href="{{if .T}}/foo?a={{else}}/bar#{{end}}{{.C}}">`, |
| `<a href="/foo?a=%3CCincinatti%3E">`, |
| }, |
| } |
| |
| for _, tc := range testCases { |
| tmpl, err := template.New(tc.name).Parse(tc.input) |
| if err != nil { |
| t.Errorf("%s: template parsing failed: %s", tc.name, err) |
| continue |
| } |
| Escape(tmpl) |
| b := new(bytes.Buffer) |
| if err = tmpl.Execute(b, data); err != nil { |
| t.Errorf("%s: template execution failed: %s", tc.name, err) |
| continue |
| } |
| if w, g := tc.output, b.String(); w != g { |
| t.Errorf("%s: escaped output: want %q got %q", tc.name, w, g) |
| continue |
| } |
| } |
| } |
| |
| func TestErrors(t *testing.T) { |
| var testCases = []struct { |
| input string |
| err string |
| }{ |
| // Non-error cases. |
| { |
| "{{if .Cond}}<a>{{else}}<b>{{end}}", |
| "", |
| }, |
| { |
| "{{if .Cond}}<a>{{end}}", |
| "", |
| }, |
| { |
| "{{if .Cond}}{{else}}<b>{{end}}", |
| "", |
| }, |
| { |
| "{{with .Cond}}<div>{{end}}", |
| "", |
| }, |
| { |
| "{{range .Items}}<a>{{end}}", |
| "", |
| }, |
| { |
| "<a href='/foo?{{range .Items}}&{{.K}}={{.V}}{{end}}'>", |
| "", |
| }, |
| // Error cases. |
| { |
| "{{if .Cond}}<a{{end}}", |
| "z:1: {{if}} branches", |
| }, |
| { |
| "{{if .Cond}}\n{{else}}\n<a{{end}}", |
| "z:1: {{if}} branches", |
| }, |
| { |
| // Missing quote in the else branch. |
| `{{if .Cond}}<a href="foo">{{else}}<a href="bar>{{end}}`, |
| "z:1: {{if}} branches", |
| }, |
| { |
| // Different kind of attribute: href implies a URL. |
| "<a {{if .Cond}}href='{{else}}title='{{end}}{{.X}}'>", |
| "z:1: {{if}} branches", |
| }, |
| { |
| "\n{{with .X}}<a{{end}}", |
| "z:2: {{with}} branches", |
| }, |
| { |
| "\n{{with .X}}<a>{{else}}<a{{end}}", |
| "z:2: {{with}} branches", |
| }, |
| { |
| "{{range .Items}}<a{{end}}", |
| `z:1: on range loop re-entry: "<" in attribute name: "<a"`, |
| }, |
| { |
| "\n{{range .Items}} x='<a{{end}}", |
| "z:2: on range loop re-entry: {{range}} branches", |
| }, |
| { |
| "<a b=1 c={{.H}}", |
| "z ends in a non-text context: {stateAttr delimSpaceOrTagEnd", |
| }, |
| { |
| `<a href="{{if .F}}/foo?a={{else}}/bar/{{end}}{{.H}}">`, |
| "z:1: (action: [(command: [F=[H]])]) appears in an ambiguous URL context", |
| }, |
| } |
| |
| for _, tc := range testCases { |
| tmpl, err := template.New("z").Parse(tc.input) |
| if err != nil { |
| t.Errorf("input=%q: template parsing failed: %s", tc.input, err) |
| continue |
| } |
| var got string |
| if _, err := Escape(tmpl); err != nil { |
| got = err.String() |
| } |
| if tc.err == "" { |
| if got != "" { |
| t.Errorf("input=%q: unexpected error %q", tc.input, got) |
| } |
| continue |
| } |
| if strings.Index(got, tc.err) == -1 { |
| t.Errorf("input=%q: error %q does not contain expected string %q", tc.input, got, tc.err) |
| continue |
| } |
| } |
| } |
| |
| func TestEscapeText(t *testing.T) { |
| var testCases = []struct { |
| input string |
| output context |
| }{ |
| { |
| ``, |
| context{}, |
| }, |
| { |
| `Hello, World!`, |
| context{}, |
| }, |
| { |
| // An orphaned "<" is OK. |
| `I <3 Ponies!`, |
| context{}, |
| }, |
| { |
| `<a`, |
| context{state: stateTag}, |
| }, |
| { |
| `<a `, |
| context{state: stateTag}, |
| }, |
| { |
| `<a>`, |
| context{state: stateText}, |
| }, |
| { |
| `<a href=`, |
| context{state: stateURL, delim: delimSpaceOrTagEnd}, |
| }, |
| { |
| `<a href=x`, |
| context{state: stateURL, delim: delimSpaceOrTagEnd, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<a href=x `, |
| context{state: stateTag}, |
| }, |
| { |
| `<a href=>`, |
| context{state: stateText}, |
| }, |
| { |
| `<a href=x>`, |
| context{state: stateText}, |
| }, |
| { |
| `<a href ='`, |
| context{state: stateURL, delim: delimSingleQuote}, |
| }, |
| { |
| `<a href=''`, |
| context{state: stateTag}, |
| }, |
| { |
| `<a href= "`, |
| context{state: stateURL, delim: delimDoubleQuote}, |
| }, |
| { |
| `<a href=""`, |
| context{state: stateTag}, |
| }, |
| { |
| `<a title="`, |
| context{state: stateAttr, delim: delimDoubleQuote}, |
| }, |
| { |
| `<a HREF='http:`, |
| context{state: stateURL, delim: delimSingleQuote, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<a Href='/`, |
| context{state: stateURL, delim: delimSingleQuote, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<a href='"`, |
| context{state: stateURL, delim: delimSingleQuote, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<a href="'`, |
| context{state: stateURL, delim: delimDoubleQuote, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<a href=''`, |
| context{state: stateURL, delim: delimSingleQuote, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<a href=""`, |
| context{state: stateURL, delim: delimDoubleQuote, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<a href=""`, |
| context{state: stateURL, delim: delimDoubleQuote, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<a href="`, |
| context{state: stateURL, delim: delimSpaceOrTagEnd, urlPart: urlPartPreQuery}, |
| }, |
| { |
| `<img alt="1">`, |
| context{state: stateText}, |
| }, |
| { |
| `<img alt="1>"`, |
| context{state: stateTag}, |
| }, |
| { |
| `<img alt="1>">`, |
| context{state: stateText}, |
| }, |
| { |
| `<input checked type="checkbox"`, |
| context{state: stateTag}, |
| }, |
| } |
| |
| for _, tc := range testCases { |
| b := []byte(tc.input) |
| c := escapeText(context{}, b) |
| if !tc.output.eq(c) { |
| t.Errorf("input %q: want context %v got %v", tc.input, tc.output, c) |
| continue |
| } |
| if tc.input != string(b) { |
| t.Errorf("input %q: text node was modified: want %q got %q", tc.input, tc.input, b) |
| continue |
| } |
| } |
| } |