1
2GOLANGCI_LINT_VERSION=v1.48.0
3
4LINTER=./bin/golangci-lint
5LINTER_VERSION_FILE=./bin/.golangci-lint-version-$(GOLANGCI_LINT_VERSION)
6
7ALL_SOURCES := $(shell find * -type f -name "*.go")
8
9COVERAGE_PROFILE_RAW=./build/coverage_raw.out
10COVERAGE_PROFILE_RAW_HTML=./build/coverage_raw.html
11COVERAGE_PROFILE_FILTERED=./build/coverage.out
12COVERAGE_PROFILE_FILTERED_HTML=./build/coverage.html
13COVERAGE_ENFORCER_FLAGS=-package github.com/launchdarkly/go-server-sdk-evaluation/v2 -skipcode "// COVERAGE" -packagestats -filestats -showcode
14
15TEST_BINARY=./go-server-sdk-evaluation.test
16ALLOCATIONS_LOG=./allocations.out
17
18EASYJSON_TAG=-tags launchdarkly_easyjson
19
20.PHONY: all build build-easyjson clean test test-easyjson lint test-coverage benchmarks benchmark-allocs
21
22all: build build-easyjson
23
24build:
25 go build ./...
26
27build-easyjson:
28 go build $(EASYJSON_TAG) ./...
29
30clean:
31 go clean
32
33test: build
34 go test -v -race -count 1 ./...
35
36test-easyjson: build-easyjson
37 go test -v -race -count 1 $(EASYJSON_TAG) ./...
38
39test-coverage: $(COVERAGE_PROFILE_RAW)
40 go run github.com/launchdarkly-labs/go-coverage-enforcer@latest $(COVERAGE_ENFORCER_FLAGS) -outprofile $(COVERAGE_PROFILE_FILTERED) $(COVERAGE_PROFILE_RAW)
41 go tool cover -html $(COVERAGE_PROFILE_FILTERED) -o $(COVERAGE_PROFILE_FILTERED_HTML)
42 go tool cover -html $(COVERAGE_PROFILE_RAW) -o $(COVERAGE_PROFILE_RAW_HTML)
43
44$(COVERAGE_PROFILE_RAW): $(ALL_SOURCES)
45 @mkdir -p ./build
46 go test -coverprofile $(COVERAGE_PROFILE_RAW) ./... >/dev/null
47
48benchmarks: build
49 @mkdir -p ./build
50 go test -benchmem '-run=^$$' '-bench=.*' ./... | tee build/benchmarks.out
51 @if grep <build/benchmarks.out 'NoAlloc.*[1-9][0-9]* allocs/op'; then echo "Unexpected heap allocations detected in benchmarks!"; exit 1; fi
52
53benchmarks-easyjson: build-easyjson
54 go test $(EASYJSON_TAG) -benchmem '-run=^$$' '-bench=.*' ./...
55
56# See CONTRIBUTING.md regarding the use of the benchmark-allocs target. Notes about this implementation:
57# 1. We precompile the test code because otherwise the allocation traces will include the actions of the compiler itself.
58# 2. "benchtime=3x" means the run count (b.N) is set to 3. Setting it to 1 would produce less redundant output, but the
59# benchmark statistics seem to be less reliable if the run count is less than 3 - they will report a higher allocation
60# count per run, possibly because the first run
61benchmark-allocs:
62 @if [ -z "$$BENCHMARK" ]; then echo "must specify BENCHMARK=" && exit 1; fi
63 @echo Precompiling test code to $(TEST_BINARY)
64 @go test -c -o $(TEST_BINARY) >/dev/null 2>&1
65 @echo "Generating heap allocation traces in $(ALLOCATIONS_LOG) for benchmark(s): $$BENCHMARK"
66 @echo "You should see some benchmark result output; if you do not, you may have misspelled the benchmark name/regex"
67 @GODEBUG=allocfreetrace=1 $(TEST_BINARY) -test.run=none -test.bench=$$BENCHMARK -test.benchmem -test.benchtime=1x 2>$(ALLOCATIONS_LOG)
68
69$(LINTER_VERSION_FILE):
70 rm -f $(LINTER)
71 curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | bash -s $(GOLANGCI_LINT_VERSION)
72 touch $(LINTER_VERSION_FILE)
73
74lint: $(LINTER_VERSION_FILE)
75 $(LINTER) run ./...
View as plain text