[check] Split github action into two stages (source, output) (#4533)

Also improve the visibility of error messages.

Author: jensmaurer

.github/workflows/check.yml

@@ -17,9 +17,11 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
+      - name: check-source
+        run: ../tools/check-source.sh
       - name: install
         run: sudo apt-get install latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended lmodern
       - name: make
         run: make quiet
-      - name: check
-        run: ../tools/check.sh
+      - name: check-output
+        run: ../tools/check-output.sh

tools/check-output.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# This script checks the results of the LaTeX run.
+
+failed=0
+
+function fail() {
+
+    # echo "::error file=app.js,line=10,col=15::Something went wrong"
+
+    ! sed 's/^\(.\+\.tex\):/file=\1::/;s/^/::error /' | grep .
+}
+
+
+# Discover "Overfull \[hv]box" and "Reference ... undefined" messages from LaTeX.
+sed -n '/\.tex/{s/^.*\/\([-a-z0-9]\+\.tex\).*$/\1/;h};
+/Overfull [\\][hv]box\|LaTeX Warning..Reference/{x;p;x;p}' std.log |
+    sed '/^.\+\.tex$/{N;s/\n/:/}' | fail || failed=1
+
+
+# Cross references since the previous standard.
+function indexentries() { sed 's,\\glossaryentry{\(.*\)@.*,\1,' "$1" | LANG=C sort; }
+function removals() { diff -u "$1" "$2" | grep '^-' | grep -v '^---' | sed 's/^-//'; }
+function difference() { diff -u "$1" "$2" | grep '^[-+]' | grep -v '^\(---\|+++\)'; }
+XREFDELTA="$(difference <(indexentries xrefdelta.glo) <(removals <(indexentries xrefprev) <(indexentries xrefindex.glo)))"
+if [ -n "$XREFDELTA" ]; then
+  echo "incorrect entries in xrefdelta.tex:" >&2
+  echo "$XREFDELTA" | sed 's,^-,spurious ,; s,^+,missing ,;' >&2
+  failed=1
+fi
+
+exit $failed

tools/check.sh renamed to tools/check-source.sh

@@ -1,109 +1,144 @@
 #!/bin/bash
 
+# This script checks that the LaTeX sources stick to the rules.
+
+failed=0
+
 # Ignore files where rules may be violated within macro definitions.
 texfiles=$(ls *.tex | grep -v macros.tex | grep -v layout.tex | grep -v tables.tex)
 texlibdesc="support.tex concepts.tex diagnostics.tex utilities.tex strings.tex containers.tex iterators.tex ranges.tex algorithms.tex numerics.tex time.tex locales.tex iostreams.tex regex.tex atomics.tex threads.tex"
 texlib="lib-intro.tex $texlibdesc"
 
-# Discover "Overfull \[hv]box" and "Reference ... undefined" messages from LaTeX.
-sed -n '/\.tex/{s/^.*\/\([-a-z0-9]\+\.tex\).*$/\1/;h};
-/Overfull [\\][hv]box\|LaTeX Warning..Reference/{x;p;x;p}' std.log |
-sed '/^.\+\.tex$/{N;s/\n/:/}' | grep . && exit 1
+# Filter that reformats the error message as a "workflow command",
+# for native handling by github actions.
+# Prefixes each line of input with "$*: ".
+function fail() {
+    # echo "::error file=app.js,line=10,col=15::Something went wrong"
+
+    # For some reason, the file/line/col information is not shown in the GUI.
+    # Make sure to leave it in the message proper.
+    ! sed 's@^\(.\+\.tex\):\([0-9]\+\):@::error file=source/\1,line=\2::\1:\2:'"$*"': @; s@^\([^:][^:]\)@::error ::'"$*"': \1@' |
+    grep .
+}
+
 
 # Find non-ASCII (Unicode) characters in the source
-LC_ALL=C grep -ne '[^ -~	]' *.tex | sed 's/$/ <--- non-ASCII character/' | grep . && exit 1
+LC_ALL=C grep -ne '[^ -~	]' *.tex |
+    fail 'non-ASCII character' || failed=1
 
 # Trailing whitespace in a line.
-grep -ne '\s$' *.tex | sed 's/$/<--- trailing whitespace/' | grep . && exit 1
+grep -ne '\s$' *.tex |
+    fail 'trailing whitespace' || failed=1
 
 # Trailing empty lines
-for f in *.tex; do [ $(tail -c 2 $f | wc -l) -eq 1 ] || (echo "$f has trailing empty lines"; exit 1 ) done
+for f in *.tex; do
+    [ $(tail -c 2 $f | wc -l) -eq 1 ] ||
+	echo "$f" | fail 'trailing empty lines' || failed=1
+done
 
 # indented \begin{codeblock} / \end{codeblock} (causes unwanted empty space)
-grep -ne '^.\+\\\(begin\|end\){codeblock}' $texfiles && exit 1
+grep -ne '^.\+\\\(begin\|end\){codeblock}' $texfiles |
+    fail 'indented codeblock env' || failed=1
 
 # \pnum not alone on a line.
-grep -ne '^[^%]\+\\pnum' $texfiles && exit 1
-grep -ne '\\pnum.\+$' $texfiles && exit 1
+grep -ne '^[^%]\+\\pnum' $texfiles |
+    fail "pnum not alone on line" || failed=1
+grep -ne '\\pnum.\+$' $texfiles |
+    fail "pnum not alone on line" || failed=1
 # Fixup: sed '/\\pnum.\+$/s/\\pnum\s*/\\pnum\n/'
 
 # Two consecutive \pnum
 for f in $texfiles; do
-    awk 'prev == $0 && /^\\pnum/ { print FILENAME ":" FNR ": duplicate \\pnum on consecutive lines" } { prev = $0 }' $f
-done | grep . && exit 1
+    awk 'prev == $0 && /^\\pnum/ { print FILENAME ":" FNR ":" } { prev = $0 }' $f
+done |
+    fail 'two consecutive \\pnum' || failed=1
 
 # punctuation after the footnote marker
-grep -n "\\end{footnote" $texfiles | grep -v '}[@)%]\?$' && exit 1
+grep -n "\\end{footnote" $texfiles | grep -v '}[@)%]\?$' |
+    fail "punctuation after footnote marker" || failed=1
 
 # \opt used incorrectly.
-grep -n '\\opt[^{]' $texfiles && exit 1
-grep -n 'opt{}' *.tex && exit 1
+grep -n '\\opt[^{]' $texfiles |
+    fail '\\opt used incorrectly' || failed=1
+grep -n 'opt{}' *.tex |
+    fail '\\opt used incorrectly' || failed=1
 
 # Use \notdef instead of "not defined".
-grep -n "// not defined" $texfiles | sed 's/$/ <--- use \\notdef instead/' | grep . && exit 1
+grep -n "// not defined" $texfiles |
+    fail "use \\notdef instead" || failed=1
 
 # Library element introducer followed by stuff.
-grep -ne '^\\\(constraints\|mandates\|expects\|effects\|sync\|ensures\|returns\|throws\|complexity\|remarks\|errors\).\+$' $texlibdesc && exit 1
+grep -ne '^\\\(constraints\|mandates\|expects\|effects\|sync\|ensures\|returns\|throws\|complexity\|remarks\|errors\).\+$' $texlibdesc |
+    fail 'stuff after library element' || failed=1
 # Fixup: sed 's/^\\\(constraints\|mandates\|expects\|effects\|sync\|ensures\|returns\|throws\|complexity\|remarks\|errors\)\s*\(.\)/\\\1\n\2/'
 # Fixup: sed 's/^\\ //'
 
 # Change marker in [diff] followed by stuff.
-grep -Hne '^\\\(change\|rationale\|effect\|difficulty\|howwide\)\s.\+$' compatibility.tex && exit 1
+grep -Hne '^\\\(change\|rationale\|effect\|difficulty\|howwide\)\s.\+$' compatibility.tex |
+    fail "change marker in [diff] followed by stuff" || failed=1
 # Fixup: sed 's/^\\\(change\|rationale\|effect\|difficulty\|howwide\)\s\(.\)/\\\1\n\2/'q
 
 # "template <class" (with space) in library clause.
-grep -ne 'template\s<class' $texlib | sed 's/$/ <--- space between "template" and "<class"/' | grep . && exit 1
+grep -ne 'template\s<class' $texlib |
+    fail 'space between "template" and "<class"' || failed=1
 
 # \begin{example/note} with non-whitespace in front on the same line.
-grep -ne '^.*[^ ]\s*\\\(begin\|end\){\(example\|note\)}' $texfiles && exit 1
+grep -ne '^.*[^ ]\s*\\\(begin\|end\){\(example\|note\)}' $texfiles |
+    fail "non-whitespace before note/example begins" || failed=1
 # Fixup: sed 's/^\(.*[^ ]\)\s*\(\\\(begin\|end\){\(example\|note\)}\)/\1\n\2/'
 
 # \begin/end{example/note} with stuff (except %) following on the same line.
-grep -ne '\\\(begin\|end\){\(example\|note\)}[^%]\+$' $texfiles && exit 1
+grep -ne '\\\(begin\|end\){\(example\|note\)}[^%]\+$' $texfiles |
+    fail "content following note/example env" || failed=1
 # Fixup: sed 's/\(\\\(begin\|end\){\(example\|note\)}\)\s*\([^ ].*\)$/\1\n\4/'
 
 # \end{note} or \end{example} at the end of a table cell
 grep -n -A1 '\\end{\(example\|note\)}' $texfiles | grep -- '- *\(\\\\\|&\)' |
-sed 's/$/ <--- needs tailnote or tailexample/' | grep . && exit 1
+    fail "needs tailnote or tailexample" || failed=1
 
 # Blank line between "begin example" and "begin codeblock"
 for f in $texfiles; do
     sed -n '/\\begin{example}/{N;N;/\n\n\\begin{codeblock}$/{=;p}}' $f |
     # prefix output with filename and line
     sed '/^[0-9]\+$/{N;s/\n/:/}' | sed "s/.*/$f:&/"
-done | grep . && exit 1
+done |
+    fail 'blank line between "begin example" and "begin codeblock"' || failed=1
 # Fixup: sed '/\\begin{example}/{N;s/\n$//}'
 
 # Comment not aligned to multiple of four. (Ignore lines with "@".)
 for f in $texfiles; do
     sed -n '/begin{codeblock\(tu\)\?}/,/end{codeblock\(tu\)\?}/{/^[^@]*[^ @][^@]*\/\//{=;p}}' $f |
     # prefix output with filename and line
     sed '/^[0-9]\+$/{N;s/\n/:/}' | sed "s/.*/$f:&/" |
-    awk '{ match($0,"^[-a-z0-9]*[.]tex:[0-9]*:"); n=match(substr($0,RLENGTH+1),"[ ;]//"); if (n % 4 != 0) print $0 " <--- comment starts in column " n; }'
-done | grep . && exit 1
+    awk '{ match($0,"^[-a-z0-9]*[.]tex:[0-9]*:"); n=match(substr($0,RLENGTH+1),"[ ;]//"); if (n % 4 != 0) print "comment starts in column " n ": " $0; }'
+done |
+    fail "comment not aligned" || failed=1
 
 # Deleted special member function with a parameter name.
-grep -n "&[ 0-9a-z_]\+) = delete" $texfiles && exit 1
+grep -n "&[ 0-9a-z_]\+) = delete" $texfiles |
+    fail 'named parameter in deleted special member' || failed=1
 # to fix: sed '/= delete/s/&[ 0-9a-z_]\+)/\&)/'
 
 # Bad characters in label. "-" is allowed due to a single remaining offender.
-grep -n '^\\rSec.\[[^]]*[^-a-z.0-9][^]]*\]{' $texfiles | sed 's/$/ <--- bad character in label/' | grep . && exit 1
+grep -n '^\\rSec.\[[^]]*[^-a-z.0-9][^]]*\]{' $texfiles |
+    fail 'bad character in label' || failed=1
 
 # "shall", "may", or "should" inside a note
 for f in $texfiles; do
     sed -n '/begin{\(note\|footnote\)}/,/end{\(note\|footnote\)}/{/\(shall\|may\|should\)[^a-zA-Z]/{=;p}}' $f |
     # prefix output with filename and line
-    sed '/^[0-9]\+$/{N;s/\n/:/}' | sed "s/.*/$f:&/" |
-    sed 's/$/ <--- "shall", "should", or "may" inside a note/'
-done | grep . && exit 1
+    sed '/^[0-9]\+$/{N;s/\n/:/}' | sed "s/.*/$f:&/"
+done |
+    fail '"shall", "should", or "may" inside a note' || failed=1
 
 # Hanging paragraphs
 for f in $texfiles; do
     sed -n '/^\\rSec/{=;p};/^\\pnum/{s/^.*$/x/;=;p}' $f |
     # prefix output with filename and line
     sed '/^[0-9]\+$/{N;s/\n/:/}' | sed "s/.*/$f:&/" |
     awk -F: 'BEGIN { prevlevel = 0 } $3 ~ /^\\rSec./ { match($3, "[0-9]"); level=substr($3, RSTART, 1); if (text && level > prevlevel) { print prevsec " <-- Hanging paragraph follows" } prevlevel = level; prevsec = $3; text = 0 } $3 == "x" { text = 1 }'
-done | grep . && exit 1
+done |
+    fail 'hanging paragraph' || failed=1
 
 # Subclauses without siblings
 for f in $texfiles; do
@@ -114,29 +149,30 @@ for f in $texfiles; do
       {
 	match($3, "[0-9]");
 	level = substr($3, RSTART, 1);
-	if (level < prevlevel && secs[prevlevel] == 1) { print title[prevlevel] " <-- Subclause without siblings" }
+	if (level < prevlevel && secs[prevlevel] == 1) { print title[prevlevel] }
 	++secs[level];
 	title[level] = $0;
 	secs[level + 1] = 0;
 	prevlevel = level;
       }'
-done | grep . && exit 1
+done | fail 'subclause without siblings' || failed=1
 
 
 # Library descriptive macros not immediately preceded by \pnum.
 for f in $texlibdesc; do
     sed -n '/^\\pnum/{h;:x;n;/^\\index/b x;/^\\\(constraints\|mandates\|expects\|effects\|sync\|ensures\|returns\|throws\|complexity\|remarks\|errors\)/{x;/\n/{x;=;p};d};/^\\pnum/D;H;b x}' $f |
     # prefix output with filename and line
-    sed '/^[0-9]\+$/{N;s/\n/:/}' | sed "s/.*/$f:&/" |
-    sed 's/$/ <--- \\pnum missing/'
-done | grep . && exit 1
+    sed '/^[0-9]\+$/{N;s/\n/:/}' | sed "s/.*/$f:&/"
+done |
+    fail '\\pnum missing' || failed=1
 
 # Cross-references pointing to their own section.
 for f in $texfiles; do
     sed -n '/^\\rSec/{s/^.rSec.\[/S /;s/\].*$//;=;p};/\\iref{/{s/^.*\\.\?ref{\([-a-z.0-9]\+\)}.*/R \1/g;=;p}' $f |
     sed '/^[0-9]\+$/{N;s/\n/: /}' | sed "s/.*/$f:&/" |
     awk '$2 == "S" { seclabel = $3 } $2 == "R" && $3 == seclabel { print $1 " section self-reference to [" $3 "]" }'
-done | grep . && exit 1
+done |
+    fail "cross-reference to its own section" || failed=1
 
 # \placeholder before (
 #egrep 'placeholder{[-A-Za-z]*}@?\(' *.tex
@@ -155,20 +191,9 @@ done | grep . && exit 1
 # different files anyway. So just check the timestamp.
 for f in *.dot; do
   if [ "$f" -nt "${f%.dot}.pdf" ]; then
-    echo -e "need to rebuild ${f%.dot}.pdf:\nmake clean-figures && make figures" >&2
-    exit 1
+    echo -e "need to rebuild ${f%.dot}.pdf:\nmake clean-figures && make figures"
   fi
-done
+done |
+    fail 'outdated figure'  || failed=1
 
-# Cross references since the previous standard.
-function indexentries() { sed 's,\\glossaryentry{\(.*\)@.*,\1,' "$1" | LANG=C sort; }
-function removals() { diff -u "$1" "$2" | grep '^-' | grep -v '^---' | sed 's/^-//'; }
-function difference() { diff -u "$1" "$2" | grep '^[-+]' | grep -v '^\(---\|+++\)'; }
-XREFDELTA="$(difference <(indexentries xrefdelta.glo) <(removals <(indexentries xrefprev) <(indexentries xrefindex.glo)))"
-if [ -n "$XREFDELTA" ]; then
-  echo "incorrect entries in xrefdelta.tex:" >&2
-  echo "$XREFDELTA" | sed 's,^-,spurious ,; s,^+,missing ,;' >&2
-  exit 1
-fi
-
-exit 0
+exit $failed