mirror of
https://github.com/apache/superset.git
synced 2024-09-12 16:49:40 -04:00
314 lines
8.8 KiB
Python
314 lines
8.8 KiB
Python
# 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.
|
|
|
|
# pylint: disable=import-outside-toplevel, protected-access
|
|
|
|
from __future__ import annotations
|
|
|
|
from textwrap import dedent
|
|
from typing import Any
|
|
|
|
import pytest
|
|
from pytest_mock import MockerFixture
|
|
from sqlalchemy import types
|
|
from sqlalchemy.dialects import sqlite
|
|
from sqlalchemy.engine.url import URL
|
|
from sqlalchemy.sql import sqltypes
|
|
|
|
from superset.sql_parse import Table
|
|
from superset.superset_typing import ResultSetColumnType, SQLAColumnType
|
|
from superset.utils.core import GenericDataType
|
|
from tests.unit_tests.db_engine_specs.utils import assert_column_spec
|
|
|
|
|
|
def test_get_text_clause_with_colon() -> None:
|
|
"""
|
|
Make sure text clauses are correctly escaped
|
|
"""
|
|
|
|
from superset.db_engine_specs.base import BaseEngineSpec
|
|
|
|
text_clause = BaseEngineSpec.get_text_clause(
|
|
"SELECT foo FROM tbl WHERE foo = '123:456')"
|
|
)
|
|
assert text_clause.text == "SELECT foo FROM tbl WHERE foo = '123\\:456')"
|
|
|
|
|
|
def test_parse_sql_single_statement() -> None:
|
|
"""
|
|
`parse_sql` should properly strip leading and trailing spaces and semicolons
|
|
"""
|
|
|
|
from superset.db_engine_specs.base import BaseEngineSpec
|
|
|
|
queries = BaseEngineSpec.parse_sql(" SELECT foo FROM tbl ; ")
|
|
assert queries == ["SELECT foo FROM tbl"]
|
|
|
|
|
|
def test_parse_sql_multi_statement() -> None:
|
|
"""
|
|
For string with multiple SQL-statements `parse_sql` method should return list
|
|
where each element represents the single SQL-statement
|
|
"""
|
|
|
|
from superset.db_engine_specs.base import BaseEngineSpec
|
|
|
|
queries = BaseEngineSpec.parse_sql("SELECT foo FROM tbl1; SELECT bar FROM tbl2;")
|
|
assert queries == [
|
|
"SELECT foo FROM tbl1",
|
|
"SELECT bar FROM tbl2",
|
|
]
|
|
|
|
|
|
def test_validate_db_uri(mocker: MockerFixture) -> None:
|
|
"""
|
|
Ensures that the `validate_database_uri` method invokes the validator correctly
|
|
"""
|
|
|
|
def mock_validate(sqlalchemy_uri: URL) -> None:
|
|
raise ValueError("Invalid URI")
|
|
|
|
mocker.patch(
|
|
"superset.db_engine_specs.base.current_app.config",
|
|
{"DB_SQLA_URI_VALIDATOR": mock_validate},
|
|
)
|
|
|
|
from superset.db_engine_specs.base import BaseEngineSpec
|
|
|
|
with pytest.raises(ValueError):
|
|
BaseEngineSpec.validate_database_uri(URL.create("sqlite"))
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"original,expected",
|
|
[
|
|
(
|
|
dedent(
|
|
"""
|
|
with currency as
|
|
(
|
|
select 'INR' as cur
|
|
)
|
|
select * from currency
|
|
"""
|
|
),
|
|
None,
|
|
),
|
|
(
|
|
"SELECT 1 as cnt",
|
|
None,
|
|
),
|
|
(
|
|
dedent(
|
|
"""
|
|
select 'INR' as cur
|
|
union
|
|
select 'AUD' as cur
|
|
union
|
|
select 'USD' as cur
|
|
"""
|
|
),
|
|
None,
|
|
),
|
|
],
|
|
)
|
|
def test_cte_query_parsing(original: types.TypeEngine, expected: str) -> None:
|
|
from superset.db_engine_specs.base import BaseEngineSpec
|
|
|
|
actual = BaseEngineSpec.get_cte_query(original)
|
|
assert actual == expected
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"native_type,sqla_type,attrs,generic_type,is_dttm",
|
|
[
|
|
("SMALLINT", types.SmallInteger, None, GenericDataType.NUMERIC, False),
|
|
("INTEGER", types.Integer, None, GenericDataType.NUMERIC, False),
|
|
("BIGINT", types.BigInteger, None, GenericDataType.NUMERIC, False),
|
|
("DECIMAL", types.Numeric, None, GenericDataType.NUMERIC, False),
|
|
("NUMERIC", types.Numeric, None, GenericDataType.NUMERIC, False),
|
|
("REAL", types.REAL, None, GenericDataType.NUMERIC, False),
|
|
("DOUBLE PRECISION", types.Float, None, GenericDataType.NUMERIC, False),
|
|
("MONEY", types.Numeric, None, GenericDataType.NUMERIC, False),
|
|
# String
|
|
("CHAR", types.String, None, GenericDataType.STRING, False),
|
|
("VARCHAR", types.String, None, GenericDataType.STRING, False),
|
|
("TEXT", types.String, None, GenericDataType.STRING, False),
|
|
# Temporal
|
|
("DATE", types.Date, None, GenericDataType.TEMPORAL, True),
|
|
("TIMESTAMP", types.TIMESTAMP, None, GenericDataType.TEMPORAL, True),
|
|
("TIME", types.Time, None, GenericDataType.TEMPORAL, True),
|
|
# Boolean
|
|
("BOOLEAN", types.Boolean, None, GenericDataType.BOOLEAN, False),
|
|
],
|
|
)
|
|
def test_get_column_spec(
|
|
native_type: str,
|
|
sqla_type: type[types.TypeEngine],
|
|
attrs: dict[str, Any] | None,
|
|
generic_type: GenericDataType,
|
|
is_dttm: bool,
|
|
) -> None:
|
|
from superset.db_engine_specs.databricks import DatabricksNativeEngineSpec as spec
|
|
|
|
assert_column_spec(spec, native_type, sqla_type, attrs, generic_type, is_dttm)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"cols, expected_result",
|
|
[
|
|
(
|
|
[SQLAColumnType(name="John", type="integer", is_dttm=False)],
|
|
[
|
|
ResultSetColumnType(
|
|
column_name="John", name="John", type="integer", is_dttm=False
|
|
)
|
|
],
|
|
),
|
|
(
|
|
[SQLAColumnType(name="hugh", type="integer", is_dttm=False)],
|
|
[
|
|
ResultSetColumnType(
|
|
column_name="hugh", name="hugh", type="integer", is_dttm=False
|
|
)
|
|
],
|
|
),
|
|
],
|
|
)
|
|
def test_convert_inspector_columns(
|
|
cols: list[SQLAColumnType], expected_result: list[ResultSetColumnType]
|
|
):
|
|
from superset.db_engine_specs.base import convert_inspector_columns
|
|
|
|
assert convert_inspector_columns(cols) == expected_result
|
|
|
|
|
|
def test_select_star(mocker: MockerFixture) -> None:
|
|
"""
|
|
Test the ``select_star`` method.
|
|
"""
|
|
from superset.db_engine_specs.base import BaseEngineSpec
|
|
|
|
class NoLimitDBEngineSpec(BaseEngineSpec):
|
|
allow_limit_clause = False
|
|
|
|
cols: list[ResultSetColumnType] = [
|
|
{
|
|
"column_name": "a",
|
|
"name": "a",
|
|
"type": sqltypes.String(),
|
|
"nullable": True,
|
|
"comment": None,
|
|
"default": None,
|
|
"precision": None,
|
|
"scale": None,
|
|
"max_length": None,
|
|
"is_dttm": False,
|
|
},
|
|
]
|
|
|
|
# mock the database so we can compile the query
|
|
database = mocker.MagicMock()
|
|
database.compile_sqla_query = lambda query: str(
|
|
query.compile(dialect=sqlite.dialect())
|
|
)
|
|
|
|
engine = mocker.MagicMock()
|
|
engine.dialect = sqlite.dialect()
|
|
|
|
sql = BaseEngineSpec.select_star(
|
|
database=database,
|
|
table=Table("my_table"),
|
|
engine=engine,
|
|
limit=100,
|
|
show_cols=True,
|
|
indent=True,
|
|
latest_partition=False,
|
|
cols=cols,
|
|
)
|
|
assert (
|
|
sql
|
|
== """SELECT
|
|
a
|
|
FROM my_table
|
|
LIMIT ?
|
|
OFFSET ?"""
|
|
)
|
|
|
|
sql = NoLimitDBEngineSpec.select_star(
|
|
database=database,
|
|
table=Table("my_table"),
|
|
engine=engine,
|
|
limit=100,
|
|
show_cols=True,
|
|
indent=True,
|
|
latest_partition=False,
|
|
cols=cols,
|
|
)
|
|
assert (
|
|
sql
|
|
== """SELECT
|
|
a
|
|
FROM my_table"""
|
|
)
|
|
|
|
|
|
def test_extra_table_metadata(mocker: MockerFixture) -> None:
|
|
"""
|
|
Test the deprecated `extra_table_metadata` method.
|
|
"""
|
|
from superset.db_engine_specs.base import BaseEngineSpec
|
|
from superset.models.core import Database
|
|
|
|
class ThirdPartyDBEngineSpec(BaseEngineSpec):
|
|
@classmethod
|
|
def extra_table_metadata(
|
|
cls,
|
|
database: Database,
|
|
table_name: str,
|
|
schema_name: str | None,
|
|
) -> dict[str, Any]:
|
|
return {"table": table_name, "schema": schema_name}
|
|
|
|
database = mocker.MagicMock()
|
|
warnings = mocker.patch("superset.db_engine_specs.base.warnings")
|
|
|
|
assert ThirdPartyDBEngineSpec.get_extra_table_metadata(
|
|
database,
|
|
Table("table", "schema"),
|
|
) == {"table": "table", "schema": "schema"}
|
|
|
|
assert (
|
|
ThirdPartyDBEngineSpec.get_extra_table_metadata(
|
|
database,
|
|
Table("table", "schema", "catalog"),
|
|
)
|
|
== {}
|
|
)
|
|
|
|
warnings.warn.assert_called()
|
|
|
|
|
|
def test_get_default_catalog(mocker: MockerFixture) -> None:
|
|
"""
|
|
Test the `get_default_catalog` method.
|
|
"""
|
|
from superset.db_engine_specs.base import BaseEngineSpec
|
|
|
|
database = mocker.MagicMock()
|
|
assert BaseEngineSpec.get_default_catalog(database) is None
|