Makefile

yaml_dirs = parsers themes views playbooks docs/examples sources
python_executables = \
	cmt \
	cmtadm \
	cmt-install \
	cmtinv \
	cmu
python_test_executables = \
	tests/async_fetch \
	tests/ansibletests \
	tests/atptests \
	tests/check_theme_use \
	tests/checkstests \
	tests/clptests \
	tests/cmtlibtests \
	tests/cnitests \
	tests/coverage_stats \
	tests/cnitests \
	tests/cursestests \
	tests/datatests \
	tests/dgtests \
	tests/dump_cluster \
	tests/dump_logs \
	tests/fgtests \
	tests/fmttests \
	tests/gentests \
	tests/infogtests \
	tests/iotests \
	tests/itemgtests \
	tests/khtests \
	tests/lgtests \
	tests/logtests \
	tests/networkiotests \
	tests/ogtests \
	tests/typetests \
	tests/validate_yaml \
	tests/validatortests
python_unit_tests_ansible = \
	tests/ansibletests
python_unit_tests_cluster = \
	tests/async_fetch
python_unit_tests = \
	tests/atptests \
	tests/checkstests \
	tests/clptests \
	tests/cmtlibtests \
	tests/cnitests \
	tests/cursestests \
	tests/datatests \
	tests/dgtests \
	tests/fgtests \
	tests/fmttests \
	tests/gentests \
	tests/infogtests \
	tests/iotests \
	tests/itemgtests \
	tests/khtests \
	tests/lgtests \
	tests/logtests \
	tests/networkiotests \
	tests/ogtests \
	tests/typetests \
	tests/validatortests
test_libs_symlink = clustermanagementtoolkit

# F841 is the warning about unused assignments.
# flake8 doesn't recognise "_<variable>" to capture unused return values;
# pylint does, so we rely on that one to handle it instead.
# W503 is for line break before binary operator;
# flake8 warns *both* for breaks before and after.
# Hence we we need to ignore one of those warnings.
FLAKE8_IGNORE := F841,W503

# Used by ruff to check for future and/or deprecated features
RUFF_PYTHON_VERSION := py39

# Used by pylint to check for future and/or deprecated features
PYLINT_PYTHON_VERSION := 3.9

# W0511 is TODO/XXX/FIXME; we know that these are things that we should fix eventually.
# Hence we do not need warnings about them.
PYLINT_DISABLE := W0511

# Warn about useless disable
PYLINT_ENABLE := useless-suppression

MYPY_FLAGS := --follow-imports silent --explicit-package-bases --ignore-missing --disallow-untyped-calls --disallow-untyped-defs --disallow-incomplete-defs --check-untyped-defs --disallow-untyped-decorators --warn-redundant-casts --warn-unused-ignores

code-checks: mypy pylint flake8 ruff
checks: bandit regexploit semgrep yamllint validate_playbooks validate_yaml ruff

tests: coverage

clean: remove_test_symlinks

generate_helptexts:
	@for file in $(python_executables); do \
		./$$file help --format markdown > docs/$${file}_helptext.md ;\
	done

coverage_stats:
	@tests/coverage_stats

coverage: setup_tests
	@cmd=python3-coverage ;\
	if command -v python3-coverage > /dev/null 2> /dev/null; then \
		cmd=python3-coverage ;\
	elif command -v coverage-3 > /dev/null 2> /dev/null; then \
		cmd=coverage-3 ;\
	else \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\n  Running: tests/atptests --include-clear\n\n" ;\
	$$cmd run --branch --append tests/atptests --include-clear --end-at 0 || exit 1 ;\
	printf -- "\n\nRunning python3-coverage to check test coverage\n" ;\
	for test in $(python_unit_tests); do \
		printf -- "\n\n  Running: $$test\n\n" ;\
		$$cmd run --branch --append $$test || exit 1 ;\
	done ;\
	$$cmd report --sort cover --precision 1 ;\
	$$cmd html --precision 1 ;\
	$$cmd json

# Run this to augment existing coverage data with tests that require manual interaction
coverage-manual: setup_tests
	@cmd=python3-coverage ;\
	if command -v python3-coverage > /dev/null 2> /dev/null; then \
		cmd=python3-coverage ;\
	elif command -v coverage-3 > /dev/null 2> /dev/null; then \
		cmd=coverage-3 ;\
	else \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\nRunning python3-coverage to check test coverage\n" ;\
	printf -- "\n\n  Running: tests/atptests --include-clear --include-input\n\n" ;\
	$$cmd run --branch --append tests/atptests --include-clear --include-input ;\
	$$cmd report --sort cover --precision 1 ;\
	$$cmd html --precision 1 ;\
	$$cmd json

