b0a79c110c<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> The following PR leverages ko instead of docker build for building the container image. The motivation for the move is that ko has been one of the widely adopted ways to build Go applications, but overall its benefits are: * Build time is much faster - around 70-80% * The resulting image size is much smaller (also more secure) - around 50% smaller The changes in this PR are: * Updated the workflows for staging and release to prod to use it * Updated the local development + the integration tests to use it (the integration tests overwrite the base image from chainguards one to alpine mostly because we rely on wget to check the health status and you don't get that in the stripped down one) From the user point of view everything should continue to work as it is. ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> --------- Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
113 lines
4.4 KiB
Makefile
113 lines
4.4 KiB
Makefile
.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
|
|
|
|
# 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..."
|
|
@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
|