chore: enforce test coverage (#159)

* chore: enforce test coverage

Signed-off-by: Travis Truman <trumant@gmail.com>

* fix: Makefile coverage read before coverage execution

* chore(ci): raise test coverage requirement to 26%

This level reflects the current coverage, up from 24% when this change was originally proposed.

---------

Signed-off-by: Travis Truman <trumant@gmail.com>

Author: trumant

.github/workflows/build.yaml

@@ -11,7 +11,7 @@ permissions:
   pull-requests: read
 
 jobs:
-  lint:
+  build:
     name: build
     runs-on: ubuntu-latest
     steps:
@@ -24,4 +24,19 @@ jobs:
       - name: build
         run: make build
       - name: test
-        run: make test-cov
+        run: make test-cov
+      - name: test coverage check
+        env:
+          TESTCOVERAGE_THRESHOLD: 26
+        run: |
+          echo "Quality Gate: checking test coverage is above threshold ..."
+          echo "Threshold             : $TESTCOVERAGE_THRESHOLD %"
+          totalCoverage=`go tool cover -func=coverage.out | grep total | grep -Eo '[0-9]+\.[0-9]+'`
+          echo "Current test coverage : $totalCoverage %"
+          if (( $(echo "$totalCoverage $TESTCOVERAGE_THRESHOLD" | awk '{print ($1 >= $2)}') )); then
+              echo "OK"
+          else
+              echo "Current test coverage is below threshold. Please add more unit tests or adjust threshold to a lower value."
+              echo "Failed"
+              exit 1
+          fi

Makefile

@@ -4,6 +4,8 @@ BUILD_WIN=@env GOOS=windows GOARCH=amd64 go build -o $(PACKNAME).exe
 BUILD_LINUX=@env GOOS=linux GOARCH=amd64 go build -o $(PACKNAME)
 BUILD_MAC=@env GOOS=darwin GOARCH=amd64 go build -o $(PACKNAME)-darwin
 
+COVERAGE = $(shell go tool cover -func=coverage.out | grep total | grep -Eo '[0-9]+\.[0-9]+')
+
 release: package release bin
 release-candidate: package release-candidate
 binary: package build
@@ -35,21 +37,24 @@ build:
 package: tidy test
 	@echo "  >  Packaging static files..."
 
-test:
+vet:
 	@echo "  >  Validating code ..."
 	@go vet ./...
+
+test: vet
 	@go clean -testcache
 	@go test ./...
 
 tidy:
 	@echo "  >  Tidying go.mod ..."
 	@go mod tidy
 
-test-cov:
+test-cov: vet
 	@echo "Running tests and generating coverage output ..."
 	@go test ./... -coverprofile coverage.out -covermode count
-	@sleep 2 # Sleeping to allow for coverage.out file to get generated
-	@echo "Current test coverage : $(shell go tool cover -func=coverage.out | grep total | grep -Eo '[0-9]+\.[0-9]+') %"
+
+print-cov:
+	@echo "Current test coverage : $(COVERAGE)%"
 
 release-candidate: tidy test
 	@echo "  >  Building release candidate for Linux..."