Black Lives Matter. Support the Equal Justice Initiative.

Source file src/text/template/parse/parse_test.go

Documentation: text/template/parse

     1  // Copyright 2011 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  package parse
     6  
     7  import (
     8  	"flag"
     9  	"fmt"
    10  	"strings"
    11  	"testing"
    12  )
    13  
    14  var debug = flag.Bool("debug", false, "show the errors produced by the main tests")
    15  
    16  type numberTest struct {
    17  	text      string
    18  	isInt     bool
    19  	isUint    bool
    20  	isFloat   bool
    21  	isComplex bool
    22  	int64
    23  	uint64
    24  	float64
    25  	complex128
    26  }
    27  
    28  var numberTests = []numberTest{
    29  	// basics
    30  	{"0", true, true, true, false, 0, 0, 0, 0},
    31  	{"-0", true, true, true, false, 0, 0, 0, 0}, // check that -0 is a uint.
    32  	{"73", true, true, true, false, 73, 73, 73, 0},
    33  	{"7_3", true, true, true, false, 73, 73, 73, 0},
    34  	{"0b10_010_01", true, true, true, false, 73, 73, 73, 0},
    35  	{"0B10_010_01", true, true, true, false, 73, 73, 73, 0},
    36  	{"073", true, true, true, false, 073, 073, 073, 0},
    37  	{"0o73", true, true, true, false, 073, 073, 073, 0},
    38  	{"0O73", true, true, true, false, 073, 073, 073, 0},
    39  	{"0x73", true, true, true, false, 0x73, 0x73, 0x73, 0},
    40  	{"0X73", true, true, true, false, 0x73, 0x73, 0x73, 0},
    41  	{"0x7_3", true, true, true, false, 0x73, 0x73, 0x73, 0},
    42  	{"-73", true, false, true, false, -73, 0, -73, 0},
    43  	{"+73", true, false, true, false, 73, 0, 73, 0},
    44  	{"100", true, true, true, false, 100, 100, 100, 0},
    45  	{"1e9", true, true, true, false, 1e9, 1e9, 1e9, 0},
    46  	{"-1e9", true, false, true, false, -1e9, 0, -1e9, 0},
    47  	{"-1.2", false, false, true, false, 0, 0, -1.2, 0},
    48  	{"1e19", false, true, true, false, 0, 1e19, 1e19, 0},
    49  	{"1e1_9", false, true, true, false, 0, 1e19, 1e19, 0},
    50  	{"1E19", false, true, true, false, 0, 1e19, 1e19, 0},
    51  	{"-1e19", false, false, true, false, 0, 0, -1e19, 0},
    52  	{"0x_1p4", true, true, true, false, 16, 16, 16, 0},
    53  	{"0X_1P4", true, true, true, false, 16, 16, 16, 0},
    54  	{"0x_1p-4", false, false, true, false, 0, 0, 1 / 16., 0},
    55  	{"4i", false, false, false, true, 0, 0, 0, 4i},
    56  	{"-1.2+4.2i", false, false, false, true, 0, 0, 0, -1.2 + 4.2i},
    57  	{"073i", false, false, false, true, 0, 0, 0, 73i}, // not octal!
    58  	// complex with 0 imaginary are float (and maybe integer)
    59  	{"0i", true, true, true, true, 0, 0, 0, 0},
    60  	{"-1.2+0i", false, false, true, true, 0, 0, -1.2, -1.2},
    61  	{"-12+0i", true, false, true, true, -12, 0, -12, -12},
    62  	{"13+0i", true, true, true, true, 13, 13, 13, 13},
    63  	// funny bases
    64  	{"0123", true, true, true, false, 0123, 0123, 0123, 0},
    65  	{"-0x0", true, true, true, false, 0, 0, 0, 0},
    66  	{"0xdeadbeef", true, true, true, false, 0xdeadbeef, 0xdeadbeef, 0xdeadbeef, 0},
    67  	// character constants
    68  	{`'a'`, true, true, true, false, 'a', 'a', 'a', 0},
    69  	{`'\n'`, true, true, true, false, '\n', '\n', '\n', 0},
    70  	{`'\\'`, true, true, true, false, '\\', '\\', '\\', 0},
    71  	{`'\''`, true, true, true, false, '\'', '\'', '\'', 0},
    72  	{`'\xFF'`, true, true, true, false, 0xFF, 0xFF, 0xFF, 0},
    73  	{`'パ'`, true, true, true, false, 0x30d1, 0x30d1, 0x30d1, 0},
    74  	{`'\u30d1'`, true, true, true, false, 0x30d1, 0x30d1, 0x30d1, 0},
    75  	{`'\U000030d1'`, true, true, true, false, 0x30d1, 0x30d1, 0x30d1, 0},
    76  	// some broken syntax
    77  	{text: "+-2"},
    78  	{text: "0x123."},
    79  	{text: "1e."},
    80  	{text: "0xi."},
    81  	{text: "1+2."},
    82  	{text: "'x"},
    83  	{text: "'xx'"},
    84  	{text: "'433937734937734969526500969526500'"}, // Integer too large - issue 10634.
    85  	// Issue 8622 - 0xe parsed as floating point. Very embarrassing.
    86  	{"0xef", true, true, true, false, 0xef, 0xef, 0xef, 0},
    87  }
    88  
    89  func TestNumberParse(t *testing.T) {
    90  	for _, test := range numberTests {
    91  		// If fmt.Sscan thinks it's complex, it's complex. We can't trust the output
    92  		// because imaginary comes out as a number.
    93  		var c complex128
    94  		typ := itemNumber
    95  		var tree *Tree
    96  		if test.text[0] == '\'' {
    97  			typ = itemCharConstant
    98  		} else {
    99  			_, err := fmt.Sscan(test.text, &c)
   100  			if err == nil {
   101  				typ = itemComplex
   102  			}
   103  		}
   104  		n, err := tree.newNumber(0, test.text, typ)
   105  		ok := test.isInt || test.isUint || test.isFloat || test.isComplex
   106  		if ok && err != nil {
   107  			t.Errorf("unexpected error for %q: %s", test.text, err)
   108  			continue
   109  		}
   110  		if !ok && err == nil {
   111  			t.Errorf("expected error for %q", test.text)
   112  			continue
   113  		}
   114  		if !ok {
   115  			if *debug {
   116  				fmt.Printf("%s\n\t%s\n", test.text, err)
   117  			}
   118  			continue
   119  		}
   120  		if n.IsComplex != test.isComplex {
   121  			t.Errorf("complex incorrect for %q; should be %t", test.text, test.isComplex)
   122  		}
   123  		if test.isInt {
   124  			if !n.IsInt {
   125  				t.Errorf("expected integer for %q", test.text)
   126  			}
   127  			if n.Int64 != test.int64 {
   128  				t.Errorf("int64 for %q should be %d Is %d", test.text, test.int64, n.Int64)
   129  			}
   130  		} else if n.IsInt {
   131  			t.Errorf("did not expect integer for %q", test.text)
   132  		}
   133  		if test.isUint {
   134  			if !n.IsUint {
   135  				t.Errorf("expected unsigned integer for %q", test.text)
   136  			}
   137  			if n.Uint64 != test.uint64 {
   138  				t.Errorf("uint64 for %q should be %d Is %d", test.text, test.uint64, n.Uint64)
   139  			}
   140  		} else if n.IsUint {
   141  			t.Errorf("did not expect unsigned integer for %q", test.text)
   142  		}
   143  		if test.isFloat {
   144  			if !n.IsFloat {
   145  				t.Errorf("expected float for %q", test.text)
   146  			}
   147  			if n.Float64 != test.float64 {
   148  				t.Errorf("float64 for %q should be %g Is %g", test.text, test.float64, n.Float64)
   149  			}
   150  		} else if n.IsFloat {
   151  			t.Errorf("did not expect float for %q", test.text)
   152  		}
   153  		if test.isComplex {
   154  			if !n.IsComplex {
   155  				t.Errorf("expected complex for %q", test.text)
   156  			}
   157  			if n.Complex128 != test.complex128 {
   158  				t.Errorf("complex128 for %q should be %g Is %g", test.text, test.complex128, n.Complex128)
   159  			}
   160  		} else if n.IsComplex {
   161  			t.Errorf("did not expect complex for %q", test.text)
   162  		}
   163  	}
   164  }
   165  
   166  type parseTest struct {
   167  	name   string
   168  	input  string
   169  	ok     bool
   170  	result string // what the user would see in an error message.
   171  }
   172  
   173  const (
   174  	noError  = true
   175  	hasError = false
   176  )
   177  
   178  var parseTests = []parseTest{
   179  	{"empty", "", noError,
   180  		``},
   181  	{"comment", "{{/*\n\n\n*/}}", noError,
   182  		``},
   183  	{"spaces", " \t\n", noError,
   184  		`" \t\n"`},
   185  	{"text", "some text", noError,
   186  		`"some text"`},
   187  	{"emptyAction", "{{}}", hasError,
   188  		`{{}}`},
   189  	{"field", "{{.X}}", noError,
   190  		`{{.X}}`},
   191  	{"simple command", "{{printf}}", noError,
   192  		`{{printf}}`},
   193  	{"$ invocation", "{{$}}", noError,
   194  		"{{$}}"},
   195  	{"variable invocation", "{{with $x := 3}}{{$x 23}}{{end}}", noError,
   196  		"{{with $x := 3}}{{$x 23}}{{end}}"},
   197  	{"variable with fields", "{{$.I}}", noError,
   198  		"{{$.I}}"},
   199  	{"multi-word command", "{{printf `%d` 23}}", noError,
   200  		"{{printf `%d` 23}}"},
   201  	{"pipeline", "{{.X|.Y}}", noError,
   202  		`{{.X | .Y}}`},
   203  	{"pipeline with decl", "{{$x := .X|.Y}}", noError,
   204  		`{{$x := .X | .Y}}`},
   205  	{"nested pipeline", "{{.X (.Y .Z) (.A | .B .C) (.E)}}", noError,
   206  		`{{.X (.Y .Z) (.A | .B .C) (.E)}}`},
   207  	{"field applied to parentheses", "{{(.Y .Z).Field}}", noError,
   208  		`{{(.Y .Z).Field}}`},
   209  	{"simple if", "{{if .X}}hello{{end}}", noError,
   210  		`{{if .X}}"hello"{{end}}`},
   211  	{"if with else", "{{if .X}}true{{else}}false{{end}}", noError,
   212  		`{{if .X}}"true"{{else}}"false"{{end}}`},
   213  	{"if with else if", "{{if .X}}true{{else if .Y}}false{{end}}", noError,
   214  		`{{if .X}}"true"{{else}}{{if .Y}}"false"{{end}}{{end}}`},
   215  	{"if else chain", "+{{if .X}}X{{else if .Y}}Y{{else if .Z}}Z{{end}}+", noError,
   216  		`"+"{{if .X}}"X"{{else}}{{if .Y}}"Y"{{else}}{{if .Z}}"Z"{{end}}{{end}}{{end}}"+"`},
   217  	{"simple range", "{{range .X}}hello{{end}}", noError,
   218  		`{{range .X}}"hello"{{end}}`},
   219  	{"chained field range", "{{range .X.Y.Z}}hello{{end}}", noError,
   220  		`{{range .X.Y.Z}}"hello"{{end}}`},
   221  	{"nested range", "{{range .X}}hello{{range .Y}}goodbye{{end}}{{end}}", noError,
   222  		`{{range .X}}"hello"{{range .Y}}"goodbye"{{end}}{{end}}`},
   223  	{"range with else", "{{range .X}}true{{else}}false{{end}}", noError,
   224  		`{{range .X}}"true"{{else}}"false"{{end}}`},
   225  	{"range over pipeline", "{{range .X|.M}}true{{else}}false{{end}}", noError,
   226  		`{{range .X | .M}}"true"{{else}}"false"{{end}}`},
   227  	{"range []int", "{{range .SI}}{{.}}{{end}}", noError,
   228  		`{{range .SI}}{{.}}{{end}}`},
   229  	{"range 1 var", "{{range $x := .SI}}{{.}}{{end}}", noError,
   230  		`{{range $x := .SI}}{{.}}{{end}}`},
   231  	{"range 2 vars", "{{range $x, $y := .SI}}{{.}}{{end}}", noError,
   232  		`{{range $x, $y := .SI}}{{.}}{{end}}`},
   233  	{"constants", "{{range .SI 1 -3.2i true false 'a' nil}}{{end}}", noError,
   234  		`{{range .SI 1 -3.2i true false 'a' nil}}{{end}}`},
   235  	{"template", "{{template `x`}}", noError,
   236  		`{{template "x"}}`},
   237  	{"template with arg", "{{template `x` .Y}}", noError,
   238  		`{{template "x" .Y}}`},
   239  	{"with", "{{with .X}}hello{{end}}", noError,
   240  		`{{with .X}}"hello"{{end}}`},
   241  	{"with with else", "{{with .X}}hello{{else}}goodbye{{end}}", noError,
   242  		`{{with .X}}"hello"{{else}}"goodbye"{{end}}`},
   243  	// Trimming spaces.
   244  	{"trim left", "x \r\n\t{{- 3}}", noError, `"x"{{3}}`},
   245  	{"trim right", "{{3 -}}\n\n\ty", noError, `{{3}}"y"`},
   246  	{"trim left and right", "x \r\n\t{{- 3 -}}\n\n\ty", noError, `"x"{{3}}"y"`},
   247  	{"trim with extra spaces", "x\n{{-  3   -}}\ny", noError, `"x"{{3}}"y"`},
   248  	{"comment trim left", "x \r\n\t{{- /* hi */}}", noError, `"x"`},
   249  	{"comment trim right", "{{/* hi */ -}}\n\n\ty", noError, `"y"`},
   250  	{"comment trim left and right", "x \r\n\t{{- /* */ -}}\n\n\ty", noError, `"x""y"`},
   251  	{"block definition", `{{block "foo" .}}hello{{end}}`, noError,
   252  		`{{template "foo" .}}`},
   253  	// Errors.
   254  	{"unclosed action", "hello{{range", hasError, ""},
   255  	{"unmatched end", "{{end}}", hasError, ""},
   256  	{"unmatched else", "{{else}}", hasError, ""},
   257  	{"unmatched else after if", "{{if .X}}hello{{end}}{{else}}", hasError, ""},
   258  	{"multiple else", "{{if .X}}1{{else}}2{{else}}3{{end}}", hasError, ""},
   259  	{"missing end", "hello{{range .x}}", hasError, ""},
   260  	{"missing end after else", "hello{{range .x}}{{else}}", hasError, ""},
   261  	{"undefined function", "hello{{undefined}}", hasError, ""},
   262  	{"undefined variable", "{{$x}}", hasError, ""},
   263  	{"variable undefined after end", "{{with $x := 4}}{{end}}{{$x}}", hasError, ""},
   264  	{"variable undefined in template", "{{template $v}}", hasError, ""},
   265  	{"declare with field", "{{with $x.Y := 4}}{{end}}", hasError, ""},
   266  	{"template with field ref", "{{template .X}}", hasError, ""},
   267  	{"template with var", "{{template $v}}", hasError, ""},
   268  	{"invalid punctuation", "{{printf 3, 4}}", hasError, ""},
   269  	{"multidecl outside range", "{{with $v, $u := 3}}{{end}}", hasError, ""},
   270  	{"too many decls in range", "{{range $u, $v, $w := 3}}{{end}}", hasError, ""},
   271  	{"dot applied to parentheses", "{{printf (printf .).}}", hasError, ""},
   272  	{"adjacent args", "{{printf 3`x`}}", hasError, ""},
   273  	{"adjacent args with .", "{{printf `x`.}}", hasError, ""},
   274  	{"extra end after if", "{{if .X}}a{{else if .Y}}b{{end}}{{end}}", hasError, ""},
   275  	// Other kinds of assignments and operators aren't available yet.
   276  	{"bug0a", "{{$x := 0}}{{$x}}", noError, "{{$x := 0}}{{$x}}"},
   277  	{"bug0b", "{{$x += 1}}{{$x}}", hasError, ""},
   278  	{"bug0c", "{{$x ! 2}}{{$x}}", hasError, ""},
   279  	{"bug0d", "{{$x % 3}}{{$x}}", hasError, ""},
   280  	// Check the parse fails for := rather than comma.
   281  	{"bug0e", "{{range $x := $y := 3}}{{end}}", hasError, ""},
   282  	// Another bug: variable read must ignore following punctuation.
   283  	{"bug1a", "{{$x:=.}}{{$x!2}}", hasError, ""},                     // ! is just illegal here.
   284  	{"bug1b", "{{$x:=.}}{{$x+2}}", hasError, ""},                     // $x+2 should not parse as ($x) (+2).
   285  	{"bug1c", "{{$x:=.}}{{$x +2}}", noError, "{{$x := .}}{{$x +2}}"}, // It's OK with a space.
   286  	// dot following a literal value
   287  	{"dot after integer", "{{1.E}}", hasError, ""},
   288  	{"dot after float", "{{0.1.E}}", hasError, ""},
   289  	{"dot after boolean", "{{true.E}}", hasError, ""},
   290  	{"dot after char", "{{'a'.any}}", hasError, ""},
   291  	{"dot after string", `{{"hello".guys}}`, hasError, ""},
   292  	{"dot after dot", "{{..E}}", hasError, ""},
   293  	{"dot after nil", "{{nil.E}}", hasError, ""},
   294  	// Wrong pipeline
   295  	{"wrong pipeline dot", "{{12|.}}", hasError, ""},
   296  	{"wrong pipeline number", "{{.|12|printf}}", hasError, ""},
   297  	{"wrong pipeline string", "{{.|printf|\"error\"}}", hasError, ""},
   298  	{"wrong pipeline char", "{{12|printf|'e'}}", hasError, ""},
   299  	{"wrong pipeline boolean", "{{.|true}}", hasError, ""},
   300  	{"wrong pipeline nil", "{{'c'|nil}}", hasError, ""},
   301  	{"empty pipeline", `{{printf "%d" ( ) }}`, hasError, ""},
   302  	// Missing pipeline in block
   303  	{"block definition", `{{block "foo"}}hello{{end}}`, hasError, ""},
   304  }
   305  
   306  var builtins = map[string]interface{}{
   307  	"printf":   fmt.Sprintf,
   308  	"contains": strings.Contains,
   309  }
   310  
   311  func testParse(doCopy bool, t *testing.T) {
   312  	textFormat = "%q"
   313  	defer func() { textFormat = "%s" }()
   314  	for _, test := range parseTests {
   315  		tmpl, err := New(test.name).Parse(test.input, "", "", make(map[string]*Tree), builtins)
   316  		switch {
   317  		case err == nil && !test.ok:
   318  			t.Errorf("%q: expected error; got none", test.name)
   319  			continue
   320  		case err != nil && test.ok:
   321  			t.Errorf("%q: unexpected error: %v", test.name, err)
   322  			continue
   323  		case err != nil && !test.ok:
   324  			// expected error, got one
   325  			if *debug {
   326  				fmt.Printf("%s: %s\n\t%s\n", test.name, test.input, err)
   327  			}
   328  			continue
   329  		}
   330  		var result string
   331  		if doCopy {
   332  			result = tmpl.Root.Copy().String()
   333  		} else {
   334  			result = tmpl.Root.String()
   335  		}
   336  		if result != test.result {
   337  			t.Errorf("%s=(%q): got\n\t%v\nexpected\n\t%v", test.name, test.input, result, test.result)
   338  		}
   339  	}
   340  }
   341  
   342  func TestParse(t *testing.T) {
   343  	testParse(false, t)
   344  }
   345  
   346  // Same as TestParse, but we copy the node first
   347  func TestParseCopy(t *testing.T) {
   348  	testParse(true, t)
   349  }
   350  
   351  type isEmptyTest struct {
   352  	name  string
   353  	input string
   354  	empty bool
   355  }
   356  
   357  var isEmptyTests = []isEmptyTest{
   358  	{"empty", ``, true},
   359  	{"nonempty", `hello`, false},
   360  	{"spaces only", " \t\n \t\n", true},
   361  	{"definition", `{{define "x"}}something{{end}}`, true},
   362  	{"definitions and space", "{{define `x`}}something{{end}}\n\n{{define `y`}}something{{end}}\n\n", true},
   363  	{"definitions and text", "{{define `x`}}something{{end}}\nx\n{{define `y`}}something{{end}}\ny\n", false},
   364  	{"definition and action", "{{define `x`}}something{{end}}{{if 3}}foo{{end}}", false},
   365  }
   366  
   367  func TestIsEmpty(t *testing.T) {
   368  	if !IsEmptyTree(nil) {
   369  		t.Errorf("nil tree is not empty")
   370  	}
   371  	for _, test := range isEmptyTests {
   372  		tree, err := New("root").Parse(test.input, "", "", make(map[string]*Tree), nil)
   373  		if err != nil {
   374  			t.Errorf("%q: unexpected error: %v", test.name, err)
   375  			continue
   376  		}
   377  		if empty := IsEmptyTree(tree.Root); empty != test.empty {
   378  			t.Errorf("%q: expected %t got %t", test.name, test.empty, empty)
   379  		}
   380  	}
   381  }
   382  
   383  func TestErrorContextWithTreeCopy(t *testing.T) {
   384  	tree, err := New("root").Parse("{{if true}}{{end}}", "", "", make(map[string]*Tree), nil)
   385  	if err != nil {
   386  		t.Fatalf("unexpected tree parse failure: %v", err)
   387  	}
   388  	treeCopy := tree.Copy()
   389  	wantLocation, wantContext := tree.ErrorContext(tree.Root.Nodes[0])
   390  	gotLocation, gotContext := treeCopy.ErrorContext(treeCopy.Root.Nodes[0])
   391  	if wantLocation != gotLocation {
   392  		t.Errorf("wrong error location want %q got %q", wantLocation, gotLocation)
   393  	}
   394  	if wantContext != gotContext {
   395  		t.Errorf("wrong error location want %q got %q", wantContext, gotContext)
   396  	}
   397  }
   398  
   399  // All failures, and the result is a string that must appear in the error message.
   400  var errorTests = []parseTest{
   401  	// Check line numbers are accurate.
   402  	{"unclosed1",
   403  		"line1\n{{",
   404  		hasError, `unclosed1:2: unexpected unclosed action in command`},
   405  	{"unclosed2",
   406  		"line1\n{{define `x`}}line2\n{{",
   407  		hasError, `unclosed2:3: unexpected unclosed action in command`},
   408  	// Specific errors.
   409  	{"function",
   410  		"{{foo}}",
   411  		hasError, `function "foo" not defined`},
   412  	{"comment",
   413  		"{{/*}}",
   414  		hasError, `unclosed comment`},
   415  	{"lparen",
   416  		"{{.X (1 2 3}}",
   417  		hasError, `unclosed left paren`},
   418  	{"rparen",
   419  		"{{.X 1 2 3)}}",
   420  		hasError, `unexpected ")"`},
   421  	{"space",
   422  		"{{`x`3}}",
   423  		hasError, `in operand`},
   424  	{"idchar",
   425  		"{{a#}}",
   426  		hasError, `'#'`},
   427  	{"charconst",
   428  		"{{'a}}",
   429  		hasError, `unterminated character constant`},
   430  	{"stringconst",
   431  		`{{"a}}`,
   432  		hasError, `unterminated quoted string`},
   433  	{"rawstringconst",
   434  		"{{`a}}",
   435  		hasError, `unterminated raw quoted string`},
   436  	{"number",
   437  		"{{0xi}}",
   438  		hasError, `number syntax`},
   439  	{"multidefine",
   440  		"{{define `a`}}a{{end}}{{define `a`}}b{{end}}",
   441  		hasError, `multiple definition of template`},
   442  	{"eof",
   443  		"{{range .X}}",
   444  		hasError, `unexpected EOF`},
   445  	{"variable",
   446  		// Declare $x so it's defined, to avoid that error, and then check we don't parse a declaration.
   447  		"{{$x := 23}}{{with $x.y := 3}}{{$x 23}}{{end}}",
   448  		hasError, `unexpected ":="`},
   449  	{"multidecl",
   450  		"{{$a,$b,$c := 23}}",
   451  		hasError, `too many declarations`},
   452  	{"undefvar",
   453  		"{{$a}}",
   454  		hasError, `undefined variable`},
   455  	{"wrongdot",
   456  		"{{true.any}}",
   457  		hasError, `unexpected . after term`},
   458  	{"wrongpipeline",
   459  		"{{12|false}}",
   460  		hasError, `non executable command in pipeline`},
   461  	{"emptypipeline",
   462  		`{{ ( ) }}`,
   463  		hasError, `missing value for parenthesized pipeline`},
   464  	{"multilinerawstring",
   465  		"{{ $v := `\n` }} {{",
   466  		hasError, `multilinerawstring:2: unexpected unclosed action`},
   467  	{"rangeundefvar",
   468  		"{{range $k}}{{end}}",
   469  		hasError, `undefined variable`},
   470  	{"rangeundefvars",
   471  		"{{range $k, $v}}{{end}}",
   472  		hasError, `undefined variable`},
   473  	{"rangemissingvalue1",
   474  		"{{range $k,}}{{end}}",
   475  		hasError, `missing value for range`},
   476  	{"rangemissingvalue2",
   477  		"{{range $k, $v := }}{{end}}",
   478  		hasError, `missing value for range`},
   479  	{"rangenotvariable1",
   480  		"{{range $k, .}}{{end}}",
   481  		hasError, `range can only initialize variables`},
   482  	{"rangenotvariable2",
   483  		"{{range $k, 123 := .}}{{end}}",
   484  		hasError, `range can only initialize variables`},
   485  }
   486  
   487  func TestErrors(t *testing.T) {
   488  	for _, test := range errorTests {
   489  		t.Run(test.name, func(t *testing.T) {
   490  			_, err := New(test.name).Parse(test.input, "", "", make(map[string]*Tree))
   491  			if err == nil {
   492  				t.Fatalf("expected error %q, got nil", test.result)
   493  			}
   494  			if !strings.Contains(err.Error(), test.result) {
   495  				t.Fatalf("error %q does not contain %q", err, test.result)
   496  			}
   497  		})
   498  	}
   499  }
   500  
   501  func TestBlock(t *testing.T) {
   502  	const (
   503  		input = `a{{block "inner" .}}bar{{.}}baz{{end}}b`
   504  		outer = `a{{template "inner" .}}b`
   505  		inner = `bar{{.}}baz`
   506  	)
   507  	treeSet := make(map[string]*Tree)
   508  	tmpl, err := New("outer").Parse(input, "", "", treeSet, nil)
   509  	if err != nil {
   510  		t.Fatal(err)
   511  	}
   512  	if g, w := tmpl.Root.String(), outer; g != w {
   513  		t.Errorf("outer template = %q, want %q", g, w)
   514  	}
   515  	inTmpl := treeSet["inner"]
   516  	if inTmpl == nil {
   517  		t.Fatal("block did not define template")
   518  	}
   519  	if g, w := inTmpl.Root.String(), inner; g != w {
   520  		t.Errorf("inner template = %q, want %q", g, w)
   521  	}
   522  }
   523  
   524  func TestLineNum(t *testing.T) {
   525  	const count = 100
   526  	text := strings.Repeat("{{printf 1234}}\n", count)
   527  	tree, err := New("bench").Parse(text, "", "", make(map[string]*Tree), builtins)
   528  	if err != nil {
   529  		t.Fatal(err)
   530  	}
   531  	// Check the line numbers. Each line is an action containing a template, followed by text.
   532  	// That's two nodes per line.
   533  	nodes := tree.Root.Nodes
   534  	for i := 0; i < len(nodes); i += 2 {
   535  		line := 1 + i/2
   536  		// Action first.
   537  		action := nodes[i].(*ActionNode)
   538  		if action.Line != line {
   539  			t.Fatalf("line %d: action is line %d", line, action.Line)
   540  		}
   541  		pipe := action.Pipe
   542  		if pipe.Line != line {
   543  			t.Fatalf("line %d: pipe is line %d", line, pipe.Line)
   544  		}
   545  	}
   546  }
   547  
   548  func BenchmarkParseLarge(b *testing.B) {
   549  	text := strings.Repeat("{{1234}}\n", 10000)
   550  	for i := 0; i < b.N; i++ {
   551  		_, err := New("bench").Parse(text, "", "", make(map[string]*Tree), builtins)
   552  		if err != nil {
   553  			b.Fatal(err)
   554  		}
   555  	}
   556  }
   557  
   558  var sinkv, sinkl string
   559  
   560  func BenchmarkVariableString(b *testing.B) {
   561  	v := &VariableNode{
   562  		Ident: []string{"$", "A", "BB", "CCC", "THIS_IS_THE_VARIABLE_BEING_PROCESSED"},
   563  	}
   564  	b.ResetTimer()
   565  	b.ReportAllocs()
   566  	for i := 0; i < b.N; i++ {
   567  		sinkv = v.String()
   568  	}
   569  	if sinkv == "" {
   570  		b.Fatal("Benchmark was not run")
   571  	}
   572  }
   573  
   574  func BenchmarkListString(b *testing.B) {
   575  	text := `
   576  {{(printf .Field1.Field2.Field3).Value}}
   577  {{$x := (printf .Field1.Field2.Field3).Value}}
   578  {{$y := (printf $x.Field1.Field2.Field3).Value}}
   579  {{$z := $y.Field1.Field2.Field3}}
   580  {{if contains $y $z}}
   581  	{{printf "%q" $y}}
   582  {{else}}
   583  	{{printf "%q" $x}}
   584  {{end}}
   585  {{with $z.Field1 | contains "boring"}}
   586  	{{printf "%q" . | printf "%s"}}
   587  {{else}}
   588  	{{printf "%d %d %d" 11 11 11}}
   589  	{{printf "%d %d %s" 22 22 $x.Field1.Field2.Field3 | printf "%s"}}
   590  	{{printf "%v" (contains $z.Field1.Field2 $y)}}
   591  {{end}}
   592  `
   593  	tree, err := New("bench").Parse(text, "", "", make(map[string]*Tree), builtins)
   594  	if err != nil {
   595  		b.Fatal(err)
   596  	}
   597  	b.ResetTimer()
   598  	b.ReportAllocs()
   599  	for i := 0; i < b.N; i++ {
   600  		sinkl = tree.Root.String()
   601  	}
   602  	if sinkl == "" {
   603  		b.Fatal("Benchmark was not run")
   604  	}
   605  }
   606  

View as plain text