Github 代码覆盖度展示

在很多开源项目上,都有很多徽章用于展现项目的状态

在这之中,有两个是大部分项目都能用到的:测试以及测试覆盖
antd badges

在更早一点的时间,测试都需要使用第三方的持续化集成工具,比如 Travis CI、以及 Azure pipeline,大概的实现原理是使用 docker 在云服务器上拉取代码并执行测试,根据测试结果返回不同的结果,并生成相应的徽章

而自从 Github Actions 发布后,已经可以直接在 Github Actions 里直接进行测试

一般而言,很多语言都有相关工具对代码覆盖率进行统计,但是要展示出来则需要一个平台来生成相应的徽章。比较常用的就是 codecov,通过测试工具生成相关的输出文件并使用对应工具发送到 codecov

下面针对不同语言,对使用 Github Actiosn 来进行测试并生成 codecov 代码覆盖率进行说明

Python

常用的 Python 测试框架是pytest,在安装pytest-cov后,可以使用pytest --cov-report=xml --cov=src/来针对./src/目录生成一个.xml覆盖率文件

使用pip安装codecov工具后,即可使用codecov --token ${{ secrets.CODECOV_TOKEN }}将覆盖率文件发送到自己 codecov.io 的对应项目中

这里用到的 token 可以登录到 codecov.io 上进入对应的项目获取,由于默认的 Github Actions 本身是公开的,因此需要在项目的 setting 内设置 secrets,这样就可以在不泄密的情况下将 token 传入 Github Actions

下面是一个参考的 Github Actions 配置文件

name: master
on: 
  push:
    branchs:
    - master
jobs:
  build:
    name: Test
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: actions/setup-python@v1
      with:
        python-version: '3.8'
    - run: sudo python -m pip install -r requirements.txt
    - run: pytest --cov-report=xml --cov=src/
    - run: codecov --token ${{ secrets.CODECOV_TOKEN }}

Go

Go 自带测试框架,直接使用go test ./... -race -coverprofile=coverage.txt -covermode=atomic即可输出覆盖文件,使用bash <(curl -s https://codecov.io/bash) -t ${{ secrets.CODECOV_TOKEN }}即可传至 codecov.io

下面是一个参考的 Github Actions 配置文件

name: master
on: 
  push:
    branchs:
    - master
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - uses: actions/setup-go@v1
      with:
        go-version: 1.13
    - run: go test ./... -race -coverprofile=coverage.txt -covermode=atomic -v
    - run: bash <(curl -s https://codecov.io/bash) -t ${{ secrets.CODECOV_TOKEN }}