Makefile

# Copyright (c) Facebook, Inc. and its affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.

##
## Variables
##

TESTSLIDE_FORMAT?=documentation
UNITTEST_VERBOSE?=1
ifeq ($(UNITTEST_VERBOSE),0)
UNITTEST_ARGS :=
else
UNITTEST_ARGS := --verbose
endif
TESTS_SRCS = tests
SRCS = testslide util pytest-testslide
ALL_SRCS = $(TESTS_SRCS) $(SRCS)
TERM_BRIGHT := $(shell tput bold)
TERM_NONE := $(shell tput sgr0)
DIST_TAR_GZ = dist/TestSlide-$(shell cat testslide/version).tar.gz

# Verbose output: make V=1
V?=0
ifeq ($(V),0)
Q := @python3 util/run_silent_if_successful.py
else
Q :=
endif

##
## Default
##

.PHONY: all
all: tests coverage_report docs sdist
	@true

##
## Venv
##
venv: requirements-dev.txt requirements.txt
	@printf "${TERM_BRIGHT}CREATE VIRTUALENV (${CURDIR}/venv)\n${TERM_NONE}"
	${Q} python3 -m venv venv
	@printf "${TERM_BRIGHT}INSTALL BUILD DEPS\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/pip install -r requirements-dev.txt
	@printf "${TERM_BRIGHT}INSTALL DEPS\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/pip install -r requirements.txt

##
## Docs
##

.PHONY: docs
docs: venv
	@printf "${TERM_BRIGHT}DOCS\n${TERM_NONE}"
	${Q} ${MAKE} SPHINXBUILD=${CURDIR}/venv/bin/sphinx-build -C docs/ html

.PHONY: docs_clean
docs_clean:
	@printf "${TERM_BRIGHT}DOCS CLEAN\n${TERM_NONE}"
	${Q} rm -rf docs/_build/

##
## Tests
##

%_unittest.py: venv coverage_erase
	@printf "${TERM_BRIGHT}UNITTEST $@\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/coverage run \
		-m unittest \
		${UNITTEST_ARGS} \
		--failfast \
		$@

