Kevin Veen-Birkenbach
a42930a699
test-e2e drove Cypress through act, which fails to start where it cannot resolve a host address for its artifact server. It now starts Flask and Cypress in one shell via scripts/run-e2e.sh, so both share a network namespace; the act path stays available as test-e2e-act. The script guards the cases that made the old target lie: it aborts when something already serves the port instead of testing that server, checks that its own Flask is alive before trusting a response, pins Cypress to the same origin Flask binds, and drops ELECTRON_RUN_AS_NODE, which VS Code exports and which makes Cypress' bundled Electron reject its own flags. 30 YAML and 18 JavaScript files had no linter. yamllint runs correctness rules only, because the repository predates it and its cosmetic findings would be noise; key-duplicates is the one that earns its keep, since PyYAML keeps the last of two identical keys without complaining. eslint runs the recommended set and already found a dead getBoundingClientRect() call in navigation.js. Both get a CI job so make lint and the workflows stop diverging. flask>=3.1 because app.config["TRUSTED_HOSTS"] arrived in 3.1 and an older Flask accepts the key and ignores it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
248 lines
6.9 KiB
Makefile
248 lines
6.9 KiB
Makefile
# Load environment variables from .env
|
|
ifneq (,$(wildcard .env))
|
|
include .env
|
|
# Export variables defined in .env
|
|
export $(shell sed 's/=.*//' .env)
|
|
endif
|
|
|
|
PYTHON ?= python3
|
|
ACT ?= act
|
|
|
|
# Bootstrap the local .env from the checked-in env.example template.
|
|
# Idempotent: leaves an existing .env untouched.
|
|
.PHONY: env
|
|
env:
|
|
@if [ -f .env ]; then \
|
|
echo ".env already exists — leaving it alone."; \
|
|
else \
|
|
cp env.example .env; \
|
|
echo "Created .env from env.example — review and adjust."; \
|
|
fi
|
|
|
|
# Bootstrap app/config.yaml from the checked-in app/config.sample.yaml
|
|
# template. Idempotent: leaves an existing config.yaml untouched. The
|
|
# Dockerfile COPYs the whole app/ directory at build time, so this file
|
|
# must exist before `make build` / `make up`.
|
|
.PHONY: config
|
|
config:
|
|
@if [ -f app/config.yaml ]; then \
|
|
echo "app/config.yaml already exists — leaving it alone."; \
|
|
else \
|
|
cp app/config.sample.yaml app/config.yaml; \
|
|
echo "Created app/config.yaml from app/config.sample.yaml — review and adjust."; \
|
|
fi
|
|
|
|
# Build/run recipes source .env at recipe-execution time (not at make
|
|
# parse time) so they work in the same invocation that bootstrapped
|
|
# .env via the `env` prereq. Without this, the inner $$IMAGE_NAME /
|
|
# $$PORT would be empty on the very first `make build` after a fresh
|
|
# checkout — the parse-time `include .env` happens before `env` runs.
|
|
define _require_env
|
|
if [ ! -f .env ]; then echo "ERROR: .env missing"; exit 1; fi; \
|
|
. ./.env; \
|
|
for v in $(1); do \
|
|
eval "val=\$$$$v"; \
|
|
[ -n "$$val" ] || { echo "ERROR: $$v is empty in .env (see env.example)"; exit 1; }; \
|
|
done
|
|
endef
|
|
|
|
.PHONY: build
|
|
build: env config
|
|
# Build the Docker image.
|
|
@$(call _require_env,IMAGE_NAME); \
|
|
docker build -t "$$IMAGE_NAME" .
|
|
|
|
.PHONY: build-no-cache
|
|
build-no-cache: env config
|
|
# Build the Docker image without cache.
|
|
@$(call _require_env,IMAGE_NAME); \
|
|
docker build --no-cache -t "$$IMAGE_NAME" .
|
|
|
|
.PHONY: up
|
|
up: env config
|
|
# Start the application using docker-compose with build.
|
|
docker-compose up -d --build --force-recreate
|
|
|
|
.PHONY: down
|
|
down:
|
|
# Stop and remove the 'portfolio' container, ignore errors, and bring down compose.
|
|
- docker stop portfolio || true
|
|
- docker rm portfolio || true
|
|
- docker-compose down
|
|
|
|
.PHONY: run-dev
|
|
run-dev: env config config
|
|
# Run the container in development mode (hot-reload).
|
|
@$(call _require_env,IMAGE_NAME PORT); \
|
|
docker run -d \
|
|
-p "$$PORT:$$PORT" \
|
|
--name portfolio \
|
|
-v "$(PWD)/app/:/app" \
|
|
-e PORT="$$PORT" \
|
|
-e TRUSTED_HOSTS="$$TRUSTED_HOSTS" \
|
|
-e FLASK_APP=app.py \
|
|
-e FLASK_ENV=development \
|
|
"$$IMAGE_NAME"
|
|
|
|
.PHONY: run-prod
|
|
run-prod: env config config
|
|
# Run the container in production mode.
|
|
@$(call _require_env,IMAGE_NAME PORT); \
|
|
docker run -d \
|
|
-p "$$PORT:$$PORT" \
|
|
--name portfolio \
|
|
-e PORT="$$PORT" \
|
|
-e TRUSTED_HOSTS="$$TRUSTED_HOSTS" \
|
|
"$$IMAGE_NAME"
|
|
|
|
.PHONY: logs
|
|
logs:
|
|
# Display the logs of the 'portfolio' container.
|
|
docker logs -f portfolio
|
|
|
|
.PHONY: dev
|
|
dev: env config
|
|
# Start the application in development mode using docker-compose.
|
|
FLASK_ENV=development docker-compose up -d
|
|
|
|
.PHONY: prod
|
|
prod: env config
|
|
# Start the application in production mode using docker-compose (with build).
|
|
docker-compose up -d --build
|
|
|
|
.PHONY: cleanup
|
|
cleanup:
|
|
# Remove all stopped Docker containers to reclaim space.
|
|
docker container prune -f
|
|
|
|
.PHONY: delete
|
|
delete:
|
|
# Force remove the 'portfolio' container if it exists.
|
|
- docker rm -f portfolio
|
|
|
|
.PHONY: browse
|
|
browse: env
|
|
# Open the application in the browser at http://localhost:$$PORT
|
|
@$(call _require_env,PORT); \
|
|
chromium "http://localhost:$$PORT"
|
|
|
|
.PHONY: install
|
|
install:
|
|
# Install runtime Python dependencies from pyproject.toml.
|
|
$(PYTHON) -m pip install -e .
|
|
|
|
.PHONY: install-dev
|
|
install-dev:
|
|
# Install runtime and developer dependencies from pyproject.toml.
|
|
$(PYTHON) -m pip install -e ".[dev]"
|
|
|
|
.PHONY: i18n
|
|
i18n: env config
|
|
# Fill missing content translations in app/i18n/content/ via LibreTranslate.
|
|
@$(call _require_env,LIBRETRANSLATE_URL); \
|
|
$(PYTHON) utils/i18n_sync.py \
|
|
--url "$$LIBRETRANSLATE_URL" \
|
|
--api-key "$$LIBRETRANSLATE_API_KEY"
|
|
|
|
.PHONY: lint-actions
|
|
lint-actions:
|
|
# Lint GitHub Actions workflows.
|
|
docker run --rm -v "$$PWD:/repo" -w /repo rhysd/actionlint:latest
|
|
|
|
.PHONY: lint-python
|
|
lint-python: install-dev
|
|
# Run Python lint and format checks.
|
|
$(PYTHON) -m ruff check .
|
|
$(PYTHON) -m ruff format --check .
|
|
|
|
.PHONY: lint-docker
|
|
lint-docker:
|
|
# Lint the Dockerfile.
|
|
docker run --rm -i hadolint/hadolint < Dockerfile
|
|
|
|
.PHONY: lint-yaml
|
|
lint-yaml: install-dev
|
|
# Lint YAML for duplicate keys and ambiguous scalars (see .yamllint).
|
|
$(PYTHON) -m yamllint --strict .
|
|
|
|
.PHONY: lint-js
|
|
lint-js: node-deps
|
|
# Lint the browser and Cypress JavaScript.
|
|
cd app && env -u ELECTRON_RUN_AS_NODE npx eslint .
|
|
|
|
.PHONY: lint-shell
|
|
lint-shell:
|
|
# Lint the shell scripts.
|
|
docker run --rm -v "$$PWD:/mnt" -w /mnt koalaman/shellcheck:stable scripts/*.sh
|
|
|
|
.PHONY: test-lint
|
|
test-lint:
|
|
# Run lint guardrail tests.
|
|
$(PYTHON) -m unittest discover -s tests/lint -t .
|
|
|
|
.PHONY: test-integration
|
|
test-integration: install
|
|
# Run repository integration tests.
|
|
$(PYTHON) -m unittest discover -s tests/integration -t .
|
|
|
|
.PHONY: test-unit
|
|
test-unit: install
|
|
# Run repository unit tests.
|
|
$(PYTHON) -m unittest discover -s tests/unit -t .
|
|
|
|
.PHONY: test-security
|
|
test-security: install
|
|
# Run repository security guardrail tests.
|
|
$(PYTHON) -m unittest discover -s tests/security -t .
|
|
|
|
.PHONY: lint
|
|
lint: lint-actions lint-python lint-yaml lint-js lint-docker lint-shell test-lint
|
|
# Run the full lint suite.
|
|
|
|
.PHONY: security
|
|
security: install-dev test-security
|
|
# Run security checks.
|
|
$(PYTHON) -m bandit -q -ll -ii -r app main.py
|
|
$(PYTHON) utils/export_runtime_requirements.py > /tmp/portfolio-runtime-requirements.txt
|
|
$(PYTHON) -m pip_audit -r /tmp/portfolio-runtime-requirements.txt
|
|
|
|
.PHONY: node-deps
|
|
node-deps:
|
|
# Install the Cypress binary and the browser vendor assets into app/.
|
|
cd app && npm install
|
|
|
|
.PHONY: test-e2e
|
|
test-e2e: env config node-deps
|
|
# Run Cypress against a locally started Flask app — no act, no runner image.
|
|
@$(call _require_env,PORT); \
|
|
PORT="$$PORT" PYTHON="$(PYTHON)" scripts/run-e2e.sh
|
|
|
|
.PHONY: test-e2e-act
|
|
test-e2e-act:
|
|
# Run the CI end-to-end job through act (stop portfolio container to free port first).
|
|
-docker stop portfolio 2>/dev/null || true
|
|
$(ACT) workflow_dispatch -W .github/workflows/tests.yml -j e2e
|
|
-docker start portfolio 2>/dev/null || true
|
|
|
|
.PHONY: test-workflow
|
|
test-workflow:
|
|
# Run the GitHub test workflow locally via act.
|
|
$(ACT) workflow_dispatch -W .github/workflows/tests.yml
|
|
|
|
.PHONY: lint-workflow
|
|
lint-workflow:
|
|
# Run the GitHub lint workflow locally via act.
|
|
$(ACT) workflow_dispatch -W .github/workflows/lint.yml
|
|
|
|
.PHONY: quality
|
|
quality: lint-workflow test-workflow
|
|
# Run the GitHub lint and test workflows locally via act.
|
|
|
|
.PHONY: ci
|
|
ci: lint security test-unit test-integration test-e2e
|
|
# Run the local CI suite.
|
|
|
|
.PHONY: test
|
|
test: ci
|
|
# Run the full validation suite.
|