0

0

在Python中使用Allure-Behave生成测试报告

DDD

DDD

发布时间:2025-08-31 21:49:00

|

769人浏览过

|

来源于php中文网

原创

在Python中使用Allure-Behave生成测试报告

本文详细介绍了如何在Python项目中使用Allure-Behave集成Behave测试框架,以自动化生成美观且功能丰富的Allure测试报告。通过配置Behave的格式化器(formatter),您可以轻松地将Allure报告的生成过程无缝嵌入到测试运行中,无需复杂的代码修改或手动调用报告生成函数,从而高效地可视化测试结果。

1. Allure-Behave 简介

allure report 是一个灵活的、轻量级的多语言测试报告工具,它提供清晰的测试执行概述和详细的测试步骤信息。behave 是一个行为驱动开发(bdd)框架,用于python编写的软件。allure-behave 库是 allure report 与 behave 框架之间的桥梁,它允许 behave 测试的执行结果被捕获并转换为 allure 报告所需的数据格式。

2. 安装 Allure-Behave

在使用 allure-behave 之前,您需要通过 pip 安装它。此外,为了最终查看报告,您还需要安装 Allure Commandline 工具(通常通过包管理器如 scoop、brew 或手动下载)。

pip install allure-behave

Allure Commandline 工具安装(以 macOS 为例,Windows 和 Linux 请参考 Allure 官方文档):

brew install allure

3. 集成 Allure-Behave 到 Behave 测试

allure-behave 的核心集成方式是作为 Behave 的一个格式化器(formatter)。Behave 允许用户指定一个或多个格式化器来处理测试运行的输出。

3.1 通过配置文件集成(推荐方式)

推荐通过 Behave 的配置文件(如 behave.ini 或 setup.cfg)来配置 Allure 格式化器。这种方式使得配置持久化且易于管理。

立即学习Python免费学习笔记(深入)”;

在您的项目根目录或 Behave 配置文件所在的目录中,创建或修改 behave.ini 或 setup.cfg 文件,并添加以下内容:

behave.ini 示例:

[behave]
default_format = allure_behave.formatter:AllureFormatter
outfiles = ./allure-results/

setup.cfg 示例:

[behave]
default_format = allure_behave.formatter:AllureFormatter
outfiles = ./allure-results/

配置说明:

  • [behave]:这是 Behave 配置文件的标准节。
  • default_format = allure_behave.formatter:AllureFormatter:这行指定了 Behave 在运行测试时应使用 allure_behave.formatter 模块中的 AllureFormatter 作为默认的输出格式化器。
  • outfiles = ./allure-results/:这行指定了 Allure 原始结果文件(通常是 JSON 格式)的输出目录。这些文件是生成最终 HTML 报告的必要中间产物。建议将其命名为 allure-results。

配置完成后,您只需像往常一样运行 Behave 测试:

behave

Behave 将会自动使用 AllureFormatter 来处理测试结果,并将原始 Allure 数据写入到 outfiles 指定的目录中。

3.2 通过命令行集成(临时方式)

如果您不想修改配置文件,或者需要临时改变报告输出方式,可以通过命令行参数来指定 Allure 格式化器。

FaceHub
FaceHub

免费的在线AI换脸工具网站

下载
behave -f allure_behave.formatter:AllureFormatter -o ./allure-results/ ./features

命令说明:

  • behave:运行 Behave 测试的命令。
  • -f allure_behave.formatter:AllureFormatter:等同于配置文件中的 default_format,指定使用 Allure 格式化器。
  • -o ./allure-results/:等同于配置文件中的 outfiles,指定 Allure 结果的输出目录。
  • ./features:指定要运行的 Behave feature 文件所在的目录(如果未指定,Behave 会在当前目录查找)。

4. 生成并查看 Allure HTML 报告

无论您使用哪种集成方式,完成 Behave 测试运行后,您会在指定的 allure-results 目录中找到一系列 JSON 或 XML 文件。这些是 Allure 的原始数据,还不是最终的 HTML 报告。

要生成并查看可交互的 HTML 报告,您需要使用 Allure Commandline 工具:

  1. 生成报告:

    allure generate ./allure-results/ -o ./allure-report/ --clean
    • allure generate:Allure 命令行的生成报告指令。
    • ./allure-results/:您的 Allure 原始结果文件所在的目录。
    • -o ./allure-report/:指定生成的 HTML 报告的输出目录。建议将其命名为 allure-report。
    • --clean:可选参数,用于在生成新报告之前清理目标输出目录(./allure-report/)中的旧文件。
  2. 打开报告:

    allure open ./allure-report/
    • allure open:Allure 命令行的打开报告指令。
    • ./allure-report/:您生成的 HTML 报告所在的目录。

    执行此命令后,Allure 会在您的默认浏览器中自动打开生成的 HTML 报告,您可以查看测试的详细结果。

5. 解决常见问题:TypeError: object NoneType can't be used in 'await' expression

在原始问题中,用户尝试在 after_all 钩子中使用 async_run_until_complete 和 await allure_report(...) 来生成报告。这种方法是不正确的,并且会导致 TypeError: object NoneType can't be used in 'await' expression 错误。

原因分析:

  • allure-behave 库的设计理念是通过 Behave 的格式化器机制来自动收集和处理测试数据,而不是通过在测试钩子中手动调用一个异步的报告生成函数。
  • allure_report 函数(如果存在的话)并非 allure-behave 标准 API 的一部分,或者其用法与用户的预期不符。allure-behave 格式化器会在测试运行结束后,将所有必要的数据写入 outfiles 目录。
  • TypeError: object NoneType can't be used in 'await' expression 错误通常意味着 await 关键字后面跟着的表达式(在这里是 allure_report(...) 的返回值)是 None,而不是一个可等待(awaitable)的对象。这进一步印证了 allure_report 并非一个异步函数,或者它没有返回一个可等待的对象。

正确方法:

按照本文前面介绍的,通过在 behave.ini 或 setup.cfg 中配置 default_format 和 outfiles,或者通过命令行参数 -f 和 -o 来集成 allure-behave。allure-behave 格式化器会自动在 Behave 测试运行结束后将原始数据写入指定目录,您无需在 after_all 钩子中进行任何额外的报告生成操作。after_all 钩子通常用于清理资源,而不是报告生成。

6. 总结

通过 allure-behave,您可以轻松地为您的 Behave 测试套件生成专业且交互性强的 Allure 报告。关键在于理解 allure-behave 是作为 Behave 的格式化器工作的,它负责在测试运行期间收集数据并将其写入原始结果文件。之后,您需要使用 Allure Commandline 工具将这些原始数据转换为最终的 HTML 报告。遵循本文的集成指南,可以避免常见的配置错误,并高效地利用 Allure Report 提升您的测试可视化能力。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

746

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

634

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

758

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1261

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

577

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

705

2023.08.11

Java 项目构建与依赖管理(Maven / Gradle)
Java 项目构建与依赖管理(Maven / Gradle)

本专题系统讲解 Java 项目构建与依赖管理的完整体系,重点覆盖 Maven 与 Gradle 的核心概念、项目生命周期、依赖冲突解决、多模块项目管理、构建加速与版本发布规范。通过真实项目结构示例,帮助学习者掌握 从零搭建、维护到发布 Java 工程的标准化流程,提升在实际团队开发中的工程能力与协作效率。

10

2026.01.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 7万人学习

Git 教程
Git 教程

共21课时 | 2.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号