hcl/scanner/scanner_test.go

package scanner

import (
	"bytes"
	"fmt"
	"testing"

	"github.com/fatih/hcl/token"
)

var f100 = "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"

type tokenPair struct {
	tok  token.Token
	text string
}

func testTokenList(t *testing.T, tokenList []tokenPair) {
	// create artifical source code
	buf := new(bytes.Buffer)
	for _, ident := range tokenList {
		fmt.Fprintf(buf, "%s\n", ident.text)
	}

	s, err := NewScanner(buf)
	if err != nil {
		t.Fatal(err)
	}

	for _, ident := range tokenList {
		tok := s.Scan()
		if tok != ident.tok {
			t.Errorf("tok = %q want %q for %q\n", tok, ident.tok, ident.text)
		}

		if s.TokenText() != ident.text {
			t.Errorf("text = %q want %q", s.TokenText(), ident.text)
		}

	}
}

func TestComment(t *testing.T) {
	var tokenList = []tokenPair{
		{token.COMMENT, "//"},
		{token.COMMENT, "////"},
		{token.COMMENT, "// comment"},
		{token.COMMENT, "// /* comment */"},
		{token.COMMENT, "// // comment //"},
		{token.COMMENT, "//" + f100},
		{token.COMMENT, "#"},
		{token.COMMENT, "##"},
		{token.COMMENT, "# comment"},
		{token.COMMENT, "# /* comment */"},
		{token.COMMENT, "# # comment #"},
		{token.COMMENT, "#" + f100},
		{token.COMMENT, "/**/"},
		{token.COMMENT, "/***/"},
		{token.COMMENT, "/* comment */"},
		{token.COMMENT, "/* // comment */"},
		{token.COMMENT, "/* /* comment */"},
		{token.COMMENT, "/*\n comment\n*/"},
		{token.COMMENT, "/*" + f100 + "*/"},
	}

	testTokenList(t, tokenList)
}

func TestOperator(t *testing.T) {
	var tokenList = []tokenPair{
		{token.LBRACK, "["},
		{token.LBRACE, "{"},
		{token.COMMA, ","},
		{token.PERIOD, "."},
		{token.RBRACK, "]"},
		{token.RBRACE, "}"},
		{token.ASSIGN, "="},
		{token.ADD, "+"},
		{token.SUB, "-"},
	}

	testTokenList(t, tokenList)
}

func TestBool(t *testing.T) {
	var tokenList = []tokenPair{
		{token.BOOL, "true"},
		{token.BOOL, "false"},
	}

	testTokenList(t, tokenList)
}

func TestIdent(t *testing.T) {
	var tokenList = []tokenPair{
		{token.IDENT, "a"},
		{token.IDENT, "a0"},
		{token.IDENT, "foobar"},
		{token.IDENT, "abc123"},
		{token.IDENT, "LGTM"},
		{token.IDENT, "_"},
		{token.IDENT, "_abc123"},
		{token.IDENT, "abc123_"},
		{token.IDENT, "_abc_123_"},
		{token.IDENT, "_äöü"},
		{token.IDENT, "_本"},
		{token.IDENT, "äöü"},
		{token.IDENT, "本"},
		{token.IDENT, "a۰۱۸"},
		{token.IDENT, "foo६४"},
		{token.IDENT, "bar９８７６"},
	}

	testTokenList(t, tokenList)
}

func TestString(t *testing.T) {
	var tokenList = []tokenPair{
		{token.STRING, `" "`},
		{token.STRING, `"a"`},
		{token.STRING, `"本"`},
		{token.STRING, `"\a"`},
		{token.STRING, `"\b"`},
		{token.STRING, `"\f"`},
		{token.STRING, `"\n"`},
		{token.STRING, `"\r"`},
		{token.STRING, `"\t"`},
		{token.STRING, `"\v"`},
		{token.STRING, `"\""`},
		{token.STRING, `"\000"`},
		{token.STRING, `"\777"`},
		{token.STRING, `"\x00"`},
		{token.STRING, `"\xff"`},
		{token.STRING, `"\u0000"`},
		{token.STRING, `"\ufA16"`},
		{token.STRING, `"\U00000000"`},
		{token.STRING, `"\U0000ffAB"`},
		{token.STRING, `"` + f100 + `"`},
	}

	testTokenList(t, tokenList)
}

