Pytest学习笔记（24）-使用 pytest-xdist 如何保证 scope=session 的 fixture 在多进程运行时仍然只运行一次

背景

• 使用 pytest-xdist 分布式插件可以加快运行，充分利用机器多核 CPU 的优势，也提高了资源利用率
• 将常用功能放到 fixture，可以提高复用性和维护性
• 做接口自动化测试的时候，通常我们会将登录接口放到 fixture 里面，并且 scope 会设置为 session，让他全局只运行一次
• 但是当使用 pytest-xdist 的时候，scope=session 的 fixture 无法保证只运行一次，官方也通报了这一问题

官方介绍

• pytest-xdist 的设计使每个工作进程将执行自己的测试集合并执行所有测试子集，这意味着在不同的测试过程中，要求高级范围的 fixture（如：session）将会被多次执行，这超出了预期，在某些情况下可能是不希望的
• 尽管 pytest-xdist 没有内置支持来确保 scope=session 的fixture 仅执行一次，但是可以通过使用 文件锁 进行进程间通信来实现

官方解决办法

import json

import pytest
from filelock import FileLock


@pytest.fixture(scope="session")
def session_data(tmp_path_factory, worker_id):
    if worker_id == "master":
        # not executing in with multiple workers, just produce the data and let
        # pytest's fixture caching do its job
        return produce_expensive_data()

    # get the temp directory shared by all workers
    root_tmp_dir = tmp_path_factory.getbasetemp().parent

    fn = root_tmp_dir / "data.json"
    with FileLock(str(fn) + ".lock"):
        if fn.is_file():
            data = json