registry/Makefile at main · modelcontextprotocol/registry · 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
.PHONY: help build test test-unit test-integration test-endpoints test-publish test-all lint lint-fix validate validate-schemas validate-examples check ko-build ko-rebuild dev-compose dev-down clean publisher generate-schema check-schema

# Use bash for all commands to support pipefail
SHELL := /bin/bash

# Default target
help: ## Show this help message
	@echo "Available targets:"
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  %-20s %s\n", $$1, $$2}'

# Build targets
build: ## Build the registry application with version info
	@mkdir -p bin
	go build -ldflags="-X main.Version=dev-$(shell git rev-parse --short HEAD) -X main.GitCommit=$(shell git rev-parse HEAD) -X main.BuildTime=$(shell date -u +%Y-%m-%dT%H:%M:%SZ)" -o bin/registry ./cmd/registry

publisher: ## Build the publisher tool with version info
	@mkdir -p bin
	go build -ldflags="-X main.Version=dev-$(shell git rev-parse --short HEAD) -X main.GitCommit=$(shell git rev-parse HEAD) -X main.BuildTime=$(shell date -u +%Y-%m-%dT%H:%M:%SZ)" -o bin/mcp-publisher ./cmd/publisher

# Schema generation targets
generate-schema: ## Generate server.schema.json from openapi.yaml
	@mkdir -p bin
	go build -o bin/extract-server-schema ./tools/extract-server-schema
	@./bin/extract-server-schema

check-schema: ## Check if server.schema.json is in sync with openapi.yaml
	@mkdir -p bin
	go build -o bin/extract-server-schema ./tools/extract-server-schema
	@./bin/extract-server-schema -check

# Test targets
test-unit: ## Run unit tests with coverage (requires PostgreSQL)
	@echo "Starting PostgreSQL for unit tests..."
	@docker compose up -d postgres 2>&1 | grep -v "Pulling\|Pulled\|Creating\|Created\|Starting\|Started" || true
	@echo "Waiting for PostgreSQL to be ready..."
	@sleep 3
	@echo ""
	@echo "Running unit tests..."
	@set -o pipefail; if command -v gotestsum >/dev/null 2>&1; then \
		gotestsum --format pkgname-and-test-fails -- -race -coverprofile=coverage.out -covermode=atomic ./internal/... ./cmd/... 2>&1 | grep -v "ld: warning:"; \
	else \
		go test -race -coverprofile=coverage.out -covermode=atomic ./internal/... ./cmd/... 2>&1 | grep -v "ld: warning:" | grep -v "^ld:"; \
	fi
	@echo ""
	@go tool cover -html=coverage.out -o coverage.html
	@echo "✅ Coverage report: coverage.html"
	@go tool cover -func=coverage.out | tail -1
	@echo ""
	@docker compose down postgres >/dev/null 2>&1
	@echo "✅ Tests complete"

test: ## Run unit tests (use 'make test-all' to run all tests)
	@echo "⚠️  Running unit tests only. Use 'make test-all' to run both unit and integration tests."
	@$(MAKE) test-unit

test-integration: ## Run integration tests
	./tests/integration/run.sh

test-endpoints: ## Test API endpoints (requires running server)
	./scripts/test_endpoints.sh

test-publish: ## Test publish endpoint (requires BEARER_TOKEN env var)
	./scripts/test_publish.sh

test-all: test-unit test-integration ## Run all tests (unit and integration)

# Validation targets
validate-schemas: ## Validate JSON schemas
	./tools/validate-schemas.sh
	@$(MAKE) check-schema

validate-examples: ## Validate examples against schemas
	./tools/validate-examples.sh

validate: validate-schemas validate-examples ## Run all validation checks

# Lint targets
lint: ## Run linter (includes formatting)
	golangci-lint run --timeout=5m

lint-fix: ## Run linter with auto-fix (includes formatting)
	golangci-lint run --fix --timeout=5m

# Combined targets
check: dev-down lint validate test-all ## Run all checks (lint, validate, unit tests) and ensure dev environment is down
	@echo "All checks passed!"

# Development targets
ko-build: ## Build registry image using ko (loads into local docker daemon)
	@echo "Building registry with ko..."
	VERSION=dev-$$(git rev-parse --short HEAD) \
	GIT_COMMIT=$$(git rev-parse HEAD) \
	BUILD_TIME=$$(date -u +%Y-%m-%dT%H:%M:%SZ) \
	KO_DOCKER_REPO=ko.local \
	ko build --preserve-import-paths --tags=dev --sbom=none ./cmd/registry
	@echo "Image built: ko.local/github.com/modelcontextprotocol/registry/cmd/registry:dev"

ko-rebuild: ## Rebuild with ko and restart registry container
	@$(MAKE) ko-build
	@echo "Restarting registry container..."
	@docker compose restart registry

dev-compose: ko-build ## Start development environment with Docker Compose (builds with ko first)
	@echo "Starting Docker Compose..."
	docker compose up

dev-down: ## Stop development environment
	docker compose down

# Cleanup
clean: ## Clean build artifacts and coverage files
	rm -rf bin
	rm -f coverage.out coverage.html


.DEFAULT_GOAL := help