Testing Workflow with Coverage Reports

Intermediate10 minTrending

Run Go tests with race detection, generate coverage reports, and visualize coverage in the browser.

Prerequisites

-Go 1.21+ installed
-A Go project with tests

Steps

Run all tests with verbose output

Execute the full test suite with verbose output and race detection enabled.

$ go test ./... -v -race

The -race flag detects data races at runtime. Always use it in CI.

Generate a coverage profile

Run tests and output a coverage profile file for analysis.

$ go test ./... -coverprofile=coverage.out -covermode=atomic

View coverage summary by function

Display a breakdown of coverage percentage per function.

$ go tool cover -func=coverage.out

Open coverage report in the browser

Generate an HTML coverage report and open it for visual inspection.

$ go tool cover -html=coverage.out -o coverage.html

Green lines are covered, red lines are not. Focus on uncovered branches in critical paths.

Enforce minimum coverage threshold

Parse coverage output and fail the build if total coverage is below a threshold.

$ go test ./... -coverprofile=coverage.out && total=$(go tool cover -func=coverage.out | grep total | awk '{print $3}' | tr -d '%') && echo "Coverage: ${total}%" && [ $(echo "$total >= 70" | bc) -eq 1 ] || (echo 'FAIL: coverage below 70%' && exit 1)

Set a realistic threshold. Forcing 100% coverage leads to low-value tests.

Full Script

full-script.sh

#!/bin/bash
# Go Test Coverage Workflow
set -euo pipefail

THRESHOLD=${1:-70}

echo "=== Running Tests with Race Detection ==="
go test ./... -v -race -coverprofile=coverage.out -covermode=atomic

echo ""
echo "=== Coverage by Function ==="
go tool cover -func=coverage.out

echo ""
echo "=== Coverage Summary ==="
TOTAL=$(go tool cover -func=coverage.out | grep total | awk '{print $3}' | tr -d '%')
echo "Total coverage: ${TOTAL}%"
echo "Threshold: ${THRESHOLD}%"

if [ "$(echo "$TOTAL >= $THRESHOLD" | bc)" -eq 1 ]; then
  echo "PASS: Coverage meets threshold"
else
  echo "FAIL: Coverage below threshold"
  exit 1
fi

echo ""
echo "=== Generate HTML Report ==="
go tool cover -html=coverage.out -o coverage.html
echo "Open coverage.html in your browser to view the report"

FAQ

Discussion

Loading comments...

#!/bin/bash # Go Test Coverage Workflow set -euo pipefail THRESHOLD=${1:-70} echo "=== Running Tests with Race Detection ===" go test ./... -v -race -coverprofile=coverage.out -covermode=atomic echo "" echo "=== Coverage by Function ===" go tool cover -func=coverage.out echo "" echo "=== Coverage Summary ===" TOTAL=$(go tool cover -func=coverage.out | grep total | awk '{print $3}' | tr -d '%') echo "Total coverage: ${TOTAL}%" echo "Threshold: ${THRESHOLD}%" if [ "$(echo "$TOTAL >= $THRESHOLD" | bc)" -eq 1 ]; then echo "PASS: Coverage meets threshold" else echo "FAIL: Coverage below threshold" exit 1 fi echo "" echo "=== Generate HTML Report ===" go tool cover -html=coverage.out -o coverage.html echo "Open coverage.html in your browser to view the report"