Makefile

.PHONY: test docs pep8 build

WHEELS=https://crossbarbuilder.s3.eu-central-1.amazonaws.com/wheels

all:
	@echo ""
	@echo "Targets:"
	@echo ""
	@echo "   install_system   Local install: OS and OS level packages"
	@echo "   install_uv       Local install: uv"
	@echo "   install_venvs    Local install: Python virtualenvs"
	@echo ""
	@echo "   clean_docs       Cleanup: scratch local built docs"
	@echo "   clean            Cleanup"
	@echo "   clean_venvs      Cleanup: scratch all Python virtualenvs"
	@echo ""
	@echo "   publish          Clean build, register and publish to PyPi"
	@echo "   test             Run unit tests"
	@echo "   flake8           Run flake8 code checking"
	@echo ""

install_system:
	sudo apt update -y
	sudo apt dist-upgrade -y
	sudo apt autoremove
	sudo apt install -y curl
	sudo apt install -y libgirepository-2.0-0
	sudo apt install -y libgirepository-2.0-dev

install_uv:
	curl -LsSf https://astral.sh/uv/install.sh | sh
	which uv
	uv --version
	uv python list

# #############################################################################

# =============================================================================
#  CONFIGURATION
#  Define all your Python environments and their interpreters.
#  This is the single, explicit source of truth.
# =================================h=============================================
ENVS := cpy312 cpy311 cpy310 pypy310 pypy311

# Map environment names to the actual python executable names
PYTHON_INTERPRETER_cpy312 := python3.12
PYTHON_INTERPRETER_cpy311 := python3.11
PYTHON_INTERPRETER_cpy310 := python3.10
PYTHON_INTERPRETER_pypy310 := pypy3.10
PYTHON_INTERPRETER_pypy311 := pypy3.11

# =============================================================================
#  VIRTUAL ENVIRONMENT MANAGEMENT
#  Declare all possible venv targets as phony to avoid conflicts with files.
# =============================================================================
.PHONY: venv-all $(addprefix venv-,$(ENVS))

venv-all: $(addprefix venv-,$(ENVS))

# Example: `make venv-cpy312`
venv-%:
	@echo "==> Creating virtual environment for '$*'..."
	# Use an indirect variable to get the correct interpreter name
	uv venv --python $(PYTHON_INTERPRETER_$(*)) .venv-$(*)

# =============================================================================
#  VERSIONS
# =============================================================================
.PHONY: version-all $(addprefix version-,$(ENVS))

version-all: $(addprefix version-,$(ENVS))

version-%: venv-%
	./.venv-$(*)/bin/python -V

version-pypy311:
	./.venv-pypy311/bin/python -V

# =============================================================================
#  LINTING
#  Declare all possible lint targets as phony.
# =============================================================================
.PHONY: lint-all $(addprefix lint-,$(ENVS))

lint-all: $(addprefix lint-,$(ENVS))

lint-%: venv-%
	@echo "==> Linting with environment '$*'..."
	./.venv-$(*)/bin/uv pip install -r requirements-dev.txt
	./.venv-$(*)/bin/ruff check autobahn

# =============================================================================
#  TESTING
#  Declare all possible test targets as phony.
# =============================================================================
.PHONY: test-all $(addprefix test-,$(ENVS))

test-all: $(addprefix test-,$(ENVS))

test-%: venv-%
	@echo "==> Running tests with environment '$*'..."
	./.venv-$(*)/bin/uv pip install -e .[dev]
	./.venv-$(*)/bin/pytest

# =============================================================================
#  CLEANUP
# =============================================================================
.PHONY: clean
clean:
	rm -rf .venv-*

# #############################################################################

install_venvs:
	uv venv --python 3.12 .venv-cpy312
	uv venv --python 3.11 .venv-cpy311
	uv venv --python 3.10 .venv-cpy310
	uv venv --python pypy-3.11 .venv-pypy311
	uv venv --python pypy-3.10 .venv-pypy310

activate_cpy312:
	source ./.venv-cpy312/bin/activate



