[PATCH] test: Use associative arrays to track external prereqs

diff --git a/f3/cdef99abe09e9f8b2a47ba7d4bc01518044781 b/f3/cdef99abe09e9f8b2a47ba7d4bc01518044781
new file mode 100644 (file)
index 0000000..b90168c
--- /dev/null
+++ b/f3/cdef99abe09e9f8b2a47ba7d4bc01518044781
@@ -0,0 +1,158 @@
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 80B47431FAF\r
+       for <notmuch@notmuchmail.org>; Tue, 27 Nov 2012 20:54:07 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id 7rvna3POiVqy for <notmuch@notmuchmail.org>;\r
+       Tue, 27 Nov 2012 20:54:07 -0800 (PST)\r
+Received: from dmz-mailsec-scanner-8.mit.edu (DMZ-MAILSEC-SCANNER-8.MIT.EDU\r
+       [18.7.68.37])\r
+       by olra.theworths.org (Postfix) with ESMTP id CDE8C431FAE\r
+       for <notmuch@notmuchmail.org>; Tue, 27 Nov 2012 20:54:06 -0800 (PST)\r
+X-AuditID: 12074425-b7f526d000002c4d-be-50b598ed2429\r
+Received: from mailhub-auth-2.mit.edu ( [18.7.62.36])\r
+       by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id CF.62.11341.DE895B05; Tue, 27 Nov 2012 23:54:05 -0500 (EST)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id qAS4s48O023495; \r
+       Tue, 27 Nov 2012 23:54:04 -0500\r
+Received: from drake.dyndns.org\r
+       (209-6-116-242.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+       [209.6.116.242]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id qAS4s22p011546\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Tue, 27 Nov 2012 23:54:04 -0500 (EST)\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1TdZes-0005R1-CE; Tue, 27 Nov 2012 23:54:02 -0500\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] test: Use associative arrays to track external prereqs\r
+Date: Tue, 27 Nov 2012 23:54:01 -0500\r
+Message-Id: <1354078441-20788-1-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.7.10.4\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFprJIsWRmVeSWpSXmKPExsUixG6novt2xtYAg5XvhC2u35zJ7MDo8WzV\r
+       LeYAxigum5TUnMyy1CJ9uwSujFcH6gsuSFQ0HPZtYNwm0sXIySEhYCJx4fw1dghbTOLCvfVs\r
+       XYxcHEIC+xglrnUeZYRwNjBKXDl9nRnCecQkMfl0N5Qzl1HizYRTbCD9bAIaEtv2L2cEsUUE\r
+       pCV23p3N2sXIwcEsoCbxp0sFJCws4C7x8OFnsBIWAVWJJbOWsILYvAIOEmsuPYE6Q1Gi+9kE\r
+       tgmMvAsYGVYxyqbkVunmJmbmFKcm6xYnJ+blpRbpWujlZpbopaaUbmIEh4CL6g7GCYeUDjEK\r
+       cDAq8fA+MN8aIMSaWFZcmXuIUZKDSUmU980koBBfUn5KZUZicUZ8UWlOavEhRgkOZiURXp42\r
+       oBxvSmJlVWpRPkxKmoNFSZz3RspNfyGB9MSS1OzU1ILUIpisDAeHkgTvmulAjYJFqempFWmZ\r
+       OSUIaSYOTpDhPEDDW0BqeIsLEnOLM9Mh8qcYFaXEebeBJARAEhmleXC9sBh9xSgO9Iowbw9I\r
+       FQ8wvuG6XwENZgIanHx9I8jgkkSElFQDo94PIe3Dn3+fvSp+TV/0k9l/vouFyeEHjuz5uyb6\r
+       XYX82dpLux/WT3wtujB/3a+zdm37/QObT9/+G6LFMW16pN7Z1efKl88Vvqia8nje+6zLgrtv\r
+       NdzyVkpbycqePId36ecVnGb8Vyc1Lor6zxY/6+ibtQ/Xli+5quLP5c/36eEmlQ2Ms0tig1Yo\r
+       sRRnJBpqMRcVJwIAX+SCQKwCAAA=\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Wed, 28 Nov 2012 04:54:07 -0000\r
+\r
+Previously, the test framework generated a variable name for each\r
+external prereq as a poor man's associative array.  Unfortunately,\r
+prereqs names may not be legal variable names, leading to\r
+unintelligible bash errors like\r
+  test_missing_external_prereq_emacsclient.emacs24_=t: command not found\r
+\r
+Using proper associative arrays to track prereqs, in addition to being\r
+much cleaner than generating variable names and using grep to\r
+carefully construct unique string lists, removes restrictions on\r
+prereq names.\r
+---\r
+ test/test-lib.sh |   24 ++++++++++++++----------\r
+ 1 file changed, 14 insertions(+), 10 deletions(-)\r
+\r
+diff --git a/test/test-lib.sh b/test/test-lib.sh\r
+index 77063a4..f169785 100644\r
+--- a/test/test-lib.sh\r
++++ b/test/test-lib.sh\r
+@@ -625,18 +625,22 @@ test_have_prereq () {\r
+       esac\r
+ }\r
+ \r
++declare -A test_missing_external_prereq_\r
++declare -A test_subtest_missing_external_prereq_\r
++\r
+ # declare prerequisite for the given external binary\r
+ test_declare_external_prereq () {\r
+       binary="$1"\r
+       test "$#" = 2 && name=$2 || name="$binary(1)"\r
+ \r
+-      hash $binary 2>/dev/null || eval "\r
+-      test_missing_external_prereq_${binary}_=t\r
++      if ! hash $binary 2>/dev/null; then\r
++              test_missing_external_prereq_["${binary}"]=t\r
++              eval "\r
+ $binary () {\r
+-      echo -n \"\$test_subtest_missing_external_prereqs_ \" | grep -qe \" $name \" ||\r
+-      test_subtest_missing_external_prereqs_=\"\$test_subtest_missing_external_prereqs_ $name\"\r
++      test_subtest_missing_external_prereq_[\"${name}\"]=t\r
+       false\r
+ }"\r
++      fi\r
+ }\r
+ \r
+ # Explicitly require external prerequisite.  Useful when binary is\r
+@@ -644,7 +648,7 @@ $binary () {\r
+ # Returns success if dependency is available, failure otherwise.\r
+ test_require_external_prereq () {\r
+       binary="$1"\r
+-      if [ "$(eval echo -n \$test_missing_external_prereq_${binary}_)" = t ]; then\r
++      if [[ ${test_missing_external_prereq_["${binary}"]} == t ]]; then\r
+               # dependency is missing, call the replacement function to note it\r
+               eval "$binary"\r
+       else\r
+@@ -737,9 +741,9 @@ test_skip () {\r
+ }\r
+ \r
+ test_check_missing_external_prereqs_ () {\r
+-      if test -n "$test_subtest_missing_external_prereqs_"; then\r
+-              say_color skip >&1 "missing prerequisites:"\r
+-              echo "$test_subtest_missing_external_prereqs_" >&1\r
++      if [[ ${#test_subtest_missing_external_prereq_[@]} != 0 ]]; then\r
++              say_color skip >&1 "missing prerequisites: "\r
++              echo ${!test_subtest_missing_external_prereq_[@]} >&1\r
+               test_report_skip_ "$@"\r
+       else\r
+               false\r
+@@ -1022,7 +1026,7 @@ test_python() {\r
+       # most others as /usr/bin/python. So first try python2, and fallback to\r
+       # python if python2 doesn't exist.\r
+       cmd=python2\r
+-      [[ "$test_missing_external_prereq_python2_" = t ]] && cmd=python\r
++      [[ ${test_missing_external_prereq_[python2]} == t ]] && cmd=python\r
+ \r
+       (echo "import sys; _orig_stdout=sys.stdout; sys.stdout=open('OUTPUT', 'w')"; cat) \\r
+               | $cmd -\r
+@@ -1064,7 +1068,7 @@ test_reset_state_ () {\r
+       test -z "$test_init_done_" && test_init_\r
+ \r
+       test_subtest_known_broken_=\r
+-      test_subtest_missing_external_prereqs_=\r
++      test_subtest_missing_external_prereq_=()\r
+ }\r
+ \r
+ # called once before the first subtest\r
+-- \r
+1.7.10.4\r
+\r