xdb/Makefile at main · xdb-dev/xdb · GitHub

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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
TOOLS_MODULE := $(PROJECT_DIR)/tools.mod

# DEVELOPMENT
.PHONY: setup build install check lint tidy

SUBMODULES := $(shell find . -mindepth 2 -name go.mod -exec dirname {} \;)

setup: ##@development Setup the project and update dependencies
	go mod tidy
	@for mod in $(SUBMODULES); do (cd $$mod && go mod tidy); done

build: ##@development Build all packages
	go build ./...
	@for mod in $(SUBMODULES); do (cd $$mod && go build ./...); done

install: ##@development Install the xdb CLI binary
	cd cmd/xdb && go install .

check: ##@development Runs linting and formatting
check: tidy lint

lint: golangci-lint ##@development Runs golangci-lint (includes formatting, vetting, and linting)
	$(GOLANGCI_LINT) run --fix --config $(PROJECT_DIR)/.golangci.yml ./...
	@for mod in $(SUBMODULES); do (cd $$mod && $(GOLANGCI_LINT) run --fix --config $(PROJECT_DIR)/.golangci.yml ./...); done

tidy: ##@development Runs go mod tidy to update dependencies
	go mod tidy
	@for mod in $(SUBMODULES); do (cd $$mod && go mod tidy); done

# TESTING

.PHONY: test bench

test: ##@testing Run all tests
	go test -race -timeout=5m -covermode=atomic -coverprofile=coverage.out ./...
	@for mod in $(SUBMODULES); do echo "==> testing $$mod" && (cd $$mod && go test -race -timeout=5m ./...) || exit 1; done

bench: ##@testing Run all benchmarks
	go test -bench=. -benchmem -run=^$$ -timeout=10m ./...
	@for mod in $(SUBMODULES); do echo "==> bench $$mod" && (cd $$mod && go test -bench=. -benchmem -run=^$$ -timeout=10m ./...) || exit 1; done

# SERVICES

.PHONY: services-up services-down services-logs

services-up: ##@services Start compose services
	podman compose up -d

services-down: ##@services Stop compose services
	podman compose down

services-logs: ##@services Tail compose service logs
	podman compose logs -f

# COVERAGE

.PHONY: coverage report

coverage: ##@tests Generates coverage report
	$(GOCOV) convert coverage.out > coverage.json
	$(GOCOV) convert coverage.out | $(GOCOV) report

report: coverage ##@tests Generates html coverage report
	$(GOCOVHTML) -t kit < coverage.json > coverage.html
	@open coverage.html

# TOOLS

GOLANGCI_LINT = go tool -modfile=$(TOOLS_MODULE) golangci-lint
golangci-lint:
	$(call go-get-tool,github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.7.0)

GOCOV = go tool -modfile=$(TOOLS_MODULE) gocov
gocov:
	$(call go-get-tool,github.com/axw/gocov/gocov@v1.1.0)

GOCOVHTML = go tool -modfile=$(TOOLS_MODULE) gocov-html
gocov-html:
	$(call go-get-tool,github.com/matm/gocov-html/cmd/gocov-html@v1.4.0)

# go-get-tool will 'go get -tool' any package $1
define go-get-tool
{ \
set -e ;\
go get -modfile=$(TOOLS_MODULE) -tool $(1) ;\
}
endef