mirror of
https://github.com/apache/superset.git
synced 2026-04-27 12:05:24 +00:00
feat(sqllab): syntax validation for sqlite-based DB engine specs (#38698)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Beto Dealmeida
303
tests/unit_tests/sql_validators/#sqlite_test.py#
Normal file
303
tests/unit_tests/sql_validators/#sqlite_test.py#
Normal file
@@ -0,0 +1,303 @@
|
||||
# Licensed to the Apache Software Foundation (ASF) under one
|
||||
# or more contributor license agreements. See the NOTICE file
|
||||
# distributed with this work for additional information
|
||||
# regarding copyright ownership. The ASF licenses this file
|
||||
# to you 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.
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import subprocess
|
||||
from subprocess import CompletedProcess
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
from superset.sql_validators.sqlite import SQLiteSQLValidator
|
||||
|
||||
|
||||
def _mock_result(
|
||||
returncode: int,
|
||||
stderr: str = "",
|
||||
stdout: str = "",
|
||||
) -> CompletedProcess[str]:
|
||||
return CompletedProcess(
|
||||
args=[],
|
||||
returncode=returncode,
|
||||
stdout=stdout,
|
||||
stderr=stderr,
|
||||
)
|
||||
|
||||
|
||||
def test_valid_syntax() -> None:
|
||||
mock_database = MagicMock()
|
||||
sql = "SELECT 1, col FROM my_table"
|
||||
|
||||
with (
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.get_binary_path",
|
||||
return_value="syntaqlite",
|
||||
),
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.subprocess.run",
|
||||
return_value=_mock_result(returncode=0),
|
||||
) as run,
|
||||
):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql=sql,
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert annotations == []
|
||||
run.assert_called_once()
|
||||
command = run.call_args.args[0]
|
||||
assert "--input" not in command
|
||||
assert "-e" not in command
|
||||
assert run.call_args.kwargs["input"] == sql
|
||||
|
||||
|
||||
def test_invalid_syntax_single_error() -> None:
|
||||
mock_database = MagicMock()
|
||||
stderr = (
|
||||
'error: near "SELEC": syntax error\n'
|
||||
" --> <input>:1:1\n"
|
||||
" |\n"
|
||||
"1 | SELEC * FROM foo\n"
|
||||
" | ^~~~~\n"
|
||||
)
|
||||
|
||||
with (
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.get_binary_path", return_value="syntaqlite"
|
||||
),
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.subprocess.run",
|
||||
return_value=_mock_result(returncode=1, stderr=stderr),
|
||||
),
|
||||
):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql="SELEC * FROM foo",
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert len(annotations) == 1
|
||||
annotation = annotations[0]
|
||||
assert annotation.line_number == 1
|
||||
assert annotation.start_column == 1
|
||||
# "SELEC" is 5 chars → caret + 4 tildes → end_column = 1 + 1 + 4 = 6
|
||||
assert annotation.end_column == 6
|
||||
assert "SELEC" in annotation.message
|
||||
|
||||
|
||||
def test_invalid_syntax_multiple_errors() -> None:
|
||||
mock_database = MagicMock()
|
||||
stderr = (
|
||||
'error: near "SELEC": syntax error\n'
|
||||
" --> <input>:1:1\n"
|
||||
" |\n"
|
||||
"1 | SELEC * FROM foo; SELEC * FROM bar\n"
|
||||
" | ^~~~~\n\n"
|
||||
'error: near "SELEC": syntax error\n'
|
||||
" --> <input>:1:20\n"
|
||||
" |\n"
|
||||
"1 | SELEC * FROM foo; SELEC * FROM bar\n"
|
||||
" | ^~~~~\n"
|
||||
)
|
||||
|
||||
with (
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.get_binary_path", return_value="syntaqlite"
|
||||
),
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.subprocess.run",
|
||||
return_value=_mock_result(returncode=1, stderr=stderr),
|
||||
),
|
||||
):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql="SELEC * FROM foo; SELEC * FROM bar",
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert len(annotations) == 2
|
||||
assert "SELEC" in annotations[0].message
|
||||
# "SELEC" is 5 chars → caret + 4 tildes → end_column = start_column + 1 + 4
|
||||
assert isinstance(annotations[0].start_column, int)
|
||||
assert isinstance(annotations[0].start_column, int)
|
||||
assert annotations[0].end_column == annotations[0].start_column + 5
|
||||
assert annotations[1].end_column == annotations[1].start_column + 5
|
||||
|
||||
|
||||
def test_multiline_error_reports_correct_line() -> None:
|
||||
mock_database = MagicMock()
|
||||
stderr = (
|
||||
'error: near "SELEC": syntax error\n'
|
||||
" --> <input>:2:1\n"
|
||||
" |\n"
|
||||
"2 | SELEC * FROM foo\n"
|
||||
" | ^~~~~\n"
|
||||
)
|
||||
|
||||
with (
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.get_binary_path", return_value="syntaqlite"
|
||||
),
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.subprocess.run",
|
||||
return_value=_mock_result(returncode=1, stderr=stderr),
|
||||
),
|
||||
):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql="SELECT 1;\nSELEC * FROM foo",
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert len(annotations) == 1
|
||||
assert annotations[0].line_number == 2
|
||||
|
||||
|
||||
def test_empty_sql() -> None:
|
||||
mock_database = MagicMock()
|
||||
|
||||
with (
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.get_binary_path", return_value="syntaqlite"
|
||||
),
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.subprocess.run",
|
||||
return_value=_mock_result(returncode=0),
|
||||
),
|
||||
):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql="",
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert annotations == []
|
||||
|
||||
|
||||
def test_valid_complex_query() -> None:
|
||||
mock_database = MagicMock()
|
||||
|
||||
with (
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.get_binary_path", return_value="syntaqlite"
|
||||
),
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.subprocess.run",
|
||||
return_value=_mock_result(returncode=0),
|
||||
),
|
||||
):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql=(
|
||||
"SELECT a, COUNT(*) AS cnt "
|
||||
"FROM my_table "
|
||||
"WHERE b > 10 "
|
||||
"GROUP BY a "
|
||||
"HAVING cnt > 1 "
|
||||
"ORDER BY cnt DESC "
|
||||
"LIMIT 100"
|
||||
),
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert annotations == []
|
||||
|
||||
|
||||
def test_annotation_to_dict() -> None:
|
||||
mock_database = MagicMock()
|
||||
stderr = (
|
||||
'error: near "SELEC": syntax error\n'
|
||||
" --> <input>:1:1\n"
|
||||
" |\n"
|
||||
"1 | SELEC * FROM foo\n"
|
||||
" | ^~~~~\n"
|
||||
)
|
||||
|
||||
with (
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.get_binary_path", return_value="syntaqlite"
|
||||
),
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.subprocess.run",
|
||||
return_value=_mock_result(returncode=1, stderr=stderr),
|
||||
),
|
||||
):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql="SELEC * FROM foo",
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert len(annotations) == 1
|
||||
result = annotations[0].to_dict()
|
||||
assert "line_number" in result
|
||||
assert "start_column" in result
|
||||
assert "end_column" in result
|
||||
assert "message" in result
|
||||
|
||||
|
||||
def test_missing_syntaqlite_returns_annotation() -> None:
|
||||
mock_database = MagicMock()
|
||||
with patch("superset.sql_validators.sqlite.get_binary_path", None):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql="SELECT 1",
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert len(annotations) == 1
|
||||
assert "syntaqlite is not installed" in annotations[0].message
|
||||
assert annotations[0].line_number is None
|
||||
|
||||
|
||||
def test_timeout_returns_annotation() -> None:
|
||||
mock_database = MagicMock()
|
||||
|
||||
with (
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.get_binary_path", return_value="syntaqlite"
|
||||
),
|
||||
patch(
|
||||
"superset.sql_validators.sqlite.subprocess.run",
|
||||
side_effect=subprocess.TimeoutExpired(cmd="syntaqlite", timeout=10),
|
||||
),
|
||||
):
|
||||
annotations = SQLiteSQLValidator.validate(
|
||||
sql="SELECT 1",
|
||||
catalog=None,
|
||||
schema="",
|
||||
database=mock_database,
|
||||
)
|
||||
|
||||
assert len(annotations) == 1
|
||||
assert "timed out" in annotations[0].message
|
||||
assert annotations[0].line_number is None
|
||||
|
||||
|
||||
def test_get_validator_by_name() -> None:
|
||||
from superset.sql_validators import get_validator_by_name
|
||||
|
||||
validator = get_validator_by_name("SQLiteSQLValidator")
|
||||
assert validator is SQLiteSQLValidator
|
||||
Reference in New Issue
Block a user