clef/Makefile at main · jkuri/clef · 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
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
# CLEF Makefile
# Provides convenient commands for building, testing, and running CLEF

.PHONY: help build test test-unit test-integration test-e2e test-e2e-quick test-all clean run dev install-deps check lint format

# Default target
help:
	@echo "CLEF - Private NPM Registry Server"
	@echo "=================================="
	@echo ""
	@echo "Available targets:"
	@echo "  build           Build the project (backend only)"
	@echo "  build-web       Build the web frontend"
	@echo "  build-all       Build both backend and frontend"
	@echo "  run             Run CLEF server"
	@echo "  dev             Run CLEF server in development mode with debug logging"
	@echo ""
	@echo "Testing:"
	@echo "  test            Run all tests (unit + integration + e2e)"
	@echo "  test-unit       Run unit tests only"
	@echo "  test-integration Run integration tests only (fastest)"
	@echo "  test-e2e        Run all end-to-end tests"
	@echo "  test-e2e-quick  Run quick end-to-end tests (optimized)"
	@echo "  test-integration-fast Run integration tests via script"
	@echo ""
	@echo "Development:"
	@echo "  install-deps    Install development dependencies (pnpm, yarn)"
	@echo "  check           Run cargo check"
	@echo "  lint            Run clippy linter"
	@echo "  format          Format code with rustfmt"
	@echo "  clean           Clean build artifacts (removes web/clef/dist and node_modules)"
	@echo ""
	@echo "E2E Test Modules:"
	@echo "  test-e2e-package        Package management tests"
	@echo "  test-e2e-auth          Authentication tests"
	@echo "  test-e2e-publish       Publishing tests"
	@echo "  test-e2e-cache         Cache management tests"
	@echo "  test-e2e-analytics     Analytics tests (optimized - no recompilation)"
	@echo "  test-e2e-security      Security tests"
	@echo "  test-e2e-scoped        Scoped package tests"
	@echo "  test-e2e-compat        Cross-manager compatibility tests"
	@echo "  test-e2e-perf          Performance tests"

# Build targets
build: ensure-web-dist
	@echo "Building CLEF..."
	cargo build

build-release: build-web
	@echo "Building CLEF (release mode)..."
	cargo build --release

# Ensure web/clef/dist directory exists before building
ensure-web-dist:
	@if [ ! -d "web/clef/dist" ]; then \
		echo "Creating web/clef/dist directory..."; \
		mkdir -p web/clef/dist; \
		echo "<!DOCTYPE html><html><head><title>Clef</title></head><body><h1>Clef Registry</h1><p>Web interface not built yet. Run 'make build-web' to build the frontend.</p></body></html>" > web/clef/dist/index.html; \
	fi

# Build the web frontend
build-web:
	@echo "Building web frontend..."
	@if [ -d "web/clef" ]; then \
		echo "Installing frontend dependencies..."; \
		cd web/clef && npm install && echo "Building frontend..." && npm run build; \
	else \
		echo "Web directory not found at web/clef"; \
		exit 1; \
	fi

# Build everything (backend + frontend)
build-all: build-web build
	@echo "Build completed!"

# Run targets
run:
	@echo "Starting CLEF server..."
	cargo run

dev:
	@echo "Starting CLEF server in development mode..."
	RUST_LOG=debug cargo run

# Test targets
test: test-unit test-integration test-e2e-quick
	@echo "All tests completed!"

test-unit: ensure-web-dist
	@echo "Running unit tests..."
	cargo test --lib

test-integration: ensure-web-dist
	@echo "Running integration tests (fastest)..."
	cargo test --test integration_tests

test-integration-fast:
	@echo "Running integration tests with optimized script..."
	./scripts/run-e2e-tests.sh --integration

test-e2e:
	@echo "Running all end-to-end tests..."
	./scripts/run-e2e-tests.sh --all

test-e2e-quick:
	@echo "Running quick end-to-end tests (optimized - builds once)..."
	./scripts/run-e2e-tests.sh --quick

test-all: test-unit test-integration test-e2e
	@echo "All tests (including full e2e suite) completed!"

# Individual E2E test modules
test-e2e-package:
	./scripts/run-e2e-tests.sh --module package_management

test-e2e-auth:
	./scripts/run-e2e-tests.sh --module authentication

test-e2e-publish:
	./scripts/run-e2e-tests.sh --module publishing

