// Copyright 2019 PingCAP, 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, // See the License for the specific language governing permissions and // limitations under the License. package parser_test import ( "crypto/sha256" "encoding/hex" "fmt" "testing" "github.com/pingcap/tidb/pkg/parser" "github.com/stretchr/testify/require" ) func TestNormalize(t *testing.T) { tests_for_generic_normalization_rules := []struct { input string expect string }{ // Generic normalization rules {"select _utf8mb4'123'", "select (_charset) ?"}, {"select * from b where id in (_utf8mb4'123')", "select * from `b` where `id` in ( (_charset) ? )"}, {"select * from b where id in (_utf8mb4'123', _binary'34')", "select * from `b` where `id` in ( ... )"}, {"select * from b where id in (_utf8mb4'123', _binary'34', _binary'56')", "select * from `b` where `id` in ( ... )"}, {"SELECT 1", "select ?"}, {"select null", "select ?"}, {"select \\N", "select ?"}, {"SELECT `null`", "select `null`"}, {"select * from b where id = 1", "select * from `b` where `id` = ?"}, {"select 1 from b where id in (1, 3, '3', 1, 2, 3, 4)", "select ? from `b` where `id` in ( ... )"}, {"select 1 from b where id in (1, a, 4)", "select ? from `b` where `id` in ( ? , `a` , ? )"}, {"select 1 from b order by 2", "select ? from `b` order by 2"}, {"select /*+ a hint */ 1", "select ?"}, {"select /* a hint */ 1", "select ?"}, {"select truncate(1, 2)", "select truncate ( ... )"}, {"select -1 + - 2 + b - c + 0.2 + (-2) from c where d in (1, -2, +3)", "select ? + ? + `b` - `c` + ? + ( ? ) from `c` where `d` in ( ... )"}, {"select * from t where a <= -1 and b < -2 and c = -3 and c > -4 and c >= -5 and e is 1", "select * from `t` where `a` <= ? and `b` < ? and `c` = ? and `c` > ? and `c` >= ? and `e` is ?"}, {"select count(a), b from t group by 2", "select count ( `a` ) , `b` from `t` group by 2"}, {"select count(a), b, c from t group by 2, 3", "select count ( `a` ) , `b` , `c` from `t` group by 2 , 3"}, {"select count(a), b, c from t group by (2, 3)", "select count ( `a` ) , `b` , `c` from `t` group by ( 2 , 3 )"}, {"select a, b from t order by 1, 2", "select `a` , `b` from `t` order by 1 , 2"}, {"select count(*) from t", "select count ( ? ) from `t`"}, {"select * from t Force Index(kk)", "select * from `t`"}, {"select * from t USE Index(kk)", "select * from `t`"}, {"select * from t Ignore Index(kk)", "select * from `t`"}, {"select * from t1 straight_join t2 on t1.id=t2.id", "select * from `t1` join `t2` on `t1` . `id` = `t2` . `id`"}, {"select * from `table`", "select * from `table`"}, {"select * from `30`", "select * from `30`"}, {"select * from `select`", "select * from `select`"}, {"select * from 🥳", "select * from `🥳`"}, // test syntax error, it will be checked by parser, but it should not make normalize dead loop. {"select * from t ignore index(", "select * from `t` ignore index"}, {"select /*+ ", "select "}, {"select 1 / 2", "select ? / ?"}, {"select * from t where a = 40 limit ?, ?", "select * from `t` where `a` = ? limit ..."}, {"select * from t where a > ?", "select * from `t` where `a` > ?"}, {"select @a=b from t", "select @a = `b` from `t`"}, {"select * from `table", "select * from"}, {"Select * from t where (i, j) in ((1,1), (2,2))", "select * from `t` where ( `i` , `j` ) in ( ( ... ) )"}, {"insert into t values (1,1), (2,2)", "insert into `t` values ( ... )"}, {"insert into t values (1), (2)", "insert into `t` values ( ... )"}, {"insert into t values (1)", "insert into `t` values ( ? )"}, } for _, test := range tests_for_generic_normalization_rules { normalized := parser.Normalize(test.input, "ON") digest := parser.DigestNormalized(normalized) require.Equal(t, test.expect, normalized) normalized2, digest2 := parser.NormalizeDigest(test.input) require.Equal(t, normalized, normalized2) require.Equalf(t, digest.String(), digest2.String(), "%+v", test) } tests_for_binding_specific_rules := []struct { input string expect string }{ // Binding specific rules // IN (Lit) => IN ( ... ) #44298 {"select * from t where a in (1)", "select * from `t` where `a` in ( ... )"}, {"select * from t where (a, b) in ((1, 1))", "select * from `t` where ( `a` , `b` ) in ( ( ... ) )"}, {"select * from t where (a, b) in ((1, 1), (2, 2))", "select * from `t` where ( `a` , `b` ) in ( ( ... ) )"}, {"select * from t where a in(1, 2)", "select * from `t` where `a` in ( ... )"}, {"select * from t where a in(1, 2, 3)", "select * from `t` where `a` in ( ... )"}, } for _, test := range tests_for_binding_specific_rules { normalized := parser.NormalizeForBinding(test.input, false) digest := parser.DigestNormalized(normalized) require.Equal(t, test.expect, normalized) normalized2, digest2 := parser.NormalizeDigestForBinding(test.input) require.Equal(t, normalized, normalized2) require.Equalf(t, digest.String(), digest2.String(), "%+v", test) } } func TestNormalizeRedact(t *testing.T) { cases := []struct { input string expect string }{ {"select * from t where a in (1)", "select * from `t` where `a` in ( ‹1› )"}, {"select * from t where a in (1, 3)", "select * from `t` where `a` in ( ‹1› , ‹3› )"}, {"select ? from b order by 2", "select ? from `b` order by ‹2›"}, {"select ? from b order by 2 limit 10 offset 10", "select ? from `b` order by ‹2› limit ‹10› offset ‹10›"}, {"with recursive cte1(c1) as (select c1 from t1 union select c1 + 1 c1 from cte1 limit 100 offset 100) select * from cte1;", "with recursive `cte1` ( `c1` ) as ( select `c1` from `t1` union select `c1` + ‹1› `c1` from `cte1` limit ‹100› offset ‹100› ) select * from `cte1`"}, {"select *, first_value(v) over (partition by p order by o range between 3 preceding and 0 following) as a from test.first_range", "select * , `first_value` ( `v` ) `over` ( partition by `p` order by `o` range between ‹3› preceding and ‹0› following ) as `a` from `test` . `first_range`"}, } for _, c := range cases { normalized := parser.Normalize(c.input, "MARKER") require.Equal(t, c.expect, normalized) } } func TestNormalizeKeepHint(t *testing.T) { tests := []struct { input string expect string }{ {"select _utf8mb4'123'", "select (_charset) ?"}, {"SELECT 1", "select ?"}, {"select null", "select ?"}, {"select \\N", "select ?"}, {"SELECT `null`", "select `null`"}, {"select * from b where id = 1", "select * from `b` where `id` = ?"}, {"select 1 from b where id in (1, 3, '3', 1, 2, 3, 4)", "select ? from `b` where `id` in ( ... )"}, {"select 1 from b where id in (1, a, 4)", "select ? from `b` where `id` in ( ? , `a` , ? )"}, {"select 1 from b order by 2", "select ? from `b` order by 2"}, {"select /*+ a hint */ 1", "select /*+ a hint */ ?"}, {"select /* a hint */ 1", "select ?"}, {"select truncate(1, 2)", "select truncate ( ... )"}, {"select -1 + - 2 + b - c + 0.2 + (-2) from c where d in (1, -2, +3)", "select ? + ? + `b` - `c` + ? + ( ? ) from `c` where `d` in ( ... )"}, {"select * from t where a <= -1 and b < -2 and c = -3 and c > -4 and c >= -5 and e is 1", "select * from `t` where `a` <= ? and `b` < ? and `c` = ? and `c` > ? and `c` >= ? and `e` is ?"}, {"select count(a), b from t group by 2", "select count ( `a` ) , `b` from `t` group by 2"}, {"select count(a), b, c from t group by 2, 3", "select count ( `a` ) , `b` , `c` from `t` group by 2 , 3"}, {"select count(a), b, c from t group by (2, 3)", "select count ( `a` ) , `b` , `c` from `t` group by ( 2 , 3 )"}, {"select a, b from t order by 1, 2", "select `a` , `b` from `t` order by 1 , 2"}, {"select count(*) from t", "select count ( ? ) from `t`"}, {"select * from t Force Index(kk)", "select * from `t` force index ( `kk` )"}, {"select * from t USE Index(kk)", "select * from `t` use index ( `kk` )"}, {"select * from t Ignore Index(kk)", "select * from `t` ignore index ( `kk` )"}, {"select * from t1 straight_join t2 on t1.id=t2.id", "select * from `t1` straight_join `t2` on `t1` . `id` = `t2` . `id`"}, {"select * from `table`", "select * from `table`"}, {"select * from `30`", "select * from `30`"}, {"select * from `select`", "select * from `select`"}, {"select * from 🥳", "select * from `🥳`"}, // test syntax error, it will be checked by parser, but it should not make normalize dead loop. {"select * from t ignore index(", "select * from `t` ignore index ("}, {"select /*+ ", "select "}, {"select 1 / 2", "select ? / ?"}, {"select * from t where a = 40 limit ?, ?", "select * from `t` where `a` = ? limit ..."}, {"select * from t where a > ?", "select * from `t` where `a` > ?"}, {"select @a=b from t", "select @a = `b` from `t`"}, {"select * from `table", "select * from"}, } for _, test := range tests { normalized := parser.NormalizeKeepHint(test.input) require.Equal(t, test.expect, normalized) } } func TestNormalizeDigest(t *testing.T) { tests := []struct { sql string normalized string digest string }{ {"select 1 from b where id in (1, 3, '3', 1, 2, 3, 4)", "select ? from `b` where `id` in ( ... )", "e1c8cc2738f596dc24f15ef8eb55e0d902910d7298983496362a7b46dbc0b310"}, } for _, test := range tests { normalized, digest := parser.NormalizeDigest(test.sql) require.Equal(t, test.normalized, normalized) require.Equal(t, test.digest, digest.String()) normalized = parser.Normalize(test.sql, "ON") digest = parser.DigestNormalized(normalized) require.Equal(t, test.normalized, normalized) require.Equal(t, test.digest, digest.String()) } } func TestDigestHashEqForSimpleSQL(t *testing.T) { sqlGroups := [][]string{ {"select * from b where id = 1", "select * from b where id = '1'", "select * from b where id =2"}, {"select 2 from b, c where c.id > 1", "select 4 from b, c where c.id > 23"}, {"Select 3", "select 1"}, {"Select * from t where (i, j) in ((1,1), (2,2))", "select * from t where (i, j) in ((1,1), (2,2), (3,3))"}, {"insert into t values (1,1)", "insert into t values (1,1), (2,2)"}, } for _, sqlGroup := range sqlGroups { var d string for _, sql := range sqlGroup { dig := parser.DigestHash(sql) if d == "" { d = dig.String() continue } require.Equal(t, dig.String(), d) } } } func TestDigestHashNotEqForSimpleSQL(t *testing.T) { sqlGroups := [][]string{ {"select * from b where id = 1", "select a from b where id = 1", "select * from d where bid =1"}, } for _, sqlGroup := range sqlGroups { var d string for _, sql := range sqlGroup { dig := parser.DigestHash(sql) if d == "" { d = dig.String() continue } require.NotEqual(t, dig.String(), d) } } } func TestGenDigest(t *testing.T) { hash := genRandDigest("abc") digest := parser.NewDigest(hash) require.Equal(t, fmt.Sprintf("%x", hash), digest.String()) require.Equal(t, hash, digest.Bytes()) digest = parser.NewDigest(nil) require.Equal(t, "", digest.String()) require.Nil(t, digest.Bytes()) } func genRandDigest(str string) []byte { hasher := sha256.New() hasher.Write([]byte(str)) return hasher.Sum(nil) } func BenchmarkDigestHexEncode(b *testing.B) { digest1 := genRandDigest("abc") b.ResetTimer() for i := 0; i < b.N; i++ { hex.EncodeToString(digest1) } } func BenchmarkDigestSprintf(b *testing.B) { digest1 := genRandDigest("abc") b.ResetTimer() for i := 0; i < b.N; i++ { fmt.Sprintf("%x", digest1) } }