cocoon/Makefile at master · projecteru2/cocoon · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
.PHONY: all build build-linux test test-race test-short lint vet fmt fmt-check \
       clean deps install check ci coverage verify help

REPO_PATH := github.com/projecteru2/cocoon
REVISION := $(shell git rev-parse HEAD || echo unknown)
BUILTAT := $(shell date +%Y-%m-%dT%H:%M:%S)
VERSION := $(shell git describe --tags $(shell git rev-list --tags --max-count=1) 2>/dev/null || echo dev)
GO_LDFLAGS ?= -X $(REPO_PATH)/version.REVISION=$(REVISION) \
              -X $(REPO_PATH)/version.BUILTAT=$(BUILTAT) \
              -X $(REPO_PATH)/version.VERSION=$(VERSION)

ifneq ($(KEEP_SYMBOL), 1)
	GO_LDFLAGS += -s
endif

## Location to install dependencies to
LOCALBIN ?= $(shell pwd)/bin
$(LOCALBIN):
	mkdir -p $(LOCALBIN)

## Tool versions
GOLANGCILINT_VERSION ?= v2.9.0
GOLANGCILINT_ROOT := $(LOCALBIN)/golangci-lint-$(GOLANGCILINT_VERSION)
GOLANGCILINT := $(GOLANGCILINT_ROOT)/golangci-lint

GOFMT := $(LOCALBIN)/gofumpt
GOIMPORTS := $(LOCALBIN)/goimports

## Tool download targets
.PHONY: golangci-lint
golangci-lint: $(GOLANGCILINT)
$(GOLANGCILINT):
	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOLANGCILINT_ROOT) $(GOLANGCILINT_VERSION)

.PHONY: gofumpt
gofumpt: $(GOFMT)
$(GOFMT): | $(LOCALBIN)
	GOBIN=$(LOCALBIN) go install mvdan.cc/gofumpt@latest

.PHONY: goimports
goimports: $(GOIMPORTS)
$(GOIMPORTS): | $(LOCALBIN)
	GOBIN=$(LOCALBIN) go install golang.org/x/tools/cmd/goimports@latest

# --- Primary targets ---

all: deps lint test build ## Run deps, lint, test, and build

ci: fmt-check vet lint test build ## Run all CI checks

verify: lint fmt-check ## Verify code is lint-clean and formatted
	@if ! git diff --quiet HEAD; then \
		git diff; \
		echo "files are out of date, run 'make fmt' and commit"; exit 1; \
	fi

# --- Dependencies ---

deps: ## Tidy Go modules
	go mod tidy

# --- Build ---

build: ## Build cocoon binary
	CGO_ENABLED=0 go build -ldflags "$(GO_LDFLAGS)" -o cocoon .

build-linux: ## Cross-compile for linux/amd64
	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "$(GO_LDFLAGS)" -o cocoon-linux-amd64 .

install: ## Install cocoon binary to GOPATH/bin
	go install -ldflags "$(GO_LDFLAGS)" .

# --- Testing ---

test: vet ## Run tests with race detection and coverage
	go test -race -timeout 120s -count=1 -cover -coverprofile=coverage.out ./...

test-race: ## Run tests with race detector only
	go test -race -timeout 120s -count=1 ./...

test-short: ## Run short tests (skip long-running tests)
	go test -short ./...

coverage: test ## Generate and display coverage report
	go tool cover -func=coverage.out
	@echo ""
	@echo "To view HTML coverage report: go tool cover -html=coverage.out"

# --- Code quality ---

vet: ## Run go vet for all target platforms
	GOOS=linux GOARCH=amd64 go vet ./...
	GOOS=darwin GOARCH=amd64 go vet ./...

lint: golangci-lint ## Run golangci-lint for all target platforms
	GOOS=linux GOARCH=amd64 $(GOLANGCILINT) run
	GOOS=darwin GOARCH=amd64 $(GOLANGCILINT) run

fmt: gofumpt goimports ## Format code with gofumpt and goimports
	$(GOFMT) -l -w .
	$(GOIMPORTS) -l -w --local 'github.com/projecteru2/cocoon' .

fmt-check: gofumpt goimports ## Check formatting (fails if files need formatting)
	@test -z "$$($(GOFMT) -l .)" || { echo "Files need formatting (gofumpt):"; $(GOFMT) -l .; exit 1; }
	@test -z "$$($(GOIMPORTS) -l .)" || { echo "Files need formatting (goimports):"; $(GOIMPORTS) -l .; exit 1; }

check: vet lint test ## Run vet, lint, and test

# --- Maintenance ---

clean: ## Remove build artifacts, coverage files, and test cache
	rm -f cocoon cocoon-linux-* cocoon-darwin-*
	rm -rf bin/ dist/
	rm -f coverage.out coverage.html coverage.txt
	go clean -testcache

cloc: ## Count lines of code (requires cloc)
	cloc --exclude-dir=vendor,dist --exclude-ext=json .

# --- Help ---

help: ## Show this help message
	@echo "Cocoon Makefile targets:"
	@echo ""
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
		awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2}'
	@echo ""