-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMakefile
More file actions
562 lines (517 loc) · 26.6 KB
/
Makefile
File metadata and controls
562 lines (517 loc) · 26.6 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
# Makefile for Role Play System (RPS)
# Run each recipe in a single bash shell for safer multiline commands
SHELL := /bin/bash
.SHELLFLAGS := -eu -o pipefail -c
.ONESHELL:
# --- Configuration ---
# SERVICE_NAME: Used for naming resources. Override for different services.
SERVICE_NAME ?= rps
# DEFAULT_ENV: Default environment if ENV is not set.
DEFAULT_ENV ?= dev
# ENV: Current operational environment (dev, beta, prod). Set via command line: make deploy ENV=prod
ENV ?= $(DEFAULT_ENV)
# GCP Region for deployments
GCP_REGION ?= us-west1
# Docker Image Configuration
# ARTIFACT_REGISTRY_REPO: Name of your Artifact Registry repository.
ARTIFACT_REGISTRY_REPO ?= $(SERVICE_NAME)-images
# IMAGE_NAME_BASE: Base name for the Docker image in Artifact Registry.
IMAGE_NAME_BASE = $(GCP_REGION)-docker.pkg.dev/$(TARGET_GCP_PROJECT_ID)/$(ARTIFACT_REGISTRY_REPO)/$(SERVICE_NAME)-api
# Git version for tagging Docker images. Uses current git tag or short commit SHA.
GIT_VERSION ?= $(shell git describe --tags --always --dirty --match "v*" 2>/dev/null || echo "dev")
# IMAGE_TAG: Tag for the Docker image (e.g., git version or 'latest').
IMAGE_TAG ?= $(GIT_VERSION)
# Central Python version for local tools and Docker (fallback 3.12)
PYTHON_VERSION ?= $(shell cat .python-version 2>/dev/null || echo 3.12)
# Frontend source directory
FRONTEND_DIR = src/ts/role_play/ui
# Backend source directory (Python)
BACKEND_DIR = src/python
# --- Environment-Specific GCP Project IDs & Configs ---
# These MUST be set in your environment (e.g., export GCP_PROJECT_ID_PROD="your-id")
# or in an uncommitted .env.mk file (see .PHONY: load-env-mk)
# Fallback to a placeholder to avoid errors if not set, but deployments will fail.
GCP_PROJECT_ID_PROD ?= placeholder-prod-project-id
GCP_PROJECT_ID_BETA ?= placeholder-beta-project-id
GCP_PROJECT_ID_DEV ?= placeholder-dev-project-id
TARGET_GCP_PROJECT_ID = ""
CLOUD_RUN_SERVICE_NAME = ""
GCS_BUCKET_APP_DATA = ""
GCS_PREFIX_APP_DATA = ""
GCS_BUCKET_LOG_EXPORTS = "" # Optional
CONFIG_FILE_PATH_IN_CONTAINER = ""
CLOUD_RUN_MIN_INSTANCES = 0
CLOUD_RUN_MAX_INSTANCES = 10
LOG_LEVEL_CONFIG = "INFO"
CORS_ORIGINS_CONFIG = "http://localhost:3000,http://localhost:5173" # Default for local dev
SERVICE_ACCOUNT_EMAIL = "" # Expected to be set per environment
API_BASE_URL_FOR_APP = "/api" # Default API prefix for the application
ifeq ($(ENV),prod)
TARGET_GCP_PROJECT_ID = $(GCP_PROJECT_ID_PROD)
CLOUD_RUN_SERVICE_NAME = $(SERVICE_NAME)-api-prod
GCS_BUCKET_APP_DATA = $(SERVICE_NAME)-app-data-prod
GCS_PREFIX_APP_DATA = prod/
GCS_BUCKET_LOG_EXPORTS = $(SERVICE_NAME)-log-exports-prod
CONFIG_FILE_PATH_IN_CONTAINER = /app/config/prod.yaml
CLOUD_RUN_MIN_INSTANCES = 1
LOG_LEVEL_CONFIG = "WARNING"
CORS_ORIGINS_CONFIG = "https://rps.cattail-sw.com"
SERVICE_ACCOUNT_EMAIL = sa-$(SERVICE_NAME)@$(GCP_PROJECT_ID_PROD).iam.gserviceaccount.com
else ifeq ($(ENV),beta)
TARGET_GCP_PROJECT_ID = $(GCP_PROJECT_ID_BETA)
CLOUD_RUN_SERVICE_NAME = $(SERVICE_NAME)-api-beta
GCS_BUCKET_APP_DATA = $(SERVICE_NAME)-app-data-beta
GCS_PREFIX_APP_DATA = beta/
GCS_BUCKET_LOG_EXPORTS = $(SERVICE_NAME)-log-exports-beta
CONFIG_FILE_PATH_IN_CONTAINER = /app/config/beta.yaml
CLOUD_RUN_MIN_INSTANCES = 0
LOG_LEVEL_CONFIG = "INFO"
CORS_ORIGINS_CONFIG = "https://beta.rps.cattail-sw.com"
SERVICE_ACCOUNT_EMAIL = sa-$(SERVICE_NAME)@$(GCP_PROJECT_ID_BETA).iam.gserviceaccount.com
else # dev (local setup, or deploying a dev instance to cloud)
TARGET_GCP_PROJECT_ID = $(GCP_PROJECT_ID_DEV)
CLOUD_RUN_SERVICE_NAME = $(SERVICE_NAME)-api-dev
GCS_BUCKET_APP_DATA = $(SERVICE_NAME)-app-data-dev
GCS_PREFIX_APP_DATA = dev/
GCS_BUCKET_LOG_EXPORTS = $(SERVICE_NAME)-log-exports-dev
CONFIG_FILE_PATH_IN_CONTAINER = /app/config/dev.yaml
CLOUD_RUN_MIN_INSTANCES = 0
LOG_LEVEL_CONFIG = "DEBUG"
CORS_ORIGINS_CONFIG = "http://localhost:3000,http://localhost:5173,https://dev.yourdomain.com" # Add dev frontend URL
SERVICE_ACCOUNT_EMAIL = sa-$(SERVICE_NAME)@$(GCP_PROJECT_ID_DEV).iam.gserviceaccount.com
endif
# ADK Model configuration (using Vertex AI for cloud environments)
ADK_MODEL ?= gemini-2.0-flash
# JWT Secret name in Secret Manager (consistent across environments, values differ)
# Note: The secret NAME in Secret Manager is different from the ENV VAR name
# Secret Manager name: rps-jwt-secret
# Environment variable: JWT_SECRET_KEY
JWT_SECRET_NAME_IN_SM = $(SERVICE_NAME)-jwt-secret
# --- Helper Commands ---
.PHONY: help
help:
@echo "Makefile for $(SERVICE_NAME) System"
@echo ""
@echo "Usage: make [target] ENV=[dev|beta|prod] [OTHER_VARIABLES...]"
@echo "------------------------------------------------------------------------------------"
@echo " VARIABLES:"
@echo " ENV : Target environment (dev, beta, prod). Default: $(DEFAULT_ENV)."
@echo " SERVICE_NAME : Base name for service and resources. Default: $(SERVICE_NAME)."
@echo " IMAGE_TAG : Docker image tag. Default: $(GIT_VERSION) (current git tag/commit)."
@echo " GCP_PROJECT_ID_PROD : GCP Project ID for Production (set in env or .env.mk)."
@echo " GCP_PROJECT_ID_BETA : GCP Project ID for Beta (set in env or .env.mk)."
@echo " GCP_PROJECT_ID_DEV : GCP Project ID for Development (set in env or .env.mk)."
@echo " NEW_GIT_TAG : Version for 'make tag-git-release' (e.g., v1.2.3)."
@echo "------------------------------------------------------------------------------------"
@echo " MAIN TARGETS:"
@echo " make dev-setup Set up development environment (copy resources to storage path)."
@echo " make build-docker Build the Docker image tagged with current IMAGE_TAG."
@echo " make push-docker Push current IMAGE_TAG to Artifact Registry for current ENV's project."
@echo " make deploy Build, push, and deploy current IMAGE_TAG to Cloud Run for current ENV."
@echo " make deploy-image IMAGE_TAG=<tag> Deploy a specific existing image tag to Cloud Run for current ENV."
@echo " make run-local-docker DATA_DIR=<path> Build and run the container locally for testing."
@echo "------------------------------------------------------------------------------------"
@echo " RELEASE MANAGEMENT:"
@echo " make tag-git-release NEW_GIT_TAG=<version> Create and push a new Git tag."
@echo "------------------------------------------------------------------------------------"
@echo " GCP SETUP (Run once per environment, ensure GCP_PROJECT_ID_* are set):"
@echo " make setup-gcp-infra ENV=[dev|beta|prod] Attempt to create GCS buckets, Artifact Repo, Secret container."
@echo "------------------------------------------------------------------------------------"
@echo " TESTING:"
@echo " make test Run full test suite with coverage report."
@echo " make test-quiet Run tests in quiet mode with coverage."
@echo " make test-chat Run only chat-related tests with coverage."
@echo " make test-unit Run only unit tests with coverage."
@echo " make test-integration Run only integration tests with coverage."
@echo " make test-coverage-html Generate HTML coverage report (viewable in browser)."
@echo " make test-no-coverage Run tests without coverage for faster execution."
@echo " make test-specific TEST_PATH=<path> Run a specific test file or test method."
@echo "------------------------------------------------------------------------------------"
@echo " RESOURCE MANAGEMENT:"
@echo " make validate-resources Validate all resource JSON files for correct structure."
@echo " make update-resource-metadata Update timestamps in resource files after manual edits."
@echo " make upload-resources Upload resources to GCS bucket for current ENV."
@echo " make download-resources Download resources from GCS bucket for current ENV."
@echo " make deploy-with-resources Deploy application and upload resources in one step."
@echo "------------------------------------------------------------------------------------"
@echo " UTILITIES:"
@echo " make logs View Cloud Run logs for the current ENV."
@echo " make list-config Show current configuration values based on ENV."
@echo " make load-env-mk (Internal) Loads .env.mk if it exists."
# Attempt to load .env.mk for local overrides of GCP_PROJECT_ID_* etc.
# This file should be in .gitignore
-include .env.mk
.PHONY: load-env-mk
load-env-mk:
@# This target is now just a dependency placeholder
@# The actual include happens at the top level above
# Call load-env-mk before most targets that need these variables.
# This ensures .env.mk is sourced if present.
build-docker: load-env-mk
push-docker: load-env-mk
deploy: load-env-mk
deploy-image: load-env-mk
setup-gcp-infra: load-env-mk
logs: load-env-mk
list-config: load-env-mk
run-local-docker: load-env-mk
.PHONY: list-config
list-config:
@echo "--- Current Configuration for ENV=$(ENV) ---"
@echo "SERVICE_NAME: $(SERVICE_NAME)"
@echo "TARGET_GCP_PROJECT_ID: $(TARGET_GCP_PROJECT_ID)"
@echo "CLOUD_RUN_SERVICE_NAME: $(CLOUD_RUN_SERVICE_NAME)"
@echo "IMAGE_NAME_BASE (for push): $(IMAGE_NAME_BASE)"
@echo "IMAGE_TAG (for build/push): $(IMAGE_TAG)"
@echo "GCS_BUCKET_APP_DATA: $(GCS_BUCKET_APP_DATA)"
@echo "GCS_PREFIX_APP_DATA: $(GCS_PREFIX_APP_DATA)"
@echo "GCS_BUCKET_LOG_EXPORTS: $(GCS_BUCKET_LOG_EXPORTS)"
@echo "CONFIG_FILE_PATH_IN_CONTAINER:$(CONFIG_FILE_PATH_IN_CONTAINER)"
@echo "JWT_SECRET_NAME_IN_SM: $(JWT_SECRET_NAME_IN_SM)"
@echo "SERVICE_ACCOUNT_EMAIL: $(SERVICE_ACCOUNT_EMAIL)"
@echo "API_BASE_URL_FOR_APP: $(API_BASE_URL_FOR_APP)"
@echo "-------------------------------------------"
@if [ "$(TARGET_GCP_PROJECT_ID)" = "placeholder-prod-project-id" ] || \
[ "$(TARGET_GCP_PROJECT_ID)" = "placeholder-beta-project-id" ] || \
[ "$(TARGET_GCP_PROJECT_ID)" = "placeholder-dev-project-id" ]; then \
echo ""; \
echo "WARNING: TARGET_GCP_PROJECT_ID is a placeholder. Set GCP_PROJECT_ID_PROD/BETA/DEV environment variables or in .env.mk."; \
echo ""; \
fi
# --- Build Targets ---
.PHONY: build-docker
build-docker:
@make list-config
@# Determine build target using Make conditionals, no shell if
ifeq ($(findstring placeholder,$(TARGET_GCP_PROJECT_ID)),placeholder)
@echo "Building Docker image rps-local:$(IMAGE_TAG) (local only - no GCP project set)..."
docker build --build-arg PYTHON_VERSION=$(PYTHON_VERSION) --build-arg GIT_VERSION=$(IMAGE_TAG) --build-arg BUILD_DATE="$$(date -u +%Y-%m-%dT%H:%M:%SZ)" -t rps-local:$(IMAGE_TAG) -f Dockerfile .
else
@echo "Building Docker image $(IMAGE_NAME_BASE):$(IMAGE_TAG)..."
docker build --build-arg PYTHON_VERSION=$(PYTHON_VERSION) --build-arg GIT_VERSION=$(IMAGE_TAG) --build-arg BUILD_DATE="$$(date -u +%Y-%m-%dT%H:%M:%SZ)" -t $(IMAGE_NAME_BASE):$(IMAGE_TAG) -f Dockerfile .
endif
@echo "Docker image built."
# --- Push Target ---
.PHONY: push-docker
push-docker: build-docker
@make list-config
ifeq ($(findstring placeholder,$(TARGET_GCP_PROJECT_ID)),placeholder)
@echo "ERROR: Cannot push to Artifact Registry with placeholder project ID."
@echo "Please set GCP_PROJECT_ID_$(shell echo $(ENV) | tr '[:lower:]' '[:upper:]') in .env.mk or environment."
exit 1
else
@echo "Authenticating Docker with Artifact Registry for $(GCP_REGION)..."
@gcloud auth configure-docker $(GCP_REGION)-docker.pkg.dev --project=$(TARGET_GCP_PROJECT_ID)
@echo "Pushing Docker image $(IMAGE_NAME_BASE):$(IMAGE_TAG) to Artifact Registry..."
@docker push $(IMAGE_NAME_BASE):$(IMAGE_TAG)
@echo "Docker image pushed."
endif
# --- Deploy Targets ---
# Comma-separated list of environment variables for Cloud Run
CLOUD_RUN_ENV_VARS_LIST = \
ENV=$(ENV),\
GCP_PROJECT_ID=$(TARGET_GCP_PROJECT_ID),\
GCS_BUCKET=$(GCS_BUCKET_APP_DATA),\
GCS_PREFIX=$(GCS_PREFIX_APP_DATA),\
CONFIG_FILE=$(CONFIG_FILE_PATH_IN_CONTAINER),\
LOG_LEVEL=$(LOG_LEVEL_CONFIG),\
CORS_ALLOWED_ORIGINS='$(CORS_ORIGINS_CONFIG)',\
PYTHONUNBUFFERED=1,\
GIT_VERSION=$(IMAGE_TAG),\
SERVICE_NAME=$(SERVICE_NAME),\
API_BASE_URL=$(API_BASE_URL_FOR_APP),\
GOOGLE_GENAI_USE_VERTEXAI=TRUE,\
GOOGLE_CLOUD_PROJECT=$(TARGET_GCP_PROJECT_ID),\
GOOGLE_CLOUD_LOCATION=us-central1,\
ADK_MODEL=$(ADK_MODEL)
.PHONY: deploy
deploy: push-docker
@make deploy-image IMAGE_TAG=$(IMAGE_TAG) # Calls deploy-image with the current default IMAGE_TAG
.PHONY: deploy-image
deploy-image: load-env-mk # Added dependency
@make list-config # IMAGE_TAG will be shown as the one passed on cmd line or default
ifeq ($(findstring placeholder,$(TARGET_GCP_PROJECT_ID)),placeholder)
@echo "ERROR: Cannot deploy with placeholder project ID."
@echo "Please set GCP_PROJECT_ID_$(shell echo $(ENV) | tr '[:lower:]' '[:upper:]') in .env.mk or environment."
exit 1
else
@echo "Deploying $(CLOUD_RUN_SERVICE_NAME) to Cloud Run in $(GCP_REGION) from existing image $(IMAGE_NAME_BASE):$(IMAGE_TAG)..."
@gcloud run deploy $(CLOUD_RUN_SERVICE_NAME) \
--image $(IMAGE_NAME_BASE):$(IMAGE_TAG) \
--platform managed \
--region $(GCP_REGION) \
--allow-unauthenticated \
--port 8080 \
--service-account=$(SERVICE_ACCOUNT_EMAIL) \
--set-env-vars="$(CLOUD_RUN_ENV_VARS_LIST)" \
--set-secrets="JWT_SECRET_KEY=$(JWT_SECRET_NAME_IN_SM):latest" \
--min-instances=$(CLOUD_RUN_MIN_INSTANCES) \
--max-instances=$(CLOUD_RUN_MAX_INSTANCES) \
--concurrency=80 \
--project=$(TARGET_GCP_PROJECT_ID)
@echo "Deployment of $(CLOUD_RUN_SERVICE_NAME) with image $(IMAGE_TAG) complete."
@echo "Service URL: $$(gcloud run services describe $(CLOUD_RUN_SERVICE_NAME) --platform managed --region $(GCP_REGION) --project=$(TARGET_GCP_PROJECT_ID) --format 'value(status.url)')"
endif
# --- Local Development ---
.PHONY: clean-venv
clean-venv:
@echo "Removing Python virtual environment..."
@rm -rf venv
@echo "Virtual environment removed."
.PHONY: run-local-docker
run-local-docker: build-docker
@echo "Running Docker container locally..."
@echo "Access at http://localhost:8080"
@# Check if DATA_DIR is provided
@if [ -z "$(DATA_DIR)" ]; then \
echo "Error: DATA_DIR parameter is required. Usage: make run-local-docker DATA_DIR=/path/to/data"; \
echo "Example: make run-local-docker DATA_DIR=~/data/rps_dev"; \
exit 1; \
fi; \
echo "Using data directory: $(DATA_DIR)"; \
if [ ! -d "$(DATA_DIR)" ]; then \
echo "Warning: Data directory $(DATA_DIR) does not exist. Creating it..."; \
mkdir -p "$(DATA_DIR)"; \
fi; \
if echo "$(TARGET_GCP_PROJECT_ID)" | grep -q "placeholder"; then \
IMAGE_TO_RUN="rps-local:$(IMAGE_TAG)"; \
else \
IMAGE_TO_RUN="$(IMAGE_NAME_BASE):$(IMAGE_TAG)"; \
fi; \
if [ -f ".env" ]; then \
echo "Loading environment variables from .env file"
docker run --rm -p 8080:8080 \
--env-file .env \
-v "$(DATA_DIR):/app/data" \
-e ENV=dev \
-e STORAGE_PATH=/app/data \
-e CONFIG_FILE=/app/config/dev.yaml \
-e LOG_LEVEL=DEBUG \
-e CORS_ALLOWED_ORIGINS="http://localhost:5173,http://localhost:3000,http://localhost:8080" \
-e PYTHONUNBUFFERED=1 \
-e GIT_VERSION=$(GIT_VERSION) \
-e SERVICE_NAME=$(SERVICE_NAME) \
-e PORT=8080 \
"$$IMAGE_TO_RUN"; \
else \
echo "No .env file found, using default environment variables"
docker run --rm -p 8080:8080 \
-v "$(DATA_DIR):/app/data" \
-e ENV=dev \
-e STORAGE_PATH=/app/data \
-e CONFIG_FILE=/app/config/dev.yaml \
-e LOG_LEVEL=DEBUG \
-e CORS_ALLOWED_ORIGINS="http://localhost:5173,http://localhost:3000,http://localhost:8080" \
-e JWT_SECRET_KEY="development-secret-key-do-not-use-in-production" \
-e PYTHONUNBUFFERED=1 \
-e GIT_VERSION=$(GIT_VERSION) \
-e SERVICE_NAME=$(SERVICE_NAME) \
-e PORT=8080 \
"$$IMAGE_TO_RUN"; \
fi
# --- Local Development ---
.PHONY: dev-setup
dev-setup: load-env-mk
@echo "=== Setting up development environment ==="
@echo ""
@# Check for virtual environment and dependencies
@if [ ! -f "venv/bin/pip" ]; then \
echo "Python virtual environment 'venv' or its dependencies not found. Creating/recreating it..."; \
rm -rf venv; \
python3 -m venv venv; \
echo "Virtual environment created."; \
echo "Installing dependencies..."; \
./venv/bin/pip install -r src/python/requirements-all.txt; \
else \
echo "Python virtual environment and dependencies are already set up."; \
fi
@make validate-resources
@echo ""
@# Determine storage path from config
@STORAGE_PATH=$$(bash -c "source venv/bin/activate && python scripts/get_storage_path.py"); \
echo "Storage path: $$STORAGE_PATH"; \
echo ""; \
if [ ! -d "$$STORAGE_PATH" ]; then \
echo "Creating storage directory: $$STORAGE_PATH"; \
mkdir -p "$$STORAGE_PATH"; \
fi; \
if [ "$$(realpath data)" = "$$(realpath $$STORAGE_PATH)" ]; then \
echo "Storage path is the same as project data directory - resources already in place"; \
else \
echo "Copying resources to $$STORAGE_PATH/resources..."; \
mkdir -p "$$STORAGE_PATH/resources"; \
cp -r data/resources/* "$$STORAGE_PATH/resources/" 2>/dev/null || true; \
fi; \
echo ""; \
echo "Resources copied successfully!"; \
echo ""; \
echo "Storage structure:"; \
find "$$STORAGE_PATH/resources" -type f -name "*.json" | sort; \
echo ""; \
echo "=== Development setup complete ==="
@echo ""
@echo "You can now run the server with:"
@echo " source venv/bin/activate && python src/python/run_server.py"
@echo ""
@echo "Or use PyCharm to run src/python/run_server.py"
# --- Release Management ---
.PHONY: tag-git-release
tag-git-release: # Expects NEW_GIT_TAG to be set, e.g., make tag-git-release NEW_GIT_TAG=v1.0.0
ifndef NEW_GIT_TAG
$(error NEW_GIT_TAG is not set. Usage: make tag-git-release NEW_GIT_TAG=vX.Y.Z)
endif
@echo "Creating Git tag: $(NEW_GIT_TAG)"
@read -p "Enter commit message for tag $(NEW_GIT_TAG) (Press Enter for default: 'Release $(NEW_GIT_TAG)'): " msg; \
COMMIT_MSG=$${msg:-Release $(NEW_GIT_TAG)}; \
git tag -a "$(NEW_GIT_TAG)" -m "$$COMMIT_MSG"
@echo "Pushing Git tag $(NEW_GIT_TAG) to origin..."
@git push origin "$(NEW_GIT_TAG)"
@echo "Git tag $(NEW_GIT_TAG) created and pushed."
# --- GCP Setup ---
.PHONY: setup-gcp-infra
setup-gcp-infra: load-env-mk # Added load-env-mk dependency
@make list-config
@# Check if we're using a placeholder project ID
ifeq ($(findstring placeholder,$(TARGET_GCP_PROJECT_ID)),placeholder)
@echo "ERROR: Cannot setup GCP infrastructure with placeholder project ID."
@echo "Please set GCP_PROJECT_ID_$(shell echo $(ENV) | tr '[:lower:]' '[:upper:]') in .env.mk or environment."
exit 1
else
@echo "--- Setting up GCP infrastructure for ENV=$(ENV) in project $(TARGET_GCP_PROJECT_ID) ---"
@echo "This is best-effort. Manual verification in GCP Console is recommended."
@echo ""
@echo "Ensuring necessary APIs are enabled..."
@gcloud services enable run.googleapis.com artifactregistry.googleapis.com secretmanager.googleapis.com storage.googleapis.com iam.googleapis.com cloudbuild.googleapis.com aiplatform.googleapis.com --project=$(TARGET_GCP_PROJECT_ID) || echo "Failed to enable some APIs or already enabled."
@echo ""
@echo "Creating GCS bucket for App Data: gs://$(GCS_BUCKET_APP_DATA)..."
@gsutil mb -p $(TARGET_GCP_PROJECT_ID) -l $(GCP_REGION) gs://$(GCS_BUCKET_APP_DATA) || echo "Bucket already exists or failed to create."
@echo "Creating GCS bucket for Log Exports: gs://$(GCS_BUCKET_LOG_EXPORTS)..."
@gsutil mb -p $(TARGET_GCP_PROJECT_ID) -l $(GCP_REGION) gs://$(GCS_BUCKET_LOG_EXPORTS) || echo "Bucket already exists or failed to create."
@echo ""
@echo "Creating Artifact Registry repository '$(ARTIFACT_REGISTRY_REPO)'..."
@gcloud artifacts repositories create $(ARTIFACT_REGISTRY_REPO) --project=$(TARGET_GCP_PROJECT_ID) \
--repository-format=docker --location=$(GCP_REGION) --description="Docker images for $(SERVICE_NAME)" || echo "Repository already exists or failed to create."
@echo ""
@SA_NAME=sa-$(SERVICE_NAME); \
echo "Creating Service Account '$$SA_NAME' (full email: $(SERVICE_ACCOUNT_EMAIL))..."; \
gcloud iam service-accounts create $$SA_NAME --display-name="$(SERVICE_NAME) Application Service Account" --project=$(TARGET_GCP_PROJECT_ID) || echo "Service account $$SA_NAME already exists or failed to create."
@echo ""
@echo "Creating Secret Manager secret container for JWT key: '$(JWT_SECRET_NAME_IN_SM)'..."
@gcloud secrets create $(JWT_SECRET_NAME_IN_SM) --project=$(TARGET_GCP_PROJECT_ID) \
--replication-policy=\"automatic\" || echo "Secret container already exists or failed to create."
@echo ""
@echo "IMPORTANT: You must add the actual secret value (version) to '$(JWT_SECRET_NAME_IN_SM)' manually:"
@echo " echo -n \"$$$(openssl rand -base64 32)\" | gcloud secrets versions add $(JWT_SECRET_NAME_IN_SM) --data-file=- --project=$(TARGET_GCP_PROJECT_ID)"
@echo ""
@echo "Granting Service Account '$(SERVICE_ACCOUNT_EMAIL)' access to the JWT secret..."
@gcloud secrets add-iam-policy-binding $(JWT_SECRET_NAME_IN_SM) --project=$(TARGET_GCP_PROJECT_ID) \
--member=\"serviceAccount:$(SERVICE_ACCOUNT_EMAIL)\" \
--role=\"roles/secretmanager.secretAccessor\" || echo "Failed to grant secret access or already granted."
@echo "Granting Service Account '$(SERVICE_ACCOUNT_EMAIL)' GCS bucket access (Object Admin)..."
@gsutil iam ch serviceAccount:$(SERVICE_ACCOUNT_EMAIL):objectAdmin gs://$(GCS_BUCKET_APP_DATA) || echo "Failed to grant GCS app data bucket access."
@gsutil iam ch serviceAccount:$(SERVICE_ACCOUNT_EMAIL):objectAdmin gs://$(GCS_BUCKET_LOG_EXPORTS) || echo "Failed to grant GCS log exports bucket access."
@echo ""
@echo "Granting Service Account '$(SERVICE_ACCOUNT_EMAIL)' Vertex AI access..."
@gcloud projects add-iam-policy-binding $(TARGET_GCP_PROJECT_ID) \
--member=\"serviceAccount:$(SERVICE_ACCOUNT_EMAIL)\" \
--role=\"roles/aiplatform.user\" || echo "Failed to grant Vertex AI access or already granted."
@echo ""
@echo "--- GCP Infrastructure setup for ENV=$(ENV) complete. Please verify in Console. ---"
endif
# --- Testing Targets ---
.PHONY: test
test:
@echo "Running full test suite with coverage..."
@bash -c "source venv/bin/activate && python -m pytest test/python/ --cov=src/python/role_play --cov-report=term-missing --cov-fail-under=25"
.PHONY: test-quiet
test-quiet:
@echo "Running tests in quiet mode with coverage..."
@bash -c "source venv/bin/activate && python -m pytest test/python/ -q --cov=src/python/role_play --cov-report=term-missing --cov-fail-under=25"
.PHONY: test-chat
test-chat:
@echo "Running chat-related tests with coverage..."
@bash -c "source venv/bin/activate && python -m pytest test/python/ -k 'chat' --cov=src/python/role_play/chat --cov-report=term-missing --cov-fail-under=0"
.PHONY: test-unit
test-unit:
@echo "Running unit tests with coverage..."
@bash -c "source venv/bin/activate && python -m pytest test/python/unit/ --cov=src/python/role_play --cov-report=term-missing --cov-fail-under=0"
.PHONY: test-integration
test-integration:
@echo "Running integration tests with coverage..."
@bash -c "source venv/bin/activate && python -m pytest test/python/integration/ --cov=src/python/role_play --cov-report=term-missing --cov-fail-under=0"
.PHONY: test-coverage-html
test-coverage-html:
@echo "Generating HTML coverage report..."
@bash -c "source venv/bin/activate && python -m pytest test/python/ --cov=src/python/role_play --cov-report=html --cov-fail-under=0"
@echo "Coverage report generated at: test/python/htmlcov/index.html"
@echo "Open in browser: file://$(shell pwd)/test/python/htmlcov/index.html"
.PHONY: test-no-coverage
test-no-coverage:
@echo "Running tests without coverage (faster)..."
@bash -c "source venv/bin/activate && python -m pytest test/python/ -v"
.PHONY: test-voice
test-voice:
@echo "Running voice-related tests with coverage..."
@bash -c "source venv/bin/activate && python -m pytest test/python/ -k 'voice' --cov=src/python/role_play/voice --cov-report=term-missing --cov-fail-under=0"
.PHONY: test-specific
test-specific:
ifndef TEST_PATH
$(error TEST_PATH is not set. Usage: make test-specific TEST_PATH="test/python/unit/chat/test_chat_logger.py::TestChatLogger::test_read_only_session_history_integration")
endif
@echo "Running specific test: $(TEST_PATH)"
@bash -c "source venv/bin/activate && python -m pytest '$(TEST_PATH)' -v --cov=src/python/role_play --cov-report=term-missing --cov-fail-under=0"
# --- Resource Management ---
.PHONY: validate-resources
validate-resources:
@echo "Validating resource JSON files..."
@bash -c "source venv/bin/activate && python scripts/validate_resources.py data/resources/"
.PHONY: update-resource-metadata
update-resource-metadata:
@echo "Updating resource metadata (timestamps)..."
@bash -c "source venv/bin/activate && python scripts/update_resource_metadata.py data/resources/"
.PHONY: upload-resources
upload-resources: load-env-mk validate-resources
@make list-config
@# Check if we're using a placeholder project ID
ifeq ($(findstring placeholder,$(TARGET_GCP_PROJECT_ID)),placeholder)
@echo "ERROR: Cannot upload resources with placeholder project ID."
@echo "Please set GCP_PROJECT_ID_$(shell echo $(ENV) | tr '[:lower:]' '[:upper:]') in .env.mk or environment."
exit 1
else
@echo "Uploading resources to GCS bucket gs://$(GCS_BUCKET_APP_DATA)/$(GCS_PREFIX_APP_DATA)resources/..."
@gsutil -m cp -r data/resources/* gs://$(GCS_BUCKET_APP_DATA)/$(GCS_PREFIX_APP_DATA)resources/
@echo "Resources uploaded successfully."
endif
.PHONY: download-resources
download-resources: load-env-mk
@make list-config
@# Check if we're using a placeholder project ID
ifeq ($(findstring placeholder,$(TARGET_GCP_PROJECT_ID)),placeholder)
@echo "ERROR: Cannot download resources with placeholder project ID."
@echo "Please set GCP_PROJECT_ID_$(shell echo $(ENV) | tr '[:lower:]' '[:upper:]') in .env.mk or environment."
exit 1
else
@echo "Downloading resources from GCS bucket gs://$(GCS_BUCKET_APP_DATA)/$(GCS_PREFIX_APP_DATA)resources/..."
@mkdir -p data/resources
@gsutil -m cp -r gs://$(GCS_BUCKET_APP_DATA)/$(GCS_PREFIX_APP_DATA)resources/* data/resources/
@echo "Resources downloaded successfully."
endif
.PHONY: deploy-with-resources
deploy-with-resources: validate-resources upload-resources deploy
@echo "Deployment with resources completed."
# --- Utilities ---
.PHONY: logs
logs:
@make list-config
@echo "Fetching logs for $(CLOUD_RUN_SERVICE_NAME) in $(GCP_REGION) from project $(TARGET_GCP_PROJECT_ID)..."
@gcloud logging read "resource.type=cloud_run_revision AND resource.labels.service_name=$(CLOUD_RUN_SERVICE_NAME) AND resource.labels.configuration_name=$(CLOUD_RUN_SERVICE_NAME)" \
--project=$(TARGET_GCP_PROJECT_ID) --limit=50 --format='table(timestamp,logName,severity,jsonPayload.message)'
# Default target
.DEFAULT_GOAL := help
# Example .env.mk file (DO NOT COMMIT THIS FILE - add to .gitignore)
# Create this file in your project root to set your actual GCP Project IDs.
#
# GCP_PROJECT_ID_PROD=your-actual-prod-project-id
# GCP_PROJECT_ID_BETA=your-actual-beta-project-id
# GCP_PROJECT_ID_DEV=your-actual-dev-project-id
# SERVICE_NAME=rps # Can also be set here if you don't want to pass it on cmd line