告别测试报告用Excel:Allure自动生成可视化报告更直观

pip install allure-pytest

# Windows：用scoop安装（类似macOS的Homebrew）Set-ExecutionPolicy RemoteSigned -Scope CurrentUseriwr -useb get.scoop.sh | iexscoop install allure# macOS：用Homebrewbrew install allure# Linux：手动下载（以2.25.0版本为例）wget https://github.com/allure-framework/allure2/releases/download/2.25.0/allure-2.25.0.tgztar -zxvf allure-2.25.0.tgz# 将allure/bin加入PATH环境变量

allure --version

# test_demo.py - 先跑通再说def test_addition():    """测试加法运算"""    result = 1 + 1    assert result == 2, "1加1应该等于2"def test_string_concat():    """测试字符串拼接"""    result = "Hello" + " " + "World"    assert result == "Hello World"

# --alluredir 指定数据存放目录pytest test_demo.py --alluredir=./allure-results

allure serve ./allure-results

# 生成报告到指定目录allure generate ./allure-results -o ./allure-report --clean# 启动服务查看allure open ./allure-report

# 引入Allure步骤装饰器import allure@allure.step("打开登录页面")def open_login_page():    # driver.get("https://example.com/login")    return True@allure.step("输入用户名：{username}")def input_username(username):    # driver.find_element(By.ID, "username").send_keys(username)    return True@allure.step("点击登录按钮")def click_login_button():    # driver.find_element(By.ID, "login-btn").click()    return Truedef test_login():    open_login_page()    input_username("testuser")    click_login_button()    assert True

import allure@allure.step("选择商品：{name}")def select_product(name):    # 点击商品 → 加入购物车    pass@allure.step("填写收货地址")def fill_address(city, detail):    # 输入城市 + 详细地址    pass@allure.step("选择支付方式：{method}")def select_payment(method):    # 选择支付渠道    pass@allure.step("提交订单")def submit_order():    # 点击提交按钮    pass@allure.step("下单流程：购买{name}")def place_order(name, city, address, payment_method):    # 顶层流程：调用四个子步骤    select_product(name)    fill_address(city, address)    select_payment(payment_method)    submit_order()@allure.feature("订单模块")@allure.story("下单流程")def test_place_order():    place_order(        name="iPhone 15 Pro",        city="北京",        address="朝阳区望京街道xxx号",        payment_method="微信支付"    )    assert True

import allureimport json@allure.step("调用登录接口")def call_login_api(username, password):    response = {        "code": 200,        "message": "登录成功",        "data": {            "token": "eyJhbGciOiJIUzI1NiIs...",            "user_id": 12345        }    }    # 附加JSON响应体到报告    allure.attach(        json.dumps(response, indent=2, ensure_ascii=False),        name="接口响应",        attachment_type=allure.attachment_type.JSON    )    return response@allure.step("截取页面截图")def take_screenshot(driver):    # 将截图附加到报告    allure.attach(        driver.get_screenshot_as_png(),        name="页面截图",        attachment_type=allure.attachment_type.PNG    )

import pytestimport allure@pytest.hookimpl(hookwrapper=True)def pytest_runtest_makereport(item, call):    outcome = yield    report = outcome.get_result()    # 只在测试失败时自动截图    if report.when == "call" and report.failed:        if "driver" in item.funcargs:            driver = item.funcargs["driver"]            allure.attach(                driver.get_screenshot_as_png(),                name="失败截图",                attachment_type=allure.attachment_type.PNG            )

import allure@allure.feature("用户模块")          # 模块@allure.story("用户登录")           # 场景@allure.title("正常登录成功")      # 用例标题def test_login_success():    assert True@allure.feature("用户模块")@allure.story("用户登录")@allure.title("密码错误登录失败")def test_login_wrong_password():    assert True@allure.feature("订单模块")@allure.story("创建订单")@allure.title("购物车商品下单")def test_create_order_from_cart():    assert True

import allure@allure.severity(allure.severity_level.BLOCKER)def test_system_startup():    """系统无法启动，阻塞所有测试"""    assert False@allure.severity(allure.severity_level.CRITICAL)def test_payment_processing():    """支付流程失败，可能导致资金损失"""    assert True@allure.severity(allure.severity_level.NORMAL)def test_search_function():    """搜索功能，返回结果有偏差"""    assert True@allure.severity(allure.severity_level.MINOR)def test_button_style():    """按钮颜色与设计稿不一致"""    assert True@allure.severity(allure.severity_level.TRIVIAL)def test_ui_typo():    """页面提示文字多了一个空格"""    assert True

import allure@allure.label("owner", "张三")       # 责任人@allure.label("priority", "P0")      # 优先级@allure.label("layer", "API")        # 测试层次：API / UI / 集成@allure.tag("冒烟测试", "回归测试")  # 测试类型标签def test_api_core_function():    assert True

