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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
|
# Copyright 2019-2025 The Wait4X Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# =============================================================================
# Configuration
# =============================================================================
# Go configuration
GO_BINARY ?= $(shell which go)
GO_ENVIRONMENTS ?=
GO_VERSION ?= $(shell $(GO_BINARY) version | cut -d' ' -f3 | sed 's/go//')
# Wait4X configuration
WAIT4X_BINARY_NAME ?= wait4x
WAIT4X_MODULE_NAME ?= wait4x.dev/v3
WAIT4X_MAIN_PATH ?= cmd/wait4x/main.go
# Test configuration
WAIT4X_COVERAGE_IGNORE_PACKAGES ?= ${WAIT4X_MODULE_NAME}/examples ${WAIT4X_MODULE_NAME}/cmd
# Build configuration
WAIT4X_BUILD_OUTPUT ?= ${CURDIR}/dist
WAIT4X_BUILD_OS ?= $(shell go env GOOS)
WAIT4X_BUILD_ARCH ?= $(shell go env GOARCH)
WAIT4X_BUILD_CGO ?= 0
# Version information
WAIT4X_COMMIT_REF_SLUG ?= $(shell [ -d ./.git ] && (git symbolic-ref -q --short HEAD || git describe --tags --always 2>/dev/null || echo "unknown"))
WAIT4X_COMMIT_HASH ?= $(shell [ -d ./.git ] && git rev-parse HEAD 2>/dev/null || echo "unknown")
WAIT4X_BUILD_TIME ?= $(shell date -u '+%FT%TZ')
# Change output to .exe for windows
ifeq (windows,$(filter windows,$(WAIT4X_BUILD_OS) $(TARGETOS)))
WAIT4X_BINARY_NAME := ${WAIT4X_BINARY_NAME}.exe
endif
# =============================================================================
# Build flags and LDFLAGS
# =============================================================================
# Base LDFLAGS for reproducible builds and metadata
WAIT4X_BUILD_LDFLAGS ?= -buildid= -w \
-X $(WAIT4X_MODULE_NAME)/internal/cmd.BuildTime=$(WAIT4X_BUILD_TIME)
# Add version information if available
ifneq ($(WAIT4X_COMMIT_REF_SLUG),)
WAIT4X_BUILD_LDFLAGS += -X $(WAIT4X_MODULE_NAME)/internal/cmd.AppVersion=$(WAIT4X_COMMIT_REF_SLUG)
endif
ifneq ($(WAIT4X_COMMIT_HASH),)
WAIT4X_BUILD_LDFLAGS += -X $(WAIT4X_MODULE_NAME)/internal/cmd.GitCommit=$(WAIT4X_COMMIT_HASH)
endif
# Build flags for reproducible builds
WAIT4X_BUILD_FLAGS ?= -trimpath -ldflags="$(WAIT4X_BUILD_LDFLAGS)"
WAIT4X_RUN_FLAGS ?= -ldflags="$(WAIT4X_BUILD_LDFLAGS)"
# Runtime flags
WAIT4X_FLAGS ?=
# =============================================================================
# Utility functions
# =============================================================================
# Check if a command exists
check_cmd = $(shell command -v $(1) 2> /dev/null)
# Filter coverage output to exclude ignored packages
filter_coverage = @grep $(foreach pkg,$(WAIT4X_COVERAGE_IGNORE_PACKAGES),-v -e "$(pkg)") coverage.out.tmp > coverage.out
# Common build function
define build_binary
@mkdir -p $(WAIT4X_BUILD_OUTPUT)
CGO_ENABLED=$(WAIT4X_BUILD_CGO) GOOS=$(WAIT4X_BUILD_OS) GOARCH=$(WAIT4X_BUILD_ARCH) \
$(GO_ENVIRONMENTS) $(GO_BINARY) build -v $(1) \
-o $(WAIT4X_BUILD_OUTPUT)/$(2) $(WAIT4X_MAIN_PATH)
endef
# =============================================================================
# Targets
# =============================================================================
.PHONY: help
help: ## Show this help message
@echo " __ __ .__ __ _________ ___"
@echo "/ \ / \_____ |__|/ |_ / | \ \/ /"
@echo "\ \/\/ /\__ \ | \ __\/ | |\ / "
@echo " \ / / __ \| || | / ^ / \ "
@echo " \__/\ / (____ /__||__| \____ /___/\ \\"
@echo " \/ \/ |__| \_/"
@echo ""
@echo "Available targets:"
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf " \033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
@echo ""
@echo "Environment variables:"
@echo " GO_BINARY Go binary to use (default: $(GO_BINARY))"
@echo " GO_ENVIRONMENTS Additional environment variables for Go (default: $(if $(GO_ENVIRONMENTS),$(GO_ENVIRONMENTS),none))"
@echo " WAIT4X_BUILD_OUTPUT Build output directory (default: ${WAIT4X_BUILD_OUTPUT})"
@echo " WAIT4X_BUILD_OS Target OS for cross-compilation (default: $(WAIT4X_BUILD_OS))"
@echo " WAIT4X_BUILD_ARCH Target architecture for cross-compilation (default: $(WAIT4X_BUILD_ARCH))"
@echo " WAIT4X_FLAGS Additional flags for wait4x binary (default: $(if $(WAIT4X_FLAGS),$(WAIT4X_FLAGS),none))"
@echo " WAIT4X_COVERAGE_IGNORE_PACKAGES Space-separated list of packages to exclude from coverage (default: ${WAIT4X_COVERAGE_IGNORE_PACKAGES})"
.PHONY: version
version: ## Show version information
@echo "Go version: $(GO_VERSION)"
@echo "Build OS: $(WAIT4X_BUILD_OS)"
@echo "Build ARCH: $(WAIT4X_BUILD_ARCH)"
@echo "Commit ref: $(WAIT4X_COMMIT_REF_SLUG)"
@echo "Commit hash: $(WAIT4X_COMMIT_HASH)"
@echo "Build time: $(WAIT4X_BUILD_TIME)"
@echo "Coverage ignore packages: $(WAIT4X_COVERAGE_IGNORE_PACKAGES)"
.PHONY: show-coverage-config
show-coverage-config: ## Show current coverage configuration
@echo "Coverage ignore packages: $(WAIT4X_COVERAGE_IGNORE_PACKAGES)"
@echo "To modify, set WAIT4X_COVERAGE_IGNORE_PACKAGES environment variable"
@echo "Example: WAIT4X_COVERAGE_IGNORE_PACKAGES='pkg1 pkg2' make test"
.PHONY: clean
clean: ## Clean build artifacts
@echo "Cleaning build artifacts..."
@rm -rf $(WAIT4X_BUILD_OUTPUT)
@go clean -cache -testcache -modcache
@echo "Clean complete!"
.PHONY: deps
deps: ## Download and tidy dependencies
@echo "Downloading dependencies..."
$(GO_ENVIRONMENTS) $(GO_BINARY) mod download
$(GO_ENVIRONMENTS) $(GO_BINARY) mod tidy
@echo "Dependencies ready!"
.PHONY: check-deps
check-deps: ## Check for outdated dependencies
@echo "Checking for outdated dependencies..."
@$(GO_ENVIRONMENTS) $(GO_BINARY) list -u -m all | grep -v "go:" || echo "All dependencies are up to date"
.PHONY: test
test: ## Run tests with coverage
@echo "Running tests..."
$(GO_ENVIRONMENTS) $(GO_BINARY) test -v -race -covermode=atomic -coverprofile=coverage.out.tmp ./...
@$(filter_coverage) > coverage.out
@rm coverage.out.tmp
@echo "Test coverage report generated: coverage.out"
.PHONY: test-short
test-short: ## Run tests without race detection and integration tests
@echo "Running tests (short mode)..."
$(GO_ENVIRONMENTS) $(GO_BINARY) test -v -short -covermode=atomic -coverprofile=coverage.out.tmp ./...
@$(filter_coverage) > coverage.out
@rm coverage.out.tmp
.PHONY: test-coverage
test-coverage: ## Run tests and show coverage report
@echo "Running tests with coverage..."
$(GO_ENVIRONMENTS) $(GO_BINARY) test -v -race -covermode=atomic -coverprofile=coverage.out.tmp ./...
@$(filter_coverage) > coverage.out
@rm coverage.out.tmp
@echo "Coverage report:"
$(GO_ENVIRONMENTS) $(GO_BINARY) tool cover -func=coverage.out
@echo ""
@echo "HTML coverage report:"
$(GO_ENVIRONMENTS) $(GO_BINARY) tool cover -html=coverage.out -o coverage.html
@echo "Coverage report saved to coverage.html"
.PHONY: lint
lint: ## Run all linting checks
@echo "Running linting checks..."
@$(MAKE) check-gofmt
@$(MAKE) check-revive
@$(MAKE) check-govet
@echo "All linting checks passed!"
.PHONY: check-gofmt
check-gofmt: ## Check Go code formatting
@echo "Checking Go code formatting..."
@if [ -n "$(shell gofmt -s -l .)" ]; then \
echo "❌ Go code is not formatted. Run 'make fmt' to fix."; \
exit 1; \
fi
@echo "✅ Go code formatting is correct"
.PHONY: fmt
fmt: ## Format Go code
@echo "Formatting Go code..."
$(GO_ENVIRONMENTS) $(GO_BINARY) fmt ./...
gofmt -s -w .
@echo "✅ Go code formatted"
.PHONY: check-revive
check-revive: ## Run revive linter
@echo "Running revive linter..."
@if [ -z "$(call check_cmd,revive)" ]; then \
echo "❌ revive not found. Install with: go install github.com/mgechev/revive@latest (or run 'nix develop' to install)"; \
exit 1; \
fi
revive -config .revive.toml -formatter friendly ./...
.PHONY: check-govet
check-govet: ## Run go vet
@echo "Running go vet..."
$(GO_ENVIRONMENTS) $(GO_BINARY) vet ./...
.PHONY: security
security: ## Run security checks
@echo "Running security checks..."
@if [ -n "$(call check_cmd,gosec)" ]; then \
gosec ./...; \
else \
echo "⚠️ gosec not found. Install with: go install github.com/securecodewarrior/gosec/v2/cmd/gosec@latest (or run 'nix develop' to install)"; \
fi
.PHONY: build
build: ## Build Wait4X binary
@echo "Building Wait4X..."
$(call build_binary,$(WAIT4X_BUILD_FLAGS),$(WAIT4X_BINARY_NAME))
@echo "✅ Binary built: $(WAIT4X_BUILD_OUTPUT)/$(WAIT4X_BINARY_NAME)"
.PHONY: build-debug
build-debug: ## Build Wait4X binary with debug information
@echo "Building Wait4X (debug mode)..."
$(call build_binary,-gcflags="all=-N -l",$(WAIT4X_BINARY_NAME)-debug)
@echo "✅ Debug binary built: $(WAIT4X_BUILD_OUTPUT)/$(WAIT4X_BINARY_NAME)-debug"
.PHONY: build-cross
build-cross: ## Build Wait4X for multiple platforms
@echo "Building Wait4X for multiple platforms..."
@mkdir -p $(WAIT4X_BUILD_OUTPUT)
@for os in linux darwin windows; do \
for arch in amd64 arm64; do \
if [ "$$os" = "windows" ]; then \
binary_name="$(WAIT4X_BINARY_NAME).exe"; \
else \
binary_name="$(WAIT4X_BINARY_NAME)"; \
fi; \
echo "Building for $$os/$$arch..."; \
CGO_ENABLED=0 GOOS=$$os GOARCH=$$arch \
$(GO_ENVIRONMENTS) $(GO_BINARY) build -v $(WAIT4X_BUILD_FLAGS) \
-o $(WAIT4X_BUILD_OUTPUT)/$(WAIT4X_BINARY_NAME)-$$os-$$arch/$$binary_name $(WAIT4X_MAIN_PATH); \
done; \
done
@echo "✅ Cross-platform builds complete!"
.PHONY: install
install: build ## Install Wait4X to system
@echo "Installing Wait4X..."
$(GO_ENVIRONMENTS) $(GO_BINARY) install $(WAIT4X_BUILD_FLAGS) $(WAIT4X_MAIN_PATH)
@echo "✅ Wait4X installed to $(shell go env GOPATH)/bin/"
.PHONY: run
run: ## Run Wait4X
@echo "Running Wait4X..."
$(GO_ENVIRONMENTS) $(GO_BINARY) run $(WAIT4X_RUN_FLAGS) $(WAIT4X_MAIN_PATH) $(WAIT4X_FLAGS)
.PHONY: run-examples
run-examples: ## Run example configurations
@echo "Running examples..."
@if [ -d "examples" ]; then \
for example in examples/*/; do \
if [ -f "$$example/main.go" ]; then \
echo "Running example: $$(basename $$example)"; \
cd $$example && go run main.go; \
cd - > /dev/null; \
fi; \
done; \
else \
echo "No examples directory found"; \
fi
.PHONY: docker-build
docker-build: ## Build Docker image
@echo "Building Docker image..."
docker build -t wait4x:latest .
@echo "✅ Docker image built: wait4x:latest"
.PHONY: docker-run
docker-run: ## Run Wait4X in Docker
@echo "Running Wait4X in Docker..."
docker run --rm wait4x:latest $(WAIT4X_FLAGS)
.PHONY: release
release: clean deps lint test build-cross ## Prepare release (clean, lint, test, build)
@echo "✅ Release preparation complete!"
.PHONY: ci
ci: deps lint test ## Run CI pipeline
@echo "✅ CI pipeline completed successfully!"
# =============================================================================
# Development helpers
# =============================================================================
.PHONY: dev-setup
dev-setup: ## Setup development environment
@echo "Setting up development environment..."
@echo "Using Nix for development environment setup..."
@echo "Run 'nix develop' to enter the development shell with all tools pre-installed"
@echo "Or run 'nix build' to build the project"
@echo "✅ Development environment ready! (Managed by Nix)"
# =============================================================================
# Documentation
# =============================================================================
.PHONY: docs
docs: ## Generate documentation
@echo "Generating documentation..."
@if [ -z "$(call check_cmd,godoc)" ]; then \
echo "⚠️ godoc not found. Install with: go install golang.org/x/tools/cmd/godoc@latest (or run 'nix develop' to install)"; \
exit 1; \
else \
echo "Running 'godoc -http=:6060' to start the documentation server"; \
echo "Open your browser to http://localhost:6060/pkg/$(WAIT4X_MODULE_NAME)/"; \
echo "Press Ctrl+C to stop the server"; \
godoc -http=:6060; \
fi
# =============================================================================
# Default target
# =============================================================================
.DEFAULT_GOAL := help
|