.PHONY: unittest_tests
unittest_tests: $(TESTS_SRCS)/*_unittest.py
	@true

.PHONY: pytest_tests
pytest_tests: export PYTHONPATH=${CURDIR}/pytest-testslide:${CURDIR}
pytest_tests: venv coverage_erase
	@printf "${TERM_BRIGHT}INSTALL pytest_testslide DEPS ${TERM_NONE}\n"
	${Q} ${CURDIR}/venv/bin/pip install -r pytest-testslide/requirements.txt
	@printf "${TERM_BRIGHT}PYTEST pytest_testslide${TERM_NONE}\n"
	${Q} ${CURDIR}/venv/bin/coverage run \
		-m pytest \
		pytest-testslide/tests

%_testslide.py: venv coverage_erase
	@printf "${TERM_BRIGHT}TESTSLIDE $@\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/coverage run \
		-m testslide.executor.cli \
		--format $(TESTSLIDE_FORMAT) \
		--show-testslide-stack-trace \
		--fail-fast \
		--fail-if-focused \
		$@

.PHONY: testslide_tests coverage_erase
testslide_tests: $(TESTS_SRCS)/*_testslide.py
	@true

.PHONY: mypy
mypy: venv
	@printf "${TERM_BRIGHT}MYPY ${ALL_SRCS}\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/mypy ${ALL_SRCS}

.PHONY: mypy_clean
mypy_clean:
	@printf "${TERM_BRIGHT}MYPY CLEAN\n${TERM_NONE}"
	${Q} rm -rf .mypy_cache/

.PHONY: flake8
flake8: venv
	@printf "${TERM_BRIGHT}FLAKE8 ${ALL_SRCS}\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/flake8 --select=F,C90 $(ALL_SRCS)

.PHONY: ruff
ruff: venv
	@printf "${TERM_BRIGHT}RUFF check ${ALL_SRCS}\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/ruff check --diff $(ALL_SRCS) || { echo "Formatting errors found, try running 'make format'."; exit 1; }

.PHONY: format_ruff
format_ruff: venv
	@printf "${TERM_BRIGHT}FORMAT BLACK ${ALL_SRCS}\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/ruff format $(ALL_SRCS)

.PHONY: tests
tests: \
	unittest_tests \
	testslide_tests \
	pytest_tests \
	mypy \
	flake8 \
	ruff \
	check-copyright

.PHONY: format
format: \
	format_ruff
	@true
##
## Coverage
##

.PHONY: coverage_erase
coverage_erase:
	@printf "${TERM_BRIGHT}COVERAGE ERASE\n${TERM_NONE}"
	${Q} rm -rf ${CURDIR}/.coverage ${CURDIR}/.coverage.*

.PHONY: coverage_combine
coverage_combine: venv unittest_tests testslide_tests
	@printf "${TERM_BRIGHT}COVERAGE COMBINE\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/coverage combine

.PHONY: coverage_report
coverage_report: venv coverage_combine
	@printf "${TERM_BRIGHT}COVERAGE REPORT\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/coverage report

.PHONY: coverage_html
coverage_html: venv coverage_combine
	@printf "${TERM_BRIGHT}COVERAGE HTML\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/coverage html

.PHONY: coverage_html_clean
coverage_html_clean:
	@printf "${TERM_BRIGHT}COVERAGE HTML CLEAN\n${TERM_NONE}"
	${Q} rm -rf htmlcov/

.PHONY: coveralls
coveralls: venv coverage_combine
	@printf "${TERM_BRIGHT}COVERALLS\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/coveralls

##
## Build
##

.PHONY: sdist
sdist:
	@printf "${TERM_BRIGHT}SDIST\n${TERM_NONE}"
	${Q} python3 setup.py sdist

.PHONY: sdist_clean
sdist_clean:
	@printf "${TERM_BRIGHT}SDIST CLEAN\n${TERM_NONE}"
	${Q} rm -rf dist/ MANIFEST TestSlide.egg-info/

.PHONY: twine
twine: venv sdist
	${CURDIR}/venv/bin/twine upload $(DIST_TAR_GZ)

.PHONY: install_local
install_local: venv sdist
	@printf "${TERM_BRIGHT}INSTALL LOCAL\n${TERM_NONE}"
	${Q} ${CURDIR}/venv/bin/pip install $(DIST_TAR_GZ)
	${Q} ${CURDIR}/venv/bin/testslide --help

.PHONY: build_dev_container
dev_container:
	@printf "${TERM_BRIGHT}BUILDING DEV CONTAINER\n${TERM_NONE}"
	${Q} docker build -t testslide-dev .

.PHONY: run_tests_in_container
run_tests_in_container:
	@printf "${TERM_BRIGHT}RUNNING CI IN DEV CONTAINER\n${TERM_NONE}"
	${Q} docker run testslide-dev

.PHONY: run_dev_container
run_dev_container: build_dev_container
	@printf "${TERM_BRIGHT}STARTING DEV CONTAINER WITH BIND-MOUNTED SOURCES\n${TERM_NONE}"
	@docker run --rm -d --name testslide -v ${CURDIR}/testslide:/code/testslide -v ${CURDIR}/tests:/code/tests testslide-dev bash -c "while true; do sleep 30; done"
	@printf "${TERM_BRIGHT}Container testslide is running.\n${TERM_NONE}"
	@printf "${TERM_BRIGHT}Use make enter_dev_container to exec into it.\n${TERM_NONE}"
	@printf "${TERM_BRIGHT}Use make kill_dev_container to terminate it.\n${TERM_NONE}"

.PHONY: enter_dev_container
enter_dev_container:
	@printf "${TERM_BRIGHT}ENTERING DEV CONTAINER\n${TERM_NONE}"
	@docker exec -it testslide bash


.PHONY: kill_dev_container
kill_dev_container:
	@printf "${TERM_BRIGHT}KILLING DEV CONTAINER\n${TERM_NONE}"
	@docker kill testslide

.PHONY: clean_dev_container
clean_dev_container:
	@printf "${TERM_BRIGHT}KILLING DEV CONTAINER\n${TERM_NONE}"
	@docker kill testslide

.PHONY: ci
ci: \
	venv \
	tests \
	coverage_report \
	docs

##
## Clean
##

.PHONY: clean
clean: sdist_clean docs_clean coverage_html_clean coverage_erase mypy_clean
	@printf "${TERM_BRIGHT}CLEAN\n${TERM_NONE}"
	${Q} rm -rf */__pycache__/ */*.pyc venv/


.PHONY: check-copyright
check-copyright: ## verify copyright for every file
	@python3 tests/copyright_check/copyright_validator.py