mirror of
https://github.com/derlin/mantelo.git
synced 2026-08-31 06:07:20 +02:00
Lucy Linder
022b4d72ac
Get rid off divio/lint, and use ruff directly. This makes the config obvious. Also ensure the tests/ folder is linted, and fix all the lint issues at the same time. This should have no impact whatsoever.
63 lines
1.9 KiB
Makefile
63 lines
1.9 KiB
Makefile
.PHONY: all help build docs lint format test mypy export-realms
|
||
|
||
default: help
|
||
|
||
help:
|
||
@awk 'BEGIN {FS = ": .*##";} /^[$$()% 0-9a-zA-Z_-]+(\\:[$$()% 0-9a-zA-Z_-]+)*:.*?##/ { gsub(/\\:/,":", $$1); printf " \033[36m%-5s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
|
||
|
||
|
||
##@ Build
|
||
|
||
build: ## Build the wheels and sdist.
|
||
find . -name "*.egg-info" | xargs rm -rf && \
|
||
rm -rf dist && \
|
||
python -m build
|
||
|
||
##@ Documentation
|
||
|
||
docs: ## Generate the HTML documentation.
|
||
cd docs && make html
|
||
|
||
docs-clean: ## Remove docs build artifacts.
|
||
cd docs && make clean
|
||
|
||
docs-open: ## Open the documentation locally (requires make docs to have ran).
|
||
open docs/_build/html/index.html
|
||
|
||
docs-test: ## Test the documentation code snippets.
|
||
docker compose up -d --wait keycloak
|
||
cd docs && make doctest
|
||
|
||
##@ Development
|
||
|
||
lint: ## Check formatting and lint with ruff.
|
||
ruff format --check mantelo tests
|
||
ruff check mantelo tests
|
||
|
||
format: ## Format and auto-fix with ruff.
|
||
ruff format mantelo tests
|
||
ruff check --fix --show-fixes mantelo tests
|
||
|
||
test: ## Run tests with tox (inside docker).
|
||
coverage erase || true
|
||
docker compose up -d --wait keycloak
|
||
docker compose run tox bash -c "git config --system --add safe.directory /app && tox ${ARGS}"
|
||
coverage combine
|
||
coverage html
|
||
coverage xml
|
||
|
||
mypy: ## Run mypy locally to check types.
|
||
mypy mantelo
|
||
|
||
mypy-strict: ## Run mypy locally and print all missing annotations.
|
||
mypy --disallow-untyped-calls --disallow-untyped-defs --disallow-incomplete-defs mantelo
|
||
|
||
export-realms: ## Export test realms after changes in Keycloak Test Server.
|
||
docker compose exec keycloak /opt/keycloak/bin/kc.sh export --dir /tmp/export --users realm_file; \
|
||
for realm in master orwell; do \
|
||
file=$$realm-realm.json; \
|
||
(docker compose exec keycloak cat /tmp/export/$$file) | \
|
||
jq 'walk(if type == "object" then del(.id) else . end)' | jq --sort-keys \
|
||
> tests/realms/$$file; \
|
||
done
|