1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# \\ SPIKE: Secure your secrets with SPIFFE. — https://spike.ist/
# \\\\\ Copyright 2024-present SPIKE contributors.
# \\\\\\\ SPDX-License-Identifier: Apache-2.0
# Run Go linting using custom script
# Usage: make lint-go
# Executes the project's Go linting script located in hack/qa/
# Depends on ./hack/qa/lint-go.sh being present and executable
.PHONY: lint-go
lint-go:
./hack/qa/lint-go.sh
# Run tests with coverage report and open HTML visualization
# Usage: make test/cover
# Executes all tests with race detection and coverage profiling
# Generates an HTML coverage report and opens it in the default browser
# Coverage data is temporarily stored in /tmp/coverage.out
# Flags: -v (verbose), -race (race detection), -buildvcs (include VCS info)
.PHONY: test/cover
test/cover:
go test -v -race -buildvcs -coverprofile=/tmp/coverage.out ./...
go tool cover -html=/tmp/coverage.out
# Run all tests with race detection
# Usage: make test
# Executes all tests in the project with verbose output and race detection
# Does not generate coverage reports (use test/cover for that)
# Flags: -v (verbose), -race (race detection), -buildvcs (include VCS info),
# -p 1 (sequential execution to avoid race conditions)
# NOTE: Sequential execution is temporary workaround for concurrent environment
# variable/database access
# FIXME: Remove -p 1 flag once issue with concurrent test isolation is resolved
.PHONY: test
test:
go test -v -race -buildvcs -p 1 ./...
# Comprehensive code quality audit
# Usage: make audit
# Prerequisite: runs 'test' target first to ensure tests pass
# Performs multiple quality checks:
# 1. go mod tidy -diff: checks if go.mod needs tidying
# (fails if changes needed)
# 2. go mod verify: verifies module dependencies haven't been tampered with
# 3. gofmt check: ensures all Go files are properly formatted
# 4. go vet: runs Go's built-in static analysis
# 5. staticcheck: runs advanced static analysis
# (excluding ST1000, U1000 checks)
# 6. govulncheck: scans for known security vulnerabilities
# 7. golangci-lint: runs a comprehensive set of linters
# (follows the configuration in .golangci.yml)
.PHONY: audit
audit:
go mod tidy -diff
go mod verify
test -z "$(shell gofmt -l .)"
go vet ./...
go run honnef.co/go/tools/cmd/staticcheck@latest -checks=all,-ST1000,-U1000 ./...
go run golang.org/x/vuln/cmd/govulncheck@latest ./...
CGO_ENABLED=0 go run github.com/golangci/golangci-lint/cmd/golangci-lint@latest run
# Comprehensive set of checks to simulate a CI environment
# Usage: make ci
# Prerequisites:
# 1. runs 'test' target first to ensure tests pass
# 2. runs 'audit' target to perform code quality checks
.PHONY: ci
ci: test audit
|
