mirror of
https://github.com/apache/superset.git
synced 2024-09-18 11:39:49 -04:00
fc5e311842
* add tests for PostgresEngineSpec.estimate_statement_cost * add tests for PostgresEngineSpec.query_cost_formatter * fix docstring * fix dependency * fix raise SyntaxError
205 lines
7.7 KiB
Python
205 lines
7.7 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.
|
|
from unittest import mock
|
|
|
|
from sqlalchemy import column, literal_column
|
|
from sqlalchemy.dialects import postgresql
|
|
|
|
from superset.db_engine_specs import engines
|
|
from superset.db_engine_specs.postgres import PostgresEngineSpec
|
|
from tests.db_engine_specs.base_tests import TestDbEngineSpec
|
|
from tests.fixtures.certificates import ssl_certificate
|
|
from tests.fixtures.database import default_db_extra
|
|
|
|
|
|
class TestPostgresDbEngineSpec(TestDbEngineSpec):
|
|
def test_get_table_names(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test get table names
|
|
"""
|
|
|
|
""" Make sure postgres doesn't try to remove schema name from table name
|
|
ie. when try_remove_schema_from_table_name == False. """
|
|
inspector = mock.Mock()
|
|
inspector.get_table_names = mock.Mock(return_value=["schema.table", "table_2"])
|
|
inspector.get_foreign_table_names = mock.Mock(return_value=["table_3"])
|
|
|
|
pg_result_expected = ["schema.table", "table_2", "table_3"]
|
|
pg_result = PostgresEngineSpec.get_table_names(
|
|
database=mock.ANY, schema="schema", inspector=inspector
|
|
)
|
|
self.assertListEqual(pg_result_expected, pg_result)
|
|
|
|
def test_time_exp_literal_no_grain(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test no grain literal column
|
|
"""
|
|
col = literal_column("COALESCE(a, b)")
|
|
expr = PostgresEngineSpec.get_timestamp_expr(col, None, None)
|
|
result = str(expr.compile(None, dialect=postgresql.dialect()))
|
|
self.assertEqual(result, "COALESCE(a, b)")
|
|
|
|
def test_time_exp_literal_1y_grain(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test grain literal column 1 YEAR
|
|
"""
|
|
col = literal_column("COALESCE(a, b)")
|
|
expr = PostgresEngineSpec.get_timestamp_expr(col, None, "P1Y")
|
|
result = str(expr.compile(None, dialect=postgresql.dialect()))
|
|
self.assertEqual(result, "DATE_TRUNC('year', COALESCE(a, b))")
|
|
|
|
def test_time_ex_lowr_col_no_grain(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test no grain expr lower case
|
|
"""
|
|
col = column("lower_case")
|
|
expr = PostgresEngineSpec.get_timestamp_expr(col, None, None)
|
|
result = str(expr.compile(None, dialect=postgresql.dialect()))
|
|
self.assertEqual(result, "lower_case")
|
|
|
|
def test_time_exp_lowr_col_sec_1y(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test grain expr lower case 1 YEAR
|
|
"""
|
|
col = column("lower_case")
|
|
expr = PostgresEngineSpec.get_timestamp_expr(col, "epoch_s", "P1Y")
|
|
result = str(expr.compile(None, dialect=postgresql.dialect()))
|
|
self.assertEqual(
|
|
result,
|
|
"DATE_TRUNC('year', "
|
|
"(timestamp 'epoch' + lower_case * interval '1 second'))",
|
|
)
|
|
|
|
def test_time_exp_mixd_case_col_1y(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test grain expr mixed case 1 YEAR
|
|
"""
|
|
col = column("MixedCase")
|
|
expr = PostgresEngineSpec.get_timestamp_expr(col, None, "P1Y")
|
|
result = str(expr.compile(None, dialect=postgresql.dialect()))
|
|
self.assertEqual(result, "DATE_TRUNC('year', \"MixedCase\")")
|
|
|
|
def test_convert_dttm(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test conversion to date time
|
|
"""
|
|
dttm = self.get_dttm()
|
|
|
|
self.assertEqual(
|
|
PostgresEngineSpec.convert_dttm("DATE", dttm),
|
|
"TO_DATE('2019-01-02', 'YYYY-MM-DD')",
|
|
)
|
|
|
|
self.assertEqual(
|
|
PostgresEngineSpec.convert_dttm("TIMESTAMP", dttm),
|
|
"TO_TIMESTAMP('2019-01-02 03:04:05.678900', 'YYYY-MM-DD HH24:MI:SS.US')",
|
|
)
|
|
|
|
self.assertEqual(PostgresEngineSpec.convert_dttm("DATETIME", dttm), None)
|
|
|
|
def test_empty_dbapi_cursor_description(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test empty cursor description (no columns)
|
|
"""
|
|
cursor = mock.Mock()
|
|
# empty description mean no columns, this mocks the following SQL: "SELECT"
|
|
cursor.description = []
|
|
results = PostgresEngineSpec.fetch_data(cursor, 1000)
|
|
self.assertEqual(results, [])
|
|
|
|
def test_engine_alias_name(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test "postgres" in engine spec
|
|
"""
|
|
self.assertIn("postgres", engines)
|
|
|
|
def test_extras_without_ssl(self):
|
|
db = mock.Mock()
|
|
db.extra = default_db_extra
|
|
db.server_cert = None
|
|
extras = PostgresEngineSpec.get_extra_params(db)
|
|
assert "connect_args" not in extras["engine_params"]
|
|
|
|
def test_extras_with_ssl_default(self):
|
|
db = mock.Mock()
|
|
db.extra = default_db_extra
|
|
db.server_cert = ssl_certificate
|
|
extras = PostgresEngineSpec.get_extra_params(db)
|
|
connect_args = extras["engine_params"]["connect_args"]
|
|
assert connect_args["sslmode"] == "verify-full"
|
|
assert "sslrootcert" in connect_args
|
|
|
|
def test_extras_with_ssl_custom(self):
|
|
db = mock.Mock()
|
|
db.extra = default_db_extra.replace(
|
|
'"engine_params": {}',
|
|
'"engine_params": {"connect_args": {"sslmode": "verify-ca"}}',
|
|
)
|
|
db.server_cert = ssl_certificate
|
|
extras = PostgresEngineSpec.get_extra_params(db)
|
|
connect_args = extras["engine_params"]["connect_args"]
|
|
assert connect_args["sslmode"] == "verify-ca"
|
|
assert "sslrootcert" in connect_args
|
|
|
|
def test_estimate_statement_cost_select_star(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test estimate_statement_cost select star
|
|
"""
|
|
|
|
cursor = mock.Mock()
|
|
cursor.fetchone.return_value = (
|
|
"Seq Scan on birth_names (cost=0.00..1537.91 rows=75691 width=46)",
|
|
)
|
|
sql = "SELECT * FROM birth_names"
|
|
results = PostgresEngineSpec.estimate_statement_cost(sql, cursor)
|
|
self.assertEqual(results, {"Start-up cost": 0.00, "Total cost": 1537.91,})
|
|
|
|
def test_estimate_statement_invalid_syntax(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test estimate_statement_cost invalid syntax
|
|
"""
|
|
from psycopg2 import errors
|
|
|
|
cursor = mock.Mock()
|
|
cursor.execute.side_effect = errors.SyntaxError(
|
|
"""
|
|
syntax error at or near "EXPLAIN"
|
|
LINE 1: EXPLAIN DROP TABLE birth_names
|
|
^
|
|
"""
|
|
)
|
|
sql = "DROP TABLE birth_names"
|
|
with self.assertRaises(errors.SyntaxError):
|
|
PostgresEngineSpec.estimate_statement_cost(sql, cursor)
|
|
|
|
def test_query_cost_formatter_example_costs(self):
|
|
"""
|
|
DB Eng Specs (postgres): Test test_query_cost_formatter example costs
|
|
"""
|
|
raw_cost = [
|
|
{"Start-up cost": 0.00, "Total cost": 1537.91,},
|
|
{"Start-up cost": 10.00, "Total cost": 1537.00,},
|
|
]
|
|
result = PostgresEngineSpec.query_cost_formatter(raw_cost)
|
|
self.assertEqual(
|
|
result,
|
|
[
|
|
{"Start-up cost": "0.0", "Total cost": "1537.91",},
|
|
{"Start-up cost": "10.0", "Total cost": "1537.0",},
|
|
],
|
|
)
|