[PATCH 3/3] test: implement and document NOTMUCH_TEST_QUIET variable usage
authorTomi Ollila <tomi.ollila@iki.fi>
Tue, 12 Nov 2013 20:41:08 +0000 (22:41 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:58:14 +0000 (09:58 -0800)
cf/c181607d8671514ccd5cd7808938bbc2551f9c [new file with mode: 0644]

diff --git a/cf/c181607d8671514ccd5cd7808938bbc2551f9c b/cf/c181607d8671514ccd5cd7808938bbc2551f9c
new file mode 100644 (file)
index 0000000..9182e23
--- /dev/null
@@ -0,0 +1,201 @@
+Return-Path: <too@guru-group.fi>\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 98887431FD7\r
+       for <notmuch@notmuchmail.org>; Tue, 12 Nov 2013 12:41:26 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       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 iJa5g7vEtoDC for <notmuch@notmuchmail.org>;\r
+       Tue, 12 Nov 2013 12:41:22 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id 05277431FDA\r
+       for <notmuch@notmuchmail.org>; Tue, 12 Nov 2013 12:41:18 -0800 (PST)\r
+Received: by guru.guru-group.fi (Postfix, from userid 501)\r
+       id BDB7710009D; Tue, 12 Nov 2013 22:41:13 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 3/3] test: implement and document NOTMUCH_TEST_QUIET variable\r
+       usage\r
+Date: Tue, 12 Nov 2013 22:41:08 +0200\r
+Message-Id: <1384288868-23903-3-git-send-email-tomi.ollila@iki.fi>\r
+X-Mailer: git-send-email 1.8.0\r
+In-Reply-To: <1384288868-23903-1-git-send-email-tomi.ollila@iki.fi>\r
+References: <1384288868-23903-1-git-send-email-tomi.ollila@iki.fi>\r
+Cc: tomi.ollila@iki.fi\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: Tue, 12 Nov 2013 20:41:27 -0000\r
+\r
+When NOTMUCH_TEST_QUIET environment variable is set to non-null value\r
+messages when new test script starts and when test PASSes are disabled.\r
+This eases picking the cases when tests FAIL (as those are still printed).\r
+---\r
+ test/README                                      |  8 ++++++++\r
+ test/basic                                       | 12 ++++++++++--\r
+ test/test-lib.sh                                 | 11 ++++++++++-\r
+ test/test.expected-output/test-quiet-verbose-no  | 20 ++++++++++++++++++++\r
+ test/test.expected-output/test-quiet-verbose-yes | 24 ++++++++++++++++++++++++\r
+ 5 files changed, 72 insertions(+), 3 deletions(-)\r
+ create mode 100644 test/test.expected-output/test-quiet-verbose-no\r
+ create mode 100644 test/test.expected-output/test-quiet-verbose-yes\r
+\r
+diff --git a/test/README b/test/README\r
+index d12cff2..79a9b1b 100644\r
+--- a/test/README\r
++++ b/test/README\r
+@@ -76,6 +76,14 @@ the tests in one of the following ways.\r
+       TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs\r
+       make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient\r
\r
++Quiet Execution\r
++---------------\r
++\r
++Normally, when new script starts and when test PASSes you get a message\r
++printed on screen. This printing can be disabled by setting the\r
++NOTMUCH_TEST_QUIET variable to a non-null value. Message on test\r
++failures and skips are still printed.\r
++\r
+ Skipping Tests\r
+ --------------\r
+ If, for any reason, you need to skip one or more tests, you can do so\r
+diff --git a/test/basic b/test/basic\r
+index 64eb7d7..3b7668b 100755\r
+--- a/test/basic\r
++++ b/test/basic\r
+@@ -73,14 +73,22 @@ suppress_diff_date() {\r
+       -e 's/\(.*\+\+\+ test-verbose\.4\.\output\).*/\1/'\r
+ }\r
\r
++if [ -z "$NOTMUCH_TEST_QUIET" ]\r
++then\r
++      test_verbose_no=$EXPECTED/test-verbose-no\r
++      test_verbose_yes=$EXPECTED/test-verbose-yes\r
++else\r
++      test_verbose_no=$EXPECTED/test-quiet-verbose-no\r
++      test_verbose_yes=$EXPECTED/test-quiet-verbose-yes\r
++fi\r
+ test_begin_subtest "Ensure that test output is suppressed unless the test fails"\r
+ output=$(cd $TEST_DIRECTORY; ./test-verbose 2>&1 | suppress_diff_date)\r
+-expected=$(cat $EXPECTED/test-verbose-no | suppress_diff_date)\r
++expected=$(cat ${test_verbose_no} | suppress_diff_date)\r
+ test_expect_equal "$output" "$expected"\r
\r
+ test_begin_subtest "Ensure that -v does not suppress test output"\r
+ output=$(cd $TEST_DIRECTORY; ./test-verbose -v 2>&1 | suppress_diff_date)\r
+-expected=$(cat $EXPECTED/test-verbose-yes | suppress_diff_date)\r
++expected=$(cat ${test_verbose_yes} | suppress_diff_date)\r
+ # Do not include the results of test-verbose in totals\r
+ rm $TEST_DIRECTORY/test-results/test-verbose\r
+ rm -r $TEST_DIRECTORY/tmp.test-verbose\r
+diff --git a/test/test-lib.sh b/test/test-lib.sh\r
+index e022e46..4b342ac 100644\r
+--- a/test/test-lib.sh\r
++++ b/test/test-lib.sh\r
+@@ -195,7 +195,10 @@ print_test_description ()\r
+       echo\r
+       echo $this_test: "Testing ${test_description}"\r
+ }\r
+-print_test_description\r
++if [ -z "$NOTMUCH_TEST_QUIET" ]\r
++then\r
++      print_test_description\r
++fi\r
\r
+ exec 5>&1\r
\r
+@@ -703,6 +706,9 @@ test_ok_ () {\r
+               return\r
+       fi\r
+       test_success=$(($test_success + 1))\r
++      if test -n "$NOTMUCH_TEST_QUIET"; then\r
++              return 0\r
++      fi\r
+       say_color pass "%-6s" "PASS"\r
+       echo " $test_subtest_name"\r
+ }\r
+@@ -713,6 +719,9 @@ test_failure_ () {\r
+               return\r
+       fi\r
+       test_failure=$(($test_failure + 1))\r
++      if test -n "$NOTMUCH_TEST_QUIET"; then\r
++              print_test_description\r
++      fi\r
+       test_failure_message_ "FAIL" "$test_subtest_name" "$@"\r
+       test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }\r
+       return 1\r
+diff --git a/test/test.expected-output/test-quiet-verbose-no b/test/test.expected-output/test-quiet-verbose-no\r
+new file mode 100644\r
+index 0000000..74840b9\r
+--- /dev/null\r
++++ b/test/test.expected-output/test-quiet-verbose-no\r
+@@ -0,0 +1,20 @@\r
++\r
++test-verbose: Testing the verbosity options of the test framework itself.\r
++ FAIL   print something in test_expect_success and fail\r
++      \r
++        echo "hello stdout" &&\r
++        echo "hello stderr" >&2 &&\r
++        false\r
++      \r
++hello stdout\r
++hello stderr\r
++\r
++test-verbose: Testing the verbosity options of the test framework itself.\r
++ FAIL   print something test_begin_subtest and test_expect_equal and fail\r
++      --- test-verbose.4.expected\r
++      +++ test-verbose.4.output\r
++      @@ -1 +1 @@\r
++      -b\r
++      +a\r
++hello stdout\r
++hello stderr\r
+diff --git a/test/test.expected-output/test-quiet-verbose-yes b/test/test.expected-output/test-quiet-verbose-yes\r
+new file mode 100644\r
+index 0000000..51e759d\r
+--- /dev/null\r
++++ b/test/test.expected-output/test-quiet-verbose-yes\r
+@@ -0,0 +1,24 @@\r
++hello stdout\r
++hello stderr\r
++hello stdout\r
++hello stderr\r
++\r
++test-verbose: Testing the verbosity options of the test framework itself.\r
++ FAIL   print something in test_expect_success and fail\r
++      \r
++        echo "hello stdout" &&\r
++        echo "hello stderr" >&2 &&\r
++        false\r
++      \r
++hello stdout\r
++hello stderr\r
++hello stdout\r
++hello stderr\r
++\r
++test-verbose: Testing the verbosity options of the test framework itself.\r
++ FAIL   print something test_begin_subtest and test_expect_equal and fail\r
++      --- test-verbose.4.expected\r
++      +++ test-verbose.4.output\r
++      @@ -1 +1 @@\r
++      -b\r
++      +a\r
+-- \r
+1.8.3.1\r
+\r