Откат транзакций не работает с py.тест и фляга
Я использую py.тест для тестирования моего приложения Flask, но я получаю IntegrityError, потому что я создаю ту же модель в двух разных тестах.
Я использую postgreSQL 9.3.5 и Flask-SQLAlchemy 1.0.
EDIT я обновил свое приспособление sessoin с ответом Джереми Аллена, и он исправил много ошибок. Однако кажется, когда я использую пользовательское приспособление, которое я все еще получаю IntegrityErrors
E IntegrityError: (IntegrityError) duplicate key value violates unique constraint "ix_users_email"
E DETAIL: Key (email)=(not_used@example.com) already exists.
E 'INSERT INTO users (email, username, name, role_id, company_id, password_hash, confirmed, member_since, last_seen) VALUES (%(email)s, %(username)s, %(name)s, %(role_id)s, %(company_id)s, %(password_hash)s, %(confirmed)s, %(member_since)s, %(last_seen)s) RETURNING users.id' {'username': 'not_used', 'confirmed': True, 'name': 'To be Removed', 'member_since': datetime.datetime(2014, 10, 29, 19, 19, 41, 7929), 'company_id': None, 'role_id': 3, 'last_seen': datetime.datetime(2014, 10, 29, 19, 19, 41, 7941), 'email': 'not_used@example.com', 'password_hash': 'pbkdf2:sha1:1000$cXUh6GbJf38242871cff5e4cce4c1dc49a62c4aea4ba1f3'}
conftest.py
@pytest.yield_fixture(scope='session')
def app():
app = create_app('testing')
app.config['SERVER_NAME'] = 'example.com:1234'
ctx = app.app_context()
ctx.push()
app.response_class = TestResponse
app.test_client_class = TestClient
yield app
ctx.pop()
@pytest.fixture(scope='session')
def db(app):
_db.drop_all()
_db.create_all()
Permission.insert_initial()
Role.insert_initial()
Technology.insert_initial()
Product.insert_initial()
Actor.insert_initial()
Industry.insert_initial()
DeliveryCategory.insert_initial()
DeliveryMethod.insert_initial()
user = User(email='admin@example.com', username='admin', confirmed=True, password='admin', name='Admin')
user.role = Role.query.filter_by(name='Administrator').first()
_db.session.add(user)
_db.session.commit()
return _db
@pytest.yield_fixture(scope='function')
def session(db):
db.session.begin_nested()
yield db.session
db.session.rollback()
@pytest.yield_fixture(scope='function')
def user(session):
yield session.query(User).filter_by(email='admin@example.com').first()
@pytest.yield_fixture(scope='function')
def client(app, user):
client = app.test_client()
client.auth = 'Basic ' + b64encode((user.email + ':' + 'admin').encode('utf-8')).decode('utf-8')
yield client
тесты, которые не
def test_edit_agenda_add_company_rep_without_company(session, client, user):
user2 = User(name='To be Removed', password='not_used', username='not_used', confirmed=True,
email='not_used@example.com', role=Role.query.filter_by(name='User').first())
agenda = Agenda(name='Invalid Company Rep', creator=user)
session.add(agenda)
session.commit()
response = client.jput('/api/v1.0/agendas/%s' % agenda.id,
data={
'company_representative': user2.id
}
)
assert response.status_code == 200
def test_edit_agenda_add_user_already_in_agenda(session, client, user):
user2 = User(name='To be Removed', password='not_used', username='not_used', confirmed=True,
email='not_used@example.com', role=Role.query.filter_by(name='User').first())
agenda = Agenda(name='Invalid Company Rep', creator=user)
agenda.users.append(user2)
session.add(agenda)
session.commit()
response = client.jput('/api/v1.0/agendas/%s' % agenda.id,
data={
'users': [user2.id]
}
)
assert response.status_code == 200
тесты, которые передают
def test_get_agenda_modules_where_agenda_that_does_not_exist(session, app):
# Create admin user with permission to create models
user = User(email='admin2@example.com', username='admin2', confirmed=True, password='admin2')
user.role = Role.query.filter_by(name='Administrator').first()
session.add(user)
session.commit()
client = app.test_client()
client.auth = 'Basic ' + b64encode(
(user.email + ':' + 'admin2').encode('utf-8')).decode('utf-8')
response = client.jget('/api/v1.0/agenda-modules/%s/%s' % (5, 4))
assert response.status_code == 404
def test_get_agenda_modules_agenda_modules_does_not_exist(session, app):
agenda = Agenda(name='Is tired in the AM')
session.add(agenda)
# Create admin user with permission to create models
user = User(email='admin2@example.com', username='admin2', confirmed=True, password='admin2')
user.role = Role.query.filter_by(name='Administrator').first()
session.add(user)
session.commit()
client = app.test_client()
client.auth = 'Basic ' + b64encode(
(user.email + ':' + 'admin2').encode('utf-8')).decode('utf-8')
response = client.jget('/api/v1.0/agenda-modules/%s/%s' % (agenda.id, 4))
assert response.status_code == 400
assert response.jdata['message'] == 'AgendaModule does not exist.'
3 ответов
похоже, вы пытаетесь Регистрация сеанса во внешней транзакции и вы используете flask-sqlalchemy.
ваш код работает не так, как ожидалось, потому что сеанс фактически заканчивается использованием другого соединения с тем, на котором вы начинаете транзакцию.
1. Вам необходимо привязать сеанс к соединению
как в примере, приведенном выше. Быстрое изменение кода в conftest.py должен сделать это:
@pytest.yield_fixture(scope='function')
def session(db):
...
session = db.create_scoped_session(options={'bind':connection})
...
к сожалению, вследствие фляга-с SQLAlchemy это SignallingSession (как в v2.0), ваш аргумент "bind" будет отклонен!
это потому, что SignallingSession установил аргумент "привязки" таким образом, что он будет иметь приоритет над нашим аргументом "привязки", и он не предлагает нам хороший способ указать наш собственный аргумент "привязки".
есть на GitHub pull-запрос С декабря 2013 года, когда кто-то еще такая же проблема.
2. Твик колбу-с SQLAlchemy
мы можем подкласс SignallingSession, чтобы позволить нам делать то, что мы хотим:
class SessionWithBinds(SignallingSession):
"""The extends the flask-sqlalchemy signalling session so that we may
provide our own 'binds' argument.
"""
def __init__(self, db, autocommit=False, autoflush=True, **options):
#: The application that this session belongs to.
self.app = db.get_app()
self._model_changes = {}
#: A flag that controls whether this session should keep track of
#: model modifications. The default value for this attribute
#: is set from the ``SQLALCHEMY_TRACK_MODIFICATIONS`` config
#: key.
self.emit_modification_signals = \
self.app.config['SQLALCHEMY_TRACK_MODIFICATIONS']
bind = options.pop('bind', None) or db.engine
# Our changes to allow a 'binds' argument
try:
binds = options.pop('binds')
except KeyError:
binds = db.get_binds(self.app)
SessionBase.__init__(self, autocommit=autocommit, autoflush=autoflush,
bind=bind,
binds=binds, **options)
а затем подкласс SQLAlchemy (основной класс flask-sqlalchemy), чтобы использовать наш SessionWithBinds вместо SignallingSession
class TestFriendlySQLAlchemy(SQLAlchemy):
"""For overriding create_session to return our own Session class"""
def create_session(self, options):
return SessionWithBinds(self, **options)
теперь вы должны использовать этот класс вместо SQLAlchemy:
db = TestFriendlySQLAlchemy()
и, наконец, обратно в наш conftest.py укажите новые "привязки":
@pytest.yield_fixture(scope='function')
def session(db):
...
session = db.create_scoped_session(options={'bind':connection, 'binds':None})
...
теперь ваши транзакции должны откатиться, как ожидалось.
это все немного сложнее...
вместо того, чтобы делать все это, вы можете попробовать использовать Session.begin_nested
. Это требует, чтобы ваша база данных поддерживала SQL SAVEPOINTs (PostgreSQL делает).
измените свой conftest.py приспособление:
@pytest.yield_fixture(scope='function')
def session(db):
db.session.begin_nested()
yield db.session
db.session.rollback()
дополнительная информация об использовании SAVEPOINT
s в SQLAlchemy: http://docs.sqlalchemy.org/en/latest/orm/session_transaction.html#using-savepoint
это довольно просто, но будет работать до тех пор, пока код, который вы тестируете, не вызывает . Если это проблема, взгляните на код здесь, в документах SQLAlchemy под заголовком "вспомогательные тесты с откатами"
вы на самом деле не сказали, что вы используете для управления базой данных, нет понятия, какая библиотека стоит за _db
или любой из классов модели.
но независимо от этого я бы заподозрил, что session.commit()
вызов, вероятно, связан с причиной фиксации транзакции. В конечном итоге вам придется прочитать документы о том, что session.commit()
в рамках Вы используете.
ключ здесь-запустить тесты во вложенном сеансе, а затем откатить все после выполнения каждого теста (это также предполагает, что между вашими тестами нет зависимостей).
Я предлагаю принять следующий подход, запустив каждый из ваших тестов во вложенной транзакции:
# module conftest.py
import pytest
from app import create_app
from app import db as _db
from sqlalchemy import event
from sqlalchemy.orm import sessionmaker
@pytest.fixture(scope="session")
def app(request):
"""
Returns session-wide application.
"""
return create_app("testing")
@pytest.fixture(scope="session")
def db(app, request):
"""
Returns session-wide initialised database.
"""
with app.app_context():
_db.drop_all()
_db.create_all()
@pytest.fixture(scope="function", autouse=True)
def session(app, db, request):
"""
Returns function-scoped session.
"""
with app.app_context():
conn = _db.engine.connect()
txn = conn.begin()
options = dict(bind=conn, binds={})
sess = _db.create_scoped_session(options=options)
# establish a SAVEPOINT just before beginning the test
# (http://docs.sqlalchemy.org/en/latest/orm/session_transaction.html#using-savepoint)
sess.begin_nested()
@event.listens_for(sess(), 'after_transaction_end')
def restart_savepoint(sess2, trans):
# Detecting whether this is indeed the nested transaction of the test
if trans.nested and not trans._parent.nested:
# The test should have normally called session.commit(),
# but to be safe we explicitly expire the session
sess2.expire_all()
sess2.begin_nested()
_db.session = sess
yield sess
# Cleanup
sess.remove()
# This instruction rollsback any commit that were executed in the tests.
txn.rollback()
conn.close()