Makefile

# Copyright (C) 2019-2020, TomTom (http://tomtom.com).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

.PHONY: clean clean-test clean-pyc clean-build docs help
.DEFAULT_GOAL := help
.SUFFIXES:

define BROWSER_PYSCRIPT
import os, webbrowser, sys

try:
	from urllib import pathname2url
except:
	from urllib.request import pathname2url

webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT

define PRINT_HELP_PYSCRIPT
import re, sys

for line in sys.stdin:
	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
	if match:
		target, help = match.groups()
		print("%-20s %s" % (target, help))
endef
export PRINT_HELP_PYSCRIPT

BROWSER := python3 -c "$$BROWSER_PYSCRIPT"

export ROOT_DIR = $(CURDIR)
export BUILD_DIR = $(CURDIR)/build

DOXYGEN_VERSIONS := 1.8.17 1.8.18 1.8.20 1.9.1 1.9.2
export LATEST_DOXYGEN_VERSION := 1.9.2

DOCKER_IMAGE_NAME ?= silvester747/asciidoxy
DOCKER_IMAGE_VERSION ?= testing
DOCKER_IMAGE_PLATFORM ?= linux/amd64

help:
	@python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts

clean-build: ## remove build artifacts
	rm -rf build/
	rm -rf dist/
	rm -rf .eggs/
	find . -path ./.venv -prune -o -name '*.egg-info' -exec rm -rf {} +
	find . -path ./.venv -prune -o -name '*.egg' -exec rm -f {} +

clean-pyc: ## remove Python file artifacts
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '*~' -exec rm -f {} +
	find . -name '__pycache__' -exec rm -rf {} +

clean-test: ## remove test and coverage artifacts
	rm -rf .tox/
	rm -f .coverage
	rm -rf htmlcov/
	rm -rf .pytest_cache
	rm -rf test_results
	rm -rf .mypy_cache
	find . -name '.asciidoxy.*' -exec rm -rf {} +

clean-docs: ## remove documentation generation artifacts
	rm -rf build/doc

lint: ## check style with flake8
	flake8 asciidoxy tests/unit

type-check: ## Check typing with mypy
	mypy asciidoxy

unit-test: ## run tests quickly with the default Python
	pytest --numprocesses=auto --maxprocesses=6 tests/unit

test-all: ## run tests on every Python version with tox
	tox -s

coverage: ## check code coverage quickly with the default Python
	coverage run --source asciidoxy -m pytest
	coverage report -m
	coverage html
	$(BROWSER) htmlcov/index.html

release: dist ## package and upload a release
	twine upload dist/*

dist: clean ## builds source and wheel package
	python3 -m build
	ls -l dist

install: clean ## install the package to the active Python's site-packages
	python3 setup.py install

virtualenv: ## set up a development environment
	python3 -m venv .venv
	. .venv/bin/activate && pip install wheel
	. .venv/bin/activate && pip install -r dev-requirements.txt
	. .venv/bin/activate && python3 setup.py develop

docker: dist ## build the docker image
	docker build -f docker/Dockerfile \
		-t $(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_VERSION) \
		--platform $(DOCKER_IMAGE_PLATFORM) \
		dist/

format: ## format the code
	yapf -r -i -p setup.py asciidoxy tests/unit
	isort .

docs: doxygen ## generate documentation
	cd documentation && $(MAKE)

define DOXYGEN_template
doxygen-$(1):
	CONAN_USER_HOME=$(BUILD_DIR) CONAN_DEFAULT_PROFILE_PATH="" DOXYGEN_VERSION=$(1) \
									conan install doxygen/conanfile.py --install-folder=build/doxygen-$(1) --build missing
endef
$(foreach version,$(DOXYGEN_VERSIONS),$(eval $(call DOXYGEN_template,$(version))))

doxygen: doxygen-$(LATEST_DOXYGEN_VERSION) ## Install the latest doxygen version

define GENERATE_TEST_XML_template
generate-test-xml-$(1): doxygen-$(1)
	. build/doxygen-$(1)/activate_run.sh; cd tests/data/source_code; python3 generate_xml.py doxygen

ALL_GENERATE_TEST_XML := $$(ALL_GENERATE_TEST_XML) generate-test-xml-$(1)
endef
$(foreach version,$(DOXYGEN_VERSIONS),$(eval $(call GENERATE_TEST_XML_template,$(version))))

generate-test-xml: $(ALL_GENERATE_TEST_XML) ## generate Doxygen XML files required for test cases

# Generate output for visual inspection tests
VISUAL_TEST_CASES := $(wildcard tests/visual/*.toml)
VISUAL_TEST_CASE_BUILD_DIR := build/visual-test

define VISUAL_TEST_template
visual-test-$(notdir $(basename $(1))): $(patsubst %.toml,%.adoc,$(1))
	asciidoxy $(patsubst %.toml,%.adoc,$(1)) \
		--build-dir $(VISUAL_TEST_CASE_BUILD_DIR) \
		--spec-file $(1) \
		--warnings-are-errors \
		--debug \
		--require asciidoctor-diagram \
		--failure-level ERROR \
		--multipage
	mv $(VISUAL_TEST_CASE_BUILD_DIR)/debug.json $(VISUAL_TEST_CASE_BUILD_DIR)/$(notdir $(basename $(1))).debug.json

ALL_VISUAL_TEST_CASES := $$(ALL_VISUAL_TEST_CASES) visual-test-$(notdir $(basename $(1)))
endef

$(foreach visual_test,$(VISUAL_TEST_CASES),$(eval $(call VISUAL_TEST_template,$(visual_test))))

visual-test: $(ALL_VISUAL_TEST_CASES) ## run visual inspection test cases

# Generate output to test Docker image
#
DOCKER_TEST_CASE_BUILD_DIR := build/docker-test

define DOCKER_TEST_template
docker-test-$(notdir $(basename $(1))): $(patsubst %.toml,%.adoc,$(1))
	docker run --rm -v `pwd`:`pwd` -w `pwd` \
		--platform $(DOCKER_IMAGE_PLATFORM) \
		$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_VERSION) \
		asciidoxy $(patsubst %.toml,%.adoc,$(1)) \
			--build-dir $(DOCKER_TEST_CASE_BUILD_DIR) \
			--spec-file $(1) \
			--warnings-are-errors \
			--require asciidoctor-diagram \
			--failure-level ERROR \
			--multipage

ALL_DOCKER_TEST_CASES := $$(ALL_DOCKER_TEST_CASES) docker-test-$(notdir $(basename $(1)))
endef

$(foreach visual_test,$(VISUAL_TEST_CASES),$(eval $(call DOCKER_TEST_template,$(visual_test))))

docker-test: $(ALL_DOCKER_TEST_CASES) ## run Docker test cases