token_test.go

/*
Copyright 2017 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package sqlparser

import (
	"fmt"
	"testing"
)

func TestLiteralID(t *testing.T) {
	testcases := []struct {
		in  string
		id  int
		out string
	}{{
		in:  "`aa`",
		id:  ID,
		out: "aa",
	}, {
		in:  "```a```",
		id:  ID,
		out: "`a`",
	}, {
		in:  "`a``b`",
		id:  ID,
		out: "a`b",
	}, {
		in:  "`a``b`c",
		id:  ID,
		out: "a`b",
	}, {
		in:  "`a``b",
		id:  LEX_ERROR,
		out: "a`b",
	}, {
		in:  "`a``b``",
		id:  LEX_ERROR,
		out: "a`b`",
	}, {
		in:  "``",
		id:  LEX_ERROR,
		out: "",
	}}

	for _, tcase := range testcases {
		tkn := NewStringTokenizer(tcase.in)
		id, out := tkn.Scan()
		if tcase.id != id || string(out) != tcase.out {
			t.Errorf("Scan(%s): %d, %s, want %d, %s", tcase.in, id, out, tcase.id, tcase.out)
		}
	}
}

func tokenName(id int) string {
	if id == STRING {
		return "STRING"
	} else if id == LEX_ERROR {
		return "LEX_ERROR"
	}
	return fmt.Sprintf("%d", id)
}

func TestString(t *testing.T) {
	testcases := []struct {
		in   string
		id   int
		want string
	}{{
		in:   "''",
		id:   STRING,
		want: "",
	}, {
		in:   "''''",
		id:   STRING,
		want: "'",
	}, {
		in:   "'hello'",
		id:   STRING,
		want: "hello",
	}, {
		in:   "'\\n'",
		id:   STRING,
		want: "\n",
	}, {
		in:   "'\\nhello\\n'",
		id:   STRING,
		want: "\nhello\n",
	}, {
		in:   "'a''b'",
		id:   STRING,
		want: "a'b",
	}, {
		in:   "'a\\'b'",
		id:   STRING,
		want: "a'b",
	}, {
		in:   "'\\'",
		id:   LEX_ERROR,
		want: "'",
	}, {
		in:   "'",
		id:   LEX_ERROR,
		want: "",
	}, {
		in:   "'hello\\'",
		id:   LEX_ERROR,
		want: "hello'",
	}, {
		in:   "'hello",
		id:   LEX_ERROR,
		want: "hello",
	}, {
		in:   "'hello\\",
		id:   LEX_ERROR,
		want: "hello",
	}}

	for _, tcase := range testcases {
		id, got := NewStringTokenizer(tcase.in).Scan()
		if tcase.id != id || string(got) != tcase.want {
			t.Errorf("Scan(%q) = (%s, %q), want (%s, %q)", tcase.in, tokenName(id), got, tokenName(tcase.id), tcase.want)
		}
	}
}

func TestScanAssignAndBindVar(t *testing.T) {
	testcases := []struct {
		in      string
		wantID  int
		wantOut string
	}{{
		in:      ":=",
		wantID:  ASSIGN,
		wantOut: "",
	}, {
		in:      ":v1",
		wantID:  VALUE_ARG,
		wantOut: ":v1",
	}, {
		in:      ":v",
		wantID:  LEX_ERROR,
		wantOut: ":v",
	}, {
		in:      ":a1",
		wantID:  LEX_ERROR,
		wantOut: ":",
	}}

	for _, tcase := range testcases {
		id, out := NewStringTokenizer(tcase.in).Scan()
		if id != tcase.wantID || string(out) != tcase.wantOut {
			t.Errorf("Scan(%q) = (%s, %q), want (%s, %q)", tcase.in, tokenName(id), out, tokenName(tcase.wantID), tcase.wantOut)
		}
	}
}

func TestScanFloatAliases(t *testing.T) {
	testcases := []struct {
		in     string
		wantID int
		want   string
	}{
		{in: "float4", wantID: FLOAT_TYPE, want: "float4"},
		{in: "float8", wantID: DOUBLE, want: "float8"},
	}

	for _, tcase := range testcases {
		id, out := NewStringTokenizer(tcase.in).Scan()
		if id != tcase.wantID || string(out) != tcase.want {
			t.Errorf("Scan(%q) = (%s, %q), want (%s, %q)", tcase.in, tokenName(id), out, tokenName(tcase.wantID), tcase.want)
		}
	}
}

func TestScanCharsetIntroducer(t *testing.T) {
	testcases := []struct {
		in          string
		wantIntroID int
		wantIntro   string
		wantStrID   int
		wantStr     string
	}{{
		in:          "_utf8mb4'hello'",
		wantIntroID: UNDERSCORE_CHARSET,
		wantIntro:   "_utf8mb4",
		wantStrID:   STRING,
		wantStr:     "hello",
	}, {
		in:          "_utf8mb4 'hello'",
		wantIntroID: UNDERSCORE_CHARSET,
		wantIntro:   "_utf8mb4",
		wantStrID:   STRING,
		wantStr:     "hello",
	}, {
		in:          "_binary'hello'",
		wantIntroID: UNDERSCORE_BINARY,
		wantIntro:   "_binary",
		wantStrID:   STRING,
		wantStr:     "hello",
	}}

	for _, tcase := range testcases {
		tkn := NewStringTokenizer(tcase.in)
		introID, intro := tkn.Scan()
		if introID != tcase.wantIntroID || string(intro) != tcase.wantIntro {
			t.Fatalf("first Scan(%q) = (%s, %q), want (%s, %q)", tcase.in, tokenName(introID), intro, tokenName(tcase.wantIntroID), tcase.wantIntro)
		}

		strID, str := tkn.Scan()
		if strID != tcase.wantStrID || string(str) != tcase.wantStr {
			t.Fatalf("second Scan(%q) = (%s, %q), want (%s, %q)", tcase.in, tokenName(strID), str, tokenName(tcase.wantStrID), tcase.wantStr)
		}
	}
}

func TestScanSpatialSRIDKeyword(t *testing.T) {
	id, out := NewStringTokenizer("srid").Scan()
	if id != SRID || string(out) != "srid" {
		t.Errorf("Scan(%q) = (%s, %q), want (%s, %q)", "srid", tokenName(id), out, tokenName(SRID), "srid")
	}
}

func TestSplitStatement(t *testing.T) {
	testcases := []struct {
		in  string
		sql string
		rem string
	}{{
		in:  "select * from table",
		sql: "select * from table",
	}, {
		in:  "select * from table; ",
		sql: "select * from table",
		rem: " ",
	}, {
		in:  "select * from table; select * from table2;",
		sql: "select * from table",
		rem: " select * from table2;",
	}, {
		in:  "select * from /* comment */ table;",
		sql: "select * from /* comment */ table",
	}, {
		in:  "select * from /* comment ; */ table;",
		sql: "select * from /* comment ; */ table",
	}, {
		in:  "select * from table where semi = ';';",
		sql: "select * from table where semi = ';'",
	}, {
		in:  "-- select * from table",
		sql: "-- select * from table",
	}, {
		in:  " ",
		sql: " ",
	}, {
		in:  "",
		sql: "",
	}}

	for _, tcase := range testcases {
		sql, rem, err := SplitStatement(tcase.in)
		if err != nil {
			t.Errorf("EndOfStatementPosition(%s): ERROR: %v", tcase.in, err)
			continue
		}

		if tcase.sql != sql {
			t.Errorf("EndOfStatementPosition(%s) got sql \"%s\" want \"%s\"", tcase.in, sql, tcase.sql)
		}

		if tcase.rem != rem {
			t.Errorf("EndOfStatementPosition(%s) got remainder \"%s\" want \"%s\"", tcase.in, rem, tcase.rem)
		}
	}
}

