From c044ee662de671d02405dabfe03d92ff9f8bc0a9 Mon Sep 17 00:00:00 2001
From: Toshio Kuratomi <a.badger@gmail.com>
Date: Thu, 11 Jan 2024 11:00:43 -0800
Subject: [PATCH] Several enhancements to the Makefile

* Allow arbitrary user supplied arguments for pytest, pylint, and flake8.  This can be used, for
  instance, to select specific tests in pytest (PYTEST_ARGS="-k 'perform_ok'"), or to "disable" a
  single linter: (PYLINT_ARGS='--version').
* Better document how to determine the proper value for ACTOR=<actor>.
---
 Makefile | 33 +++++++++++++++++++++------------
 1 file changed, 21 insertions(+), 12 deletions(-)

diff --git a/Makefile b/Makefile
index b504a854ef..0de2a86a90 100644
--- a/Makefile
+++ b/Makefile
@@ -16,6 +16,12 @@ REPOSITORIES ?= $(shell ls $(_SYSUPG_REPOS) | xargs echo | tr " " ",")
 SYSUPG_TEST_PATHS=$(shell echo $(REPOSITORIES) | sed -r "s|(,\\|^)| $(_SYSUPG_REPOS)/|g")
 TEST_PATHS:=commands repos/common $(SYSUPG_TEST_PATHS)
 
+# Several commands can take arbitrary user supplied arguments from environment
+# variables as well:
+PYTEST_ARGS ?=
+PYLINT_ARGS ?=
+FLAKE8_ARGS ?=
+
 # python version to run test with
 _PYTHON_VENV=$${PYTHON_VENV:-python2.7}
 
@@ -131,10 +137,13 @@ help:
 	@echo "  test_container_all_no_lint  run tests without linting in all available containers"
 	@echo "  clean_containers            clean all testing and building container images (to force a rebuild for example)"
 	@echo ""
-	@echo "Targets test, lint and test_no_lint support environment variables ACTOR and"
-	@echo "TEST_LIBS."
-	@echo "If ACTOR=<actor> is specified, targets are run against the specified actor."
-	@echo "If TEST_LIBS=y is specified, targets are run against shared libraries."
+	@echo "* Targets test, lint and test_no_lint support environment variables ACTOR and"
+	@echo "  TEST_LIBS."
+	@echo "* If ACTOR=<actor> is specified, targets are run against the specified actor."
+	@echo "  <actor> must be the name attribute defined in actor.py."
+	@echo "* If TEST_LIBS=y is specified, targets are run against shared libraries."
+	@echo "* Command line options can be added to pytest, pylint, and flake8 by setting"
+	@echo "  the PYTEST_ARGS, PYLINT_ARGS, and FLAKE8_ARGS environment variables."
 	@echo ""
 	@echo "Envars affecting actions with COPR (optional):"
 	@echo "  COPR_REPO             specify COPR repository, e,g. @oamg/leapp"
@@ -323,15 +332,15 @@ lint:
 	SEARCH_PATH="$(TEST_PATHS)" && \
 	echo "Using search path '$${SEARCH_PATH}'" && \
 	echo "--- Running pylint ---" && \
-	bash -c "[[ ! -z '$${SEARCH_PATH}' ]] && find $${SEARCH_PATH} -name '*.py' | sort -u | xargs pylint -j0" && \
+	bash -c "[[ ! -z '$${SEARCH_PATH}' ]] && find $${SEARCH_PATH} -name '*.py' | sort -u | xargs pylint -j0 $(PYLINT_ARGS)" && \
 	echo "--- Running flake8 ---" && \
-	bash -c "[[ ! -z '$${SEARCH_PATH}' ]] && flake8 $${SEARCH_PATH}"
+	bash -c "[[ ! -z '$${SEARCH_PATH}' ]] && flake8 $${SEARCH_PATH} $(FLAKE8_ARGS)"
 
 	if [[ "$(_PYTHON_VENV)" == "python2.7" ]] ; then \
 		. $(VENVNAME)/bin/activate; \
 		echo "--- Checking py3 compatibility ---" && \
 		SEARCH_PATH=$(REPOS_PATH) && \
-		bash -c "[[ ! -z '$${SEARCH_PATH}' ]] && find $${SEARCH_PATH} -name '*.py' | sort -u | xargs pylint --py3k" && \
+		bash -c "[[ ! -z '$${SEARCH_PATH}' ]] && find $${SEARCH_PATH} -name '*.py' | sort -u | xargs pylint --py3k $(PYLINT_ARGS)" && \
 		echo "--- Linting done. ---"; \
 	fi
 
@@ -358,7 +367,7 @@ test_no_lint:
 	cd repos/system_upgrade/el7toel8/; \
 	snactor workflow sanity-check ipu && \
 	cd - && \
-	$(_PYTHON_VENV) -m pytest $(REPORT_ARG) $(TEST_PATHS) $(LIBRARY_PATH)
+	$(_PYTHON_VENV) -m pytest $(REPORT_ARG) $(TEST_PATHS) $(LIBRARY_PATH) $(PYTEST_ARGS)
 
 test: lint test_no_lint
 
@@ -474,14 +483,14 @@ fast_lint:
 	@. $(VENVNAME)/bin/activate; \
 	FILES_TO_LINT="$$(git diff --name-only $(MASTER_BRANCH) --diff-filter AMR | grep '\.py$$')"; \
 	if [[ -n "$$FILES_TO_LINT" ]]; then \
-		pylint -j 0 $$FILES_TO_LINT && \
-		flake8 $$FILES_TO_LINT; \
+		pylint -j 0 $$FILES_TO_LINT $(PYLINT_ARGS) && \
+		flake8 $$FILES_TO_LINT $(FLAKE8_ARG); \
 		LINT_EXIT_CODE="$$?"; \
 		if [[ "$$LINT_EXIT_CODE" != "0" ]]; then \
 			exit $$LINT_EXIT_CODE; \
 		fi; \
 		if [[ "$(_PYTHON_VENV)" == "python2.7" ]] ; then \
-			pylint --py3k $$FILES_TO_LINT; \
+			pylint --py3k $$FILES_TO_LINT $(PYLINT_ARGS); \
 		fi; \
 	else \
 		echo "No files to lint."; \
@@ -489,7 +498,7 @@ fast_lint:
 
 dev_test_no_lint:
 	. $(VENVNAME)/bin/activate; \
-	$(_PYTHON_VENV) -m pytest $(REPORT_ARG) $(APPROX_TEST_PATHS) $(LIBRARY_PATH)
+	$(_PYTHON_VENV) -m pytest $(REPORT_ARG) $(APPROX_TEST_PATHS) $(LIBRARY_PATH) $(PYTEST_ARGS)
 
 dashboard_data:
 	. $(VENVNAME)/bin/activate; \