# install locally
# https://github.com/pypy/pypy/issues/5248#issuecomment-3011857854
install_old:
	-pip uninstall -y pytest_asyncio # remove the broken shit
	-pip uninstall -y pytest_cov # remove the broken shit
	pip3 install git+https://gitlab.gnome.org/GNOME/pygobject
	# enforce use of bundled libsodium
	AUTOBAHN_USE_NVX=1 SODIUM_INSTALL=bundled pip install -e .[all]

build:
	-rm -f dist/*
	# AUTOBAHN_USE_NVX=0 python -m build
	AUTOBAHN_USE_NVX=1 python -m build
	ls -la dist

# upload to our internal deployment system
upload: clean
	AUTOBAHN_USE_NVX=0 python -m build
	aws s3 cp --acl public-read \
		dist/autobahn-*.whl \
		s3://fabric-deploy/autobahn/

# cleanup docs
clean_docs:
	-rm -rf ./docs/_build
	-rm -rf ./docs/autoapi/


# cleanup everything but venvs
clean2: clean_docs
	-rm -f ./*.so
	-rm -rf ./docs/build
	-rm -rf ./.cache
	-rm -rf ./autobahn.egg-info
	-rm -rf ./build
	-rm -rf ./dist
	-rm -rf ./temp
	-rm -rf ./_trial_temp
	-rm -rf ./.tox
	-rm -rf ./.eggs
	-rm -rf ./htmlcov
	-rm -f  ./twisted/plugins/dropin.cache
	-find . -name "*dropin.cache.new" -type f -exec rm -f {} \;
	-find . -name ".pytest_cache" -type d -exec rm -rf {} \;
	-find . -name "*.tar.gz" -type f -exec rm -f {} \;
	-find . -name "*.egg" -type f -exec rm -f {} \;
	-find . -name "*.pyc" -type f -exec rm -f {} \;

	# Learn to love the shell! http://unix.stackexchange.com/a/115869/52500
	-find . \( -name "*__pycache__" -type d \) -prune -exec rm -rf {} +

# cleanup venvs
clean_venvs: clean
	rm -rf ./.venv*

# publish to PyPI
publish: clean
	AUTOBAHN_USE_NVX=0 python -m build
	twine upload dist/*

# autoformat with import sorting, including __all__
#
autoformat_python:
	ruff check --select I,RUF022 --fix .
	ruff format .

# Prettier: Markdown docs => opinionated, auto-formatting tool that "just works"
# 	https://prettier.io/
# Config: ./.prettierrc.json
# Installation: npm install --save-dev --save-exact prettier
#
autoformat_markdown_docs:
	npx prettier --write README.md
	npx prettier --write OVERVIEW.md
	npx prettier --write CONTRIBUTING.md
	npx prettier --write RELEASING.md
	npx prettier --write AI_AUDIT_PROCESS.md
	npx prettier --write AI_POLICY.md
	npx prettier --write CLAUDE.md
	npx prettier --write .audit/README.md
	npx prettier --write .github/pull_request_template.md
	npx prettier --write .github/ISSUE_TEMPLATE/bug_report.md
	npx prettier --write .github/ISSUE_TEMPLATE/feature_request.md

# rstfmt: ReST docs => opinionated, auto-formatting tool that "just works"
# 	https://github.com/dzhu/rstfmt
# Config: ./pyproject.toml
# Installation: pip install rstfmt
#
autoformat_rest_docs:
	rstfmt AI_POLICY.rst

# copy AI Policy and GitHub template files; and adjust them; in one go
copy_project_templates:
	@python3 copy_project_templates.py

docs:
	tox -e sphinx

spelling:
	cd docs && sphinx-build -b spelling . _spelling

run_docs:
	twistd --nodaemon web --port=tcp:8090 --path=./docs/_build/


clean_wheels:
	rm -rf ./.wheels
	mkdir -p ./.wheels/

download_wheels:
	mkdir -p ./.wheels/
	rm -f ./.wheels/*.whl
	curl -o ./.wheels/txaio-latest-py2.py3-none-any.whl 	$(WHEELS)/txaio-latest-py2.py3-none-any.whl
	curl -o ./.wheels/autobahn-latest-py2.py3-none-any.whl 	$(WHEELS)/autobahn-latest-py2.py3-none-any.whl
	ls -la ./.wheels

build_this_wheel:
	mkdir -p ./.wheels/
	rm -f ./.wheels/autobahn*.whl
	pip3 wheel --no-deps --wheel-dir=./.wheels .
	mv .wheels/autobahn*.whl .wheels/autobahn-latest-py2.py3-none-any.whl
	ls -la ./.wheels

build_exe:
	tox -e buildexe

mypy:
	mypy --install-types --non-interactive autobahn

test_wamp_serializer:
	-USE_TWISTED=1 trial autobahn.wamp.test.test_wamp_serializer
	-USE_ASYNCIO=1 pytest autobahn/wamp/test/test_wamp_serializer.py

test_nvx:
	python -m pytest -rsx autobahn/nvx/test
	USE_TWISTED=1 trial autobahn.nvx.test.test_utf8validator

test_styleguide:
	flake8 --statistics -qq autobahn

# direct test via pytest (only here because of setuptools test integration)
test_pytest:
	USE_ASYNCIO=1 python -m pytest -c setup.cfg -rsvx autobahn/

test:
	tox -e flake8,py37-twtrunk,py37-asyncio

#test: flake8 test_twisted test_asyncio

# test under Twisted
test_twisted:
	USE_TWISTED=1 trial autobahn
#	WAMP_ROUTER_URL="ws://127.0.0.1:8080/ws" USE_TWISTED=1 trial autobahn

test_application_runner:
	USE_TWISTED=1 trial autobahn.twisted.test.test_tx_application_runner

test_util:
	USE_TWISTED=1 trial autobahn.test.test_util

test_rng:
	USE_TWISTED=1 trial autobahn.test.test_rng

test_serializer:
	USE_TWISTED=1 trial autobahn.wamp.test.test_wamp_serializer

test_wamp_identifiers:
	USE_TWISTED=1 trial autobahn.wamp.test.test_wamp_identifiers

test_tx_cryptobox:
	USE_TWISTED=1 trial autobahn.wamp.test.test_cryptobox

test_tx_choosereactor:
	USE_TWISTED=1 trial autobahn.twisted.test.test_choosereactor

test_cryptosign:
#	USE_ASYNCIO=1 trial autobahn.wamp.test.test_wamp_cryptosign
	USE_ASYNCIO=1 pytest -s -v -rfA --ignore=./autobahn/twisted autobahn/wamp/test/test_wamp_cryptosign.py
	USE_TWISTED=1 trial autobahn.wamp.test.test_wamp_cryptosign

test_wamp_scram:
	USE_ASYNCIO=1 trial autobahn.wamp.test.test_wamp_scram
	USE_TWISTED=1 trial autobahn.wamp.test.test_wamp_scram

test_transport_details:
	USE_ASYNCIO=1 trial autobahn.wamp.test.test_wamp_transport_details
	USE_TWISTED=1 trial autobahn.wamp.test.test_wamp_transport_details

test_session_details:
	USE_ASYNCIO=1 trial autobahn.wamp.test.test_wamp_session_details
	USE_TWISTED=1 trial autobahn.wamp.test.test_wamp_session_details

test_tx_protocol:
	USE_TWISTED=1 trial autobahn.twisted.test.test_tx_protocol

test_asyncio:
	USE_ASYNCIO=1 pytest -s -v -rfP --ignore=./autobahn/twisted autobahn
#	USE_ASYNCIO=1 pytest -s -v -rA --ignore=./autobahn/twisted ./autobahn/asyncio/test/test_aio_websocket.py
#	USE_ASYNCIO=1 pytest -s -v -rA --log-cli-level=info --ignore=./autobahn/twisted ./autobahn/asyncio/test/test_aio_websocket.py

test_cs1:
	USE_ASYNCIO=1 python -m pytest -s -v autobahn/wamp/test/test_cryptosign.py

test1:
	USE_TWISTED=1 trial autobahn.wamp.test.test_wamp_uri_pattern
#	USE_TWISTED=1 trial autobahn.wamp.test.test_auth
#	USE_TWISTED=1 python -m pytest -s -v autobahn/wamp/test/test_auth.py
#	USE_TWISTED=1 python -m pytest -s -v autobahn/wamp/test/test_router.py
#	USE_ASYNCIO=1 python -m pytest -s -v autobahn/wamp/test/test_router.py

test2:
#	USE_TWISTED=1 python -m pytest -s -v autobahn/wamp/test/test_router.py
	USE_ASYNCIO=1 python -m pytest -s -v autobahn/wamp/test/test_router.py
#	trial autobahn
#	trial autobahn.websocket.test
#	trial autobahn.wamp.test
#	trial autobahn.wamp.test.test_component
#	trial autobahn.wamp.test.test_message
#	trial autobahn.wamp.test.test_protocol
#	trial autobahn.wamp.test.test_protocol_peer
#	trial autobahn.wamp.test.test_serializer
#	trial autobahn.wamp.test.test_uri_pattern

pyflakes:
	pyflakes .

# run PEP8 check and print statistics
pep8:
	pep8 --statistics --ignore=E501 -qq autobahn

# run PEP8 check and show source for offending code
pep8show:
	pep8 --show-source --ignore=E501 autobahn

# run autopep8 to automatically transform offending code
autopep8:
	autopep8 -ri --aggressive autobahn

# This will run pep8, pyflakes and can skip lines that end with # noqa
flake8:
	tox -c tox.ini -e flake8

# run PyLint
pylint:
	pylint -d line-too-long,invalid-name autobahn

# on Unix, check for files with Windows line endings
find_windows_files:
	find . -name "*" -exec file {} \; | grep "CRLF"

# on Windows (Git Bash), check for files with Unix lines endings
find_unix_files:
	find . -name "*" -exec dos2unix -tv {} \; 2>&1 | grep "Unix"

# sudo apt install gource ffmpeg
gource:
	gource \
	--path . \
	--seconds-per-day 0.15 \
	--title "autobahn-python" \
	-1280x720 \
	--file-idle-time 0 \
	--auto-skip-seconds 0.75 \
	--multi-sampling \
	--stop-at-end \
	--highlight-users \
	--hide filenames,mouse,progress \
	--max-files 0 \
	--background-colour 000000 \
	--disable-bloom \
	--font-size 24 \
	--output-ppm-stream - \
	--output-framerate 30 \
	-o - \
	| ffmpeg \
	-y \
	-r 60 \
	-f image2pipe \
	-vcodec ppm \
	-i - \
	-vcodec libx264 \
	-preset ultrafast \
	-pix_fmt yuv420p \
	-crf 1 \
	-threads 0 \
	-bf 0 \
	autobahn-python.mp4

#
# generate (a special set of) WAMP message classes from FlatBuffers schema
#

# To build flatc from sourcces:
#
#  git clone https://github.com/google/flatbuffers.git
#  cd flatbuffers
#  git checkout v22.12.06
#  cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release
#  make
#  sudo cp ./flatc /usr/local/bin/flatc

# input .fbs files for schema
FBSFILES=./autobahn/wamp/flatbuffers/*.fbs

# flatc compiler to use
FLATC=flatc

clean_fbs:
	-rm -rf ./autobahn/wamp/gen/

build_fbs:
	# generate schema binary type library (*.bfbs files)
	$(FLATC) -o ./autobahn/wamp/gen/schema/ --binary --schema --bfbs-comments --bfbs-builtins $(FBSFILES)
	@find ./autobahn/wamp/gen/schema/ -name "*.bfbs" | wc -l

	# generate schema Python bindings (*.py files)
	$(FLATC) -o ./autobahn/wamp/gen/ --python $(FBSFILES)
	@touch ./autobahn/wamp/gen/__init__.py
	@find ./autobahn/wamp/gen/ -name "*.py" | wc -l

build_fbs_cpp:
	# generate schema C++ bindings (*.cpp/hpp files)
	$(FLATC) -o /tmp/gen-cpp/ --cpp $(FBSFILES)
	@find /tmp/gen-cpp/

build_fbs_rust:
	# generate schema Rust bindings (*.rs files)
	$(FLATC) -o /tmp/gen-rust/ --rust $(FBSFILES)
	@find /tmp/gen-rust/

fix_copyright:
	find . -type f -exec sed -i 's/Copyright (c) Crossbar.io Technologies GmbH/Copyright (c) typedef int GmbH/g' {} \;