func TestNumber(t *testing.T) {
	var tokenList = []tokenPair{
		{token.NUMBER, "0"},
		{token.NUMBER, "1"},
		{token.NUMBER, "9"},
		{token.NUMBER, "42"},
		{token.NUMBER, "1234567890"},
		{token.NUMBER, "00"},
		{token.NUMBER, "01"},
		{token.NUMBER, "07"},
		{token.NUMBER, "042"},
		{token.NUMBER, "01234567"},
		{token.NUMBER, "0x0"},
		{token.NUMBER, "0x1"},
		{token.NUMBER, "0xf"},
		{token.NUMBER, "0x42"},
		{token.NUMBER, "0x123456789abcDEF"},
		{token.NUMBER, "0x" + f100},
		{token.NUMBER, "0X0"},
		{token.NUMBER, "0X1"},
		{token.NUMBER, "0XF"},
		{token.NUMBER, "0X42"},
		{token.NUMBER, "0X123456789abcDEF"},
		{token.NUMBER, "0X" + f100},
		{token.FLOAT, "0."},
		{token.FLOAT, "1."},
		{token.FLOAT, "42."},
		{token.FLOAT, "01234567890."},
		{token.FLOAT, ".0"},
		{token.FLOAT, ".1"},
		{token.FLOAT, ".42"},
		{token.FLOAT, ".0123456789"},
		{token.FLOAT, "0.0"},
		{token.FLOAT, "1.0"},
		{token.FLOAT, "42.0"},
		{token.FLOAT, "01234567890.0"},
		{token.FLOAT, "0e0"},
		{token.FLOAT, "1e0"},
		{token.FLOAT, "42e0"},
		{token.FLOAT, "01234567890e0"},
		{token.FLOAT, "0E0"},
		{token.FLOAT, "1E0"},
		{token.FLOAT, "42E0"},
		{token.FLOAT, "01234567890E0"},
		{token.FLOAT, "0e+10"},
		{token.FLOAT, "1e-10"},
		{token.FLOAT, "42e+10"},
		{token.FLOAT, "01234567890e-10"},
		{token.FLOAT, "0E+10"},
		{token.FLOAT, "1E-10"},
		{token.FLOAT, "42E+10"},
		{token.FLOAT, "01234567890E-10"},
	}

	testTokenList(t, tokenList)
}
-												hcl: split up package for more control

											
										
										
											2015-10-04 17:16:43 +00:00
+								package scanner
-												parser: add scanning ident test

											
										
										
											2015-10-03 18:06:30 +00:00
 								import (
 									"bytes"
 									"fmt"
 									"testing"
-												scanner: use new hcl/token package

											
										
										
											2015-10-04 17:19:39 +00:00
 									"github.com/fatih/hcl/token"
-												parser: add scanning ident test

											
										
										
											2015-10-03 18:06:30 +00:00
+								)
-												lexer: scan strings

											
										
										
											2015-10-03 21:20:26 +00:00
+								var f100 = "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
-												scanner: use new hcl/token package

											
										
										
											2015-10-04 17:19:39 +00:00
+								type tokenPair struct {
 									tok  token.Token
-												parser: add scanning ident test

											
										
										
											2015-10-03 18:06:30 +00:00
+									text string
 								}
-												scanner: reuse tests code

											
										
										
											2015-10-04 19:17:59 +00:00
+								func testTokenList(t *testing.T, tokenList []tokenPair) {
-												lexer: more robust implementation

											
										
										
											2015-10-03 22:29:13 +00:00
+									// create artifical source code
 									buf := new(bytes.Buffer)
 									for _, ident := range tokenList {
-												scanner: implement parsing octals

											
										
										
											2015-10-05 08:56:11 +00:00
+										fmt.Fprintf(buf, "%s\n", ident.text)
-												lexer: more robust implementation

											
										
										
											2015-10-03 22:29:13 +00:00
+									}
-												scanner: reuse tests code

											
										
										
											2015-10-04 19:17:59 +00:00
+									s, err := NewScanner(buf)
-												lexer: more robust implementation

											
										
										
											2015-10-03 22:29:13 +00:00
+									if err != nil {
 										t.Fatal(err)
 									}
 									for _, ident := range tokenList {
-												scanner: reuse tests code

											
										
										
											2015-10-04 19:17:59 +00:00
+										tok := s.Scan()
-												lexer: more robust implementation

											
										
										
											2015-10-03 22:29:13 +00:00
+										if tok != ident.tok {
-												scanner: # style line comment scanning implemented

											
										
										
											2015-10-05 10:24:38 +00:00
+											t.Errorf("tok = %q want %q for %q\n", tok, ident.tok, ident.text)
-												lexer: more robust implementation

											
										
										
											2015-10-03 22:29:13 +00:00
+										}
-												scanner: reuse tests code

											
										
										
											2015-10-04 19:17:59 +00:00
+										if s.TokenText() != ident.text {
-												scanner: # style line comment scanning implemented

											
										
										
											2015-10-05 10:24:38 +00:00
+											t.Errorf("text = %q want %q", s.TokenText(), ident.text)
-												lexer: more robust implementation

											
										
										
											2015-10-03 22:29:13 +00:00
+										}
 									}
 								}
