flask-sqlalchemy、pytest 的单元测试和事务自动回滚
flask-sqlalchemy、pytest 的单元测试和事务自动回滚
使用 flask-sqlalchemy 做数据库时,单元测试可以帮助发现一些可能意想不到的问题,像 delete-cascade 、数据长度、多对多关联等等。如果使用 alembic 管理数据库版本,还可以写些跟迁移相关的单元测试。在团队中实现规范的单元测试,再配合 flake8 / pep8 之类的代码规范工具,有助于提高代码的质量,让开发人员有意识去主动发现问题,在新功能进行回归测试时可重复使用单元测试的代码,避免中断已有功能。
在数据库的单元测试前,先要把数据库表结构创建起来。有两种方式来做这个事,一是用一个专门用于单元测试的数据库,重新进行 create_all 的建表操作;或者直接用开发用的数据库, upgrade 到最新的版本,然后在单元测试完成后再进行 downgrade 。两种方法都可以使用 pytest 的 fixture 实现,都可以使用。
做数据库的单元测试需要注意的是事务回滚。通常每个单元测试会针对某个单独的类,而为了避免单元测试所插入或删除的数据对其它单元测试的影响,需要把整个单元测试包含在一个事务中,单元测试结束时自动回滚。事务所针对的层次可以是一个模块,或者是单元测试函数。
假如项目的目录结构如下 ::
.
├── config.py
├── db.sqlite
├── manage.py
├── maze
├── migrations
├── requirements-dev.txt
├── requirements-test.txt
├── requirements.txt
├── tests
├── tox.ini
db.sqlite 为开发用的 sqlite 数据库,migrations 为数据库迁移文件,tests 中放单元测试。在配置 sqlite 路径时,需要注意使用绝对路径,否则会把 sqlite 文件写在 maze 目录下。
现在有 model 类的定义如下 ::
class User(db.Model, Base, UserMixin):
"""User model."""
__tablename__ = 'users'
username = db.Column(db.String(20), unique=True, nullable=False)
email = db.Column(db.String(64), unique=True, nullable=False)
password_hash = db.Column(db.String(128), nullable=False)
@property
def password(self):
raise AttributeError('Not readable')
@password.setter
def password(self, value):
self.password_hash = generate_password_hash(value)
def save(self):
db.session.add(self)
db.session.flush()
为了测试这个类,需要先编写一些可行的测试框架代码,以在 pytest 中支持对 flask 的测试。
在 tests 中创建 conftest.py
文件,包含我们在整个测试中都需要使用的 fixture 。首先,需要创建一个 flask 的 fixture ,并创建一个测试上下文。
# -*- coding: utf-8 -*-
import pytest
@pytest.yield_fixture(scope='session',autouse=True)
def app():
from maze import create_app
app = create_app()
ctx = app.test_request_context()
with ctx:
yield app
如果使用单独测试数据库的方式进行单元测试,那么加一个创建数据库的 fixture ,并在测试::
@pytest.yield_fixture(scope='session', autouse=True)
@pytest.mark.usefixtures('app')
def create_schema():
from maze import db
db.create_all()
try:
yield
finally:
db.drop_all()
那么在单元测试中,就已经可以通过 @pytest.mark.usefixtures('app')
,flask 的相关代码就能进行测试。为了支持自动回滚,还需要加一个 rollback
的 fixture ,如下 ::
@pytest.yield_fixture(autouse=True)
def rollback(app):
from maze import db
ctx = app.test_request_context()
with ctx:
db.session.begin(subtransactions=True)
try:
yield
finally:
db.session.rollback()
db.session.remove()
rollback
可使用默认的 function scope ,如果需要在模块范围内才进行 rollback ,那么设置 scope='module'
。但要注意,原始代码中应用 db.session.flush()
的方式刷新 session
数据,而不是用 commit
。 rollback
对本事务上次 commit
之后的数据才生效,因此如果单元测试中有 commit 的代码,部分数据会被写入数据库,从而达不到 rollback
的目的。
OK,现在在 test_user.py
的单元测试模块中写些测试代码 ::
@pytest.usefixtures('rollback')
def test_user():
user = User(username='test', password='test123')
user.save()
assert user.id is not None
user2 = User.query.filter_by(username='test').first()
assert user2 is not None
assert user == user2
with pytest.raises(AttributeError):
p = user.password # noqa:F841
最后,执行 pytest 单元测试 ::
pytest tests
整个过程有几点要注意的:
(1) 为了支持自动回滚,原始代码不使用 commit 而要用 flush ,但要在 flask 中用 @app.teardown_request
注册一个处理函数,在函数中进行最终的 commit ;
(2) fixture 需要写在 conftest.py
文件中(或在 conftest.py
中进行 import
),而单元测试模块不需要 import
这些 fixture ,否则会出现找不到 fixture (尤其在 pycharm IDE 直接调用 pytest 测试时非常容易出现);
(3) 注意 flask 的上下文处理,可使用 pytest-flask
这个插件处理一些问题。
pytest 的 fixture 编写方式和 unittest 、 nose 、 xUnit 等有点区别,它是以函数的方式出现,在一开始用的时候会不习惯,也没有用 setup 、 teardown 等常见的约定函数来注入依赖,而是用简单的函数参数的方式,用过一小段时间后,感觉也还挺好,简单明了处理的方式在编写代码时少了很多麻烦。
flask-sqlalchemy、pytest 的单元测试和事务自动回滚的更多相关文章
- MockMvc 进行 controller层单元测试 事务自动回滚 完整实例
package com.ieou.ms_backend.controller; import com.google.gson.Gson; import com.ieou.ms_backend.dto. ...
- Spring事务为什么不会自动回滚?Spring事务怎样才会自动回滚?事务自动回滚条件及手动回滚
原文:https://blog.csdn.net/qq_32331073/article/details/76508147 更多Spring事务问题请访问链接:Spring事务回滚问题疑难详解 在此, ...
- mysql 事务中如果有sql语句出错,会导致自动回滚吗?
事务,我们都知道具有原子性,操作要么全部成功,要么全部失败.但是有可能会造成误解. 我们先准备一张表,来进行测试 CREATE TABLE `name` ( `id` int(11) unsigned ...
- spring事务什么时候会自动回滚
在java中异常的基类为Throwable,他有两个子类xception与Errors.同时RuntimeException就是Exception的子类,只有RuntimeException才会进行回 ...
- 事务框架之声明事务(自动开启,自动提交,自动回滚)Spring AOP 封装
利用Spring AOP 封装事务类,自己的在方法前begin 事务,完成后提交事务,有异常回滚事务 比起之前的编程式事务,AOP将事务的开启与提交写在了环绕通知里面,回滚写在异常通知里面,找到指定的 ...
- DDL, DML不是所有SQL都是可以自动回滚的
因为DDL没有事务性,所以DDL不能回滚. 要实现自动回滚.(begin,commit,rollback),则SQL语句中只能包括DML. 这样,自动化发布就会受限规范格式. 故而,一刀切的办法是,假 ...
- Spring,SpringMvc配置常见的坑,注解的使用注意事项,applicationContext.xml和spring.mvc.xml配置注意事项,spring中的事务失效,事务不回滚原因
1.Spring中的applicationContext.xml配置错误导致的异常 异常信息: org.apache.ibatis.binding.BindingException: Invalid ...
- Spring声明式事务不回滚问题
疑问,确实像往常一样在service上添加了注解 @Transactional,为什么查询数据库时还是发现有数据不一致的情况,想想肯定是事务没起作用,出现异常的时候数据没有回滚.于是就对相关代码进行了 ...
- spring 在service中需要抛出异常才能自动回滚
在spring 事务配置中,如果service方法捕获了异常,则程序报错也不会自动回滚, 1.手动开启关闭事务 2.抛出异常,可以先捕获异常,然后自定义runtime异常,可不用声明
随机推荐
- C/C++中无条件花括号的妙用
C/C++中无条件花括号可以形成一个代码块,一个作用域.可以使括号内定义的变量就只在本域(就是这个大括号)内有效,而且不会影响其他域,即使名字相同. 在花括号内,如果变量前面带类型,则相当于新创建一个 ...
- Oracle安装介质及补丁集下载地址
Oracle9i Database Release 2 Enterprise/Standard/Personal Edition for Windows NT/2000/XP http://downl ...
- C++ 定义全局数组
数组怎么用,全局数组就怎么用,只是他的作用域不一样才叫全局数组... 在A.h 或 A.cpp中定义char buf[10]; 如果在B.cpp要用,就在其开头中写成 extern char buf[ ...
- MEF Parts Sample
namespace Microshaoft.MEF.Contracts { using System; public delegate void ExceptionEventHandler<TS ...
- Python爬虫学习(5): 简单的爬取
学习了urllib,urlib2以及正则表达式之后就可以做一些简单的抓取以及处理工作.为了抓取方便,这里选择糗事百科的网页作为抓取对象. 1. 获取数据: In [293]: url = " ...
- web api :Action Results in Web API 2
原文:http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/action-results Web api 返回 ...
- 《Invert》开发日志04:工具、资源和服务
这篇记录一下<Invert>用到的工具.资源和服务.秉承两个原则:一,绝不侵犯版权:二,尽量节省开支. 首先是工具.游戏引擎使用免费的Unity个人版: 编码IDE使用免费的VisualS ...
- [BZOJ4029][HEOI2015] 定价
Description 在市场上有很多商品的定价类似于 999 元.4999 元.8999 元这样.它们和 1000 元.5000 元和 9000 元并没有什么本质区别,但是在心理学上会让人感觉便宜很 ...
- NOI 题库 2727
2727 仙岛求药 描述 少年李逍遥的婶婶病了,王小虎介绍他去一趟仙灵岛,向仙女姐姐要仙丹救婶婶.叛逆但孝顺的李逍遥闯进了仙灵岛,克服了千险万难来到岛的中心,发现仙药摆在了迷阵的深处.迷阵由M×N ...
- mongoose连接collection后自动加s的问题
这两天折腾mongoose,发现数据成功写入集合了,但是在Terminal查询的时候却查不到 于是show collections后发现在原来的集合底下,又生成了一个加了s的集合,shenmegui ...