如何为自定义GitHub Action添加测试？以JavaDoc发布Action为例

一、测试方案选型 #

GitHub Action的测试分为单元测试和集成测试，结合你这个生成JavaDoc并发布到GitHub Pages的场景，重点要覆盖集成流程：

• 如果你的Action是用JavaScript/TypeScript开发的，单元测试可以用Jest/Mocha；如果是Composite Action（基于YAML和CLI命令），重点用act工具做本地集成测试，再配合GitHub Workflow做CI级别的验证。
• 因为涉及Java环境和GitHub Pages部署，集成测试是保障功能正确性的核心。

二、具体操作步骤 #

1. 准备测试依赖

• 安装act工具：用于在本地模拟GitHub Actions运行环境，命令如下（以Mac为例，其他系统参考官方文档）：

  brew install act
  

• 准备一个测试用Java项目：在仓库的test/目录下创建一个简单的Java类（带标准JavaDoc注释），比如：

  /**
   * 测试用Java类
   */
  public class TestClass {
      /**
       * 测试方法
       * @param name 用户名
       * @return 问候语
       */
      public String sayHello(String name) {
          return "Hello " + name;
      }
  }
  

2. 编写集成测试Workflow

在.github/workflows/下创建test-action.yml，用于验证完整流程：

name: Test JavaDoc Action
on: [push, pull_request]

jobs:
  test-javadoc-generation:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Java
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'
      # 运行你的自定义Action
      - name: Run JavaDoc Action
        uses: ./ # 本地引用Action，适合测试
        with:
          # 配置你的Action所需参数，比如Java源码路径
          source-path: './test'
          github-token: ${{ secrets.GITHUB_TOKEN }}
      # 验证JavaDoc是否生成成功
      - name: Verify JavaDoc output
        run: |
          # 检查生成的JavaDoc目录是否存在
          if [ ! -d "target/site/apidocs" ]; then
              echo "JavaDoc directory not found!"
              exit 1
          fi
          # 检查是否包含测试类的注释内容
          grep -q "测试用Java类" target/site/apidocs/TestClass.html
          if [ $? -ne 0 ]; then
              echo "JavaDoc content missing expected comment!"
              exit 1
          fi

3. 本地运行测试

用act命令在本地触发测试Workflow，模拟GitHub环境验证：

act -j test-javadoc-generation -W .github/workflows/test-action.yml

如果测试通过，说明Action的核心功能（JavaDoc生成）正常。

4. 补充单元测试（针对代码型Action）

如果你的Action包含自定义逻辑（比如JS脚本处理参数、拼接javadoc命令），可以编写单元测试：

• 比如用Jest测试参数解析逻辑：

  const parseArgs = require('../src/parseArgs');
  
  test('parse source path correctly', () => {
      const args = parseArgs({ 'source-path': './src' });
      expect(args.sourcePath).toBe('./src');
  });
  

• 运行单元测试：

  npm test
  

5. 加入CI流程

将测试Workflow加入项目的CI体系，确保每次代码提交或PR都自动运行测试：

• 可以直接用上面的test-action.yml，触发条件设为push和pull_request，这样每次改动都会自动验证Action功能。

三、边缘场景测试 #

还要覆盖一些异常情况：

• 测试Java项目无任何注释的情况，确保Action不会崩溃。
• 测试不同Java版本（比如8、11、17）下的兼容性。
• 测试私有仓库的部署权限（可以用测试仓库模拟）。

内容的提问来源于stack exchange，提问作者ThrowsError