-												scanner: # style line comment scanning implemented

											
										
										
											2015-10-05 10:24:38 +00:00
+								func TestComment(t *testing.T) {
 									var tokenList = []tokenPair{
-												scanner: // style comments are implemented too

											
										
										
											2015-10-05 10:26:18 +00:00
+										{token.COMMENT, "//"},
 										{token.COMMENT, "////"},
 										{token.COMMENT, "// comment"},
 										{token.COMMENT, "// /* comment */"},
 										{token.COMMENT, "// // comment //"},
 										{token.COMMENT, "//" + f100},
-												scanner: # style line comment scanning implemented

											
										
										
											2015-10-05 10:24:38 +00:00
+										{token.COMMENT, "#"},
 										{token.COMMENT, "##"},
 										{token.COMMENT, "# comment"},
 										{token.COMMENT, "# /* comment */"},
 										{token.COMMENT, "# # comment #"},
 										{token.COMMENT, "#" + f100},
-												scanner: implement comments

											
										
										
											2015-10-05 10:36:28 +00:00
+										{token.COMMENT, "/**/"},
 										{token.COMMENT, "/***/"},
 										{token.COMMENT, "/* comment */"},
 										{token.COMMENT, "/* // comment */"},
 										{token.COMMENT, "/* /* comment */"},
 										{token.COMMENT, "/*\n comment\n*/"},
 										{token.COMMENT, "/*" + f100 + "*/"},
-												scanner: # style line comment scanning implemented

											
										
										
											2015-10-05 10:24:38 +00:00
+									}
 									testTokenList(t, tokenList)
 								}
-												scanner: implement remaning tokens

											
										
										
											2015-10-05 10:12:48 +00:00
+								func TestOperator(t *testing.T) {
 									var tokenList = []tokenPair{
 										{token.LBRACK, "["},
 										{token.LBRACE, "{"},
 										{token.COMMA, ","},
 										{token.PERIOD, "."},
 										{token.RBRACK, "]"},
 										{token.RBRACE, "}"},
 										{token.ASSIGN, "="},
 										{token.ADD, "+"},
 										{token.SUB, "-"},
 									}
 									testTokenList(t, tokenList)
 								}
-												scanner: reuse tests code

											
										
										
											2015-10-04 19:17:59 +00:00
+								func TestBool(t *testing.T) {
 									var tokenList = []tokenPair{
 										{token.BOOL, "true"},
 										{token.BOOL, "false"},
 									}
 									testTokenList(t, tokenList)
 								}
-												parser: add scanning ident test

											
										
										
											2015-10-03 18:06:30 +00:00
