Test Reporter 使用教程

1. 项目介绍

Test Reporter 是一个 GitHub Action，用于直接在 GitHub 中显示来自流行测试框架的测试结果。它能够解析 XML 或 JSON 格式的测试结果，并创建漂亮的报告。Test Reporter 支持多种编程语言和测试框架，包括 .NET (xUnit, NUnit, MSTest)、Dart、Flutter、Java (JUnit)、JavaScript (JEST, Mocha) 等。

2. 项目快速启动

2.1 安装

首先，在你的 GitHub 仓库中创建一个 .github/workflows 目录，并在其中创建一个 .yml 文件（例如 test-reporter.yml）。

2.2 配置 GitHub Action

在 .yml 文件中添加以下内容：

name: Test Reporter

on:
  pull_request:
  push:

jobs:
  build-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm ci
      - run: npm test
      - name: Test Report
        uses: dorny/test-reporter@v1
        if: success() || failure()
        with:
          name: JEST Tests
          path: reports/jest-*.xml
          reporter: jest-junit

2.3 运行测试

提交并推送你的更改，GitHub Actions 将自动运行测试并生成测试报告。

3. 应用案例和最佳实践

3.1 公共仓库的最佳实践

对于公共仓库，建议使用两个独立的 GitHub Actions 工作流：

1. CI 工作流：在 PR 头分支的上下文中运行，执行测试并将测试结果上传为构建工件。
2. Test Report 工作流：在仓库主分支的上下文中运行，下载测试结果并创建报告。

示例配置如下：

# CI 工作流
name: 'CI'
on:
  pull_request:
jobs:
  build-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm ci
      - run: npm test
      - uses: actions/upload-artifact@v4
        if: success() || failure()
        with:
          name: test-results
          path: jest-junit.xml

# Test Report 工作流
name: 'Test Report'
on:
  workflow_run:
    workflows: ['CI']
    types: [completed]
permissions:
  contents: read
  actions: read
  checks: write
jobs:
  report:
    runs-on: ubuntu-latest
    steps:
      - uses: dorny/test-reporter@v1
        with:
          artifact: test-results
          name: JEST Tests
          path: '*.xml'
          reporter: jest-junit

3.2 私有仓库的最佳实践

对于私有仓库，可以直接使用单个工作流来运行测试并生成报告。

4. 典型生态项目

4.1 GitHub Actions

Test Reporter 是 GitHub Actions 生态系统的一部分，可以与其他 GitHub Actions 无缝集成，例如 actions/checkout 和 actions/upload-artifact。

4.2 JEST

JEST 是一个流行的 JavaScript 测试框架，Test Reporter 支持 JEST 生成的 JUnit XML 格式的测试结果。

4.3 NUnit

NUnit 是一个 .NET 测试框架，Test Reporter 支持 NUnit 生成的 XML 格式的测试结果。

4.4 JUnit

JUnit 是一个 Java 测试框架，Test Reporter 支持 JUnit 生成的 XML 格式的测试结果。

通过以上步骤，你可以轻松地在 GitHub 中集成 Test Reporter，并生成漂亮的测试报告。