Merge pull request #25 from CAFxX/patch-4 #46
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This script is provided by github.com/bool64/dev. | |
name: test-unit | |
on: | |
push: | |
branches: | |
- master | |
- main | |
pull_request: | |
# Cancel the workflow in progress in newer build is about to start. | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
cancel-in-progress: true | |
env: | |
GO111MODULE: "on" | |
RUN_BASE_COVERAGE: "on" # Runs test for PR base in case base test coverage is missing. | |
COV_GO_VERSION: 1.20.x # Version of Go to collect coverage | |
TARGET_DELTA_COV: 90 # Target coverage of changed lines, in percents | |
jobs: | |
test: | |
strategy: | |
matrix: | |
go-version: [ 1.16.x, 1.19.x, 1.20.x ] | |
runs-on: ubuntu-latest | |
steps: | |
- name: Install Go stable | |
if: matrix.go-version != 'tip' | |
uses: actions/setup-go@v4 | |
with: | |
go-version: ${{ matrix.go-version }} | |
- name: Install Go tip | |
if: matrix.go-version == 'tip' | |
run: | | |
curl -sL https://storage.googleapis.com/go-build-snap/go/linux-amd64/$(git ls-remote https://github.com/golang/go.git HEAD | awk '{print $1;}').tar.gz -o gotip.tar.gz | |
ls -lah gotip.tar.gz | |
mkdir -p ~/sdk/gotip | |
tar -C ~/sdk/gotip -xzf gotip.tar.gz | |
~/sdk/gotip/bin/go version | |
echo "PATH=$HOME/go/bin:$HOME/sdk/gotip/bin/:$PATH" >> $GITHUB_ENV | |
- name: Checkout code | |
uses: actions/checkout@v3 | |
- name: Go cache | |
uses: actions/cache@v3 | |
with: | |
# In order: | |
# * Module download cache | |
# * Build cache (Linux) | |
path: | | |
~/go/pkg/mod | |
~/.cache/go-build | |
key: ${{ runner.os }}-go-cache-${{ hashFiles('**/go.sum') }} | |
restore-keys: | | |
${{ runner.os }}-go-cache | |
- name: Restore base test coverage | |
id: base-coverage | |
if: matrix.go-version == env.COV_GO_VERSION && github.event.pull_request.base.sha != '' | |
uses: actions/cache@v2 | |
with: | |
path: | | |
unit-base.txt | |
# Use base sha for PR or new commit hash for master/main push in test result key. | |
key: ${{ runner.os }}-unit-test-coverage-${{ (github.event.pull_request.base.sha != github.event.after) && github.event.pull_request.base.sha || github.event.after }} | |
- name: Run test for base code | |
if: matrix.go-version == env.COV_GO_VERSION && env.RUN_BASE_COVERAGE == 'on' && steps.base-coverage.outputs.cache-hit != 'true' && github.event.pull_request.base.sha != '' | |
run: | | |
git fetch origin master ${{ github.event.pull_request.base.sha }} | |
HEAD=$(git rev-parse HEAD) | |
git reset --hard ${{ github.event.pull_request.base.sha }} | |
(make test-unit && go tool cover -func=./unit.coverprofile > unit-base.txt) || echo "No test-unit in base" | |
git reset --hard $HEAD | |
- name: Test | |
id: test | |
run: | | |
make test-unit | |
go tool cover -func=./unit.coverprofile > unit.txt | |
TOTAL=$(grep 'total:' unit.txt) | |
echo "${TOTAL}" | |
echo "total=$TOTAL" >> $GITHUB_OUTPUT | |
- name: Annotate missing test coverage | |
id: annotate | |
if: matrix.go-version == env.COV_GO_VERSION && github.event.pull_request.base.sha != '' | |
run: | | |
curl -sLO https://github.com/vearutop/gocovdiff/releases/download/v1.3.6/linux_amd64.tar.gz && tar xf linux_amd64.tar.gz | |
gocovdiff_hash=$(git hash-object ./gocovdiff) | |
[ "$gocovdiff_hash" == "8e507e0d671d4d6dfb3612309b72b163492f28eb" ] || (echo "::error::unexpected hash for gocovdiff, possible tampering: $gocovdiff_hash" && exit 1) | |
git fetch origin master ${{ github.event.pull_request.base.sha }} | |
REP=$(./gocovdiff -cov unit.coverprofile -gha-annotations gha-unit.txt -delta-cov-file delta-cov-unit.txt -target-delta-cov ${TARGET_DELTA_COV}) | |
echo "${REP}" | |
cat gha-unit.txt | |
DIFF=$(test -e unit-base.txt && ./gocovdiff -func-cov unit.txt -func-base-cov unit-base.txt || echo "Missing base coverage file") | |
TOTAL=$(cat delta-cov-unit.txt) | |
echo "rep<<EOF" >> $GITHUB_OUTPUT && echo "$REP" >> $GITHUB_OUTPUT && echo "EOF" >> $GITHUB_OUTPUT | |
echo "diff<<EOF" >> $GITHUB_OUTPUT && echo "$DIFF" >> $GITHUB_OUTPUT && echo "EOF" >> $GITHUB_OUTPUT | |
echo "total<<EOF" >> $GITHUB_OUTPUT && echo "$TOTAL" >> $GITHUB_OUTPUT && echo "EOF" >> $GITHUB_OUTPUT | |
- name: Comment test coverage | |
continue-on-error: true | |
if: matrix.go-version == env.COV_GO_VERSION && github.event.pull_request.base.sha != '' | |
uses: marocchino/sticky-pull-request-comment@v2 | |
with: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
header: unit-test | |
message: | | |
### Unit Test Coverage | |
${{ steps.test.outputs.total }} | |
${{ steps.annotate.outputs.total }} | |
<details><summary>Coverage of changed lines</summary> | |
${{ steps.annotate.outputs.rep }} | |
</details> | |
<details><summary>Coverage diff with base branch</summary> | |
${{ steps.annotate.outputs.diff }} | |
</details> | |
- name: Store base coverage | |
if: ${{ github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main' }} | |
run: cp unit.txt unit-base.txt | |
- name: Upload code coverage | |
if: matrix.go-version == env.COV_GO_VERSION | |
uses: codecov/codecov-action@v1 | |
with: | |
file: ./unit.coverprofile | |
flags: unittests |