From c2ccd37cbb9fd43622f46ac312163aa19ade98c3 Mon Sep 17 00:00:00 2001
From: Steve Beattie <steve.beattie@chainguard.dev>
Date: Fri, 30 May 2025 12:00:12 -0700
Subject: [PATCH] tests: generate coverage info report

Adds two toplevel make targets:

- make coverage-html: generates out/coverage.html
- make coverage-browser: opens a browser page with the coverage report
  loaded

Signed-off-by: Steve Beattie <steve.beattie@chainguard.dev>
---
 DEVELOPMENT.md | 10 ++++++++++
 Makefile       | 23 +++++++++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 945064dfa..828b8368d 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -27,6 +27,16 @@ integration tests:
 
 ```make integration```
 
+## Viewing test coverage
+
+Generate an html report in `out/coverage.html`:
+
+```make coverage-html```
+
+Open the coverage report in a browser automatically:
+
+```make coverage-browser```
+
 
 ## Writing rule tests
 
diff --git a/Makefile b/Makefile
index f61308c3f..ff6d1ef0b 100644
--- a/Makefile
+++ b/Makefile
@@ -131,6 +131,29 @@ install-yara-x: out/$(YARA_X_REPO)/.git/commit-$(YARA_X_COMMIT)
 test:
 	go test -race ./pkg/...
 
+# unit tests only
+.PHONY: coverage
+coverage: out/mal.coverage
+
+# generate the html report
+.PHONY: coverage-html
+coverage-html: out/coverage.html
+
+# pop open the html page in a browser directly
+.PHONY: coverage-browser
+coverage-browser: out/mal.coverage
+	go tool cover -html=$<
+
+# generate the html report
+out/coverage.html: out/mal.coverage
+	go tool cover -html=$< -o $@
+
+# we always want to regen the coverage data file
+.PHONY: out/mal.coverage
+out/mal.coverage:
+	mkdir -p out
+	go test -coverprofile $@ -race ./pkg/... -coverpkg ./pkg/...
+
 # integration tests only
 .PHONY: integration
 integration: out/$(SAMPLES_REPO)/.decompressed-$(SAMPLES_COMMIT)