Files
sqlalchemy/test/sql/test_from_linter.py
T
Federico Caselli 9ec7588220 Deprecate plain string in execute and introduce exec_driver_sql
Execution of literal sql string is deprecated in the
:meth:`.Connection.execute` and a warning is raised when used stating
that it will be coerced to :func:`.text` in a future release.
To execute a raw sql string the new connection method
:meth:`.Connection.exec_driver_sql` was added, that will retain the previous
behavior, passing the string to the DBAPI driver unchanged.
Usage of scalar or tuple positional parameters in :meth:`.Connection.execute`
is also deprecated.

Fixes: #4848
Fixes: #5178
Change-Id: I2830181054327996d594f7f0d59c157d477c3aa9
2020-03-21 17:03:45 -04:00

278 lines
9.5 KiB
Python

from sqlalchemy import Integer
from sqlalchemy import select
from sqlalchemy import sql
from sqlalchemy import true
from sqlalchemy.testing import config
from sqlalchemy.testing import engines
from sqlalchemy.testing import expect_warnings
from sqlalchemy.testing import fixtures
from sqlalchemy.testing import is_
from sqlalchemy.testing.schema import Column
from sqlalchemy.testing.schema import Table
def find_unmatching_froms(query, start=None):
compiled = query.compile(linting=sql.COLLECT_CARTESIAN_PRODUCTS)
return compiled.from_linter.lint(start)
class TestFindUnmatchingFroms(fixtures.TablesTest):
@classmethod
def define_tables(cls, metadata):
Table("table_a", metadata, Column("col_a", Integer, primary_key=True))
Table("table_b", metadata, Column("col_b", Integer, primary_key=True))
Table("table_c", metadata, Column("col_c", Integer, primary_key=True))
Table("table_d", metadata, Column("col_d", Integer, primary_key=True))
def setup(self):
self.a = self.tables.table_a
self.b = self.tables.table_b
self.c = self.tables.table_c
self.d = self.tables.table_d
def test_everything_is_connected(self):
query = (
select([self.a])
.select_from(self.a.join(self.b, self.a.c.col_a == self.b.c.col_b))
.select_from(self.c)
.select_from(self.d)
.where(self.d.c.col_d == self.b.c.col_b)
.where(self.c.c.col_c == self.d.c.col_d)
.where(self.c.c.col_c == 5)
)
froms, start = find_unmatching_froms(query)
assert not froms
for start in self.a, self.b, self.c, self.d:
froms, start = find_unmatching_froms(query, start)
assert not froms
def test_plain_cartesian(self):
query = select([self.a]).where(self.b.c.col_b == 5)
froms, start = find_unmatching_froms(query, self.a)
assert start == self.a
assert froms == {self.b}
froms, start = find_unmatching_froms(query, self.b)
assert start == self.b
assert froms == {self.a}
def test_count_non_eq_comparison_operators(self):
query = select([self.a]).where(self.a.c.col_a > self.b.c.col_b)
froms, start = find_unmatching_froms(query, self.a)
is_(start, None)
is_(froms, None)
def test_dont_count_non_comparison_operators(self):
query = select([self.a]).where(self.a.c.col_a + self.b.c.col_b == 5)
froms, start = find_unmatching_froms(query, self.a)
assert start == self.a
assert froms == {self.b}
def test_disconnect_between_ab_cd(self):
query = (
select([self.a])
.select_from(self.a.join(self.b, self.a.c.col_a == self.b.c.col_b))
.select_from(self.c)
.select_from(self.d)
.where(self.c.c.col_c == self.d.c.col_d)
.where(self.c.c.col_c == 5)
)
for start in self.a, self.b:
froms, start = find_unmatching_froms(query, start)
assert start == start
assert froms == {self.c, self.d}
for start in self.c, self.d:
froms, start = find_unmatching_froms(query, start)
assert start == start
assert froms == {self.a, self.b}
def test_c_and_d_both_disconnected(self):
query = (
select([self.a])
.select_from(self.a.join(self.b, self.a.c.col_a == self.b.c.col_b))
.where(self.c.c.col_c == 5)
.where(self.d.c.col_d == 10)
)
for start in self.a, self.b:
froms, start = find_unmatching_froms(query, start)
assert start == start
assert froms == {self.c, self.d}
froms, start = find_unmatching_froms(query, self.c)
assert start == self.c
assert froms == {self.a, self.b, self.d}
froms, start = find_unmatching_froms(query, self.d)
assert start == self.d
assert froms == {self.a, self.b, self.c}
def test_now_connected(self):
query = (
select([self.a])
.select_from(self.a.join(self.b, self.a.c.col_a == self.b.c.col_b))
.select_from(self.c.join(self.d, self.c.c.col_c == self.d.c.col_d))
.where(self.c.c.col_c == self.b.c.col_b)
.where(self.c.c.col_c == 5)
.where(self.d.c.col_d == 10)
)
froms, start = find_unmatching_froms(query)
assert not froms
for start in self.a, self.b, self.c, self.d:
froms, start = find_unmatching_froms(query, start)
assert not froms
def test_disconnected_subquery(self):
subq = (
select([self.a]).where(self.a.c.col_a == self.b.c.col_b).subquery()
)
stmt = select([self.c]).select_from(subq)
froms, start = find_unmatching_froms(stmt, self.c)
assert start == self.c
assert froms == {subq}
froms, start = find_unmatching_froms(stmt, subq)
assert start == subq
assert froms == {self.c}
def test_now_connect_it(self):
subq = (
select([self.a]).where(self.a.c.col_a == self.b.c.col_b).subquery()
)
stmt = (
select([self.c])
.select_from(subq)
.where(self.c.c.col_c == subq.c.col_a)
)
froms, start = find_unmatching_froms(stmt)
assert not froms
for start in self.c, subq:
froms, start = find_unmatching_froms(stmt, start)
assert not froms
def test_right_nested_join_without_issue(self):
query = select([self.a]).select_from(
self.a.join(
self.b.join(self.c, self.b.c.col_b == self.c.c.col_c),
self.a.c.col_a == self.b.c.col_b,
)
)
froms, start = find_unmatching_froms(query)
assert not froms
for start in self.a, self.b, self.c:
froms, start = find_unmatching_froms(query, start)
assert not froms
def test_join_on_true(self):
# test that a join(a, b) counts a->b as an edge even if there isn't
# actually a join condition. this essentially allows a cartesian
# product to be added explicitly.
query = select([self.a]).select_from(self.a.join(self.b, true()))
froms, start = find_unmatching_froms(query)
assert not froms
def test_right_nested_join_with_an_issue(self):
query = (
select([self.a])
.select_from(
self.a.join(
self.b.join(self.c, self.b.c.col_b == self.c.c.col_c),
self.a.c.col_a == self.b.c.col_b,
)
)
.where(self.d.c.col_d == 5)
)
for start in self.a, self.b, self.c:
froms, start = find_unmatching_froms(query, start)
assert start == start
assert froms == {self.d}
froms, start = find_unmatching_froms(query, self.d)
assert start == self.d
assert froms == {self.a, self.b, self.c}
def test_no_froms(self):
query = select([1])
froms, start = find_unmatching_froms(query)
assert not froms
class TestLinter(fixtures.TablesTest):
@classmethod
def define_tables(cls, metadata):
Table("table_a", metadata, Column("col_a", Integer, primary_key=True))
Table("table_b", metadata, Column("col_b", Integer, primary_key=True))
@classmethod
def setup_bind(cls):
# from linting is enabled by default
return config.db
def test_noop_for_unhandled_objects(self):
with self.bind.connect() as conn:
conn.exec_driver_sql("SELECT 1;").fetchone()
def test_does_not_modify_query(self):
with self.bind.connect() as conn:
[result] = conn.execute(select([1])).fetchone()
assert result == 1
def test_warn_simple(self):
a, b = self.tables("table_a", "table_b")
query = select([a.c.col_a]).where(b.c.col_b == 5)
with expect_warnings(
r"SELECT statement has a cartesian product between FROM "
r'element\(s\) "table_[ab]" '
r'and FROM element "table_[ba]"'
):
with self.bind.connect() as conn:
conn.execute(query)
def test_warn_anon_alias(self):
a, b = self.tables("table_a", "table_b")
b_alias = b.alias()
query = select([a.c.col_a]).where(b_alias.c.col_b == 5)
with expect_warnings(
r"SELECT statement has a cartesian product between FROM "
r'element\(s\) "table_(?:a|b_1)" '
r'and FROM element "table_(?:a|b_1)"'
):
with self.bind.connect() as conn:
conn.execute(query)
def test_warn_anon_cte(self):
a, b = self.tables("table_a", "table_b")
b_cte = select([b]).cte()
query = select([a.c.col_a]).where(b_cte.c.col_b == 5)
with expect_warnings(
r"SELECT statement has a cartesian product between "
r"FROM element\(s\) "
r'"(?:anon_1|table_a)" '
r'and FROM element "(?:anon_1|table_a)"'
):
with self.bind.connect() as conn:
conn.execute(query)
def test_no_linting(self):
eng = engines.testing_engine(options={"enable_from_linting": False})
eng.pool = self.bind.pool # needed for SQLite
a, b = self.tables("table_a", "table_b")
query = select([a.c.col_a]).where(b.c.col_b == 5)
with eng.connect() as conn:
conn.execute(query)