Skip to content
GitLab
Commit a26de332 authored by Thomas Goirand's avatar Thomas Goirand
Browse files

Merge tag '12.1.0' into debian/zed 

oslo.db 12.1.0 release

meta:version: 12.1.0
meta:diff-start: -
meta:series: zed
meta:release-type: release
meta:pypi: yes
meta:first: no
meta:release:Author: Elod Illes <elod.illes@est.tech>
meta:release:Commit: Elod Illes <elod.illes@est.tech>
meta:release:Change-Id: I950a1a790e12e2dde82a912cbb1662b0b8d1bc0d
meta:release:Code-Review+1: Daniel Bengtsson <dbengt@redhat.com>
meta:release:Code-Review+2: Hervé Beraud <herveberaud.pro@gmail.com>
meta:release:Code-Review+2: Elod Illes <elod.illes@est.tech>
meta:release:Workflow+1: Elod Illes <elod.illes@est.tech>
parents 73bd2dce 7f3647bf
Hide whitespace changes
Inline Side-by-side
oslo_db/sqlalchemy/enginefacade.py
View file @ a26de332
......@@ -163,7 +163,7 @@ class _TransactionFactory(object):
}
self._maker_cfg = {
'expire_on_commit': _Default(False),
'__autocommit': True
'__autocommit': False,
}
self._transaction_ctx_cfg = {
'rollback_reader_sessions': False,
......@@ -1266,13 +1266,22 @@ class LegacyEngineFacade(object):
"""
def __init__(self, sql_connection, slave_connection=None,
sqlite_fk=False, autocommit=True,
sqlite_fk=False, autocommit=False,
expire_on_commit=False, _conf=None, _factory=None, **kwargs):
warnings.warn(
"EngineFacade is deprecated; please use "
"oslo_db.sqlalchemy.enginefacade",
warning.OsloDBDeprecationWarning,
stacklevel=2)
if autocommit is True:
warnings.warn(
'autocommit support will be removed in SQLAlchemy 2.0 and '
'should not be relied on; please rework your code to remove '
'reliance on this feature',
warning.OsloDBDeprecationWarning,
stacklevel=2)
if _factory:
self._factory = _factory
else:
......@@ -1346,7 +1355,7 @@ class LegacyEngineFacade(object):
@classmethod
def from_config(cls, conf,
sqlite_fk=False, autocommit=True, expire_on_commit=False):
sqlite_fk=False, autocommit=False, expire_on_commit=False):
"""Initialize EngineFacade using oslo.config config instance options.
:param conf: oslo.config config instance
......
oslo_db/sqlalchemy/orm.py
View file @ a26de332
......@@ -57,7 +57,7 @@ class Session(sqlalchemy.orm.session.Session):
"""oslo.db-specific Session subclass."""
def get_maker(engine, autocommit=True, expire_on_commit=False):
def get_maker(engine, autocommit=False, expire_on_commit=False):
"""Return a SQLAlchemy sessionmaker using the given engine."""
return sqlalchemy.orm.sessionmaker(bind=engine,
class_=Session,
......
oslo_db/sqlalchemy/test_migrations.py
View file @ a26de332
......@@ -77,7 +77,8 @@ class WalkVersionsMixin(object, metaclass=abc.ABCMeta):
"""
@abc.abstractproperty
@property
@abc.abstractmethod
def INIT_VERSION(self):
"""Initial version of a migration repository.
......@@ -87,7 +88,8 @@ class WalkVersionsMixin(object, metaclass=abc.ABCMeta):
"""
pass
@abc.abstractproperty
@property
@abc.abstractmethod
def REPOSITORY(self):
"""Allows basic manipulation with migration repository.
......@@ -95,7 +97,8 @@ class WalkVersionsMixin(object, metaclass=abc.ABCMeta):
"""
pass
@abc.abstractproperty
@property
@abc.abstractmethod
def migration_api(self):
"""Provides API for upgrading, downgrading and version manipulations.
......@@ -103,7 +106,8 @@ class WalkVersionsMixin(object, metaclass=abc.ABCMeta):
"""
pass
@abc.abstractproperty
@property
@abc.abstractmethod
def migrate_engine(self):
"""Provides engine instance.
......
oslo_db/sqlalchemy/utils.py
View file @ a26de332
......@@ -39,6 +39,7 @@ from sqlalchemy import Index
from sqlalchemy import inspect
from sqlalchemy import Integer
from sqlalchemy import MetaData
from sqlalchemy import PrimaryKeyConstraint
from sqlalchemy.sql.expression import cast
from sqlalchemy.sql.expression import literal_column
from sqlalchemy.sql import text
......@@ -608,7 +609,14 @@ def _change_deleted_column_type_to_boolean_sqlite(engine, table_name,
# FIXME(stephenfin): We shouldn't be using this private API;
# figure out how else to copy an arbitrary column schema
constraints = [constraint._copy() for constraint in table.constraints]
# NOTE(stephenfin): We drop PrimaryKeyConstraint-type constraints since
# these duplicate the 'primary_key=True' attribute on the speicified
# column(s). This technically breaks things when the primary key covers
# multiple columns but that's okay: these are deprecated APIs
constraints = [
constraint._copy() for constraint in table.constraints
if not isinstance(constraint, PrimaryKeyConstraint)
]
with engine.connect() as conn:
meta = table.metadata
......@@ -738,7 +746,10 @@ def _change_deleted_column_type_to_id_type_sqlite(engine, table_name,
constraints = []
for constraint in table.constraints:
if not _is_deleted_column_constraint(constraint):
if not (
_is_deleted_column_constraint(constraint) or
isinstance(constraint, PrimaryKeyConstraint)
):
# FIXME(stephenfin): We shouldn't be using this private API;
# figure out how else to copy an arbitrary constraint schema
constraints.append(constraint._copy())
......@@ -749,7 +760,8 @@ def _change_deleted_column_type_to_id_type_sqlite(engine, table_name,
with conn.begin():
new_table = Table(
table_name + "__tmp__", meta,
*(columns + constraints))
*(columns + constraints),
)
new_table.create(conn)
indexes = []
......@@ -1162,7 +1174,9 @@ def get_non_ndbcluster_tables(connectable, skip_tables=None):
params['database'] = connectable.engine.url.database
query = text(query_str)
nonndbcluster = connectable.execute(query, **params)
# TODO(stephenfin): What about if this is already a Connection?
with connectable.connect() as conn, conn.begin():
nonndbcluster = connectable.execute(query, **params)
return [i[0] for i in nonndbcluster]
......
oslo_db/tests/fixtures.py
View file @ a26de332
......@@ -24,28 +24,28 @@ class WarningsFixture(fixtures.Fixture):
self._original_warning_filters = warnings.filters[:]
# Make deprecation warnings only happen once to avoid spamming
warnings.simplefilter('once', DeprecationWarning)
# Except things we've deprecated but are still testing until removal
warnings.filterwarnings(
'error', message='Evaluating non-mapped column expression',
category=sqla_exc.SAWarning)
'ignore',
category=DeprecationWarning,
module='oslo_db')
# Enable deprecation warnings to capture upcoming SQLAlchemy changes
# Enable generic warnings to ensure we're not doing anything odd
warnings.filterwarnings(
'error',
category=sqla_exc.SADeprecationWarning)
category=sqla_exc.SAWarning)
# ...but filter everything out until we get around to fixing them
# FIXME(stephenfin): Remove all of these
# Enable deprecation warnings to capture upcoming SQLAlchemy changes
warnings.filterwarnings(
'once',
message=r'The Session.autocommit parameter is deprecated .*',
'error',
category=sqla_exc.SADeprecationWarning)
# ...plus things that aren't our fault
# ...but filter things that aren't our fault
# FIXME(stephenfin): These are caused by sqlalchemy-migrate, not us,
# and should be removed when we drop support for that library
......
oslo_db/tests/sqlalchemy/test_enginefacade.py
View file @ a26de332
......@@ -357,11 +357,11 @@ class MockFacadeTest(test_base.BaseTestCase):
maker_factories = mock.Mock(side_effect=get_maker)
maker_factories(
autocommit=True, engine=engines.writer,
autocommit=False, engine=engines.writer,
expire_on_commit=False)
if self.slave_uri:
maker_factories(
autocommit=True, engine=engines.async_reader,
autocommit=False, engine=engines.async_reader,
expire_on_commit=False)
yield makers
......@@ -1692,11 +1692,12 @@ class LiveFacadeTest(db_test_base._DbTestCase):
with enginefacade.writer.using(context) as session:
session.add(self.User(name="u1"))
session = self.sessionmaker(autocommit=True)
self.assertEqual(
"u1",
session.query(self.User.name).scalar()
)
session = self.sessionmaker(autocommit=False)
with session.begin():
self.assertEqual(
"u1",
session.query(self.User.name).scalar()
)
def test_transaction_rollback(self):
context = oslo_context.RequestContext()
......@@ -1712,11 +1713,12 @@ class LiveFacadeTest(db_test_base._DbTestCase):
self.assertRaises(MyException, go, context)
session = self.sessionmaker(autocommit=True)
self.assertEqual(
None,
session.query(self.User.name).scalar()
)
session = self.sessionmaker(autocommit=False)
with session.begin():
self.assertEqual(
None,
session.query(self.User.name).scalar()
)
@mock.patch.object(Session, 'commit')
@mock.patch.object(Session, 'rollback')
......@@ -1783,11 +1785,12 @@ class LiveFacadeTest(db_test_base._DbTestCase):
s2.add(self.User(name="u1"))
s2.flush()
session = self.sessionmaker(autocommit=True)
self.assertEqual(
"u1",
session.query(self.User.name).scalar()
)
session = self.sessionmaker(autocommit=False)
with session.begin():
self.assertEqual(
"u1",
session.query(self.User.name).scalar()
)
def test_context_deepcopy_on_connection(self):
context = oslo_context.RequestContext()
......@@ -1804,11 +1807,12 @@ class LiveFacadeTest(db_test_base._DbTestCase):
self._assert_ctx_connection(ctx2, conn2)
session = self.sessionmaker(autocommit=True)
self.assertEqual(
"u1",
session.query(self.User.name).scalar()
)
session = self.sessionmaker(autocommit=False)
with session.begin():
self.assertEqual(
"u1",
session.query(self.User.name).scalar()
)
@db_test_base.backend_specific("postgresql", "mysql")
def test_external_session_transaction(self):
......@@ -1840,14 +1844,14 @@ class LiveFacadeTest(db_test_base._DbTestCase):
session.begin()
session.add(self.User(name="u4"))
session = self.sessionmaker(autocommit=True)
session = self.sessionmaker(autocommit=False)
# inner transaction + second part of "outer" transaction were committed
self.assertEqual(
[("u2",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
with session.begin():
self.assertEqual(
[("u2",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
def test_savepoint_transaction_decorator(self):
context = oslo_context.RequestContext()
......@@ -1880,14 +1884,14 @@ class LiveFacadeTest(db_test_base._DbTestCase):
go1(context)
session = self.sessionmaker(autocommit=True)
session = self.sessionmaker(autocommit=False)
# inner transaction + second part of "outer" transaction were committed
self.assertEqual(
[("u1",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
with session.begin():
self.assertEqual(
[("u1",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
def test_savepoint_transaction(self):
context = oslo_context.RequestContext()
......@@ -1908,14 +1912,14 @@ class LiveFacadeTest(db_test_base._DbTestCase):
session.add(self.User(name="u4"))
session = self.sessionmaker(autocommit=True)
session = self.sessionmaker(autocommit=False)
# inner transaction + second part of "outer" transaction were committed
self.assertEqual(
[("u1",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
with session.begin():
self.assertEqual(
[("u1",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
@db_test_base.backend_specific("postgresql", "mysql")
def test_external_session_transaction_decorator(self):
......@@ -1956,14 +1960,14 @@ class LiveFacadeTest(db_test_base._DbTestCase):
go1(context)
session = self.sessionmaker(autocommit=True)
session = self.sessionmaker(autocommit=False)
# inner transaction + second part of "outer" transaction were committed
self.assertEqual(
[("u2",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
with session.begin():
self.assertEqual(
[("u2",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
@db_test_base.backend_specific("postgresql", "mysql")
def test_external_connection_transaction(self):
......@@ -1995,12 +1999,13 @@ class LiveFacadeTest(db_test_base._DbTestCase):
# add more state on the "outer" transaction
connection.execute(self.user_table.insert().values(name="u4"))
session = self.sessionmaker(autocommit=True)
self.assertEqual(
[("u2",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
session = self.sessionmaker(autocommit=False)
with session.begin():
self.assertEqual(
[("u2",), ("u3",), ("u4", )],
session.query(
self.User.name).order_by(self.User.name).all()
)
@db_test_base.backend_specific("postgresql", "mysql")
def test_external_writer_in_reader(self):
......@@ -2030,12 +2035,13 @@ class LiveFacadeTest(db_test_base._DbTestCase):
user = session.query(self.User).first()
self.assertEqual("u1_commit", user.name)
session = self.sessionmaker(autocommit=True)
self.assertEqual(
[("u1_commit",)],
session.query(
self.User.name).order_by(self.User.name).all()
)
session = self.sessionmaker(autocommit=False)
with session.begin():
self.assertEqual(
[("u1_commit",)],
session.query(
self.User.name).order_by(self.User.name).all()
)
def test_replace_scope(self):
# "timeout" is an argument accepted by
......
oslo_db/tests/sqlalchemy/test_types.py
View file @ a26de332
......@@ -81,8 +81,7 @@ class JsonTypesTestCase(test_base._DbTestCase):
{'a': 'b'}
]
for i, test in enumerate(tested):
with self.session.begin():
JsonTable(id=i, json=test).save(self.session)
JsonTable(id=i, json=test).save(self.session)
obj = self.session.query(JsonTable).filter_by(id=i).one()
self.assertEqual(test, obj.json)
......
tox.ini
View file @ a26de332
......@@ -10,6 +10,8 @@ allowlist_externals =
passenv =
OS_TEST_DBAPI_ADMIN_CONNECTION
setenv =
OS_STDOUT_CAPTURE=true
OS_STDERR_CAPTURE=true
BASECOMMAND=stestr run
{postgresql,all}: PIFPAF_POSTGRESQL=pifpaf -g OS_TEST_DBAPI_ADMIN_CONNECTION run postgresql --
{mysql,all}: PIFPAF_MYSQL=pifpaf -g OS_TEST_DBAPI_ADMIN_CONNECTION run mysql --
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment