botsudo/action-shunit2

action-shunit2 镜像说明

镜像概述

本镜像为集成shunit2和kcov的Docker镜像，主要作为GitHub Action使用，支持Shell脚本的自动化单元测试与代码覆盖率分析，帮助开发者提升Shell脚本的质量与可靠性。

核心功能

1. Shell脚本测试：提供shunit2框架，支持编写和执行Shell脚本单元测试；
2. 覆盖率分析：集成kcov工具，生成详细的代码覆盖率报告；
3. CI/CD集成：可直接作为GitHub Action嵌入工作流，实现自动化测试与覆盖率上传。

使用场景

1. GitHub仓库中Shell脚本的CI/CD自动化测试；
2. 生成Shell脚本覆盖率报告并上传至Codecov平台；
3. 本地开发环境中快速验证Shell脚本测试逻辑。

配置说明

通过GitHub Action的with参数传递cli命令，指定执行的测试脚本或kcov命令：

• cli: "./tests/test.sh"：执行指定的Shell测试脚本；
• cli: "kcov --dump-summary ./coverage ./tests/run.sh"：使用kcov生成覆盖率报告。

部署示例

GitHub Action工作流示例（测试脚本）

yml
name: 执行Shell测试
permissions:
  contents: read
on: [push]
jobs:
  tests:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: 运行测试
        uses: sudo-bot/action-shunit2@latest
        with:
          cli: "./tests/test.sh"

GitHub Action工作流示例（带覆盖率）

yml
name: 测试与覆盖率分析
permissions:
  contents: read
on: [push]
jobs:
  coverage:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: 运行测试并生成覆盖率
        uses: sudo-bot/action-shunit2@latest
        with:
          cli: "kcov --dump-summary ./coverage ./tests/run.sh"
      - name: 上传覆盖率至Codecov
        uses: codecov/codecov-action@v4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          directory: ./coverage/
          fail_ci_if_error: true

本地Docker运行示例

执行Shell测试脚本：

bash
docker run -v $(pwd):/workspace docker.xuanyuan.run/botsudo/action-shunit2 sh /workspace/test.sh

生成覆盖率报告：

bash
docker run -v $(pwd):/workspace docker.xuanyuan.run/botsudo/action-shunit2 kcov --dump-summary /workspace/coverage /workspace/tests/run.sh