From d5a4a6e1951fb2f4fbbad205405c0f6b1b349187 Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <danielsh@apache.org>
Date: Sun, 10 Nov 2019 11:29:20 +0000
Subject: [PATCH] tests: Make $expected_mismatch skip the cardinality check,
 rather than consider it an expected failure.

With this change, if $expected_region_highlight and $region_highlight
coincidentally have the same number of elements, the test won't be considered
to fail.

This is useful in conjunction with the next commit, q.v..

At this time, no tests set $expected_mismatch explicitly.  However, the
commit after next (this commit's grandchild) will add a test that will
set $expected_mismatch implicitly, using the functionality in the next
commit (this commit's child).
---
 tests/README.md             | 3 +--
 tests/test-highlighting.zsh | 9 ++++++---
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/tests/README.md b/tests/README.md
index 89aef14..a413e16 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -23,8 +23,7 @@ need not match the order in `$region_highlight`.
 
 Normally, tests fail if `$expected_region_highlight` and `$region_highlight`
 have different numbers of elements.  Tests may set `$expected_mismatch` to an
-explanation string (like `$todo`) to avoid this and mark the cardinality check
-as todo.
+explanation string (like `$todo`) to avoid this and skip the cardinality check.
 
 **Note**: `$region_highlight` uses the same `"$i $j $style"` syntax but
 interprets the indexes differently.
diff --git a/tests/test-highlighting.zsh b/tests/test-highlighting.zsh
index b55324c..7b32dbc 100755
--- a/tests/test-highlighting.zsh
+++ b/tests/test-highlighting.zsh
@@ -171,14 +171,17 @@ run_test_internal() {
     unset desc
   done
 
-  if (( $#expected_region_highlight == $#region_highlight )); then
-    print -r -- "ok $i - cardinality check" "${expected_mismatch:+"# TODO ${(qqq)expected_mismatch}"}"
+  if [[ -n $expected_mismatch ]]; then
+    tap_escape $expected_mismatch; expected_mismatch=$REPLY
+    print "ok $i - cardinality check" "# SKIP $expected_mismatch"
+  elif (( $#expected_region_highlight == $#region_highlight )); then
+    print -r -- "ok $i - cardinality check"
   else
     local details
     details+="have $#expected_region_highlight expectations and $#region_highlight region_highlight entries: "
     details+="«$(typeset_p expected_region_highlight)» «$(typeset_p region_highlight)»"
     tap_escape $details; details=$REPLY
-    print -r -- "not ok $i - cardinality check" "$details" "${expected_mismatch:+"# TODO ${(qqq)expected_mismatch}"}"
+    print -r -- "not ok $i - cardinality check - $details"
   fi
 }