test-e2e-cache:
	./scripts/run-e2e-tests.sh --module cache_management

test-e2e-analytics:
	@echo "Running analytics tests (optimized - builds once, reuses binary)..."
	./scripts/run-e2e-tests.sh --module analytics

test-e2e-security:
	./scripts/run-e2e-tests.sh --module security

test-e2e-scoped:
	./scripts/run-e2e-tests.sh --module scoped_packages

test-e2e-compat:
	./scripts/run-e2e-tests.sh --module compatibility

test-e2e-perf:
	./scripts/run-e2e-tests.sh --module performance

# Development targets
install-deps:
	@echo "Installing development dependencies..."
	@if command -v npm >/dev/null 2>&1; then \
		echo "Installing pnpm..."; \
		npm install -g pnpm || echo "Failed to install pnpm (may need sudo)"; \
		echo "Installing yarn..."; \
		npm install -g yarn || echo "Failed to install yarn (may need sudo)"; \
	else \
		echo "npm not found. Please install Node.js first."; \
	fi

check: ensure-web-dist
	@echo "Running cargo check..."
	cargo check

lint:
	@echo "Running clippy linter..."
	cargo clippy -- -D warnings

format:
	@echo "Formatting code..."
	cargo fmt

format-check:
	@echo "Checking code formatting..."
	cargo fmt -- --check

# Utility targets
clean:
	@echo "Cleaning build artifacts..."
	cargo clean
	@echo "Cleaning test cache directories..."
	rm -rf ./test_cache_*
	@echo "Cleaning web frontend artifacts..."
	rm -rf web/clef/node_modules
	rm -rf web/clef/dist

# Docker targets
docker-build:
	@echo "Building Docker image..."
	docker build -t clef .

docker-run:
	@echo "Running CLEF in Docker..."
	docker run -p 8000:8000 clef

# Database targets
db-reset:
	@echo "Resetting database..."
	rm -f data/clef.db
	cargo run -- --reset-db || true

# Benchmark targets
benchmark:
	@echo "Running benchmarks..."
	./scripts/benchmark.sh

# CI targets
ci-test: check lint format-check test-unit test-integration test-e2e-quick
	@echo "CI tests completed!"

ci-test-full: check lint format-check test-all
	@echo "Full CI tests completed!"

# Help for specific commands
help-e2e:
	@echo "End-to-End Test Commands:"
	@echo "========================"
	@echo ""
	@echo "Quick tests (recommended for development):"
	@echo "  make test-integration        # Fastest (in-process)"
	@echo "  make test-integration-fast   # Fast (via script)"
	@echo "  make test-e2e-quick          # Quick E2E (optimized)"
	@echo ""
	@echo "Full test suite (comprehensive, optimized):"
	@echo "  make test-e2e                # All E2E tests (builds once)"
	@echo ""
	@echo "Individual test modules:"
	@echo "  make test-e2e-package    # Package management"
	@echo "  make test-e2e-auth       # Authentication"
	@echo "  make test-e2e-publish    # Publishing"
	@echo "  make test-e2e-cache      # Cache management"
	@echo "  make test-e2e-analytics  # Analytics (optimized)"
	@echo "  make test-e2e-security   # Security"
	@echo "  make test-e2e-scoped     # Scoped packages"
	@echo "  make test-e2e-compat     # Cross-manager compatibility"
	@echo "  make test-e2e-perf       # Performance"
	@echo ""
	@echo "Debug mode:"
	@echo "  RUST_LOG=debug make test-e2e-quick"

help-dev:
	@echo "Development Commands:"
	@echo "===================="
	@echo ""
	@echo "Setup:"
	@echo "  make install-deps    # Install pnpm and yarn"
	@echo ""
	@echo "Development cycle (fastest to slowest):"
	@echo "  make check               # Quick syntax check"
	@echo "  make test-unit           # Fast unit tests"
	@echo "  make test-integration    # Integration tests (fastest)"
	@echo "  make test-e2e-quick      # Core E2E tests (optimized)"
	@echo "  make dev                 # Run with debug logging"
	@echo ""
	@echo "After make clean:"
	@echo "  make build-web      # Build frontend first"
	@echo "  make build          # Then build backend"
	@echo "  # OR: make build-all # Build both at once"
	@echo ""
	@echo "Before committing:"
	@echo "  make lint           # Check code quality"
	@echo "  make format         # Format code"
	@echo "  make test           # Run all tests"