igodwin
315027ab0d
- .gitea/workflows/ci.yml: lint, race tests (e2e excluded), and govulncheck on push to main and PRs; shared composite action installs protoc + pinned protoc-gen-go/protoc-gen-go-grpc and generates the (gitignored) protobuf code before each Go job. - .golangci.yml (v2 schema): govet, staticcheck, errcheck, ineffassign, unused, misspell, gosec, revive; generated api/grpc/pb excluded. - Makefile: vuln target (govulncheck) added and chained into qa. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
264 lines
8.5 KiB
Makefile
264 lines
8.5 KiB
Makefile
.PHONY: proto proto-gen proto-clean deps build build-dev run run-grpc run-rest test lint vuln fmt vet check docker-build docker-build-dev docker-buildx-setup docker-run clean help
|
|
|
|
# Variables
|
|
REGISTRY ?=
|
|
IMAGE ?= notifier
|
|
PLATFORMS ?= linux/amd64,linux/arm64
|
|
PROTO_DIR=api/grpc
|
|
PROTO_FILE=$(PROTO_DIR)/notifier.proto
|
|
PROTO_OUT=$(PROTO_DIR)/pb
|
|
GO_MODULE=$(shell head -n 1 go.mod | awk '{print $$2}')
|
|
GO_FILES=$(shell find . -type f -name '*.go' -not -path "./vendor/*" -not -path "./api/grpc/pb/*")
|
|
|
|
# Build information
|
|
VERSION ?= dev
|
|
GIT_COMMIT := $(shell git rev-parse --short HEAD 2>/dev/null || echo unknown)
|
|
BUILD_TIME := $(shell date -u "+%Y-%m-%d_%H:%M:%S_UTC" 2>/dev/null || echo unknown)
|
|
|
|
# Base LDFLAGS (version info only)
|
|
LDFLAGS_BASE := -X main.Version=$(VERSION) -X main.GitCommit=$(GIT_COMMIT) -X main.BuildTime=$(BUILD_TIME)
|
|
|
|
# Production LDFLAGS: include symbol stripping for smaller binaries
|
|
LDFLAGS := $(LDFLAGS_BASE) -s -w
|
|
|
|
# Development LDFLAGS: keep symbols for debugging
|
|
LDFLAGS_DEV := $(LDFLAGS_BASE)
|
|
|
|
# Generate protobuf code
|
|
proto-gen:
|
|
@echo "Generating protobuf code..."
|
|
@mkdir -p $(PROTO_OUT)
|
|
protoc -I. --go_out=. --go_opt=module=$(GO_MODULE) \
|
|
--go-grpc_out=. --go-grpc_opt=module=$(GO_MODULE) \
|
|
$(PROTO_FILE)
|
|
@echo "Protobuf code generated successfully"
|
|
|
|
# Clean generated protobuf code
|
|
proto-clean:
|
|
@echo "Cleaning generated protobuf code..."
|
|
@rm -rf $(PROTO_OUT)
|
|
@echo "Cleaned"
|
|
|
|
# Install dependencies
|
|
deps:
|
|
@echo "Installing dependencies..."
|
|
go mod download
|
|
go mod tidy
|
|
@echo "Dependencies installed"
|
|
|
|
# Install protoc plugins
|
|
proto-deps:
|
|
@echo "Installing protoc plugins..."
|
|
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
|
|
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
|
|
@echo "Protoc plugins installed"
|
|
|
|
# Build binary (production - optimized with stripped symbols)
|
|
build:
|
|
@echo "Building binary (production - optimized)..."
|
|
@echo "Version: $(VERSION)"
|
|
@echo "Git Commit: $(GIT_COMMIT)"
|
|
@echo "Build Time: $(BUILD_TIME)"
|
|
@mkdir -p bin
|
|
go build -ldflags "$(LDFLAGS)" -o bin/server ./cmd/server
|
|
@ls -lh bin/server
|
|
@echo "Binary built successfully (symbols stripped for smaller size)"
|
|
|
|
# Build binary with debug symbols (development)
|
|
build-dev:
|
|
@echo "Building binary (development - with debug symbols)..."
|
|
@echo "Version: $(VERSION)"
|
|
@echo "Git Commit: $(GIT_COMMIT)"
|
|
@echo "Build Time: $(BUILD_TIME)"
|
|
@mkdir -p bin
|
|
go build -ldflags "$(LDFLAGS_DEV)" -o bin/server ./cmd/server
|
|
@ls -lh bin/server
|
|
@echo "Binary built successfully (debug symbols included for profiling/debugging)"
|
|
|
|
# Run server (default: both REST and gRPC)
|
|
run:
|
|
@echo "Running server (both REST and gRPC)..."
|
|
go run ./cmd/server/main.go
|
|
|
|
# Run in REST-only mode
|
|
run-rest:
|
|
@echo "Running server in REST-only mode..."
|
|
SERVER_MODE=rest go run ./cmd/server/main.go
|
|
|
|
# Run in gRPC-only mode
|
|
run-grpc:
|
|
@echo "Running server in gRPC-only mode..."
|
|
SERVER_MODE=grpc go run ./cmd/server/main.go
|
|
|
|
# Run tests
|
|
test:
|
|
@echo "Running tests..."
|
|
go test -v -race -cover ./...
|
|
|
|
# Run tests with coverage report
|
|
test-coverage:
|
|
@echo "Running tests with coverage..."
|
|
go test -race -coverprofile=coverage.out -covermode=atomic ./...
|
|
go tool cover -html=coverage.out -o coverage.html
|
|
@echo "Coverage report generated: coverage.html"
|
|
|
|
# Format code
|
|
fmt:
|
|
@echo "Formatting code..."
|
|
gofmt -s -w $(GO_FILES)
|
|
@echo "Code formatted"
|
|
|
|
# Check formatting
|
|
fmt-check:
|
|
@echo "Checking code formatting..."
|
|
@if [ -n "$$(gofmt -l $(GO_FILES))" ]; then \
|
|
echo "The following files need formatting:"; \
|
|
gofmt -l $(GO_FILES); \
|
|
exit 1; \
|
|
fi
|
|
@echo "All files are properly formatted"
|
|
|
|
# Run go vet
|
|
vet:
|
|
@echo "Running go vet..."
|
|
go vet ./...
|
|
@echo "go vet passed"
|
|
|
|
# Run static analysis
|
|
check: fmt-check vet
|
|
@echo "Running static checks..."
|
|
go mod verify
|
|
@echo "All checks passed"
|
|
|
|
# Run linter (requires golangci-lint)
|
|
lint:
|
|
@echo "Running linter..."
|
|
@which golangci-lint > /dev/null || (echo "golangci-lint not installed. Run: brew install golangci-lint" && exit 1)
|
|
golangci-lint run ./...
|
|
@echo "Linting passed"
|
|
|
|
# Run vulnerability scan (requires govulncheck)
|
|
vuln:
|
|
@echo "Running vulnerability scan..."
|
|
@which govulncheck > /dev/null || (echo "govulncheck not installed. Run: go install golang.org/x/vuln/cmd/govulncheck@latest" && exit 1)
|
|
govulncheck ./...
|
|
@echo "Vulnerability scan passed"
|
|
|
|
# Run all quality checks
|
|
qa: fmt vet lint vuln test
|
|
@echo "All quality checks passed!"
|
|
|
|
# Build Docker image (production - optimized)
|
|
# When REGISTRY is set, builds a multi-arch image and pushes
|
|
# $(REGISTRY)/$(IMAGE):$(VERSION) and :latest.
|
|
# Otherwise builds a single-arch local image tagged $(IMAGE):latest.
|
|
docker-build:
|
|
@echo "Version: $(VERSION)"
|
|
@echo "Git Commit: $(GIT_COMMIT)"
|
|
@echo "Build Time: $(BUILD_TIME)"
|
|
ifeq ($(strip $(REGISTRY)),)
|
|
@echo "Building single-arch local Docker image..."
|
|
docker build \
|
|
--build-arg VERSION=$(VERSION) \
|
|
--build-arg GIT_COMMIT=$(GIT_COMMIT) \
|
|
--build-arg BUILD_TIME=$(BUILD_TIME) \
|
|
--build-arg BUILD_FLAGS="-s -w" \
|
|
-t $(IMAGE):latest .
|
|
@echo "Docker image built successfully (production - optimized)"
|
|
else
|
|
@$(MAKE) docker-buildx-setup
|
|
@echo "Building multi-arch image ($(PLATFORMS)) and pushing to $(REGISTRY)/$(IMAGE):$(VERSION)..."
|
|
docker buildx build \
|
|
--platform $(PLATFORMS) \
|
|
--build-arg VERSION=$(VERSION) \
|
|
--build-arg GIT_COMMIT=$(GIT_COMMIT) \
|
|
--build-arg BUILD_TIME=$(BUILD_TIME) \
|
|
--build-arg BUILD_FLAGS="-s -w" \
|
|
--provenance=false \
|
|
--tag $(REGISTRY)/$(IMAGE):$(VERSION) \
|
|
--tag $(REGISTRY)/$(IMAGE):latest \
|
|
--push .
|
|
@echo "Multi-arch image pushed successfully"
|
|
endif
|
|
|
|
# Build Docker image with debug symbols (development)
|
|
docker-build-dev:
|
|
@echo "Building Docker image (development - with debug symbols)..."
|
|
@echo "Version: $(VERSION)"
|
|
@echo "Git Commit: $(GIT_COMMIT)"
|
|
@echo "Build Time: $(BUILD_TIME)"
|
|
docker build \
|
|
--build-arg VERSION=$(VERSION) \
|
|
--build-arg GIT_COMMIT=$(GIT_COMMIT) \
|
|
--build-arg BUILD_TIME=$(BUILD_TIME) \
|
|
--build-arg BUILD_FLAGS="" \
|
|
-t notifier:latest-dev .
|
|
@echo "Docker image built successfully (development)"
|
|
|
|
# Set up Docker buildx builder for multi-arch builds
|
|
docker-buildx-setup:
|
|
@echo "Setting up Docker buildx builder..."
|
|
@docker buildx inspect multiarch > /dev/null 2>&1 || docker buildx create --name multiarch --driver docker-container
|
|
@docker buildx use multiarch
|
|
@docker buildx inspect multiarch --bootstrap
|
|
@echo "Buildx builder ready"
|
|
|
|
# Run Docker container
|
|
docker-run:
|
|
@echo "Running Docker container..."
|
|
docker run -p 8080:8080 -p 50051:50051 -v $(PWD)/config.yaml:/app/config.yaml notifier:latest
|
|
|
|
# Clean build artifacts
|
|
clean:
|
|
@echo "Cleaning build artifacts..."
|
|
@rm -rf bin/
|
|
@rm -rf $(PROTO_OUT)
|
|
@echo "Cleaned"
|
|
|
|
# Help
|
|
help:
|
|
@echo "Available targets:"
|
|
@echo ""
|
|
@echo "Build:"
|
|
@echo " build - Build server binary"
|
|
@echo " clean - Clean build artifacts"
|
|
@echo ""
|
|
@echo "Run:"
|
|
@echo " run - Run server (both REST and gRPC)"
|
|
@echo " run-rest - Run server in REST-only mode"
|
|
@echo " run-grpc - Run server in gRPC-only mode"
|
|
@echo ""
|
|
@echo "Test:"
|
|
@echo " test - Run tests with race detector"
|
|
@echo " test-coverage - Run tests with coverage report"
|
|
@echo ""
|
|
@echo "Code Quality:"
|
|
@echo " fmt - Format code with gofmt"
|
|
@echo " fmt-check - Check if code is formatted"
|
|
@echo " vet - Run go vet"
|
|
@echo " lint - Run golangci-lint (requires installation)"
|
|
@echo " check - Run fmt-check + vet + mod verify"
|
|
@echo " qa - Run all quality checks (fmt + vet + lint + test)"
|
|
@echo ""
|
|
@echo "Protobuf:"
|
|
@echo " proto-gen - Generate protobuf code"
|
|
@echo " proto-clean - Clean generated protobuf code"
|
|
@echo " proto-deps - Install protoc plugins"
|
|
@echo ""
|
|
@echo "Dependencies:"
|
|
@echo " deps - Install Go dependencies"
|
|
@echo ""
|
|
@echo "Docker:"
|
|
@echo " docker-build - Build Docker image"
|
|
@echo " - default: single-arch local image"
|
|
@echo " - with REGISTRY set: multi-arch (amd64+arm64) build + push"
|
|
@echo " docker-build-dev - Build Docker image with debug symbols"
|
|
@echo " docker-buildx-setup - Set up buildx builder for multi-arch"
|
|
@echo " docker-run - Run Docker container locally"
|
|
@echo ""
|
|
@echo "Variables:"
|
|
@echo " VERSION - Image version tag (default: dev)"
|
|
@echo " REGISTRY - Registry prefix for docker-build (e.g. registry.example.com/org)"
|
|
@echo " IMAGE - Image name (default: notifier)"
|
|
@echo " PLATFORMS - Build platforms (default: $(PLATFORMS))"
|