# Run this to augment existing coverage data with tests that require an ansible inventory
coverage-ansible: setup_tests
	@cmd=python3-coverage ;\
	if command -v python3-coverage > /dev/null 2> /dev/null; then \
		cmd=python3-coverage ;\
	elif command -v coverage-3 > /dev/null 2> /dev/null; then \
		cmd=coverage-3 ;\
	else \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\nRunning python3-coverage to check test coverage\n" ;\
	printf -- "\n\n  Running: tests/cmtlibtests --include-ansible\n\n" ;\
	$$cmd run --branch --append tests/cmtlibtests --include-ansible || exit 1 ;\
	printf -- "\n\n  Running: tests/ansibletests\n\n" ;\
	$$cmd run --branch --append tests/ansibletests || exit 1 ;\
	$$cmd report --sort cover --precision 1 ;\
	$$cmd html --precision 1 ;\
	$$cmd json

# Run this to augment existing coverage data with tests that require a running cluster
coverage-cluster: setup_tests
	@cmd=python3-coverage ;\
	if command -v python3-coverage > /dev/null 2> /dev/null; then \
		cmd=python3-coverage ;\
	elif command -v coverage-3 > /dev/null 2> /dev/null; then \
		cmd=coverage-3 ;\
	else \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\nRunning python3-coverage to check test coverage\n" ;\
	printf -- "\n\n  Running: tests/async_fetch\n\n" ;\
	$$cmd run --branch --append tests/async_fetch || exit 1 ;\
	printf -- "\n\n  Running: tests/dgtests --include-cluster\n\n" ;\
	$$cmd run --branch --append tests/dgtests --include-cluster || exit 1 ;\
	printf -- "\n\n  Running: tests/lgtests --include-cluster\n\n" ;\
	$$cmd run --branch --append tests/lgtests --include-cluster || exit 1 ;\
	printf -- "\n\n  Running: tests/khtests --include-cluster\n\n" ;\
	$$cmd run --branch --append tests/khtests --include-cluster || exit 1 ;\
	printf -- "\n\n  Running: tests/cmtlibtests --include-cluster\n\n" ;\
	$$cmd run --branch --append tests/cmtlibtests --include-cluster || exit 1 ;\
	printf -- "\n\n  Running: tests/itemgtests --include-cluster\n\n" ;\
	$$cmd run --branch --append tests/itemgtests --include-cluster || exit 1 ;\
	$$cmd report --sort cover --precision 1 ;\
	$$cmd html --precision 1 ;\
	$$cmd json

unhack_sources:
	@mkdir -p tests/modified_repo ;\
	git archive main | tar -x -C tests/modified_repo ;\
	(cd tests/modified_repo ;\
	 mv cmt cmt.py ;\
	 mv cmtadm cmtadm.py ;\
	 mv cmt-install cmt-install.py ;\
	 mv cmtinv cmtinv.py ;\
	 mv cmu cmu.py ;\
	 sed -i -e "s/^''''eval.*$$//;s,#! /bin/sh,#! /usr/bin/env python3,;/^    grep '.*/d;/^    version=\\$$.*/d;/^    \[ \\$$.*/d;/^    exec \/usr\/bin.*/d" cmt.py ;\
	 sed -i -e "s/^''''eval.*$$//;s,#! /bin/sh,#! /usr/bin/env python3,;/^    grep '.*/d;/^    version=\\$$.*/d;/^    \[ \\$$.*/d;/^    exec \/usr\/bin.*/d" cmtadm.py ;\
	 sed -i -e "s/^''''eval.*$$//;s,#! /bin/sh,#! /usr/bin/env python3,;/^    grep '.*/d;/^    version=\\$$.*/d;/^    \[ \\$$.*/d;/^    exec \/usr\/bin.*/d" cmt-install.py ;\
	 sed -i -e "s/^''''eval.*$$//;s,#! /bin/sh,#! /usr/bin/env python3,;/^    grep '.*/d;/^    version=\\$$.*/d;/^    \[ \\$$.*/d;/^    exec \/usr\/bin.*/d" cmtinv.py ;\
	 sed -i -e "s/^''''eval.*$$//;s,#! /bin/sh,#! /usr/bin/env python3,;/^    grep '.*/d;/^    version=\\$$.*/d;/^    \[ \\$$.*/d;/^    exec \/usr\/bin.*/d" cmu.py)

