Return-Path: <tomi.ollila@iki.fi>
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 0A225431FAF
	for <notmuch@notmuchmail.org>; Wed,  6 Mar 2013 00:34:26 -0800 (PST)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Spam-Flag: NO
X-Spam-Score: 0
X-Spam-Level: 
X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]
	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 U8XTb+B4e6pC for <notmuch@notmuchmail.org>;
	Wed,  6 Mar 2013 00:34:25 -0800 (PST)
Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])
	by olra.theworths.org (Postfix) with ESMTP id 09D70431FAE
	for <notmuch@notmuchmail.org>; Wed,  6 Mar 2013 00:34:25 -0800 (PST)
Received: from guru.guru-group.fi (localhost [IPv6:::1])
	by guru.guru-group.fi (Postfix) with ESMTP id AF8D2100051;
	Wed,  6 Mar 2013 10:34:12 +0200 (EET)
From: Tomi Ollila <tomi.ollila@iki.fi>
To: Aaron Ecay <aaronecay@gmail.com>, notmuch@notmuchmail.org
Subject: Re: [PATCH] test/README: mention the test_expect_equal_json and
	*sanitize* functions
In-Reply-To: <1362540882-1894-1-git-send-email-aaronecay@gmail.com>
References: <1362540882-1894-1-git-send-email-aaronecay@gmail.com>
User-Agent: Notmuch/0.15.2+48~g8dcc33e (http://notmuchmail.org) Emacs/24.2.1
	(x86_64-unknown-linux-gnu)
X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL
	$[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F
	!)g;OY^,BjTbr)Np:%c_o'jj,Z
Date: Wed, 06 Mar 2013 10:34:12 +0200
Message-ID: <m2ppzd3p17.fsf@guru.guru-group.fi>
MIME-Version: 1.0
Content-Type: text/plain
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 08:34:26 -0000

On Wed, Mar 06 2013, Aaron Ecay <aaronecay@gmail.com> wrote:

> also fix one typo
> ---

LGTM.

Tomi


>  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
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch