使用 pytest 测试框架构建自动化测试套件之测试报告

Project/
│  
├── allure/
│   ├── bin/
│   ├── config/
│   ├── lib/
│   └── plugins/ 
│ 
├── Config/
│	└── pytest.ini            # 自定义 mark 标记
│
├── ParametrizeData/
│   ├── user_add.json         # user_add测试用例的参数化数据
│   └── user_delete.json      # user_delete测试用例的参数化数据
│
├── Package/                  # 程序目录
│   ├── __init__.py           # 包初始化文件，可以定义一些变量或执行一些操作。当然里面什么都不写也可以。
│   ├── timeout.py            # 工具模块，定义了超时标记
│   ├── tools.py              # 工具模块，包括处理参数化文件逻辑
│   ├── module1.py            # 测试程序模块，比如连接数据库操作数据，接口请求等操作，推荐按功能封装成类
│   └── module2.py            # 测试程序模块，比如连接数据库操作数据，接口请求等操作，推荐按功能封装成类
│
├── Test/                     # 测试用例目录
│   ├── __init__.py           # 包初始化文件
│   ├── test_module1.py       # 测试 module1 的测试用例
│   └── test_module2.py       # 测试 module2 的测试用例
├── app.py                    # 项目启动文件
├── requirements.txt          # 项目依赖项列表
└── README.md                 # 项目说明文档

pip install allure-pytest

import subprocess
import pytest
import sys
import logging
import argparse
import os

# 自定义日志格式
LOG_FORMAT = '%(asctime)s - %(name)s - %(levelname)s - %(module)s:%(lineno)d - %(message)s'
logging.basicConfig(level=logging.INFO, format=LOG_FORMAT)
logger = logging.getLogger(__name__)
# 配置文件
CONFIG_PATH = "Config/pytest.ini"

def run_tests(test_target: str, testprint: str, tb: str, mark: str)->int:
    """
    运行pytest测试并返回退出码

    Args:
        test_target (str): 测试目标路径
        testprint (str): 控制输出信息的命令行参数
        tb (str): 控制输出信息的命令行参数
        mark (str): 指定运行特定标记的测试用例

    Returns:
        int: pytest退出码
    """
    if not os.path.exists(test_target):
        logger.error(f"测试目标路径不存在: {test_target}")
        return 1

    # 构建pytest参数
    pytest_args = []
    if os.path.exists(CONFIG_PATH):
        pytest_args.append("-c")
        pytest_args.append(CONFIG_PATH)
    else:
        logger.warning("未找到配置文件，将使用默认配置")
    if testprint:
        pytest_args.append("-"+ testprint)
    pytest_args.extend([
        test_target,
        "--clean-alluredir", "--alluredir=./result",
        "--tb=" + tb
    ])
    if mark:
        pytest_args.append("-m")
        pytest_args.append(mark)


    try:
        logger.info(f"开始运行测试，目标路径: {test_target}")
        exit_code = pytest.main(pytest_args)

        # 退出码说明映射
        exit_messages = {
            0: "✅ 全部测试用例通过",
            1: "⚠️ 部分测试用例未通过",
            2: "❌ 测试过程中有中断或其他非正常终止",
            3: "❌ 内部错误",
            4: "❌ pytest无法找到任何测试用例",
            5: "❌ pytest遇到了命令行解析错误"
        }

        logger.info(exit_messages.get(exit_code, f"❓ 未知的退出码: {exit_code}"))
        return exit_code

    except Exception as e:
        logger.exception("运行测试时发生致命错误:")
        logger.debug("异常详情:", exc_info=True)
        return 1


def parse_arguments()-> argparse.Namespace:
    """解析命令行参数"""
    parser = argparse.ArgumentParser(description="使用指定的命令运行 pytest 测试")
    parser.add_argument(
        'test_target',
        nargs='?',
        type=str,
        default="Test/",
        help='指定测试目录文件 (默认: Test/)'
    )
    parser.add_argument(
        '-p', '--testprint',
        nargs='?',
        type=str,
        default="",
        choices=["","v", "ra", "rA", "rp", "rx", "rs", "rN", "vra", "vrA", "vrp", "vrx", "vrs", "vrN"],
        help='控制输出信息'
    )
    parser.add_argument(
        '-tb', '--tb',
        nargs='?',
        type=str,
        default="auto",
        choices=["auto","long", "short", "line", "native", "no"],
        help='控制输出信息'
    )
    parser.add_argument(
        '-m', '--mark',
        nargs='?',
        type=str,
        help='控制输出信息'
    )
    return parser.parse_args()


if __name__ == "__main__":
    args = parse_arguments()

    exit_code = run_tests(args.test_target, args.testprint, args.tb, args.mark)
    # 生成 Allure 报告
    try:
        allure_command = [
            r".\allure\bin\allure.bat", "generate",
            "./result",
            "-o", "./report",
            "--clean"
        ]
        result = subprocess.run(allure_command, check=True, text=True, capture_output=True, cwd=os.getcwd())
        logging.info("Allure 报告生成成功")
        logging.info(result.stdout)
    except subprocess.CalledProcessError as e:
        logging.error(f"生成 Allure 报告时出错: {e}")
        logging.error(e.stderr)

    sys.exit(exit_code)

import allure

@allure.step("登录获取token")
def get_token(user_name, password):
    if user_name == "JZY" and password == "123456":
        # 此处省略登录的代码，直接返回token
        return True, "token"
    return False, "具体的错误原因"

@allure.step("获取用户列表")
def get_user_list(token):
    if token != "token":
        return False, "用户未登录"
    # 此处省略获取用户列表的代码，直接返回用户列表，应该有异常处理，比如请求地址错误等
    return True, [{"username": "test_user", "user_id":1},{"username": "test_user1", "user_id":2}]


@allure.step("删除用户")
def delete_user(token, user_id):
    if token != "token" or  not user_id:
        return False, "token错误"
    # 此处省略删除用户的代码，直接返回删除结果
    return True, "删除成功"

@allure.step("查询数据库中用户数据")
def select_user():
    # 此处省略查询数据库中用户数据的代码，直接返回查询结果
    return True, [{"username": "test_user1", "user_id":2}]

import allure

from Package.user import get_token, get_user_list, delete_user


@allure.epic("书籍管理平台接口测试")
@allure.feature("用户管理模块测试")
class TestUserManagement:

    @allure.story("新增用户测试")
    @allure.title("新增用户-冒烟")
    @allure.description("验证系统可以新增用户")
    @allure.severity("blocker")
    def test_add_user_smoke(self):
        pass

    @allure.story("新增用户测试")
    @allure.title("新增用户-正向测试")
    @allure.description("验证系统可以正确新增符合条件的用户")
    @allure.severity("critical")
    def test_add_user_success(self):
        pass

    @allure.story("新增用户测试")
    @allure.title("新增用户-异向测试")
    @allure.description("验证系统可以正确处理新增用户的异常参数，包括sql注入、边界值等")
    @allure.severity("critical")
    def test_add_user_fail(self):
        pass

    @allure.story("删除用户测试")
    @allure.title("删除用户-冒烟")
    @allure.description("验证系统可以删除用户")
    @allure.severity("blocker")
    def test_delete_user_smoke(self):
        result, user_token = get_token("JZY", "123456")
        if not result:
            assert False, "用户登录失败，速检查原因"
        result, user_list = get_user_list(user_token)
        if not result:
            assert False, user_list
        result, msg = delete_user(user_token, user_list[0]["user_id"])
        assert result, msg

import allure
import pytest

# 定义测试数据
test_data = [
    ("登录账号 - 正确密码", "admin", "123456"),
    ("登录账号 - 错误密码", "admin", "wrongpassword"),
    ("登录账号 - 错误账号", "adminerror", "123456"),
    ("登录账号 - 空密码", "admin", "")
]


# 参数化测试
@pytest.mark.parametrize("title, user_name, password", test_data, ids=[data[0] for data in test_data])
@allure.story("测试参数化")
@allure.severity("blocker")
def test_login(title, user_name, password):
    # 动态设置测试用例标题
    allure.dynamic.title(title)
    # 动态设置测试用例描述
    allure.dynamic.description(f"用户名: {user_name}, 密码: {password}")

    # 模拟登录操作
    with allure.step("执行登录操作"):
        # 打印的日志会被allure记录
        print(f"尝试使用用户名 '{user_name}' 和密码 '{password}' 登录")

        # 假设这是一个成功的登录
        assert True, "登录失败"

import allure

@allure.story("添加附件测试")
@allure.severity("blocker")
def test_text():
    # 添加附件文本
    allure.attach(
        body="这是 test_login 的文本附件",
        name="文本附件说明",
        attachment_type=allure.attachment_type.TEXT
    )
    assert True, "登录失败"

@allure.story("添加附件测试")
@allure.severity("blocker")
def test_files():
    # 添加附件文本
    allure.attach.file(
        source="Test/img.png",  # app.py的相对路径
        name="文件附件说明",
        attachment_type=allure.attachment_type.PNG
    )
    assert True, "登录失败"