From: Aaron Ecay <aaronecay@gmail.com>
Date: Wed, 6 Mar 2013 03:34:42 +0000 (+1900)
Subject: [PATCH] test/README: mention the test_expect_equal_json and *sanitize* functions
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=4caf4f9e2eecee458ffec97e7ce08c5c7a9f04a7;p=notmuch-archives.git

[PATCH] test/README: mention the test_expect_equal_json and *sanitize* functions
---

diff --git a/6b/0d8fa0887b036758992dbd062b1dd64601c60e b/6b/0d8fa0887b036758992dbd062b1dd64601c60e
new file mode 100644
index 000000000..c2acf00f6
--- /dev/null
+++ b/6b/0d8fa0887b036758992dbd062b1dd64601c60e
@@ -0,0 +1,110 @@
+Return-Path: <aaronecay@gmail.com>
+X-Original-To: notmuch@notmuchmail.org
+Delivered-To: notmuch@notmuchmail.org
+Received: from localhost (localhost [127.0.0.1])
+	by olra.theworths.org (Postfix) with ESMTP id 79D6A431FBC
+	for <notmuch@notmuchmail.org>; Tue,  5 Mar 2013 19:34:46 -0800 (PST)
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
+X-Spam-Flag: NO
+X-Spam-Score: -0.799
+X-Spam-Level: 
+X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5
+	tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,
+	FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled
+Received: from olra.theworths.org ([127.0.0.1])
+	by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
+	with ESMTP id BWZ+nWkfTiPb for <notmuch@notmuchmail.org>;
+	Tue,  5 Mar 2013 19:34:46 -0800 (PST)
+Received: from mail-qa0-f41.google.com (mail-qa0-f41.google.com
+	[209.85.216.41]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
+	(No client certificate requested)
+	by olra.theworths.org (Postfix) with ESMTPS id 0AEC5431FAE
+	for <notmuch@notmuchmail.org>; Tue,  5 Mar 2013 19:34:46 -0800 (PST)
+Received: by mail-qa0-f41.google.com with SMTP id bs12so2285179qab.7
+	for <notmuch@notmuchmail.org>; Tue, 05 Mar 2013 19:34:45 -0800 (PST)
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;
+	h=x-received:from:to:subject:date:message-id:x-mailer;
+	bh=5zA3gs2ShwST3YkD0xsIhPqkYnTQ+jCAkHYYT+koaXY=;
+	b=CBNOZqlq3C/VoSDG34SLPi0ixNL0+9+euaiJVkT95tvkQP00aJK2XhgtqxJFq4Ob/O
+	U7mp6C6CY4feika7BAWjRLTQk2twvRNsYTmYdWWtdzWtVvu8r54lWp1CgE/PppRVVkSJ
+	oeHgPUyHAXokTTVar7mjkhZq+Q49gKZ9gWrxjF1C+sbbnXvk6og2MBwzBPK9XMvE+7+0
+	JbFBTPys6h4c5Qb7RsYd0IrE87/M6ILVJYRfTkJkKtjjJnlmMnSCzNTlWB2NiKONugqW
+	kulLhc5VIVqo146d862lU1OeAdtY5+5DxEBzsGZha8BIo2d1/Oh3iuO6vrwRT7Shrgbz
+	nHaA==
+X-Received: by 10.224.78.196 with SMTP id m4mr15137174qak.67.1362540885526;
+	Tue, 05 Mar 2013 19:34:45 -0800 (PST)
+Received: from haize.hsd1.pa.comcast.net (c-68-80-94-73.hsd1.pa.comcast.net.
+	[68.80.94.73])
+	by mx.google.com with ESMTPS id dt10sm46580562qab.0.2013.03.05.19.34.44
+	(version=TLSv1.2 cipher=ECDHE-RSA-RC4-SHA bits=128/128);
+	Tue, 05 Mar 2013 19:34:45 -0800 (PST)
+From: Aaron Ecay <aaronecay@gmail.com>
+To: notmuch@notmuchmail.org
+Subject: [PATCH] test/README: mention the test_expect_equal_json and
+	*sanitize* functions
+Date: Tue,  5 Mar 2013 22:34:42 -0500
+Message-Id: <1362540882-1894-1-git-send-email-aaronecay@gmail.com>
+X-Mailer: git-send-email 1.8.1.5
+X-BeenThere: notmuch@notmuchmail.org
+X-Mailman-Version: 2.1.13
+Precedence: list
+List-Id: "Use and development of the notmuch mail system."
+	<notmuch.notmuchmail.org>
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
+	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>
+List-Post: <mailto:notmuch@notmuchmail.org>
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
+	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
+X-List-Received-Date: Wed, 06 Mar 2013 03:34:46 -0000
+
+also fix one typo
+---
+ test/README | 22 +++++++++++++++++++++-
+ 1 file changed, 21 insertions(+), 1 deletion(-)
+
+diff --git a/test/README b/test/README
+index 81c232d..d12cff2 100644
+--- a/test/README
++++ b/test/README
+@@ -178,11 +178,18 @@ library for your script to use.
+ 
+  test_expect_equal_file <file1> <file2>
+ 
+-   Identical to test_exepect_equal, except that <file1> and <file2>
++   Identical to test_expect_equal, except that <file1> and <file2>
+    are files instead of strings.  This is a much more robust method to
+    compare formatted textual information, since it also notices
+    whitespace and closing newline differences.
+ 
++ test_expect_equal_json <output> <expected>
++
++   Identical to test_expect_equal, except that the two strings are
++   treated as JSON and canonicalized before equality testing.  This is
++   useful to abstract away from whitespace differences in the expected
++   output and that generated by running a notmuch command.
++
+  test_debug <script>
+ 
+    This takes a single argument, <script>, and evaluates it only
+@@ -253,3 +260,16 @@ variables which are useful in writing tests:
+     generated script that should be called instead of notmuch to do
+     the counting.  The notmuch_counter_value() function prints the
+     current counter value.
++
++There are also functions which remove various environment-dependent
++values from notmuch output; these are useful to ensure that test
++results remain consistent across different machines.
++
++ notmuch_search_sanitize
++ notmuch_show_sanitize
++ notmuch_show_sanitize_all
++ notmuch_json_show_sanitize
++
++   All these functions should receive the text to be sanitized as the
++   input of a pipe, e.g.
++   output=`notmuch search "..." | notmuch_search_sanitize`
+-- 
+1.8.1.5
+