doctests: Extract and use

Include the doctests from the toplevel Subdir.sd.mk.

In check, extract the doctests, and seddery the expected output into
the combined expected output file.  This involves adding a comment in
Subdir.mk.expected to indicate where the doctests will appear.

In update-expected, contrive to strip the doctest output back out of
the actual output so we can update only the manually-edited part.

Consequential changes to MAKEFILE_TEMPLATES in main.mk.expected
and .gitignore.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/tests/filter/.gitignore b/tests/filter/.gitignore
index 08c232ca8386baf52690c435fabf49c72738e384..802a3e6344bb85619c94477b00ba2dde8fef9fe3 100644 (file)
--- a/tests/filter/.gitignore
+++ b/tests/filter/.gitignore
@@ -1,2 +1,5 @@
 Makefile
 *.mk.tmp
+*.mk.expected.tmp
+doctest.sd.mk
+doctest.mk.part

diff --git a/tests/filter/Subdir.mk.expected b/tests/filter/Subdir.mk.expected
index 84f73093d02ce6ee1d53fbc911255539b1674ef8..c0bc70f593b540fd3e391793c391525d78e4140c 100644 (file)
--- a/tests/filter/Subdir.mk.expected
+++ b/tests/filter/Subdir.mk.expected
@@ -1,5 +1,6 @@
 # autogenerated - do not edit
 # test cases for generate script
+# doctests:
 
 all:: $(TOP_TARGETS) sub/all
 .PHONY: all

diff --git a/tests/filter/Subdir.sd.mk b/tests/filter/Subdir.sd.mk
index f9423674c6a55f695a8401644f92fc6e3aef817c..9e51e2363b6d1ca15cf49289c8953f9ae66bb298 100644 (file)
--- a/tests/filter/Subdir.sd.mk
+++ b/tests/filter/Subdir.sd.mk
@@ -1 +1,3 @@
 # test cases for generate script
+# doctests:
+&:include doctest.sd.mk

diff --git a/tests/filter/check b/tests/filter/check
index 2a5a8ee1d9be97df9dafe0531c6e7af7786e50d8..18ead3eb444a0823a706cd1ef99910238e402b26 100755 (executable)
--- a/tests/filter/check
+++ b/tests/filter/check
@@ -2,8 +2,19 @@
 set -e
 
 cd tests/filter
+
+expand <../../README | ./extract-doctest . >/dev/null
+
 ../../generate sub/dir
 files=$(find -name \*.expected)
-for f in $files; do diff -u $f ${f%.expected}.tmp; done
+for f in $files; do
+       sed <$f >$f.tmp '
+               /^# doctests:/ {
+                       r '"${f%/*}/doctest.mk.part"'
+                       a
+               }
+       '
+       diff -u $f.tmp ${f%.expected}.tmp
+done
 
 echo ok.

diff --git a/tests/filter/main.mk.expected b/tests/filter/main.mk.expected
index ba72c96dcb7937c13ecf1b37f6a9a91d4c8cf175..110c60880a2815c2c2bc6ec2179058c4a5452488 100644 (file)
--- a/tests/filter/main.mk.expected
+++ b/tests/filter/main.mk.expected
@@ -7,5 +7,6 @@ SUBDIRMK_MAKEFILES += Subdir.mk
 SUBDIRMK_MAKEFILES += sub/Subdir.mk
 SUBDIRMK_MAKEFILES += sub/dir/Subdir.mk
 MAKEFILE_TEMPLATES += ./Subdir.sd.mk
+MAKEFILE_TEMPLATES += ./doctest.sd.mk
 MAKEFILE_TEMPLATES += ./sub/dir/Subdir.sd.mk
 include $(SUBDIRMK_MAKEFILES)

diff --git a/tests/filter/update-expected b/tests/filter/update-expected
index ff105423fa427ffe1d68836c36fe76735f4fb9f9..18c53cff4cfdf15d6f925f0b6cf55d4151e6c970 100755 (executable)
--- a/tests/filter/update-expected
+++ b/tests/filter/update-expected
@@ -6,5 +6,13 @@
 #   selectively git-add the things that are right, after inspecting them
 
 set -e
-files=$(find tests/filter -name \*.tmp)
-for f in $files; do cp $f ${f%.tmp}.expected; done
+files=$(find tests/filter -name \*.expected.tmp)
+for f in $files; do
+       perl -pe '
+               (s/\n//, $stripnl=0) if $stripnl;
+               next unless /^# doctest starts/../^# doctest ends/;
+               $_="";
+               $stripnl=1;
+       ' \
+               <${f%.expected.tmp}.tmp >${f%.tmp}
+done