dolthub--dolt/go/cmd/dolt/commands/sql_statement_scanner_test.go

// Copyright 2020 Dolthub, 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 commands

import (
	"strings"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestScanStatements(t *testing.T) {
	type testcase struct {
		input      string
		statements []string
		lineNums   []int
	}

	// Some of these include malformed input (e.g. strings that aren't properly terminated)
	testcases := []testcase{
		{
			input: `insert into foo values (";;';'");`,
			statements: []string{
				`insert into foo values (";;';'")`,
			},
		},
		{
			input: `select ''';;'; select ";\;"`,
			statements: []string{
				`select ''';;'`,
				`select ";\;"`,
			},
		},
		{
			input: `select ''';;'; select ";\;`,
			statements: []string{
				`select ''';;'`,
				`select ";\;`,
			},
		},
		{
			input: `select ''';;'; select ";\;
;`,
			statements: []string{
				`select ''';;'`,
				`select ";\;
;`,
			},
		},
		{
			input: `select '\\'''; select '";";'; select 1`,
			statements: []string{
				`select '\\'''`,
				`select '";";'`,
				`select 1`,
			},
		},
		{
			input: `select '\\''; select '";";'; select 1`,
			statements: []string{
				`select '\\''; select '";"`,
				`'; select 1`,
			},
		},
		{
			input: `insert into foo values(''); select 1`,
			statements: []string{
				`insert into foo values('')`,
				`select 1`,
			},
		},
		{
			input: `insert into foo values('''); select 1`,
			statements: []string{
				`insert into foo values('''); select 1`,
			},
		},
		{
			input: `insert into foo values(''''); select 1`,
			statements: []string{
				`insert into foo values('''')`,
				`select 1`,
			},
		},
		{
			input: `insert into foo values(""); select 1`,
			statements: []string{
				`insert into foo values("")`,
				`select 1`,
			},
		},
		{
			input: `insert into foo values("""); select 1`,
			statements: []string{
				`insert into foo values("""); select 1`,
			},
		},
		{
			input: `insert into foo values(""""); select 1`,
			statements: []string{
				`insert into foo values("""")`,
				`select 1`,
			},
		},
		{
			input: `select '\''; select "hell\"o"`,
			statements: []string{
				`select '\''`,
				`select "hell\"o"`,
			},
		},
		{
			input: `select * from foo; select baz from foo;
select
a from b; select 1`,
			statements: []string{
				"select * from foo",
				"select baz from foo",
				"select\na from b",
				"select 1",
			},
			lineNums: []int{
				1, 1, 2, 3,
			},
		},
		{
			input: "create table dumb (`hell\\`o;` int primary key);",
			statements: []string{
				"create table dumb (`hell\\`o;` int primary key)",
			},
		},
		{
			input: "create table dumb (`hell``o;` int primary key); select \n" +
				"baz from foo;\n" +
				"\n" +
				"select\n" +
				"a from b; select 1\n\n",
			statements: []string{
				"create table dumb (`hell``o;` int primary key)",
				"select \nbaz from foo",
				"select\na from b",
				"select 1",
			},
			lineNums: []int{
				1, 1, 4, 5,
			},
		},
		{
			input: `insert into foo values ('a', "b;", 'c;;""
'); update foo set baz = bar,
qux = '"hello"""' where xyzzy = ";;';'";

  
create table foo (a int not null default ';',
primary key (a));`,
			statements: []string{
				`insert into foo values ('a', "b;", 'c;;""
')`,
				`update foo set baz = bar,
qux = '"hello"""' where xyzzy = ";;';'"`,
				`create table foo (a int not null default ';',
primary key (a))`,
			},
			lineNums: []int{
				1, 2, 6,
			},
		},
		{
			input: `DELIMITER |
insert into foo values (1,2,3)|`,
			statements: []string{
				"",
				"insert into foo values (1,2,3)",
			},
			lineNums: []int{1, 2},
		},
		{
			// https://github.com/dolthub/dolt/issues/10828
			input: `-- comment asdfasdf
		delimiter //
		select current_user() //`,
			statements: []string{
				"",
				"",
				"select current_user()",
			},
			lineNums: []int{1, 2, 3},
		},
		{
			// https://github.com/dolthub/dolt/issues/8495
			input: strings.Repeat(" ", 4096) + `insert into foo values (1,2,3)`,
			statements: []string{
				"insert into foo values (1,2,3)",
			},
			lineNums: []int{1, 2},
		},
		{
			input: "DELIMITER" + strings.Repeat(" ", 4096) + `|
insert into foo values (1,2,3)|`,
			statements: []string{
				"",
				"insert into foo values (1,2,3)",
			},
			lineNums: []int{1, 2},
		},
		{
			// https://github.com/dolthub/dolt/issues/10694
			input: `-- '
-- can have intermediate comments
CALL dolt_commit('-m', 'message', '--allow-empty');
CALL dolt_checkout('main');`,
			statements: []string{
				"", "",
				"CALL dolt_commit('-m', 'message', '--allow-empty')",
				"CALL dolt_checkout('main')",
			},
			lineNums: []int{1, 2, 3, 4},
		},
		{
			input: `/* block comment with lone quote '
*/
-- can have intermediate comments
CALL dolt_commit('-m', 'message', '--allow-empty');
CALL dolt_checkout('main');`,
			statements: []string{
				`/* block comment with lone quote '
*/
-- can have intermediate comments
CALL dolt_commit('-m', 'message', '--allow-empty')`,
				"CALL dolt_checkout('main')",
			},
			lineNums: []int{1, 5},
		},
		{
			input: `select * /* -- ignore line comment inside block comment */ from xy;
select x from xy; -- select y from xy;
select * /* ignore multi-line comment with ;
comment;
comment;
*/ from foo;
select '-- ignore line comment
in quote';`,
			statements: []string{
				"select * /* -- ignore line comment inside block comment */ from xy",
				"select x from xy",
				"",
				`select * /* ignore multi-line comment with ;
comment;
comment;
*/ from foo`,
				`select '-- ignore line comment
in quote'`,
			},
			lineNums: []int{1, 2, 2, 3, 7},
		},
	}

	for _, tt := range testcases {
		t.Run(tt.input, func(t *testing.T) {
			reader := strings.NewReader(tt.input)
			scanner := NewStreamScanner(reader)
			var i int
			for scanner.Scan() {
				require.True(t, i < len(tt.statements))
				assert.Equal(t, tt.statements[i], strings.TrimSpace(scanner.Text()))
				if tt.lineNums != nil {
					assert.Equal(t, tt.lineNums[i], scanner.state.statementStartLine)
				} else {
					assert.Equal(t, 1, scanner.state.statementStartLine)
				}
				i++
			}

			require.NoError(t, scanner.Err())
		})
	}
}