Test coverage in PRs

.github/workflows/unit-tests.yaml

@@ -20,9 +20,40 @@ jobs:
     - name: Check style
       run: make check_style
 
+    - name: Install Go Test Coverage
+      run: make install-go-test-coverage
+
     - name: Build
       run: make bin
 
     - name: Test
       # Run tests as root as we require it for systemd tests
       run: sudo make test
+
+    - name: Check test coverage
+      uses: vladopajic/go-test-coverage@v2
+      id: go-test-coverage
+      with:
+        config: ./.testcoverage.yml
+
+    - name: Upload report
+      uses: actions/upload-artifact@v4
+      id: uploaded-report
+      with:
+        name: cover
+        path: cover.html
+
+    - name: Comment test coverage
+      if: ${{ github.event_name == 'pull_request' }}
+      uses: actions/github-script@v7
+      env:
+        TOTAL_COVERAGE: ${{ steps.go-test-coverage.outputs.total-coverage }}
+        ARTIFACT_URL: ${{ steps.uploaded-report.outputs.artifact-url }}
+      with:
+        script: |
+          github.rest.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: 'Total test coverage: ${{ env.TOTAL_COVERAGE }}%\n Download report: ${{ env.ARTIFACT_URL }}'
+          })

.gitignore

@@ -4,3 +4,5 @@ go.work
 go.work.sum
 .github/artifacts/benchmark-data.json
 .github/artifacts/data.json
+cover.out
+cover.html

.testcoverage.yml

@@ -0,0 +1,17 @@
+# (mandatory)
+# Path to coverprofile file (output of `go test -coverprofile` command)
+profile: cover.out
+
+# (optional)
+# When specified reported file paths will not contain local prefix in the output
+local-prefix: "github.com/awslabs/mountpoint-s3-csi-driver"
+
+# Holds regexp rules which will exclude matched files or packages from coverage statistics
+exclude:
+  # Exclude files or packages matching their paths
+  paths:
+    - \.pb\.go$ # excludes all protobuf generated files
+
+# NOTES:
+# - symbol `/` in all path regexps will be replaced by
+#   current OS file path separator to properly work on Windows

Makefile

@@ -119,9 +119,15 @@ bin:
 	CGO_ENABLED=0 GOOS=linux GOARCH=${TARGETARCH} go build -ldflags ${LDFLAGS} -o bin/aws-s3-csi-driver ./cmd/aws-s3-csi-driver/
 	CGO_ENABLED=0 GOOS=linux GOARCH=${TARGETARCH} go build -ldflags ${LDFLAGS} -o bin/install-mp ./cmd/install-mp/
 
+.PHONY: install-go-test-coverage
+install-go-test-coverage:
+	go install github.com/vladopajic/go-test-coverage/v2@latest
+
 .PHONY: test
 test:
-	go test -v -race ./pkg/...
+	go test -v -race ./pkg/... -coverprofile=./cover.out -covermode=atomic -coverpkg=./pkg/...
+	${GOBIN}/go-test-coverage --config=./.testcoverage.yml
+	go tool cover -html=cover.out -o=cover.html
 	# skipping controller test cases because we don't implement controller for static provisioning, this is a known limitation of sanity testing package: https://github.com/kubernetes-csi/csi-test/issues/214
 	go test -v ./tests/sanity/... -ginkgo.skip="ControllerGetCapabilities" -ginkgo.skip="ValidateVolumeCapabilities"