From: Alan T. DeKok <aland@freeradius.org>
Date: Thu, 11 Jun 2020 13:47:06 +0000 (-0400)
Subject: move to the standard TEST_BOOTSTRAP framework
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9baab04ccd458e3cd41970eb9974732c35dace81;p=thirdparty%2Ffreeradius-server.git

move to the standard TEST_BOOTSTRAP framework

with some additional magic for filtering modules which need
a test server
---

diff --git a/src/tests/modules/all.mk b/src/tests/modules/all.mk
index bfa0ec85879..63903d74f64 100644
--- a/src/tests/modules/all.mk
+++ b/src/tests/modules/all.mk
@@ -1,52 +1,98 @@
 #
-#  Find the subdirs which have "all.mk"
+#  Test name
 #
-TEST_SUBDIRS := $(patsubst src/tests/modules/%/all.mk,%,$(wildcard src/tests/modules/*/all.mk))
+TEST := test.modules
 
 #
-#  Find out which of those have a similar target.  i.e. modules/foo -> rlm_foo.la
+#  The test files are files without extensions.
+#  The list is unordered.  The order is added in the next step by looking
+#  at precursors.
 #
-TEST_TARGETS := $(sort $(foreach x,$(TEST_SUBDIRS),$(findstring rlm_$x.la,$(ALL_TGTS))))
+FILES := $(sort $(patsubst $(DIR)/%.unlang,%,$(wildcard $(DIR)/*/*unlang)))
 
 #
-#  Remove things which are known to not work under travis
+#  Remove things which are known to fail on travis.
 #
 ifeq "$(TRAVIS)" "1"
-TEST_TARGETS := $(filter-out rlm_icmp.la,$(TEST_TARGETS))
+MODULES_SKIP := $(filter icmp,$(FILES))
 endif
 
-TEST_BUILT := $(patsubst rlm_%.la,%,$(TEST_TARGETS))
-
 #
-#  Ensure that the tests depend on the module, so that changes to the
-#  module will re-run the test
+#  Figure out what to do with the module.
 #
-$(foreach x,$(TEST_BUILT),$(eval $x.test: rlm_$x.la))
-
-######################################################################
+define MODULE_FILTER
+ifneq "$(findstring rlm_${1}.la,$(ALL_TGTS))" "rlm_${1}.la"
+  # the library isn't built, skip the module.
+  MODULES_SKIP += ${2}
 
-#
-#  And do the same thing for sub-directories
-#
-TEST_SUBSUBDIRS := $(patsubst src/tests/modules/%/all.mk,%,$(wildcard src/tests/modules/*/*/all.mk))
+else ifeq "$(wildcard src/tests/modules/${1}/all.mk)" ""
+  # there's no "all.mk" file, skip the module
+  MODULES_SKIP += ${2}
 
-TEST_SUBTARGETS := $(foreach x,$(TEST_SUBSUBDIRS),$(findstring rlm_$(subst /,_,$x).la,$(ALL_TGTS)))
+else
+  # the output file depends on the library, too.
+  $(BUILD_DIR)/tests/modules/${2}.out: rlm_${1}.la
 
-TEST_SUBBUILT := $(patsubst rlm_%.la,%,$(TEST_SUBTARGETS))
+  -include src/tests/modules/${1}/all.mk
 
-$(foreach x,$(TEST_SUBBUILT),$(eval $x.test: rlm_$(subst /,_,$x).la))
+  ifdef ${1}_require_test_server
+    ifdef TEST_SERVER
+      # define FOO_TEST_SERVER
+      $(eval $(shell echo ${1} | tr a-z A-Z)_TEST_SERVER := $(TEST_SERVER))
+    else
+      # the module requires a test server, but we don't have one.  Skip it.
+      MODULES_SKIP += ${2}
+    endif
+  endif
+endif
+endef
 
-######################################################################
 #
-#  For the remaining subdirs, add on the directory to include.
-#  test.mk will run the tests for all modules
-#  It is included last so that the module specific makefiles can be processed first
-#  (modules that require a test server can set the corresponding require_test_server variable)
+#  Ensure that "rlm_foo.a" is built when we run a module from directory "foo"
 #
