Update GitHub Actions templates to cache modules and restore base code coverage and benchmark results (#16)

Author: vearutop

templates/github/workflows/bench.yml

@@ -1,14 +1,20 @@
 name: bench
 on:
-  push:
-    tags:
-      - v*
-    branches:
-      - master
-      - main
   pull_request:
+  workflow_dispatch:
+    inputs:
+      old:
+        description: 'Old Ref'
+        required: false
+        default: 'master'
+      new:
+        description: 'New Ref'
+        required: true
+
 env:
   GO111MODULE: "on"
+  CACHE_BENCHMARK: "off"    # Enables benchmark result reuse between runs, may skew latency results.
+  RUN_BASE_BENCHMARK: "on"  # Runs benchmark for PR base in case benchmark result is missing.
 jobs:
   bench:
     strategy:
@@ -22,32 +28,52 @@ jobs:
           go-version: ${{ matrix.go-version }}
       - name: Checkout code
         uses: actions/checkout@v2
-      - name: Restore vendor
+        with:
+          ref: ${{ (github.event.inputs.new != '') && github.event.inputs.new || github.event.ref }}
+      - name: Go cache
         uses: actions/cache@v2
         with:
+          # In order:
+          # * Module download cache
+          # * Build cache (Linux)
           path: |
-            vendor
-          key: ${{ runner.os }}-go${{ matrix.go-version }}-vendor-${{ hashFiles('**/go.mod') }}
-      - name: Populate dependencies
-        run: |
-          (test -d vendor && echo vendor found) || (go mod vendor && du -sh vendor && du -sh ~/go/pkg/mod)
+            ~/go/pkg/mod
+            ~/.cache/go-build
+          key: ${{ runner.os }}-go-cache-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-cache
       - name: Restore benchstat
         uses: actions/cache@v2
         with:
           path: ~/go/bin/benchstat
           key: ${{ runner.os }}-benchstat
       - name: Restore base benchmark result
+        if: env.CACHE_BENCHMARK == 'on'
+        id: benchmark-base
         uses: actions/cache@v2
         with:
           path: |
             bench-master.txt
             bench-main.txt
           # Use base sha for PR or new commit hash for master/main push in benchmark result key.
           key: ${{ runner.os }}-bench-${{ (github.event.pull_request.base.sha != github.event.after) && github.event.pull_request.base.sha || github.event.after }}
+      - name: Checkout base code
+        if: env.RUN_BASE_BENCHMARK == 'on' && steps.benchmark-base.outputs.cache-hit != 'true' && (github.event.pull_request.base.sha != '' || github.event.inputs.old != '')
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ (github.event.pull_request.base.sha != '' ) && github.event.pull_request.base.sha || github.event.inputs.old }}
+          path: __base
+      - name: Run base benchmark
+        if: env.RUN_BASE_BENCHMARK == 'on' && steps.benchmark-base.outputs.cache-hit != 'true' && (github.event.pull_request.base.sha != '' || github.event.inputs.old != '')
+        run: |
+          export REF_NAME=master
+          cd __base
+          BENCH_COUNT=5 make bench-run bench-stat
+          cp bench-master.txt ../bench-master.txt
       - name: Benchmark
         id: bench
         run: |
-          export REF_NAME=${GITHUB_REF##*/}
+          export REF_NAME=new
           BENCH_COUNT=5 make bench-run bench-stat
           OUTPUT=$(make bench-stat)
           OUTPUT="${OUTPUT//'%'/'%25'}"

templates/github/workflows/test-unit.yml

@@ -7,6 +7,7 @@ on:
   pull_request:
 env:
   GO111MODULE: "on"
+  RUN_BASE_COVERAGE: "on"  # Runs test for PR base in case base test coverage is missing.
 jobs:
   test:
     strategy:
@@ -20,22 +21,37 @@ jobs:
           go-version: ${{ matrix.go-version }}
       - name: Checkout code
         uses: actions/checkout@v2
+      - name: Go cache
+        uses: actions/cache@v2
+        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
         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: Restore vendor
-        uses: actions/cache@v2
+      - name: Checkout base code
+        if: env.RUN_BASE_COVERAGE == 'on' && steps.benchmark-base.outputs.cache-hit != 'true' && github.event.pull_request.base.sha != ''
+        uses: actions/checkout@v2
         with:
-          path: |
-            vendor
-          key: ${{ runner.os }}-go${{ matrix.go-version }}-vendor-${{ hashFiles('**/go.mod') }}
-      - name: Populate dependencies
+          ref: ${{ github.event.pull_request.base.sha }}
+          path: __base
+      - name: Run test for base code
+        if: env.RUN_BASE_COVERAGE == 'on' && steps.benchmark-base.outputs.cache-hit != 'true' && github.event.pull_request.base.sha != ''
         run: |
-          (test -d vendor && echo vendor found) || (go mod vendor && du -sh vendor && du -sh ~/go/pkg/mod)
+          cd __base
+          make test-unit
+          go tool cover -func=./unit.coverprofile | sed -e 's/.go:[0-9]*:\t/.go\t/g' | sed -e 's/\t\t*/\t/g'  > ../unit-base.txt
       - name: Test
         id: test
         run: |