使用 pytest 作为测试框架

[codetalks-new]

我们选择 pytest 作为测试框架。

pytest 测试环境基本配置

1. 安装pytest 和 pytest-django
2. 在 tox.ini 中配置 pytest 。pytest 也会读取 tox.ini 中的配置。
   第一个配置是，设置 django 测试环境变量如下：

[pytest]
DJANGO_SETTINGS_MODULE = wepost.conf.test

3. 加了快速测试的 密码 hash 速度。在 wepost.conf.test 中配置简单的密码 hash 函数。

PASSWORD_HASHERS = [
    'django.contrib.auth.hashers.MD5PasswordHasher',
]

PyCharm 的 pytest 测试环境配置

首先选择 pytest 作为 PyCharm 默认的测试框架如下图所示：

第一个测试

添加测试用户作为 fixture

之前我们添加了一些 dev1,dev2,test1,test2 等的测试用户。这样在测试用例每次使用到这些用户时。
就需要写例如如下的代码： dev1 = WepostUser.objects.filter(username="dev1").first() 之类的代码。
但是在 pytest 中可以使用。将 ut1 作为一个 fixture 添加进 pytest ，这样每一次使用时就可以直接使用了。

1. 在 项目根目录下创建针对项目的 conftest.py 模块。在里面添加一个名为 ut1 的 fixture

@pytest.fixture()
def ut1(db):
    return WepostUser.objects.filter(username="test1").first()

上面ut1 函数使用， db 是为了访问数据库。否则会报如下错误，对于在 fixtures 中访问数据库的话，使用 @pytest.mark.django_db 也是没有用的。
备注：pytest 匹配 fixture 是根据测试函数中的参数名字来的。

E       Failed: Database access not allowed, use the "django_db" mark, or the "db" or "transactional_db" fixtures to enable it.

2. 以测试 UserNodeService 为例，添加测试模块，删除apps/posts目录原来空的 tests.py 模块。
   创建名为 tests 的包。添加 test_user_node_service.py 模块。

3. 添加测试用例:

def test_toggle_star_node(ut1):
  assert ut1

4. 运行测试如下（在 PyCharm 中可以直接点击 测试用例前面的运行按钮运行）
   

[codetalks-new]

加快测试运行速度

为什么测试执行得这么慢？

1. 在运行测试用例之前，Django 或者 pytest-django 都会创建一个隔离的干净的测试环境，以免多个测试用例之间的相互影响。

2. 创建测试环境慢，主要是由于创建测试环境数据库比较慢，特别是数据库比较复杂，迁移脚本比较复杂的情况，创建的测试环境也会从头到尾去执行以创建一个新的测试环境。 以 pytest-django 插件来说是，pytest 初始化时，会调用插件的注册的初始化fixture 中

@pytest.fixture(scope="session")
def django_db_setup(
    request,
    django_test_environment,
    django_db_blocker,
    django_db_use_migrations,
    django_db_keepdb,
    django_db_createdb,
    django_db_modify_db_settings,
):
"""Top level fixture to ensure test databases are available"""

3.对 SQLite 来说创建一个内存数据库，对于其他的来说。会创建以 test_ 为前缀的数据库。

加速测试环境的创建

根据 我们的测试场景，我们一般不需要完全重新创建一个数据库，可以重用一个已经创建好的。

1. 修改 tox.ini 启用重用选项。

[pytest]
DJANGO_SETTINGS_MODULE = wepost.conf.test
addopts = --reuse-db

2. 对于 SQLite 数据库， 我们还要在配置中，指定数据库配置下 TEST 配置项指定对应测试数据库的名称，对于 SQlite 来说就是数据库文件地址。配置修改后如下:

DATABASES = {
  'default': {
    'ENGINE': 'django.db.backends.sqlite3',
    'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    'TEST': {
      'NAME': os.path.join(BASE_DIR, 'test_db.sqlite3'),
    }
  }
}

3. 再次执行时，执行速度明显加快，只要 0.29 秒。