mirror of
https://github.com/kevinveenbirkenbach/homepage.veen.world.git
synced 2026-09-10 21:26:48 +00:00
Kevin Veen-Birkenbach
f830153cf4
make test installed the project into whatever PYTHON pointed at, which is the system python3 by default. On Manjaro, Debian and Ubuntu that Python is externally managed, so pip refuses (PEP 668) and not a single suite runs, although AGENTS.md requires make test before every commit. It also stopped at the first failing suite, so one broken linter hid the result of every test behind it. make test now creates .venv on first use and runs ci with --keep-going and that interpreter, so every suite runs and make lists each failed target. The path is fixed to the checkout: an exported VENV, which other tooling sets, would otherwise redirect it. It is absolute because run-e2e.sh changes into app/ before starting Flask. All other targets keep PYTHON ?= python3. Verified with a full make test: actionlint, ruff, yamllint, eslint, hadolint, shellcheck, the lint, security, unit and integration suites, bandit, pip-audit and 107 Cypress tests all pass. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
262 lines
7.5 KiB
Makefile
262 lines
7.5 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
|
|
TEST_VENV := $(CURDIR)/.venv
|
|
TEST_PYTHON ?= $(TEST_VENV)/bin/python
|
|
|
|
# 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: i18n-ui
|
|
i18n-ui: env
|
|
# Fill missing interface translations in app/i18n/ui/ via LibreTranslate.
|
|
@$(call _require_env,LIBRETRANSLATE_URL); \
|
|
$(PYTHON) utils/i18n_sync.py \
|
|
--catalog ui \
|
|
--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: install
|
|
# 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:
|
|
# Run every local suite in a project virtualenv, since PEP 668 refuses pip on
|
|
# a system Python, and keep going so each failing suite reports.
|
|
@[ -x "$(TEST_PYTHON)" ] || python3 -m venv "$(TEST_VENV)"
|
|
$(MAKE) --keep-going ci PYTHON="$(TEST_PYTHON)"
|