func TestScanForceEOFSkipsSpecialComment(t *testing.T) {
	tkn := NewStringTokenizer("ignored")
	tkn.ForceEOF = true
	tkn.specialComment = NewStringTokenizer("character set utf8mb4")

	id, out := tkn.Scan()
	if id != 0 || out != nil {
		t.Fatalf("Scan() = (%d, %q), want (0, nil)", id, out)
	}
	if tkn.specialComment != nil {
		t.Fatalf("expected specialComment to be cleared when forcing EOF")
	}
}

func TestScanMySQLSpecificCommentExpandsTokens(t *testing.T) {
	tkn := NewStringTokenizer("select /*!40101 * from*/ t")

	id, out := tkn.Scan()
	if id != SELECT || string(out) != "select" {
		t.Fatalf("first token = (%d, %q), want (%d, %q)", id, out, SELECT, "select")
	}

	id, out = tkn.Scan()
	if id != '*' || out != nil {
		t.Fatalf("second token = (%d, %q), want (%d, nil)", id, out, '*')
	}

	id, out = tkn.Scan()
	if id != FROM || string(out) != "from" {
		t.Fatalf("third token = (%d, %q), want (%d, %q)", id, out, FROM, "from")
	}

	id, out = tkn.Scan()
	if id != ID || string(out) != "t" {
		t.Fatalf("fourth token = (%d, %q), want (%d, %q)", id, out, ID, "t")
	}

	id, out = tkn.Scan()
	if id != 0 || out != nil {
		t.Fatalf("final token = (%d, %q), want (0, nil)", id, out)
	}
}

func TestScanMalformedMySQLSpecificComment(t *testing.T) {
	tkn := NewStringTokenizer("/*!40101 select")

	id, out := tkn.Scan()
	if id != LEX_ERROR {
		t.Fatalf("Scan() token = (%d, %q), want LEX_ERROR", id, out)
	}
}