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

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 格式化器。

面试猫

AI面试助手，在线面试神器，助你轻松拿Offer

39

查看详情

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中使用Allure-Behave生成测试报告的详细内容，更多请关注php中文网其它相关文章！