syfthub/Makefile at main · OpenMined/syfthub · 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
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
.PHONY: help setup dev stop test test-integration check logs

# =============================================================================
# SyftHub Development Commands
# =============================================================================
#
# Quick Start:
#   make setup       - Install dev dependencies (pre-commit, etc.)
#   make dev         - Start development environment
#   make logs        - View logs (debug issues)
#   make test        - Run tests (parallel, uses all CPU cores)
#   make check       - Run code quality checks
#   make stop        - Stop all services
#
# For production deployment, see README.md
# =============================================================================

help:  ## Show available commands
	@echo ''
	@echo 'SyftHub Development Commands:'
	@echo ''
	@echo '  make setup        Install dev dependencies (pre-commit, etc.)'
	@echo '  make dev          Start development environment (http://localhost:8080)'
	@echo '  make stop         Stop all services'
	@echo '  make test         Run all tests (parallel execution)'
	@echo '  make check        Run code quality checks (lint, format, types)'
	@echo '  make logs         View container logs'
	@echo ''
	@echo 'Production deployment:'
	@echo '  docker compose -f docker-compose.prod.yml up -d'
	@echo ''

setup:  ## Install dev dependencies (pre-commit, etc.)
	@echo 'Setting up development environment...'
	@test -d .venv || uv venv .venv
	@. .venv/bin/activate && uv pip install pre-commit
	@. .venv/bin/activate && pre-commit install
	@npm install ./sdk/typescript
	@npm --prefix sdk/typescript run build
	@echo ''
	@echo 'Setup complete! Activate the virtualenv with:'
	@echo '  source .venv/bin/activate'
	@echo ''

dev:  ## Start development environment
	@docker compose -f deploy/docker-compose.dev.yml up -d --build
	@echo ''
	@echo '══════════════════════════════════════════'
	@echo '  SyftHub Development Environment'
	@echo '══════════════════════════════════════════'
	@echo ''
	@echo '  App:      http://localhost:8080'
	@echo '  API Docs: http://localhost:8080/docs'
	@echo '  Database: localhost:5432 (syfthub/syfthub_dev_password)'
	@echo ''
	@echo '  make logs  - View logs'
	@echo '  make stop  - Stop services'
	@echo '══════════════════════════════════════════'

stop:  ## Stop all services
	@docker compose -f deploy/docker-compose.dev.yml down 2>/dev/null || true
	@docker compose -f deploy/docker-compose.deploy.yml down 2>/dev/null || true
	@echo 'All services stopped'

test:  ## Run all tests (parallel execution using all CPU cores)
	@echo '═══════════════════════════════════════════════════════════════'
	@echo '  Running all tests in PARALLEL mode (-n auto)'
	@echo '═══════════════════════════════════════════════════════════════'
	@echo ''
	@echo 'Backend tests...'
	@cd components/backend && uv sync --extra dev && uv run pytest
	@echo ''
	@echo 'Aggregator tests...'
	@cd components/aggregator && uv sync --extra dev && uv run pytest
	@echo ''
	@echo 'CLI tests...'
	@cd cli && uv sync --extra dev && uv run pytest
	@echo ''
	@echo 'Python SDK unit tests...'
	@cd sdk/python && uv sync --extra dev && uv run pytest tests/unit
	@echo ''
	@echo 'TypeScript SDK unit tests...'
	@cd sdk/typescript && npx vitest run --exclude 'tests/integration/**' || echo 'TypeScript SDK tests skipped'
	@echo ''
	@echo 'Frontend tests...'
	@cd components/frontend && npm run test --if-present || echo 'Frontend tests skipped (playwright not configured)'
	@echo ''
	@echo '═══════════════════════════════════════════════════════════════'
	@echo '  All tests complete!'
	@echo '═══════════════════════════════════════════════════════════════'

test-integration:  ## Run integration tests (requires dev server running)
	@echo 'Running SDK integration tests...'
	@echo '(Requires: make dev to be running)'
	@echo ''
	@echo 'Python SDK integration tests...'
	@cd sdk/python && uv run pytest tests/integration/ -v
	@echo ''
	@echo 'TypeScript SDK integration tests...'
	@cd sdk/typescript && npx vitest run tests/integration/

check:  ## Run code quality checks (mirrors pre-commit hooks)
	@echo '═══════════════════════════════════════════════════════════════'
	@echo '  Running all code quality checks'
	@echo '  (mirrors pre-commit hooks — pass here, pass on commit)'
	@echo '═══════════════════════════════════════════════════════════════'
	@echo ''
	@echo 'Executing make setup'
	@make setup
	@echo 'General checks (whitespace, yaml, toml, merge conflicts)...'
	@. .venv/bin/activate && pre-commit run trailing-whitespace --all-files
	@. .venv/bin/activate && pre-commit run end-of-file-fixer --all-files
	@. .venv/bin/activate && pre-commit run check-yaml --all-files
	@. .venv/bin/activate && pre-commit run check-toml --all-files
	@. .venv/bin/activate && pre-commit run check-merge-conflict --all-files
	@. .venv/bin/activate && pre-commit run check-case-conflict --all-files
	@. .venv/bin/activate && pre-commit run check-added-large-files --all-files
	@. .venv/bin/activate && pre-commit run debug-statements --all-files
	@. .venv/bin/activate && pre-commit run mixed-line-ending --all-files
	@echo ''
	@echo 'Backend checks (ruff, format, mypy)...'
	@cd components/backend && uv sync --extra dev && uv run ruff check src/ tests/
	@cd components/backend && uv run ruff format --check src/ tests/
	@cd components/backend && uv run python -m mypy src/
	@echo ''
	@echo 'Aggregator checks (ruff, format, mypy)...'
	@cd components/aggregator && uv sync --extra dev && uv run ruff check src/ tests/
	@cd components/aggregator && uv run ruff format --check src/ tests/
	@cd components/aggregator && uv run mypy src/aggregator/
	@echo ''
	@echo 'Python SDK checks (ruff, format, mypy)...'
	@cd sdk/python && uv sync --extra dev && uv run ruff check src/ tests/
	@cd sdk/python && uv run ruff format --check src/ tests/
	@cd sdk/python && uv run mypy src/syfthub_sdk/
	@echo ''
	@echo 'Frontend checks (eslint, prettier, typecheck)...'
	@cd components/frontend && npm install --silent && npm run lint
	@cd components/frontend && npx prettier --check src/
	@cd components/frontend && npm run typecheck
	@echo ''
	@echo 'TypeScript SDK checks (eslint, typecheck)...'
	@cd sdk/typescript && npm install --silent && npm run lint
	@cd sdk/typescript && npm run typecheck
	@echo ''
	@echo 'Go SDK checks (fmt, vet)...'
	@cd sdk/golang && $(MAKE) lint
	@echo ''
	@echo 'CLI checks (fmt, vet)...'
	@cd cli && $(MAKE) lint
	@echo ''
	@echo '═══════════════════════════════════════════════════════════════'
	@echo '  All checks passed!'
	@echo '═══════════════════════════════════════════════════════════════'

logs:  ## View container logs
	@docker compose -f deploy/docker-compose.dev.yml logs -f