Jest-Allure 项目使用教程

Jest-Allure 项目使用教程

jest-allure Generate Allure Report for jest. Allure Report, a flexible lightweight multi-language test report tool with the possibility to add steps, attachments, parameters and so on. 项目地址: https://gitcode.com/gh_mirrors/je/jest-allure

1. 项目介绍

Jest-Allure 是一个用于生成 Allure 报告的 Jest 插件。Allure 报告是一个灵活、轻量级的多语言测试报告工具，支持添加步骤、附件、参数等功能。通过 Jest-Allure，您可以轻松地在 Jest 测试框架中生成美观的测试报告。

2. 项目快速启动

安装

首先，您需要安装 Jest-Allure 插件。您可以使用 Yarn 或 npm 进行安装：

yarn add -D jest-allure

或

npm install --save-dev jest-allure

配置

在 Jest 配置文件中，添加 Jest-Allure 的设置。根据您的 Jest 版本，配置方式有所不同：

• Jest 版本 >= 27：

  在 jest.config.js 中添加以下配置：

  module.exports = {
    testRunner: "jest-jasmine2",
    setupFilesAfterEnv: ["jest-allure/dist/setup"],
  };
  

• Jest 版本 < 24：

  在 jest.config.js 中添加以下配置：

  module.exports = {
    reporters: ["default", "jest-allure"],
  };
  

运行测试

运行您的 Jest 测试：

jest

生成报告

安装 Allure CLI 以生成报告：

npm install -g allure-commandline

生成报告：

allure serve

或生成 HTML 版本的报告：

allure generate

3. 应用案例和最佳实践

添加描述和截图

在测试中，您可以添加描述、截图等详细信息，以丰富测试报告的内容。以下是一个示例：

import { Severity } from "jest-allure/dist/Reporter";

describe("Fancy test", () => {
  it("Test your amazing feature", async () => {
    reporter.description("Feature should work cool");
    reporter.severity(Severity.Critical);
    reporter.feature("Betting");
    reporter.story("BOND-007");

    reporter.startStep("Check it's fancy");
    // 预期结果：功能很酷
    reporter.endStep();

    reporter.startStep("Check it's cool");
    // 预期结果：功能很酷
    reporter.endStep();

    const screenshotBuffer = await page.screenshot();
    reporter.addAttachment("Screenshot", screenshotBuffer, "image/png");
  });
});

最佳实践

• 使用步骤和附件：在测试中使用步骤和附件，可以更清晰地展示测试的执行过程和结果。
• 添加标签和参数：通过添加标签和参数，可以更好地组织和分类测试报告。
• 定期生成报告：定期生成和查看测试报告，以便及时发现和解决问题。

4. 典型生态项目

visual-unit-tests

visual-unit-tests 是一个与 Jest-Allure 结合使用的项目，用于生成可视化的单元测试报告。通过该工具，您可以更直观地查看测试结果和差异。

jest-allure-image-snapshot

jest-allure-image-snapshot 是一个用于生成图像快照的工具，结合 Jest-Allure 使用，可以生成包含图像对比的测试报告。

通过这些生态项目，您可以进一步扩展 Jest-Allure 的功能，提升测试报告的质量和可读性。

jest-allure Generate Allure Report for jest. Allure Report, a flexible lightweight multi-language test report tool with the possibility to add steps, attachments, parameters and so on. 项目地址: https://gitcode.com/gh_mirrors/je/jest-allure