Repository navigation
Expand file tree
/
Copy pathMakefile
More file actions
575 lines (493 loc) · 24.9 KB
/
Copy pathMakefile
File metadata and controls
575 lines (493 loc) · 24.9 KB
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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
##
# Collection of helper scripts used for local dev.
##
# This key can live anywhere on your machine. Adjust path as needed.
PATH_TO_SYNC_SPANNER_KEYS = `pwd`/service-account.json
# TODO: replace with rust grpc alternative when ready
# Assumes you've cloned the server-syncstorage repo locally into a peer dir.
# https://github.com/mozilla-services/server-syncstorage
PATH_TO_GRPC_CERT = ../server-syncstorage/local/lib/python2.7/site-packages/grpc/_cython/_credentials/roots.pem
POETRY := $(shell command -v poetry 2> /dev/null)
INSTALL_STAMP := .install.stamp
TOOLS_DIR := tools
PROJECT_ROOT_DIR := ./
ROOT_PYPROJECT_TOML := pyproject.toml
HAWK_DIR := $(TOOLS_DIR)/hawk
INTEGRATION_TEST_DIR := $(TOOLS_DIR)/integration_tests
INTEGRATION_TEST_DIR_TOKENSERVER := $(TOOLS_DIR)/integration_tests/tokenserver
SPANNER_DIR := $(TOOLS_DIR)/spanner
TOKENSERVER_UTIL_DIR := $(TOOLS_DIR)/tokenserver
LOAD_TEST_DIR := $(TOOLS_DIR)/tokenserver/loadtests
SYNCSTORAGE_LOAD_TEST_DIR := $(TOOLS_DIR)/syncstorage-loadtest
RUST_LOG ?= debug
SYNC_SYNCSTORAGE__DATABASE_URL ?= mysql://sample_user:sample_password@localhost/syncstorage_rs
SYNC_TOKENSERVER__DATABASE_URL ?= mysql://sample_user:sample_password@localhost/tokenserver_rs
PYTHON_SITE_PACKAGES = $(shell poetry run python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())")
# In order to be consumed by the ETE Test Metric Pipeline, files need to follow a strict naming
# convention: {job_number}__{utc_epoch_datetime}__{repository}__{workflow}__{test_suite}__results{-index}.xml
EPOCH_TIME := $(shell date +"%s")
WORKFLOW := $(shell echo "$(GITHUB_WORKFLOW)" | tr ' ' '-' | tr '[:upper:]' '[:lower:]')
TEST_RESULTS_DIR ?= workflow/test-results
TEST_PROFILE := $(if $(or $(CIRCLECI),$(GITHUB_ACTIONS)),ci,default)
TEST_FILE_PREFIX := $(if $(GITHUB_ACTIONS),$(GITHUB_RUN_NUMBER)__$(EPOCH_TIME)__$(notdir $(GITHUB_REPOSITORY))__$(WORKFLOW)__)
UNIT_MYSQL_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)unit__mysql-results.xml
UNIT_POSTGRES_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)unit__postgres-results.xml
UNIT_SPANNER_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)unit__spanner-results.xml
UNIT_COVERAGE_MYSQL_JSON := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)unit__mysql-coverage.json
UNIT_COVERAGE_POSTGRES_JSON := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)unit__postgres-coverage.json
UNIT_COVERAGE_SPANNER_JSON := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)unit__spanner-coverage.json
INT_SPANNER_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)integration__spanner-results.xml
INT_SPANNER_NO_JWK_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)integration__spanner-no-jwk-results.xml
INT_POSTGRES_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)integration__postgres-results.xml
INT_POSTGRES_NO_JWK_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)integration__postgres-no-jwk-results.xml
INT_MYSQL_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)integration__mysql-results.xml
INT_MYSQL_NO_JWK_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)integration__mysql-no-jwk-results.xml
INT_RECONCILIATION_JUNIT_XML := $(TEST_RESULTS_DIR)/$(TEST_FILE_PREFIX)integration__reconciliation-results.xml
clippy_mysql:
# Matches what's run in circleci
cargo clippy --workspace --all-targets --no-default-features --features=syncstorage-db/mysql --features=py_verifier -- -D clippy::dbg_macro -D warnings
clippy_postgres:
cargo clippy --workspace --all-targets --no-default-features --features=syncstorage-db/postgres --features=py_verifier -- -D clippy::dbg_macro -D warnings
clippy_spanner:
# Matches what's run in circleci
cargo clippy --workspace --all-targets --no-default-features --features=syncstorage-db/spanner --features=py_verifier -- -D clippy::dbg_macro -D warnings
clippy_release_mysql:
# Release mode clippy — catches dead code and issues only visible with optimizations
cargo clippy --release --workspace --no-default-features --features=syncstorage-db/mysql --features=py_verifier -- -D warnings
clippy_release_postgres:
# Release mode clippy — catches dead code and issues only visible with optimizations
cargo clippy --release --workspace --no-default-features --features=syncstorage-db/postgres --features=tokenserver-db/postgres --features=py_verifier -- -D warnings
clippy_release_spanner:
# Release mode clippy — catches dead code and issues only visible with optimizations
cargo clippy --release --workspace --no-default-features --features=syncstorage-db/spanner --features=py_verifier -- -D warnings
.PHONY: clippy-all
clippy-all: clippy_mysql clippy_postgres clippy_spanner ## Run clippy for all backends (mysql, postgres, spanner).
.PHONY: audit
audit: ## Check dependencies for known CVEs (run by CI on every push).
cargo audit
clean:
cargo clean
docker_start_mysql:
docker compose -f docker/docker-compose.mysql.yaml up -d
docker_start_mysql_rebuild:
docker compose -f docker/docker-compose.mysql.yaml up --build -d
docker_stop_mysql:
docker compose -f docker/docker-compose.mysql.yaml down
docker_start_spanner:
docker compose -f docker/docker-compose.spanner.yaml up -d
docker_start_spanner_rebuild:
docker compose -f docker/docker-compose.spanner.yaml up --build -d
docker_stop_spanner:
docker compose -f docker/docker-compose.spanner.yaml down
docker_oneshot_mysql: ## Build & run a stand-alone MySQL Syncserver (curl localhost:8000/__heartbeat__).
docker compose -f docker/docker-compose.one-shot.mysql.yaml up -d --build
docker_oneshot_mysql_stop: ## Stop the stand-alone MySQL Syncserver.
docker compose -f docker/docker-compose.one-shot.mysql.yaml down
docker_oneshot_postgres: ## Build & run a stand-alone PostgreSQL Syncserver (curl localhost:8000/__heartbeat__).
docker compose -f docker/docker-compose.one-shot.postgres.yaml up -d --build
docker_oneshot_postgres_stop: ## Stop the stand-alone PostgreSQL Syncserver.
docker compose -f docker/docker-compose.one-shot.postgres.yaml down
docker_oneshot_spanner: ## Build & run a stand-alone Spanner-emulator Syncserver, local dev only (curl localhost:8000/__heartbeat__).
docker compose -f docker/docker-compose.one-shot.spanner.yaml up -d --build
docker_oneshot_spanner_stop: ## Stop the stand-alone Spanner-emulator Syncserver.
docker compose -f docker/docker-compose.one-shot.spanner.yaml down
.ONESHELL:
docker_run_mysql_e2e_tests:
exit_code=0
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__KTY \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__ALG \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__KID \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__FXA_CREATED_AT \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__USE \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__N \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__E \
RESULTS_FILENAME=mysql_no_jwk_integration_results.xml \
docker compose \
-f docker/docker-compose.mysql.yaml \
-f docker/docker-compose.e2e.mysql.yaml \
-f docker/docker-compose.e2e.no-jwk-cache.yaml \
up \
--exit-code-from e2e-tests \
--abort-on-container-exit || exit_code=$$?
docker cp mysql-e2e-tests:/mysql_no_jwk_integration_results.xml ${INT_MYSQL_NO_JWK_JUNIT_XML}
RESULTS_FILENAME=mysql_integration_results.xml docker compose \
-f docker/docker-compose.mysql.yaml \
-f docker/docker-compose.e2e.mysql.yaml \
-f docker/docker-compose.e2e.jwk-cache.yaml \
up \
--exit-code-from e2e-tests \
--abort-on-container-exit || exit_code=$$?
docker cp mysql-e2e-tests:/mysql_integration_results.xml ${INT_MYSQL_JUNIT_XML}
docker compose \
-f docker/docker-compose.mysql.yaml \
-f docker/docker-compose.e2e.mysql.yaml \
down -v --remove-orphans
exit $$exit_code
.ONESHELL:
docker_run_postgres_e2e_tests:
exit_code=0
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__KTY \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__ALG \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__KID \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__FXA_CREATED_AT \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__USE \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__N \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__E \
RESULTS_FILENAME=postgres_no_jwk_integration_results.xml \
docker compose \
-f docker/docker-compose.postgres.yaml \
-f docker/docker-compose.e2e.postgres.yaml \
-f docker/docker-compose.e2e.no-jwk-cache.yaml \
up \
--exit-code-from e2e-tests \
--abort-on-container-exit || exit_code=$$?
docker cp postgres-e2e-tests:/postgres_no_jwk_integration_results.xml ${INT_POSTGRES_NO_JWK_JUNIT_XML}
RESULTS_FILENAME=postgres_integration_results.xml docker compose \
-f docker/docker-compose.postgres.yaml \
-f docker/docker-compose.e2e.postgres.yaml \
-f docker/docker-compose.e2e.jwk-cache.yaml \
up \
--exit-code-from e2e-tests \
--abort-on-container-exit || exit_code=$$?
docker cp postgres-e2e-tests:/postgres_integration_results.xml ${INT_POSTGRES_JUNIT_XML}
docker compose \
-f docker/docker-compose.postgres.yaml \
-f docker/docker-compose.e2e.postgres.yaml \
down -v --remove-orphans
exit $$exit_code
.ONESHELL:
docker_run_spanner_e2e_tests:
exit_code=0
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__KTY \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__ALG \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__KID \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__FXA_CREATED_AT \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__USE \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__N \
env -u SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__E \
RESULTS_FILENAME=spanner_no_jwk_integration_results.xml \
docker compose \
-f docker/docker-compose.spanner.yaml \
-f docker/docker-compose.e2e.spanner.yaml \
-f docker/docker-compose.e2e.no-jwk-cache.yaml \
up \
--exit-code-from e2e-tests \
--abort-on-container-exit || exit_code=$$?
docker cp spanner-e2e-tests:/spanner_no_jwk_integration_results.xml ${INT_SPANNER_NO_JWK_JUNIT_XML}
RESULTS_FILENAME=spanner_integration_results.xml docker compose \
-f docker/docker-compose.spanner.yaml \
-f docker/docker-compose.e2e.spanner.yaml \
-f docker/docker-compose.e2e.jwk-cache.yaml \
up \
--exit-code-from e2e-tests \
--abort-on-container-exit || exit_code=$$?
docker cp spanner-e2e-tests:/spanner_integration_results.xml ${INT_SPANNER_JUNIT_XML}
docker compose \
-f docker/docker-compose.spanner.yaml \
-f docker/docker-compose.e2e.spanner.yaml \
down -v --remove-orphans
exit $$exit_code
.ONESHELL:
docker_run_reconciliation_e2e_tests:
exit_code=0
RESULTS_FILENAME=reconciliation_integration_results.xml \
docker compose \
-f docker/docker-compose.spanner.yaml \
-f docker/docker-compose.e2e.spanner.yaml \
-f docker/docker-compose.e2e.reconciliation.yaml \
-f docker/docker-compose.e2e.jwk-cache.yaml \
up \
--exit-code-from e2e-tests \
--abort-on-container-exit || exit_code=$$?
docker cp spanner-e2e-tests:/reconciliation_integration_results.xml ${INT_RECONCILIATION_JUNIT_XML} || true
docker compose \
-f docker/docker-compose.spanner.yaml \
-f docker/docker-compose.e2e.spanner.yaml \
down -v --remove-orphans
exit $$exit_code
run_mysql: $(INSTALL_STAMP)
# See https://github.com/PyO3/pyo3/issues/1741 for discussion re: why we need to set the
# below env var
PYTHONPATH=$(PYTHON_SITE_PACKAGES) \
RUST_LOG=$(RUST_LOG) \
RUST_BACKTRACE=full \
cargo run --no-default-features --features=syncstorage-db/mysql --features=py_verifier -- --config config/local.toml
run_spanner: $(INSTALL_STAMP)
GOOGLE_APPLICATION_CREDENTIALS=$(PATH_TO_SYNC_SPANNER_KEYS) \
GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=$(PATH_TO_GRPC_CERT) \
# See https://github.com/PyO3/pyo3/issues/1741 for discussion re: why we need to set the
# below env var
PYTHONPATH=$(PYTHON_SITE_PACKAGES) \
RUST_LOG=$(RUST_LOG) \
RUST_BACKTRACE=full \
cargo run --no-default-features --features=syncstorage-db/spanner --features=py_verifier -- --config config/local.toml
.ONESHELL:
test:
SYNC_SYNCSTORAGE__DATABASE_URL=${SYNC_SYNCSTORAGE__DATABASE_URL} \
SYNC_TOKENSERVER__DATABASE_URL=${SYNC_TOKENSERVER__DATABASE_URL} \
RUST_TEST_THREADS=1 \
cargo nextest run --workspace --profile ${TEST_PROFILE} $(ARGS)
.ONESHELL:
test_with_coverage:
SYNC_SYNCSTORAGE__DATABASE_URL=${SYNC_SYNCSTORAGE__DATABASE_URL} \
SYNC_TOKENSERVER__DATABASE_URL=${SYNC_TOKENSERVER__DATABASE_URL} \
RUST_TEST_THREADS=1 \
cargo llvm-cov --summary-only --json --output-path ${UNIT_COVERAGE_MYSQL_JSON} \
nextest --workspace --profile ${TEST_PROFILE}; exit_code=$$?
mv target/nextest/${TEST_PROFILE}/junit.xml ${UNIT_MYSQL_JUNIT_XML}
exit $$exit_code
.ONESHELL:
spanner_test_with_coverage:
cargo llvm-cov --summary-only --json --output-path ${UNIT_COVERAGE_SPANNER_JSON} \
nextest --workspace --no-default-features --features=syncstorage-db/spanner --features=py_verifier --profile ${TEST_PROFILE}; exit_code=$$?
mv target/nextest/${TEST_PROFILE}/junit.xml ${UNIT_SPANNER_JUNIT_XML}
exit $$exit_code
.ONESHELL:
postgres_test_with_coverage:
cargo llvm-cov --summary-only --json --output-path ${UNIT_COVERAGE_POSTGRES_JSON} \
nextest --workspace --no-default-features --features=syncstorage-db/postgres --features=tokenserver-db/postgres --features=py_verifier --profile ${TEST_PROFILE}; exit_code=$$?
mv target/nextest/${TEST_PROFILE}/junit.xml ${UNIT_POSTGRES_JUNIT_XML}
exit $$exit_code
.ONESHELL:
run_token_server_integration_tests:
cd tools/tokenserver
poetry install --no-root --without dev
poetry run pytest tools/tokenserver --junit-xml=${INTEGRATION_JUNIT_XML}
run_local_e2e_tests:
PYTHONPATH=$(PWD)/tools \
SYNC_MASTER_SECRET=$${SYNC_MASTER_SECRET:-secret0} \
SYNC_TOKENSERVER__FXA_OAUTH_SERVER_URL=$${SYNC_TOKENSERVER__FXA_OAUTH_SERVER_URL:-http://localhost:6000} \
TOKENSERVER_HOST=$${TOKENSERVER_HOST:-http://localhost:8000} \
poetry -C tools/integration_tests \
run pytest . --ignore=tokenserver/test_e2e.py
.PHONY: install
install: $(INSTALL_STAMP) ## Install dependencies with poetry
$(INSTALL_STAMP): pyproject.toml poetry.lock
@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
$(POETRY) install
touch $(INSTALL_STAMP)
.PHONY: install-hooks
install-hooks: $(INSTALL_STAMP) ## Install git pre-commit/pre-push hooks (via poetry).
$(POETRY) run pre-commit install --install-hooks
hawk:
# install dependencies for hawk token utility.
$(POETRY) -V
$(POETRY) install --directory=$(HAWK_DIR) --no-root
integration-test:
# install dependencies for integration tests.
$(POETRY) -V
$(POETRY) install --directory=$(INTEGRATION_TEST_DIR) --no-root
spanner:
# install dependencies for spanner utilities.
$(POETRY) -V
$(POETRY) install --directory=$(SPANNER_DIR) --no-root
tokenserver:
# install dependencies for tokenserver utilities.
$(POETRY) -V
$(POETRY) install --directory=$(TOKENSERVER_UTIL_DIR) --no-root
tokenserver-load:
# install dependencies for tokenserver load tests.
$(POETRY) -V
$(POETRY) install --directory=$(LOAD_TEST_DIR) --no-root
## Syncstorage Load Tests
syncstorage-loadtest:
# install dependencies for syncstorage load tests.
@echo "Installing syncstorage load test dependencies with Python 3.10+"
@cd $(SYNCSTORAGE_LOAD_TEST_DIR) && \
eval "$$(pyenv init -)" && \
eval "$$(pyenv virtualenv-init -)" && \
python --version && \
$(POETRY) env use python && \
$(POETRY) install --no-root
.PHONY: loadtest-install
loadtest-install: syncstorage-loadtest ## Install dependencies for syncstorage load tests.
.PHONY: loadtest-direct
loadtest-direct: syncstorage-loadtest ## Run load tests with direct access mode (requires SERVER_URL with secret).
@echo "Running syncstorage load tests in direct access mode..."
@echo "Usage: make loadtest-direct SERVER_URL='http://localhost:8000#secretValue' [MOLOTOV_ARGS='--max-runs 5']"
cd $(SYNCSTORAGE_LOAD_TEST_DIR) && \
SERVER_URL=$(or $(SERVER_URL),"http://localhost:8000#changeme") \
$(POETRY) run molotov $(or $(MOLOTOV_ARGS),--max-runs 5 -cxv) loadtest.py
.PHONY: loadtest-fxa
loadtest-fxa: syncstorage-loadtest ## Run load tests with FxA OAuth mode (Stage environment).
@echo "Running syncstorage load tests with FxA OAuth..."
@echo "Usage: make loadtest-fxa [SERVER_URL=...] [MOLOTOV_ARGS='--workers 3 --duration 60']"
cd $(SYNCSTORAGE_LOAD_TEST_DIR) && \
SERVER_URL=$(or $(SERVER_URL),"https://token.stage.mozaws.net") \
FXA_API_HOST=$(or $(FXA_API_HOST),"https://api-accounts.stage.mozaws.net") \
FXA_OAUTH_HOST=$(or $(FXA_OAUTH_HOST),"https://oauth.stage.mozaws.net") \
$(POETRY) run molotov $(or $(MOLOTOV_ARGS),--workers 3 --duration 60 -v) loadtest.py
.PHONY: loadtest-jwt
loadtest-jwt: syncstorage-loadtest ## Run load tests with self-signed JWT mode (requires OAUTH_PRIVATE_KEY_FILE).
@echo "Running syncstorage load tests with self-signed JWTs..."
@echo "Usage: make loadtest-jwt OAUTH_PRIVATE_KEY_FILE=/path/to/key.pem [SERVER_URL=...] [MOLOTOV_ARGS='--workers 100 --duration 300']"
@if [ -z "$(OAUTH_PRIVATE_KEY_FILE)" ]; then \
echo "Error: OAUTH_PRIVATE_KEY_FILE is required"; \
echo "Example: make loadtest-jwt OAUTH_PRIVATE_KEY_FILE=/path/to/load_test.pem"; \
exit 1; \
fi
cd $(SYNCSTORAGE_LOAD_TEST_DIR) && \
SERVER_URL=$(or $(SERVER_URL),"http://localhost:8000") \
OAUTH_PRIVATE_KEY_FILE=$(OAUTH_PRIVATE_KEY_FILE) \
$(POETRY) run molotov $(or $(MOLOTOV_ARGS),--workers 100 --duration 300 -v) loadtest.py
## Offloaded Payload Load Tests
#
# Molotov against the full offload + change-stream pipeline on emulators.
# No GCP project, no credentials. Documented in
# docs/src/tools/load-testing.md. Covers STOR-628 and STOR-629.
# The reconciliation stack reads the server image from SYNCSTORAGE_RS_IMAGE
# while its setup/mock-fxa containers hardcode app:build, so both names have to
# point at the same locally built spanner image. Set inline rather than
# exported, so the existing docker_run_*_e2e_tests targets keep their own
# defaults.
LOADTEST_COMPOSE := SYNCSTORAGE_RS_IMAGE=$(or $(SYNCSTORAGE_RS_IMAGE),app:build) \
docker compose \
-f docker/docker-compose.spanner.yaml \
-f docker/docker-compose.e2e.spanner.yaml \
-f docker/docker-compose.e2e.reconciliation.yaml \
-f docker/docker-compose.e2e.jwk-cache.yaml \
-f docker/docker-compose.loadtest.yaml
.PHONY: loadtest-offload-image
loadtest-offload-image: ## Build the spanner server image the load-test rig needs.
docker build . --tag app:build --build-arg SYNCSTORAGE_DATABASE_BACKEND=spanner
# Services the rig needs running before molotov starts. mock-fxa-server is not
# a syncserver dependency in compose, but tokenserver is enabled in this stack,
# so start it rather than leave a dangling FXA_OAUTH_SERVER_URL. The load test
# itself uses direct-access mode and never calls tokenserver.
LOADTEST_SERVICES := sync-db-setup syncserver mock-fxa-server \
payload-link-publisher payload-reconciler statsd
# Per-collection raised limits. Only ever applied to offloaded collections:
# Spanner caps a single STRING(MAX) value at 2.5 MiB, so an inline collection
# above that fails in the database. See docker-compose.loadtest.yaml.
LOADTEST_BIG := {"max_record_payload_bytes":10485760,"max_post_bytes":20971520,"max_request_bytes":22020096}
LOADTEST_ALL_COLLS := bookmarks,forms,passwords,history,prefs
# STOR-629: every batch write offloaded and expanded.
LOADTEST_ENV_HANDLER := \
LOADTEST_OFFLOAD_COLLECTIONS=$(LOADTEST_ALL_COLLS) \
LOADTEST_COLLECTION_LIMITS='{"bookmarks":$(LOADTEST_BIG),"forms":$(LOADTEST_BIG),"passwords":$(LOADTEST_BIG),"history":$(LOADTEST_BIG),"prefs":$(LOADTEST_BIG)}' \
OFFLOAD_COLLECTIONS=$(LOADTEST_ALL_COLLS) \
LARGE_PAYLOAD_PROB=1.0
# STOR-628: bookmarks+history offloaded and expanded; forms/passwords/prefs
# inline, capped at the 2.5 MiB Spanner limit. OFFLOAD_COLLECTIONS is
# deliberately left unset so writes spread across all five.
LOADTEST_ENV_CHANGESTREAM := \
LOADTEST_OFFLOAD_COLLECTIONS=bookmarks,history \
LOADTEST_COLLECTION_LIMITS='{"bookmarks":$(LOADTEST_BIG),"history":$(LOADTEST_BIG)}' \
LARGE_PAYLOAD_PROB=0.5
# LOADTEST_OFFLOAD_COLLECTIONS and LOADTEST_COLLECTION_LIMITS configure
# *syncserver*, so they have to be in the environment when its container is
# created, not just when molotov runs. `compose run` will not recreate an
# already-running container whose env has since changed, so each scenario does
# its own `up --wait` with its own env first -- compose then recreates
# syncserver because its config hash moved. Do not factor this back into a
# shared prerequisite target: that reintroduces a silent bug where the scenario
# runs against the previous scenario's server config.
.PHONY: loadtest-offload-up
loadtest-offload-up: ## Start the load-test rig with the default (STOR-628) server config.
$(LOADTEST_ENV_CHANGESTREAM) $(LOADTEST_COMPOSE) up -d --wait --build $(LOADTEST_SERVICES)
.PHONY: loadtest-offload-handler
loadtest-offload-handler: ## STOR-629: 100% offloaded payloads, handler GCS read/write path.
@echo "STOR-629: every batch write offloaded and expanded."
$(LOADTEST_ENV_HANDLER) $(LOADTEST_COMPOSE) up -d --wait --build $(LOADTEST_SERVICES)
$(LOADTEST_ENV_HANDLER) \
MOLOTOV_ARGS="$(or $(MOLOTOV_ARGS),--processes 1 --workers 5 --duration 60 -v)" \
$(LOADTEST_COMPOSE) run --rm loadtest
.PHONY: loadtest-offload-changestream
loadtest-offload-changestream: ## STOR-628: mixed offloaded/inline payloads, change stream to reconciler.
@echo "STOR-628: bookmarks+history offloaded and expanded;"
@echo " forms/passwords/prefs inline, capped at the 2.5 MiB Spanner limit."
$(LOADTEST_ENV_CHANGESTREAM) $(LOADTEST_COMPOSE) up -d --wait --build $(LOADTEST_SERVICES)
$(LOADTEST_ENV_CHANGESTREAM) \
MOLOTOV_ARGS="$(or $(MOLOTOV_ARGS),--processes 1 --workers 5 --duration 120 -v)" \
$(LOADTEST_COMPOSE) run --rm loadtest
.PHONY: loadtest-offload-report
loadtest-offload-report: ## Wait for the pipeline to drain, then report reconciler + GCS state.
docker/loadtest-report.sh
.PHONY: loadtest-offload-logs
loadtest-offload-logs: ## Tail the pipeline containers.
$(LOADTEST_COMPOSE) logs -f syncserver payload-link-publisher payload-reconciler
.PHONY: loadtest-offload-down
loadtest-offload-down: ## Tear the load-test rig down, including the fake-gcs volume.
$(LOADTEST_COMPOSE) down -v --remove-orphans
## Python Utilities
.PHONY: ruff-lint
ruff-lint: $(INSTALL_STAMP) ## Lint check for utilities.
$(POETRY) run ruff check $(TOOLS_DIR)
.PHONY: ruff-fmt-chk
ruff-fmt-chk: $(INSTALL_STAMP) ## Format check with change summary.
$(POETRY) run ruff format --diff $(TOOLS_DIR)
.PHONY: ruff-format
ruff-format: $(INSTALL_STAMP) ## Formats files in directory.
$(POETRY) run ruff format $(TOOLS_DIR)
.PHONY: py-deps-latest
py-deps-latest: $(INSTALL_STAMP) ## Checks latest versions in PyPI
$(POETRY) show --latest --top-level $(TOOLS_DIR)
.PHONY: py-deps-outdated
py-deps-outdated: $(INSTALL_STAMP) ## Checks for outdated Python packages
$(POETRY) show --outdated $(TOOLS_DIR)
.PHONY: bandit
bandit: $(INSTALL_STAMP) ## Run bandit
$(POETRY) run bandit --quiet -r -c $(ROOT_PYPROJECT_TOML) $(TOOLS_DIR)
.PHONY: mypy
mypy: $(INSTALL_STAMP) ## Run mypy
$(POETRY) run mypy --config-file=$(ROOT_PYPROJECT_TOML) $(TOOLS_DIR)
.PHONY: pydocstyle
pydocstyle: $(INSTALL_STAMP) ## Run pydocstyle
$(POETRY) run pydocstyle -es --count --config=$(ROOT_PYPROJECT_TOML) $(TOOLS_DIR)
# Documentation utilities
.PHONY: doc-install-deps
doc-install-deps: ## Install the dependencies for doc generation
cargo install mdbook && cargo install mdbook-mermaid && mdbook-mermaid install docs/
.PHONY: doc-test
doc-test: ## Tests documentation for errors.
mdbook test docs/
.PHONY: doc-clean
doc-clean: ## Erases output/ contents and clears mdBook output.
mdbook clean docs/
.PHONY: doc-watch
doc-watch: ## Generate live preview of docs and open in browser and watch. No build artifacts.
mdbook clean docs/
mdbook watch docs/ --open
.PHONY: doc-prev
doc-prev: ## Generate live preview of docs and open in browser.
mdbook-mermaid install docs/
mdbook clean docs/
mdbook build docs/
mdbook serve docs/ --open
SWAGGER_IMG := swaggerapi/swagger-ui
SWAGGER_NAME := swagger-ui-preview
OPENAPI_FILE := openapi.json
.PHONY: api-prev
api-prev: ## Generate live preview of OpenAPI Swagger Docs and open in browser (port 8080).
@set -e; \
echo "Generating OpenAPI spec..."; \
cargo run --example generate_openapi_spec > $(OPENAPI_FILE); \
echo "Starting Swagger UI..."; \
cid="$$(docker ps -q -f name=^/$(SWAGGER_NAME)$$)"; \
if [ -n "$$cid" ]; then \
echo "Restarting existing container $$cid"; \
docker restart "$$cid" >/dev/null; \
else \
old="$$(docker ps -aq -f name=^/$(SWAGGER_NAME)$$)"; \
if [ -n "$$old" ]; then \
echo "Removing stale container $$old"; \
docker rm -f "$$old" >/dev/null || true; \
fi; \
cid="$$(docker run -d --rm \
--name $(SWAGGER_NAME) \
-p 8080:8080 \
-e SWAGGER_JSON=/openapi.json \
-v $$(pwd)/$(OPENAPI_FILE):/openapi.json:ro \
$(SWAGGER_IMG))"; \
echo "Started container $$cid"; \
fi; \
if command -v open >/dev/null 2>&1; then \
open http://localhost:8080; \
elif command -v xdg-open >/dev/null 2>&1; then \
xdg-open http://localhost:8080; \
else \
echo "Open http://localhost:8080 manually"; \
fi; \
trap 'echo ""; echo "Stopping Swagger UI..."; docker stop "$$cid" >/dev/null || true' INT TERM EXIT; \
echo "Swagger UI running (Ctrl-C to stop)"; \
wait