import allureimport pytest@allure.feature("计算器")@allure.story("加法运算")@allure.title("加法测试: {a} + {b} = {expected}")@pytest.mark.parametrize("a, b, expected", [    (1, 1, 2),    (2, 3, 5),    (10, 20, 30),    (-1, 1, 0),])def test_addition(a, b, expected):    result = a + b    assert result == expected

# environment.properties# 放在项目根目录，与allure-results同级Python.Version=3.11.0Pytest.Version=7.4.3Allure.Version=2.25.0Browser=Chrome 120.0Browser.Driver=ChromeDriver 120.0Test.Environment=测试环境API.BaseURL=https://api-test.example.comDB.Host=192.168.1.100DB.Port=3306DB.Name=test_dbDB.Version=MySQL 8.0

import osimport platformimport datetimeimport pytestdef write_environment_properties():    env_info = {        "OS": platform.system(),        "Python.Version": platform.python_version(),        "Test.Time": datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"),        "Pytest.Version": pytest.__version__,    }    results_dir = "./allure-results"    os.makedirs(results_dir, exist_ok=True)    with open(        os.path.join(results_dir, "environment.properties"),        "w", encoding="utf-8"    ) as f:\n        for key, value in env_info.items():            f.write(f"{key}={value}\n")@pytest.fixture(scope="session", autouse=True)def setup_environment():    write_environment_properties()

# 首次运行pytest tests/ --alluredir=./allure-results# 第二次运行（不要加--clean-alluredir，让数据追加）pytest tests/ --alluredir=./allure-results# 生成的报告会包含两次运行的对比allure serve ./allure-results

import allureimport os@allure.step("附加测试视频")def attach_video(video_path):    if os.path.exists(video_path):        with open(video_path, "rb") as f:\n            allure.attach(\n                f.read(),\n                name="测试执行视频",                attachment_type=allure.attachment_type.MP4            )

# 安装依赖python3 -m venv venv. venv/bin/activatepip install -r requirements.txtpip install allure-pytest# 运行测试，生成数据到allure-results目录pytest tests/ --alluredir=./allure-results --clean-alluredir -v --tb=short

// Jenkinsfile - Allure测试报告Pipelinepipeline {    agent any    environment {        ALLURE_RESULTS = 'allure-results'        PYTHON_VERSION = '3.11'    }    triggers {        // 定时触发：每天凌晨2点执行        cron('0 2 * * *')        // 代码提交触发（需配置GitLab webhook）        gitlab(triggerOnPush: true, triggerOnMergeRequest: true)    }    stages {        stage('环境准备') {            steps {                echo '准备Python环境...'                sh '''                    python3 -m venv venv                    . venv/bin/activate                    pip install -r requirements.txt                    pip install allure-pytest                '''            }        }        stage('运行测试') {            steps {                echo '执行测试用例...'                sh '''                    . venv/bin/activate                    pytest tests/ \\                        --alluredir=${ALLURE_RESULTS} \\                        -v \\                        --tb=short                '''            }        }        stage('生成报告') {            steps {                echo '生成Allure报告...'                allure includeProperties: false,                       jdk: '',                       results: [[path: env.ALLURE_RESULTS]]            }        }    }    post {        always {            echo '构建后处理...'        }        failure {            // 构建失败时发送钉钉通知            dingtalk(                robot: 'your-robot-id',                type: 'MARKDOWN',                title: '测试构建失败',                text: [                    "### 测试构建失败",                    "- 项目：${env.JOB_NAME}",                    "- 构建：#${env.BUILD_NUMBER}",                    "- 原因：测试用例执行失败",                    "- 报告：[查看详情](${env.BUILD_URL}allure/)"                ]            )        }        success {            echo '测试通过！'            cleanWs()        }    }}/** * 使用说明： * 1. 将此文件放在项目根目录，命名为 Jenkinsfile * 2. Jenkins中创建 Pipeline 项目，选择 "Pipeline script from SCM" * 3. 配置Git仓库地址 * 4. 确保Jenkins已安装 Allure Plugin 和 DingTalk Plugin * 5. 在 Jenkins 全局配置中添加 Allure 命令行工具 */

# 必须通过HTTP服务访问allure serve ./allure-results# 或先生成报告，再用服务打开allure generate ./allure-results -o ./allure-report --cleanallure open ./allure-report

# 方案一：conftest.py中强制设置编码import sysimport iosys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8')sys.stderr = io.TextIOWrapper(sys.stderr.buffer, encoding='utf-8')# 方案二：确保Python文件保存为UTF-8编码（大部分IDE默认如此）

# 本地检查版本allure --version# Windows更新scoop update allure# macOS更新brew upgrade allure