Makefile

.PHONY: all test lib-test docs-test modules-test coverage dist upload clean doc deps

python_bin ?= python
pretty ?= all
languages ?= python,shell

all:
	@echo "Usage: make deps"
	@echo " - deps: install the dependencies for byexample"
	@echo
	@echo "Usage: make test"
	@echo "Run all the suite of tests using only Python and Shell."
	@echo
	@echo "Usage: make [lib|modules|docs|examples]-test"
	@echo "Run a suite of tests. We assume a minimum environment where"
	@echo "only Python and Shell are available and therefor we run only"
	@echo "a large but not complete subset of tests."
	@echo "Modify test/minumum.env to add more languages if you have"
	@echo "installed them or to add/modify custom flags."
	@echo " - lib-test: run the tests in the lib (unit test)."
	@echo " - modules-test: run the tests of the modules (unit test)."
	@echo " - docs-test: run the tests in the docs."
	@echo " - examples-test: run the examples."
	@echo
	@echo "Usage: make docker-test"
	@echo "Run the suite of tests of the modules and examples and a few"
	@echo "others using all the languages available inside a docker"
	@echo "container where all the interpreters are installed."
	@echo "Modify test/docker.env to modify the flags of the execution."
	@echo "This should complement the suite of tests executed by 'make test'"
	@echo
	@echo "Usage: make travis-<lang>-test"
	@echo "Run a small suite of tests using <lang> and Shell as the only"
	@echo "interpreters. Designed to be executed in the Travis CI environment"
	@echo
	@echo "Usage: make docker-[build|shell]"
	@echo "Create the docker image (build) used by the tests or run a"
	@echo "container and get a shell (shell) to play with it."
	@echo
	@echo "Usage: make dist|upload"
	@echo "Package byexample (dist) and upload it to pypi (upload)"
	@echo
	@echo "Usage: make coverage"
	@echo "Run several times variants of 'make test' with the coverage"
	@echo "activated and show the results."
	@echo
	@echo "Usage: make clean|clean_test"
	@echo "Clean the environment in general (clean) or only related"
	@echo "with the environment for testing (clean_test)."
	@exit 1

deps:
	pip install -e .

private-all-test: clean_test
	@$(python_bin) test/r.py --timeout 90 --pretty $(pretty) --ff -l shell test/test.md
	@make -s clean_test

## Python + Shell tests only
#  =========================
lib-test: clean_test
	@$(python_bin) test/r.py @test/minimum.env -- byexample/*.py
	@make -s clean_test

modules-test: clean_test
	@$(python_bin) test/r.py @test/minimum.env -- byexample/modules/*.py
	@make -s clean_test

docs-test: clean_test
	@$(python_bin) test/r.py @test/minimum.env -- *.md
	@$(python_bin) test/r.py @test/minimum.env -- `find docs -name "*.md"`
	@make -s clean_test

examples-test: clean_test
	@$(python_bin) test/r.py @test/minimum.env -- docs/examples/*
	@make -s clean_test

index-links-test: clean_test
	@./test/idx.sh

test: lib-test modules-test docs-test examples-test index-links-test

#
##

## Tests for specific interpreters to be used in Travis
#  ===================================================
travis-ruby-test: clean_test
	@$(python_bin) test/r.py @test/travis-ruby.env

#
##

## Docker manager
#  ==============

# Docker image build for running the full suite of tests
docker-build:
	@sudo docker build -q -t byexample-test -f test/Dockerfile .

# Drop an interactive shell inside the docker
docker-shell: docker-build
	@sudo docker run -it --rm -v `pwd`:/srv -w /srv byexample-test bash

#
##

## Tests for specific interpreters to be used in the docker container
#  ==================================================================

# Run the tests where other languages than Python and Shell are used
# inside the docker where all the interpreters are installed
docker-test: docker-build
	@sudo docker run -it --rm -v `pwd`:/srv -w /srv byexample-test bash -c 'pip3 install -e . && byexample @test/docker.env -- byexample/modules/*.py docs/languages/*.md docs/examples/* docs/advanced/{geometry,terminal-emulation}.md ; make -s clean_test'

#
##

## Coverage
#  ========

coverage: clean_test
	@cp test/r.py .
	@echo "Run the byexample's tests with the Python interpreter."
	@echo "to start the coverage, use a hook in test/ to initialize the coverage"
	@echo "engine at the begin of the execution (and to finalize it at the end)"
	@$(python_bin) r.py @test/coverage.env --modules test/ -q byexample/*.py
	@echo
	@echo "Run the rest of the tests with an environment variable to make"
	@echo "r.py to initialize the coverage too"
	@BYEXAMPLE_COVERAGE_TEST=1 $(python_bin) r.py @test/coverage.env -q `find docs -name "*.md"`
	@BYEXAMPLE_COVERAGE_TEST=1 $(python_bin) r.py @test/coverage.env -q *.md
	@echo
	@echo "Run again, but with different flags to force the"
	@echo "execution of different parts of byexample"
	@PYTHONIOENCODING=utf-8 BYEXAMPLE_COVERAGE_TEST=1 $(python_bin) r.py @test/coverage.env -vvvvvvvvvvvv --no-enhance-diff README.md > /dev/null
	@PYTHONIOENCODING=utf-8 BYEXAMPLE_COVERAGE_TEST=1 $(python_bin) r.py @test/coverage.env --pretty none -vvvvvvvvvvvv README.md > /dev/null
	@echo
	@echo "Results:"
	@coverage combine
	@coverage report --include="byexample/*"
	@make -s clean_test

#
##

## Packaging and clean up
#  ======================

dist:
	rm -Rf dist/ build/ *.egg-info
	$(python_bin) setup.py sdist bdist_wheel --universal
	rm -Rf build/ *.egg-info

upload: dist
	twine upload dist/*.tar.gz dist/*.whl

clean_test:
	@rm -f .coverage .coverage.work.*
	@rm -f r.py
	@rm -Rf w/
	@mkdir -p w/

clean: clean_test
	rm -Rf dist/ build/ *.egg-info
	rm -Rf build/ *.egg-info
	find . -name "*.pyc" -delete
	find . -type d -name "__pycache__" -delete
	rm -f README.rst

#
##