# Semgrep gets confused by the horrible python hacks in cmt-install/cmt/cmtadm/cmtinv/cmu,
# and also doesn't understand that python executables aren't necessarily suffixed with .py;
# export the repository, rename the files, remove the hack, and run semgrep on that checkout.
# We also need to extend the timeout since validation gives up on cmu otherwise.
#
# --exclude-rule generic.secrets.security.detected-generic-secret.detected-generic-secret.semgrep-legacy.30980
# is necessary since it triggers on every single mention of the word secret
# (which occurs a lot in various Kubernetes API names).
# --exclude-rule python.flask.security.xss.audit.direct-use-of-jinja2.direct-use-of-jinja2
# is needed since it flags the risk of cross-site scripting in a file that is:
# a.) Not used to template HTML (it's templating YAML)
# b.) Not accepting external input (it's used by the build-system)
#
# We validate YAML by other means, so skip *.yaml
semgrep_flags := --exclude-rule "generic.secrets.security.detected-generic-secret.detected-generic-secret.semgrep-legacy.30980"
semgrep_flags += --exclude-rule "python.flask.security.xss.audit.direct-use-of-jinja2.direct-use-of-jinja2"
semgrep_flags += --exclude "*.yaml" --exclude "*.j2" --exclude "*.json"
semgrep: unhack_sources
	@cmd=semgrep ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\nRunning semgrep to check for common security issues in Python code\n" ;\
	printf -- "Note: if this is taking a very long time you might be behind a proxy;\n" ;\
	printf -- "if that's the case you need to set the environment variable https_proxy\n\n" ;\
	(cd tests/modified_repo ;\
	 $$cmd scan $(semgrep_flags) --timeout=0 --no-git-ignore)

bandit:
	@cmd=bandit ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n" ;\
		exit 0 ;\
	fi ;\
	printf -- "\n\nRunning bandit to check for common security issues in Python code\n\n" ;\
	$$cmd -c .bandit $(python_executables) $(python_test_executables) clustermanagementtoolkit/*.py

ruff:
	@cmd=ruff ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n" ;\
		exit 0 ;\
	fi ;\
	printf -- "\n\nRunning $$cmd to check Python code quality\n\n" ;\
	for file in $(python_executables) clustermanagementtoolkit/*.py; do \
		case $$file in \
		'cmtlog.py'|'noxfile.py') \
			continue;; \
		esac ;\
		printf -- "File: $$file\n" ;\
		$$cmd check --target-version $(RUFF_PYTHON_VERSION) $$file ;\
	done

ruff-tests:
	@cmd=ruff ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n" ;\
		exit 0 ;\
	fi ;\
	printf -- "\n\nRunning $$cmd to check Python code quality\n\n" ;\
	for file in $(python_test_executables); do \
		printf -- "File: $$file\n" ;\
		$$cmd check --target-version $(RUFF_PYTHON_VERSION) $$file ;\
	done

pylint:
	@cmd=pylint ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n" ;\
		exit 0 ;\
	fi ;\
	printf -- "\n\nRunning pylint to check Python code quality\n\n" ;\
	for file in $(python_executables) clustermanagementtoolkit/*.py; do \
		case $$file in \
		'cmtlog.py'|'noxfile.py') \
			continue;; \
		esac ;\
		printf -- "File: $$file\n" ;\
		PYTHONPATH=. $$cmd --py-version $(PYLINT_PYTHON_VERSION) --disable $(PYLINT_DISABLE) --enable $(PYLINT_ENABLE) $$file ;\
	done

pylint-markdown:
	@cmd=pylint ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n" ;\
		exit 0 ;\
	fi ;\
	tmpfile=$$(mktemp); \
	for file in $(python_executables) clustermanagementtoolkit/*.py; do \
		case $$file in \
		'cmtlog.py'|'noxfile.py') \
			continue;; \
		esac ;\
		result=$$(PYTHONPATH=. $$cmd --py-version $(PYLINT_PYTHON_VERSION) --disable $(PYLINT_DISABLE) --enable $(PYLINT_ENABLE) $$file | grep "Your code" | sed -e 's/Your code has been rated at //;s/ (previous run.*//') ;\
		row="$$file | $$result\n" ;\
		printf -- "$$row" >> $${tmpfile} ;\
	done && \
	./mdtable.py --bold-regex "^\s*\d\.\d\d/10" $${tmpfile} "=Source file" "Score=" && rm $${tmpfile}