+								func TestIdent(t *testing.T) {
-												scanner: use new hcl/token package

											
										
										
											2015-10-04 17:19:39 +00:00
+									var tokenList = []tokenPair{
 										{token.IDENT, "a"},
 										{token.IDENT, "a0"},
 										{token.IDENT, "foobar"},
 										{token.IDENT, "abc123"},
 										{token.IDENT, "LGTM"},
 										{token.IDENT, "_"},
 										{token.IDENT, "_abc123"},
 										{token.IDENT, "abc123_"},
 										{token.IDENT, "_abc_123_"},
 										{token.IDENT, "_äöü"},
 										{token.IDENT, "_本"},
 										{token.IDENT, "äöü"},
 										{token.IDENT, "本"},
 										{token.IDENT, "a۰۱۸"},
 										{token.IDENT, "foo६४"},
 										{token.IDENT, "bar９８７６"},
-												parser: add scanning ident test

											
										
										
											2015-10-03 18:06:30 +00:00
+									}
-												scanner: reuse tests code

											
										
										
											2015-10-04 19:17:59 +00:00
+									testTokenList(t, tokenList)
-												parser: add scanning ident test

											
										
										
											2015-10-03 18:06:30 +00:00
+								}
-												lexer: scan strings

											
										
										
											2015-10-03 21:20:26 +00:00
 								func TestString(t *testing.T) {
-												scanner: use new hcl/token package

											
										
										
											2015-10-04 17:19:39 +00:00
+									var tokenList = []tokenPair{
 										{token.STRING, `" "`},
 										{token.STRING, `"a"`},
 										{token.STRING, `"本"`},
-												scanner: implement string scanning

											
										
										
											2015-10-04 19:01:10 +00:00
+										{token.STRING, `"\a"`},
 										{token.STRING, `"\b"`},
 										{token.STRING, `"\f"`},
 										{token.STRING, `"\n"`},
 										{token.STRING, `"\r"`},
 										{token.STRING, `"\t"`},
 										{token.STRING, `"\v"`},
 										{token.STRING, `"\""`},
 										{token.STRING, `"\000"`},
 										{token.STRING, `"\777"`},
 										{token.STRING, `"\x00"`},
 										{token.STRING, `"\xff"`},
 										{token.STRING, `"\u0000"`},
 										{token.STRING, `"\ufA16"`},
 										{token.STRING, `"\U00000000"`},
 										{token.STRING, `"\U0000ffAB"`},
 										{token.STRING, `"` + f100 + `"`},
-												lexer: scan strings

											
										
										
											2015-10-03 21:20:26 +00:00
+									}
-												scanner: reuse tests code

											
										
										
											2015-10-04 19:17:59 +00:00
+									testTokenList(t, tokenList)
-												lexer: scan strings

											
										
										
											2015-10-03 21:20:26 +00:00
+								}
-												scanner: organize Scan() so it's easier to read

											
										
										
											2015-10-04 19:53:20 +00:00
 								func TestNumber(t *testing.T) {
 									var tokenList = []tokenPair{
-												scanner: parse floats in form of .9 , .123

											
										
										
											2015-10-05 09:31:26 +00:00
+										{token.NUMBER, "0"},
 										{token.NUMBER, "1"},
 										{token.NUMBER, "9"},
 										{token.NUMBER, "42"},
 										{token.NUMBER, "1234567890"},
 										{token.NUMBER, "00"},
 										{token.NUMBER, "01"},
 										{token.NUMBER, "07"},
 										{token.NUMBER, "042"},
 										{token.NUMBER, "01234567"},
 										{token.NUMBER, "0x0"},
 										{token.NUMBER, "0x1"},
 										{token.NUMBER, "0xf"},
 										{token.NUMBER, "0x42"},
 										{token.NUMBER, "0x123456789abcDEF"},
 										{token.NUMBER, "0x" + f100},
 										{token.NUMBER, "0X0"},
 										{token.NUMBER, "0X1"},
 										{token.NUMBER, "0XF"},
 										{token.NUMBER, "0X42"},
 										{token.NUMBER, "0X123456789abcDEF"},
 										{token.NUMBER, "0X" + f100},
 										{token.FLOAT, "0."},
 										{token.FLOAT, "1."},
 										{token.FLOAT, "42."},
 										{token.FLOAT, "01234567890."},
-												scanner: parse a set of fractions

											
										
										
											2015-10-05 09:26:22 +00:00
+										{token.FLOAT, ".0"},
 										{token.FLOAT, ".1"},
 										{token.FLOAT, ".42"},
 										{token.FLOAT, ".0123456789"},
-												scanner: parse floats in form of .9 , .123

											
										
										
											2015-10-05 09:31:26 +00:00
+										{token.FLOAT, "0.0"},
-												scanner: finalize float scanning

											
										
										
											2015-10-05 09:59:55 +00:00
+										{token.FLOAT, "1.0"},
 										{token.FLOAT, "42.0"},
 										{token.FLOAT, "01234567890.0"},
 										{token.FLOAT, "0e0"},
 										{token.FLOAT, "1e0"},
 										{token.FLOAT, "42e0"},
 										{token.FLOAT, "01234567890e0"},
 										{token.FLOAT, "0E0"},
 										{token.FLOAT, "1E0"},
 										{token.FLOAT, "42E0"},
 										{token.FLOAT, "01234567890E0"},
 										{token.FLOAT, "0e+10"},
 										{token.FLOAT, "1e-10"},
 										{token.FLOAT, "42e+10"},
 										{token.FLOAT, "01234567890e-10"},
 										{token.FLOAT, "0E+10"},
 										{token.FLOAT, "1E-10"},
 										{token.FLOAT, "42E+10"},
 										{token.FLOAT, "01234567890E-10"},
-												scanner: organize Scan() so it's easier to read

											
										
										
											2015-10-04 19:53:20 +00:00
+									}
 									testTokenList(t, tokenList)
 								}