Skip to content

chore: make coverage-check a realistic gate and add coverage-gaps helper #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mrofreP wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: make coverage-check a realistic gate and add coverage-gaps helper #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ config.yml

# Output of the go coverage tool, specifically when used with LiteIDE
*.out
coverage.txt
coverage.html

# Temporary directories
bin/
Expand Down
24 changes: 19 additions & 5 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,32 @@ coverage-report: test
go tool cover -html=coverage.out -o coverage.html
@echo "Coverage report generated: coverage.html"

# Coverage with threshold check (95% target)
# Threshold is a floor on Go code coverage. Raise it as coverage improves --
# do not lower it without justification. Coverage is measured per-package (the
# same coverage.out that `make test` produces); packages with no unit tests,
# such as the generated mocks and OpenAPI stubs, are absent from the profile
# rather than counted as uncovered, so this already reflects hand-written code.
COVERAGE_MIN ?= 70

coverage-check: test
@echo "--- Checking coverage threshold"
@go tool cover -func=coverage.out | tail -1 | awk '{print "Total coverage: " $$3}' | tee coverage.txt
@COVERAGE=$$(go tool cover -func=coverage.out | tail -1 | awk '{print $$3}' | sed 's/%//'); \
if [ $${COVERAGE%.*} -lt 95 ]; then \
echo "ERROR: Coverage $${COVERAGE}% is below 95% threshold"; \
if [ $${COVERAGE%.*} -lt $(COVERAGE_MIN) ]; then \
echo "ERROR: Coverage $${COVERAGE}% is below $(COVERAGE_MIN)% threshold"; \
echo "Run 'make coverage-report' for the HTML report or 'make coverage-gaps' for the least-covered functions."; \
exit 1; \
else \
echo "SUCCESS: Coverage $${COVERAGE}% meets 95% threshold"; \
echo "SUCCESS: Coverage $${COVERAGE}% meets $(COVERAGE_MIN)% threshold"; \
fi

# List the 20 least-covered functions so devs can see where to invest in tests.
coverage-gaps: test
@echo "--- 20 least-covered functions"
@go tool cover -func=coverage.out | \
awk '$$1 != "total:" {print $$3, $$1}' | \
sort -n | head -20

# Race condition detection
test-race: TEST_TYPE = race
test-race: TESTFLAGS += -race -coverprofile=coverage-race.out -covermode=atomic
Expand Down Expand Up @@ -182,4 +196,4 @@ docs: $(SWAG)
clean:
@rm -rf "$(BINDIR)" "$(DISTDIR)"

.PHONY: all mod build test integration-test test-all security-test benchmark-test coverage-report coverage-check test-race test-stress test-short test-verbose test-timeout load-test test-run format migrateup migrateup1 migratedown migratedown1 sqlc mock build-cross docs clean
.PHONY: all mod build test integration-test test-all security-test benchmark-test coverage-report coverage-check coverage-gaps test-race test-stress test-short test-verbose test-timeout load-test test-run format migrateup migrateup1 migratedown migratedown1 sqlc mock build-cross docs clean
Loading