Makefile

#!/usr/bin/env make -f
#
# Makefile for recipe static site generator
#

# ---------------------------------------------------------------------------
#
# General setup
#

# Set default target
.DEFAULT_GOAL := test

# Decide if use python3 or python
ifeq (, $(@shell which python3))
	py = python3
else
	py = python
endif
# Decide if use pip3 or pip
ifeq (, $(@shell which pip3))
	pip = pip3
else
	pip = pip
endif
# Decide if use firefox or firefox.exe
ifeq (, $(@shell which firefox.exe))
	browser = firefox.exe
else
	browser = firefox
endif


# Detect OS
OS = $(shell uname -s)

# Defaults
ECHO = echo

# Make adjustments based on OS
ifneq (, $(findstring CYGWIN, $(OS)))
	ECHO = /bin/echo -e
endif

# Colors and helptext
NO_COLOR	= \033[0m
ACTION		= \033[32;01m
OK_COLOR	= \033[32;01m
ERROR_COLOR	= \033[31;01m
WARN_COLOR	= \033[33;01m

# Which makefile am I in?
WHERE-AM-I = $(CURDIR)/$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
THIS_MAKEFILE := $(call WHERE-AM-I)

# Echo some nice helptext based on the target comment
HELPTEXT = $(ECHO) "$(ACTION)--->" `egrep "^\# target: $(1) " $(THIS_MAKEFILE) | sed "s/\# target: $(1)[ ]*-[ ]* / /g"` "$(NO_COLOR)"



# ----------------------------------------------------------------------------
#
# Highlevel targets
#
# target: help                         - Displays help with targets available.
.PHONY:  help
help:
	@$(call HELPTEXT,$@)
	@echo "Usage:"
	@echo " make [target] ..."
	@echo "target:"
	@egrep "^# target:" Makefile | sed 's/# target: / /g'



# target: info                         - Displays versions.
.PHONY: info
info:
	@${py} --version
	@${py} -m pip --version
#@virtualenv --version



# target: validate                     - Validate code with pylint
.PHONY: validate
validate:
	@pylint --rcfile=.pylintrc app tests



# target: validate-docker              - Validate Dockerfile with hadolint
.PHONY: validate-docker
validate-docker:
	@docker run --rm -i hadolint/hadolint < docker/Dockerfile_prod
	@docker run --rm -i hadolint/hadolint < docker/Dockerfile_test



# target: validate-ci                  - Validate CircleCi config with CircleCi CLI
.PHONY: validate-ci
validate-ci:
	@circleci config validate



# target: test-integration             - Run tests in tests/integration with coverage.py
.PHONY: test-integration
test-integration: clean
	@$(ECHO) "$(ACTION)---> Running all tests in tests/integration" "$(NO_COLOR)"
	@${py} \
		-m coverage run --rcfile=.coveragerc \
		-m py.test -c .pytest.ini tests/integration
	$(MAKE) clean-py



# target: test-unit                    - Run tests in tests/unit with coverage.py
.PHONY: test-unit
test-unit: clean
	@$(ECHO) "$(ACTION)---> Running all tests in tests/unit" "$(NO_COLOR)"
	@${py} \
		-m coverage run --rcfile=.coveragerc \
		-m py.test -c .pytest.ini tests/unit
	$(MAKE) clean-py



# target: run-test test=test-file.py   - Run one test file
.PHONY: run-test
run-test:
	@${py} \
		-m pytest --pylint --pylint-rcfile=.pylintrc $(test)



## target: exec-tests                   - Run all tests in tests/ with coverage.py
.PHONY: exec-tests
exec-tests: test-unit test-integration



# target: test                         - Run tests and display code coverage
.PHONY: test
test: validate exec-tests
	${py} -m coverage report  --rcfile=.coveragerc
	$(MAKE) clean-cov



## target: test-html                    - Run tests and display detailed code coverage with html
.PHONY: test-html
test-html: exec-tests
	${py} -m coverage html  --rcfile=.coveragerc && ${browser} tests/coverage_html/index.html &



## target: clean-py                     - Remove generated python files
.PHONY: clean-py
clean-py:
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '__pycache__' -exec rm -fr {} +
	find . -name '.pytest_cache' -exec rm -fr {} +



## target: clean-cov                    - Remove generated coverage files
.PHONY: clean-cov
clean-cov:
	rm -f .coverage
	rm -rf tests/coverage_html



# target: clean                        - Remove all generated files
.PHONY: clean
clean: clean-py clean-cov
	find . -name '*~' -exec rm -f {} +
	find . -name '*.log*' -exec rm -fr {} +



# target: install                      - Install all Python packages specified in the .requirement.txt file
.PHONY: install
install:
	${pip} install -r .requirements.txt

# target: install-dev                  - Install all Python packages for development
.PHONY: install-dev
install-dev:
	${pip} install --upgrade pip
	${pip} install --upgrade setuptools
	${pip} install -r requirements/dev.txt