villebro commented on code in PR #24918: URL: https://github.com/apache/superset/pull/24918#discussion_r1291507209
########## superset/cli/test_db.py: ########## @@ -0,0 +1,417 @@ +# 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 sys +from collections import defaultdict +from datetime import datetime +from typing import Any, Callable + +import click +import yaml +from rich.console import Console +from sqlalchemy import ( + Column, + create_engine, + DateTime, + ForeignKey, + insert, + Integer, + MetaData, + select, + String, + Table, +) +from sqlalchemy.engine import Engine +from sqlalchemy.exc import NoSuchModuleError + +from superset.databases.utils import make_url_safe +from superset.db_engine_specs import load_engine_specs +from superset.db_engine_specs.base import BaseEngineSpec +from superset.db_engine_specs.lib import ( + ADVANCED_FEATURES, + BASIC_FEATURES, + DATABASE_DETAILS, + diagnose, + LIMIT_METHODS, + NICE_TO_HAVE_FEATURES, +) + +metadata_obj = MetaData() + +user = Table( + "user", + metadata_obj, + Column("user_id", Integer, primary_key=True), + Column("user_name", String(16), nullable=False), + Column("email_address", String(60), key="email"), + Column("nickname", String(50), nullable=False), +) + +user_prefs = Table( + "user_prefs", + metadata_obj, + Column("pref_id", Integer, primary_key=True), + Column("user_id", Integer, ForeignKey("user.user_id"), nullable=False), + Column("pref_name", String(40), nullable=False), + Column("pref_value", String(100)), +) + + +TestType = Callable[[Console, Engine], None] + + +class TestRegistry: + def __init__(self) -> None: + self.tests: dict[str, Any] = defaultdict(list) + + def add(self, *dialects: str) -> Callable[[TestType], TestType]: + def decorator(func: TestType) -> TestType: + for dialect in dialects: + self.tests[dialect].append(func) + + return func + + return decorator + + def get_tests(self, dialect: str) -> list[TestType]: + return self.tests[dialect] + + +registry = TestRegistry() + + [email protected]("sqlite", "postgresql") +def test_datetime(console: Console, engine: Engine) -> None: + """ + Create a table with a timestamp column. + """ + console.print("[bold]Testing datetime support...") + + md = MetaData() + table = Table( + "test", + md, + Column("ts", DateTime), + ) + + try: + console.print("Creating a table with a timestamp column...") + md.create_all(engine) + console.print("[green]Table created!") + + now = datetime.now() + + console.print("Inserting timestamp value...") + stmt = insert(table).values(ts=now) + engine.execute(stmt) + + console.print("Reading timestamp value...") + stmt = select(table) + row = engine.execute(stmt).fetchone() + assert row[0] == now + console.print(":thumbs_up: [green]Succcess!") + except Exception as ex: # pylint: disable=broad-except + console.print(f"[red]Test failed: {ex}") + console.print("[bold]Exiting...") + sys.exit(1) + + [email protected]() [email protected]("sqlalchemy_uri") [email protected]( + "--connect-args", + "-c", + "raw_connect_args", + help="Connect args as JSON or YAML", +) +def test_db(sqlalchemy_uri: str, raw_connect_args: str | None = None) -> None: + """ + Run a series of tests against an analytics database. Review Comment: nit: I believe we refer to "analytical databases" elsewhere: ```suggestion Run a series of tests against an analytical database. ``` ########## superset/cli/test_db.py: ########## @@ -0,0 +1,417 @@ +# 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 sys +from collections import defaultdict +from datetime import datetime +from typing import Any, Callable + +import click +import yaml +from rich.console import Console +from sqlalchemy import ( + Column, + create_engine, + DateTime, + ForeignKey, + insert, + Integer, + MetaData, + select, + String, + Table, +) +from sqlalchemy.engine import Engine +from sqlalchemy.exc import NoSuchModuleError + +from superset.databases.utils import make_url_safe +from superset.db_engine_specs import load_engine_specs +from superset.db_engine_specs.base import BaseEngineSpec +from superset.db_engine_specs.lib import ( + ADVANCED_FEATURES, + BASIC_FEATURES, + DATABASE_DETAILS, + diagnose, + LIMIT_METHODS, + NICE_TO_HAVE_FEATURES, +) + +metadata_obj = MetaData() + +user = Table( + "user", Review Comment: To limit the risk of collisions with pre-existing tables and make it easier to identify the table if it's left dangling, maybe we could add some prefix, like `tmp_superset_test_table_user`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