pylint-tests:
	@cmd=pylint ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n" ;\
		exit 0 ;\
	fi ;\
	printf -- "\n\nRunning pylint to check Python code quality\n\n" ;\
	for file in $(python_test_executables); do \
		printf -- "File: $$file\n" ;\
		PYTHONPATH=. $$cmd --py-version $(PYLINT_PYTHON_VERSION) --disable $(PYLINT_DISABLE) --enable $(PYLINT_ENABLE) $$file ;\
	done

flake8:
	@cmd=flake8 ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n" ;\
		exit 0 ;\
	fi ;\
	printf -- "\n\nRunning flake8 to check Python code quality\n\n" ;\
	$$cmd --ignore $(FLAKE8_IGNORE) --max-line-length 100 --statistics $(python_executables) clustermanagementtoolkit/*.py && printf -- "OK\n\n" ;\
	printf -- "\n\nRunning flake8 to check Python test case code quality\n\n" ;\
	$$cmd --ignore $(FLAKE8_IGNORE) --max-line-length 100 --statistics $(python_test_executables) && printf -- "OK\n\n"

regexploit:
	@cmd=regexploit-py ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed (install with 'pipx install regexploit' or pipx install --proxy <proxy> regexploit'); skipping.\n\n\n" ;\
		exit 0 ;\
	fi ;\
	printf -- "\n\nRunning regexploit to check for ReDoS attacks\n\n" ;\
	printf -- "Checking executables\n" ;\
	$$cmd $(python_executables) $(python_test_executables) &&\
	printf -- "\nChecking libraries\n" ;\
	$$cmd clustermanagementtoolkit/*.py

yamllint:
	@cmd=yamllint ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\nRunning yamllint to check that all YAML is valid\n\n"; \
	for dir in $(yaml_dirs); do \
		$$cmd $$dir/*.yaml; \
	done; \
	$$cmd cmt.yaml

# Note: we know that the code does not have complete type-hinting,
# hence we return 0 after each test to avoid it from stopping.
mypy:
	@cmd=mypy ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\nRunning mypy to check Python typing\n\n"; \
	for file in $(python_executables) clustermanagementtoolkit/*.py; do \
		$$cmd $(MYPY_FLAGS) $$file || true; \
	done

# Note: we know that the code does not have complete type-hinting,
# hence we return 0 after each test to avoid it from stopping.
mypy-tests:
	@cmd=mypy ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\nRunning mypy to check Python typing\n\n"; \
	for file in $(python_test_executables); do \
		$$cmd $(MYPY_FLAGS) $$file || true; \
	done

# Note: we know that the code does not have complete type-hinting,
# hence we return 0 after each test to avoid it from stopping.
mypy-markdown:
	@cmd=mypy ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	tmpfile=$$(mktemp); \
	for file in $(python_executables) clustermanagementtoolkit/*.py; do \
		case $$file in \
		'cmtlog.py'|'noxfile.py') \
			continue;; \
		esac ;\
		result=$$($$cmd $(MYPY_FLAGS) $$file | grep -E "^Found|^Success") ;\
		row="$$file | $$result\n" ;\
		printf -- "$$row" >> $${tmpfile} ;\
	done && \
	./mdtable.py --bold-regex "^\s*Found.*errors" $${tmpfile} "=Source file" "=Score" && rm $${tmpfile}

nox: create_test_symlinks
	@cmd=nox ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "Running nox for unit testing\n\n"; \
	$$cmd --no-reuse-existing-virtualenvs || true; \
	printf -- "\n-----\n\n"

validate_yaml:
	@printf -- "\n\nRunning validate_yaml to check that all view-files/parser-files/theme-files are valid\n\n"; \
	./tests/validate_yaml

validate_playbooks:
	@cmd=ansible-lint ;\
	if ! command -v $$cmd > /dev/null 2> /dev/null; then \
		printf -- "\n\n$$cmd not installed; skipping.\n\n\n"; \
		exit 0; \
	fi; \
	printf -- "\n\nRunning ansible-lint to check that all Ansible playbooks are valid\n\n"; \
	ansible-lint playbooks/*.yaml

export_src:
	git archive --format zip --output ~/cmt-$(shell date -I).zip origin/main

parser_bundle:
	@printf -- "Building parser bundle\n" ;\
	rm -f parsers/BUNDLE.yaml; \
	for file in parsers/*.yaml; do \
		printf -- "---\n" >> parsers/BUNDLE.yaml; \
		cat $$file >> parsers/BUNDLE.yaml; \
	done

remove_test_symlinks:
	@(cd tests; rm -f $(test_libs_symlink))

create_test_symlinks:
	@(cd tests; test -L $(test_libs_symlink) || ln -s ../$(test_libs_symlink) .)

setup_tests: create_test_symlinks
	@(cd tests ;\
	  test -d testpaths || mkdir testpaths );\
	(mkdir -p tests/testlogs/2023-05-06_16:02:39.012047_uptime ;\
	 cp playbooks/uptime.yaml tests/testlogs );\
	(cd tests/testpaths ;\
	 test -f cmt.yaml || printf -- "Debug:\n  developer_mode: true" > cmt.yaml ;\
	 test -d cmt.yaml.d || mkdir cmt.yaml.d ;\
	 test -f cmt.yaml.d/Debug.yaml || printf -- "Debug:\n  developer_mode: false" > cmt.yaml.d/Debug.yaml ;\
	 test -f cmt.yaml.d/~Debug.yaml || printf -- "Debug:\n  value1: true" > cmt.yaml.d/~Debug.yaml ;\
	 test -f cmt.yaml.d/.Debug.yaml || printf -- "Debug:\n  value2: true" > cmt.yaml.d/.Debug.yaml ;\
	 test -f cmt.yaml.d/Debug || printf -- "Debug:\n  value3: true" > cmt.yaml.d/Debug ;\
	 test -f cmt.yaml.d/Empty.yml || touch cmt.yaml.d/Empty.yml ;\
	 test -f 01-wrong_permissions || touch 01-wrong_permissions ;\
	 test -L 02-symlink || ln -s 05-not_executable.sh 02-symlink ;\
	 test -d 03-wrong_dir_permissions || mkdir 03-wrong_dir_permissions ;\
	 test -L 04-dir_symlink || ln -s 03-wrong_dir_permissions 04-dir_symlink ;\
	 test -e 05-not_executable.sh || echo "#! /bin/sh\nprint -- \"This file should be executable\n\"" > 05-not_executable.sh ;\
	 test -e 06-executable.sh || echo "#! /bin/sh\nprint -- \"This file should NOT be executable\n\"" > 06-executable.sh ;\
	 test -L 07-dangling_symlink || ln -s this_destination_does_not_exist 07-dangling_symlink ;\
	 test -f 08-not_utf8.txt || /usr/bin/printf -- "\xc3\x28" > 08-not_utf8.txt ;\
	 test -f 09-this_is_not_valid.yaml || printf -- ": this is not valid yaml\n" > 09-this_is_not_valid.yaml ;\
	 test -f 10-valid_yaml_for_load_all.yaml || printf -- "---\nvalid_yaml:\n  this_should_load_with_load_all: true\n---\nalso_valid_yaml:\n  everything_should_be_fine: true\n" > 10-valid_yaml_for_load_all.yaml ;\
	 test -f 11-valid_yaml_but_single.yaml || printf -- "valid_yaml:\n  but_only_when_using_load: true\n  this_wont_work_with_load_all: true\n" > 11-valid_yaml_but_single.yaml ;\
	 test -f 12-valid_yaml_followed_by_invalid_yaml.yaml || printf -- "---\nvalid_yaml:\n  this_should_load_with_load_all: true\n---\ninvalid_yaml:\n  : this is not valid yaml\n" > 12-valid_yaml_followed_by_invalid_yaml.yaml ;\
	 test -d 13-correct_directory || mkdir 13-correct_directory ;\
	 test -d 16-dir_no_permissions || mkdir 16-dir_no_permissions && chmod a= 16-dir_no_permissions ;\
	 test -f 03-wrong_dir_permissions/14-correct_file_in_wrong_permission_directory || touch 03-wrong_dir_permissions/14-correct_file_in_wrong_permission_directory ;\
	 test -L 15-symlink_directory || ln -s 13-correct_directory 15-symlink_directory ;\
	 test -f 13-correct_directory/16-correct_file_in_correct_permission_directory || touch 13-correct_directory/16-correct_file_in_correct_permission_directory ;\
	 test -e ssh || ln -s /usr/bin/ssh ssh ;\
	 test -f testfile.txt || printf -- "Random text\n" > testfile.txt ;\
	 test -f test_symlink || ln -s $$(pwd)/05-not_executable.sh test_symlink ;\
	 chmod a+x 06-executable.sh ;\
	 chmod o+w 03-wrong_dir_permissions ;\
	 chmod 0600 testfile.txt ;\
	 chmod o+w 01-wrong_permissions )

async_fetch: setup_tests
	@printf -- "\n\nRunning async_fetch to check that reexecutor.py behaves as expected\n\n"; \
	(cd tests && ./async_fetch)

iotests: setup_tests
	@printf -- "\n\nRunning iotests to check that cmtio.py behaves as expected\n\n"; \
	(cd tests && ./iotests)

logtests: setup_tests
	@printf -- "\n\nRunning logtests to check that logparser.py behaves as expected\n\n"; \
	(cd tests && ./logtests)

validatortests: setup_tests
	@printf -- "\n\nRunning validatortests to check that cmtvalidators.py behaves as expected\n\n"; \
	(cd tests && ./validatortests)

cmtlibtests: setup_tests
	@printf -- "\n\nRunning cmtlibtests to check that cmtlib.py behaves as expected\n\n"; \
	(cd tests && ./cmtlibtests)

cursestests: setup_tests
	@printf -- "\n\nRunning cursestests to check that curses_helper.py behaves as expected\n\n"; \
	(cd tests && ./cursestests)

atptests: setup_tests
	@printf -- "\n\nRunning atptests --include-clear to check that ansithemeprint.py behaves as expected; if there's a failure please re-run manually without the --include-clear flag\n\n"; \
	(cd tests && ./atptests --include-clear)

atptests-manual: setup_tests
	@printf -- "\n\nRunning atptests --include-clear ---include-input to check that ansithemeprint.py behaves as expected; if there's a failure please re-run manually without the --include-clear flag\n\n"; \
	(cd tests && ./atptests --include-clear --include-input)

check_theme_use: setup_tests
	@printf -- "\n\nRunning check_theme_use to check that all verifiable uses of ThemeStr and ANSIThemeStr are valid\n\n"; \
	for theme in themes/*.yaml; do \
		printf -- "\nChecking against theme file $$theme:\n" ;\
		printf -- "---\n" ;\
		./tests/check_theme_use $$theme $(python_executables) $(python_test_executables) clustermanagementtoolkit/*.py ;\
	done

build:
	./build.py views/templates views/variables views

# This rule is used when making a system-wide install
INSTALL := install --mode=755
INSTALL_DATA := install --mode=644
INSTALL_DIRECTORY := install -d
BASH_COMPLETION_DIR := /usr/share/bash-completion/completions
CMT_CONFIG_DIR := /etc/cmt
CMT_CONFIGLET_DIR := $(CMT_CONFIG_DIR)/cmt.yaml.d
CMT_DATA_DIR := /usr/share/cluster-management-toolkit
CMT_VIEWS_DIR := $(CMT_DATA_DIR)/views
DIST_PACKAGE_DIR := /usr/lib/python3/dist-packages
BINDIR := /usr/bin
COMPLETION_FILES := bash-completion/cmt bash-completion/cmtadm bash-completion/cmtinv bash-completion/cmu

install:
	@$(INSTALL_DIRECTORY) $(DESTDIR)$(BASH_COMPLETION_DIR) &&\
	$(INSTALL_DIRECTORY) $(DESTDIR)$(CMT_CONFIGLET_DIR) &&\
	$(INSTALL_DIRECTORY) $(DESTDIR)$(CMT_DATA_DIR) &&\
	$(INSTALL_DIRECTORY) $(DESTDIR)$(CMT_VIEWS_DIR) &&\
	$(INSTALL_DIRECTORY) $(DESTDIR)$(DIST_PACKAGE_DIR) &&\
	$(INSTALL_DIRECTORY) $(DESTDIR)$(BINDIR) &&\
	$(INSTALL_DATA) cmt.yaml $(DESTDIR)$(CMT_CONFIG_DIR) &&\
	$(INSTALL_DATA) $(COMPLETION_FILES) $(DESTDIR)$(BASH_COMPLETION_DIR) &&\
	$(INSTALL) cmt cmtadm cmtinv cmu $(DESTDIR)$(BINDIR) &&\
	tar cf - --exclude-ignore=$$(pwd)/.gitignore clustermanagementtoolkit | (cd $(DESTDIR)$(DIST_PACKAGE_DIR); tar xf -) &&\
	tar cf - --exclude-ignore=$$(pwd)/.gitignore parsers playbooks sources themes | (cd $(DESTDIR)$(CMT_DATA_DIR); tar xf -) &&\
	cp views/*.yaml $(DESTDIR)$(CMT_VIEWS_DIR) || printf -- "Installation failed.\n"