[PATCH v3 1/7] test: add support for external executable dependencies
authorDmitry Kurochkin <dmitry.kurochkin@gmail.com>
Sun, 27 Nov 2011 18:36:13 +0000 (22:36 +0400)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:40:26 +0000 (09:40 -0800)
cb/8603e881d0d521a073796db4e0e9818064015e [new file with mode: 0644]

diff --git a/cb/8603e881d0d521a073796db4e0e9818064015e b/cb/8603e881d0d521a073796db4e0e9818064015e
new file mode 100644 (file)
index 0000000..5e91a1a
--- /dev/null
@@ -0,0 +1,172 @@
+Return-Path: <dmitry.kurochkin@gmail.com>\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 3EED9429E33\r
+       for <notmuch@notmuchmail.org>; Sun, 27 Nov 2011 10:36:51 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.799\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_FROM=0.001, 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 ltVMGtHdSC0l for <notmuch@notmuchmail.org>;\r
+       Sun, 27 Nov 2011 10:36:49 -0800 (PST)\r
+Received: from mail-bw0-f53.google.com (mail-bw0-f53.google.com\r
+       [209.85.214.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 81A13429E26\r
+       for <notmuch@notmuchmail.org>; Sun, 27 Nov 2011 10:36:47 -0800 (PST)\r
+Received: by bkaq10 with SMTP id q10so8006916bka.26\r
+       for <notmuch@notmuchmail.org>; Sun, 27 Nov 2011 10:36:46 -0800 (PST)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma;\r
+       h=from:to:subject:date:message-id:x-mailer:in-reply-to:references;\r
+       bh=um1k2bHXxFXLQIusIXomr3Zo1em9TFc10EaDya0tLnI=;\r
+       b=xaa8+dOE++BfcaSlBAy7f3gk/lSFYtrrn9pInbTrB+pxEnnYszimgmdS8prS5kEjj2\r
+       KrV7jHCw9tzh7wWOZZc5T1XDTe1dYJGEs88eOWeS/XLe+7xigbPToU8c5YVtaNMUBIKt\r
+       +4CicJHFwb0d9FZXGFAko0yHB0Jbk/r4bFbMo=\r
+Received: by 10.205.118.14 with SMTP id fo14mr42632089bkc.63.1322419006145;\r
+       Sun, 27 Nov 2011 10:36:46 -0800 (PST)\r
+Received: from localhost ([91.144.186.21])\r
+       by mx.google.com with ESMTPS id hy13sm25145042bkc.0.2011.11.27.10.36.45\r
+       (version=TLSv1/SSLv3 cipher=OTHER);\r
+       Sun, 27 Nov 2011 10:36:45 -0800 (PST)\r
+From: Dmitry Kurochkin <dmitry.kurochkin@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v3 1/7] test: add support for external executable dependencies\r
+Date: Sun, 27 Nov 2011 22:36:13 +0400\r
+Message-Id: <1322418979-19180-2-git-send-email-dmitry.kurochkin@gmail.com>\r
+X-Mailer: git-send-email 1.7.7.3\r
+In-Reply-To: <1322418979-19180-1-git-send-email-dmitry.kurochkin@gmail.com>\r
+References: <87pqgd7d23.fsf@rocinante.cs.unb.ca>\r
+       <1322418979-19180-1-git-send-email-dmitry.kurochkin@gmail.com>\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: Sun, 27 Nov 2011 18:36:51 -0000\r
+\r
+There is existing support for general prerequisites in the test suite.\r
+But it is not very convenient to use: every test case has to keep\r
+track for it's dependencies and they have to be explicitly listed.\r
+\r
+The patch aims to add better support for a particular type of external\r
+dependencies: external executables.  The main idea is to replace\r
+missing external binaries with shell functions that have the same\r
+name.  These functions always fail and keep track of missing\r
+dependencies for a subtest.  The result reporting functions later can\r
+check that an external binaries are missing and correctly report SKIP\r
+result instead of FAIL.  The primary benefit is that the test cases do\r
+not need to declare their dependencies or be changed in any way.\r
+---\r
+ test/test-lib.sh |   49 +++++++++++++++++++++++++++++++++++++++++--------\r
+ 1 files changed, 41 insertions(+), 8 deletions(-)\r
+\r
+diff --git a/test/test-lib.sh b/test/test-lib.sh\r
+index 076f929..0996a74 100644\r
+--- a/test/test-lib.sh\r
++++ b/test/test-lib.sh\r
+@@ -548,6 +548,19 @@ test_have_prereq () {\r
+       esac\r
+ }\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
++$binary () {\r
++      echo -n \"\$test_subtest_missing_external_prereqs_\" | grep -e \" $name \" ||\r
++      test_subtest_missing_external_prereqs_=\"$test_subtest_missing_external_prereqs_ $name\"\r
++      false\r
++}"\r
++}\r
++\r
+ # You are not expected to call test_ok_ and test_failure_ directly, use\r
+ # the text_expect_* functions instead.\r
\r
+@@ -624,18 +637,31 @@ test_skip () {\r
+       fi\r
+       case "$to_skip" in\r
+       t)\r
+-              test_reset_state_\r
+-              say_color skip >&3 "skipping test: $@"\r
+-              say_color skip "%-6s" "SKIP"\r
+-              echo " $1"\r
+-              : true\r
++              test_report_skip_ "$@"\r
+               ;;\r
+       *)\r
+-              false\r
++              test_check_missing_external_prereqs_ "$@"\r
+               ;;\r
+       esac\r
+ }\r
\r
++test_check_missing_external_prereqs_ () {\r
++      if test -n "$test_subtest_missing_external_prereqs_"; then\r
++              say_color skip >&3 "missing prerequisites:"\r
++              echo "$test_subtest_missing_external_prereqs_" >&3\r
++              test_report_skip_ "$@"\r
++      else\r
++              false\r
++      fi\r
++}\r
++\r
++test_report_skip_ () {\r
++      test_reset_state_\r
++      say_color skip >&3 "skipping test: $@"\r
++      say_color skip "%-6s" "SKIP"\r
++      echo " $1"\r
++}\r
++\r
+ test_subtest_known_broken () {\r
+       test_subtest_known_broken_=t\r
+ }\r
+@@ -648,7 +674,10 @@ test_expect_success () {\r
+       if ! test_skip "$@"\r
+       then\r
+               test_run_ "$2"\r
+-              if [ "$?" = 0 -a "$eval_ret" = 0 ]\r
++              run_ret="$?"\r
++              # test_run_ may update missing external prerequisites\r
++              test_check_missing_external_prereqs_ "$@" ||\r
++              if [ "$run_ret" = 0 -a "$eval_ret" = 0 ]\r
+               then\r
+                       test_ok_ "$1"\r
+               else\r
+@@ -665,7 +694,10 @@ test_expect_code () {\r
+       if ! test_skip "$@"\r
+       then\r
+               test_run_ "$3"\r
+-              if [ "$?" = 0 -a "$eval_ret" = "$1" ]\r
++              run_ret="$?"\r
++              # test_run_ may update missing external prerequisites,\r
++              test_check_missing_external_prereqs_ "$@" ||\r
++              if [ "$run_ret" = 0 -a "$eval_ret" = "$1" ]\r
+               then\r
+                       test_ok_ "$2"\r
+               else\r
+@@ -870,6 +902,7 @@ test_emacs () {\r
\r
+ test_reset_state_ () {\r
+       test_subtest_known_broken_=\r
++      test_subtest_missing_external_prereqs_=\r
+ }\r
\r
\r
+-- \r
+1.7.7.3\r
+\r