-SUBMAKEFILES := $(addsuffix /all.mk,$(TEST_BUILT) $(subst _,/,$(TEST_SUBBUILT))) test.mk
+$(foreach x,$(FILES),$(eval $(call MODULE_FILTER,$(firstword $(subst /, ,$x)),$x)))
+$(info $(MODULES_SKIP))
+FILES := $(filter-out $(MODULES_SKIP),$(FILES))
+$(eval $(call TEST_BOOTSTRAP))
+
 
 #
-#  Create the certs directory
+#  Files in the output dir depend on the unit tests
 #
-$(DIR)/certs: $(top_srcdir)/raddb/certs
-	@ln -s $< $@
+#	src/tests/modules/*/FOO.unlang	unlang for the test
+#	src/tests/modules/*/FOO.attrs	input RADIUS and output filter
+#	build/tests/modules/*/FOO.out	updated if the test succeeds
+#	build/tests/modules/*/FOO.log	debug output for the test
+#
+#  If the test fails, then look for ERROR in the input.  No error
+#  means it's unexpected, so we die.
+#
+#  Otherwise, check the log file for a parse error which matches the
+#  ERROR line in the input.
+#
+$(OUTPUT)/%: $(DIR)/%.unlang $(TEST_BIN_DIR)/unit_test_module | build.raddb
+	@echo "MODULE-TEST $(lastword $(subst /, ,$(dir $@))) $(basename $(notdir $@))"
+	${Q}mkdir -p $(dir $@)
+	${Q}cp $(if $(wildcard $(basename $<).attrs),$(basename $<).attrs,src/tests/modules/default-input.attrs) $@.attrs
+	${Q}if ! MODULE_TEST_DIR=$(dir $<) MODULE_TEST_UNLANG=$< $(TEST_BIN)/unit_test_module -D share/dictionary -d src/tests/modules/ -i "$@.attrs" -f "$@.attrs" -r "$@" -xxx > "$@.log" 2>&1 || ! test -f "$@"; then \
+		if ! grep ERROR $< 2>&1 > /dev/null; then \
+			cat "$@.log"; \
+			echo "# $@.log"; \
+			echo "MODULE_TEST_DIR=$(dir $<) MODULE_TEST_UNLANG=$< $(TEST_BIN)/unit_test_module -D share/dictionary -d src/tests/modules/ -i \"$@.attrs\" -f \"$@.attrs\" -r \"$@\" -xx"; \
+			exit 1; \
+		fi; \
+		FOUND=$$(grep ^$< $@.log | head -1 | sed 's/:.*//;s/.*\[//;s/\].*//'); \
+		EXPECTED=$$(grep -n ERROR $< | sed 's/:.*//'); \
+		if [ "$$EXPECTED" != "$$FOUND" ]; then \
+			cat "$@.log"; \
+			echo "# $@.log"; \
+			echo "MODULE_TEST_DIR=$(dir $<) MODULE_TEST_UNLANG=$< $(TEST_BIN)/unit_test_module -D share/dictionary -d src/tests/modules/ -i \"$@.attrs\" -f \"$@.attrs\" -r \"$@\" -xx"; \
+			exit 1; \
+		else \
+			touch "$@"; \
+		fi \
+	fi
+
+
+$(TEST):
+	@touch $(BUILD_DIR)/tests/$@
diff --git a/src/tests/modules/ldap/all.mk b/src/tests/modules/ldap/all.mk
index f37c134c55c..b1de4946223 100644
--- a/src/tests/modules/ldap/all.mk
+++ b/src/tests/modules/ldap/all.mk
@@ -2,10 +2,5 @@
 #  Test the "ldap" module
 #
 
-#  MODULE.test is the main target for this module.
-
 # Don't test ldap if TEST_SERVER ENV is not set
 ldap_require_test_server := 1
-
-ldap.test:
-	${Q}echo OK: ldap.test
diff --git a/src/tests/modules/redis/all.mk b/src/tests/modules/redis/all.mk
index 39281c64da1..9dd9f58527b 100644
--- a/src/tests/modules/redis/all.mk
+++ b/src/tests/modules/redis/all.mk
@@ -2,10 +2,5 @@
 #  Test the "redis" module
 #
 
-#  MODULE.test is the main target for this module.
-
 # Don't test redis if REDIS_TEST_SERVER ENV is not set
 redis_require_test_server := 1
-
-redis.test:
-	${Q}echo OK: redis.test