mirror of
https://github.com/apache/superset.git
synced 2026-09-06 07:21:35 +00:00
Superset Dev
051105098c
Pilot for real-container testing of db_engine_specs against actual databases (CockroachDB, CrateDB, Trino), via testcontainers-python. Existing unit tests mock the driver/dialect layer entirely, which cannot catch real SQL-compilation or type-mapping bugs -- e.g. #42899, where Trino emitted OFFSET before LIMIT for paginated queries. Runs nightly (.github/workflows/nightly-testcontainers.yml), not on every merge: container pulls and startup are slower and more flake-prone than the existing mocked unit tests, and this measures that cost/signal tradeoff before considering wider adoption. Building this surfaced two real bugs, fixed/documented separately: - The cockroachdb dialect was completely broken under SQLAlchemy 2.0 due to a dead upstream package -- fixed in #43501. - testcontainers-python's TrinoContainer.get_connection_url() returns the container-internal port instead of the Docker-mapped host port; worked around locally, filed upstream.
104 lines
3.6 KiB
Python
104 lines
3.6 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.
|
|
"""
|
|
Tests db_engine_specs.cockroachdb against a real CockroachDB instance,
|
|
spun up on demand via testcontainers. Run nightly (see
|
|
.github/workflows/nightly-testcontainers.yml), not on every merge -- these
|
|
exercise real SQL execution and dialect introspection, which mocked unit
|
|
tests structurally cannot.
|
|
"""
|
|
|
|
from collections.abc import Iterator
|
|
|
|
import pytest
|
|
from sqlalchemy import (
|
|
Column,
|
|
create_engine,
|
|
insert,
|
|
inspect,
|
|
Integer,
|
|
MetaData,
|
|
select,
|
|
Table as SATable,
|
|
)
|
|
from sqlalchemy.engine import Engine
|
|
|
|
from superset.db_engine_specs.cockroachdb import CockroachDbEngineSpec
|
|
from superset.sql.parse import Table
|
|
|
|
pytest.importorskip("testcontainers.community.cockroachdb")
|
|
|
|
from testcontainers.community.cockroachdb import CockroachDBContainer # noqa: E402
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def engine() -> Iterator[Engine]:
|
|
# sqlalchemy-cockroachdb registers its dialect under the plain
|
|
# "cockroachdb" name; the container's own default ("cockroachdb+psycopg2")
|
|
# matches the abandoned `cockroachdb` package instead (see #43501).
|
|
with CockroachDBContainer(dialect="cockroachdb") as container:
|
|
yield create_engine(container.get_connection_url())
|
|
|
|
|
|
def test_paginated_query_returns_correct_rows_in_order(engine: Engine) -> None:
|
|
"""
|
|
A plain SQLAlchemy Core LIMIT/OFFSET query, compiled and executed against
|
|
a real instance. Mocked tests cannot catch a dialect compiling this
|
|
incorrectly (see apache/superset#42899, where Trino emitted OFFSET
|
|
before LIMIT) -- only real execution can.
|
|
"""
|
|
metadata = MetaData()
|
|
t = SATable(
|
|
"pilot_pagination",
|
|
metadata,
|
|
Column("id", Integer, primary_key=True),
|
|
)
|
|
metadata.create_all(engine)
|
|
with engine.begin() as conn:
|
|
conn.execute(insert(t), [{"id": i} for i in range(10)])
|
|
|
|
with engine.connect() as conn:
|
|
stmt = select(t.c.id).order_by(t.c.id).limit(3).offset(4)
|
|
rows = conn.execute(stmt).fetchall()
|
|
|
|
assert [row.id for row in rows] == [4, 5, 6]
|
|
|
|
|
|
def test_get_columns_maps_native_types(engine: Engine) -> None:
|
|
"""
|
|
CockroachDbEngineSpec.get_columns wraps a real SQLAlchemy Inspector;
|
|
this exercises that against actual server-reported column metadata
|
|
rather than a mocked Inspector.
|
|
"""
|
|
metadata = MetaData()
|
|
SATable(
|
|
"pilot_types",
|
|
metadata,
|
|
Column("id", Integer, primary_key=True),
|
|
Column("amount", Integer),
|
|
)
|
|
metadata.create_all(engine)
|
|
|
|
inspector = inspect(engine)
|
|
columns = CockroachDbEngineSpec.get_columns(inspector, Table("pilot_types"))
|
|
|
|
by_name = {col["column_name"]: col for col in columns}
|
|
assert set(by_name) == {"id", "amount"}
|
|
for col in by_name.values():
|
|
spec = CockroachDbEngineSpec.get_column_spec(str(col["type"]))
|
|
assert spec is not None
|