From: Austin Clements <amdragon@MIT.EDU>
To: Dmitry Kurochkin <dmitry.kurochkin@gmail.com>, notmuch@notmuchmail.org
Subject: Re: [PATCH 1/3] test: add functions to count how much times notmuch
	was called
In-Reply-To: <1322271878-32614-1-git-send-email-dmitry.kurochkin@gmail.com>
References: <1322271878-32614-1-git-send-email-dmitry.kurochkin@gmail.com>
User-Agent: Notmuch/0.9+77~gfdb7dac (http://notmuchmail.org) Emacs/23.3.1
	(i486-pc-linux-gnu)
Date: Sun, 27 Nov 2011 21:44:23 -0500
Message-ID: <87ipm52cfs.fsf@awakening.csail.mit.edu>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Precedence: list

On Sat, 26 Nov 2011 05:44:36 +0400, Dmitry Kurochkin <dmitry.kurochkin@gmail.com> wrote:
> The patch adds two auxiliary functions and a variable:
> 
>   notmuch_counter_reset
>   $notmuch_counter
>   notmuch_counter
> 
> They allow to count how many times notmuch binary is called.
> notmuch_counter_reset() function generates a script that counts how
> many times it is called and resets the counter to zero.  The function
> sets $notmuch_counter variable to the path to the generated script
> that should be called instead of notmuch to do the counting.  The
> notmuch_counter() function returns the current counter value.

Great idea!

> ---
>  test/README      |   16 ++++++++++++++--
>  test/test-lib.sh |   32 ++++++++++++++++++++++++++++++++
>  2 files changed, 46 insertions(+), 2 deletions(-)
> 
> diff --git a/test/README b/test/README
> index 2481f16..1570f7c 100644
> --- a/test/README
> +++ b/test/README
> @@ -187,8 +187,8 @@ library for your script to use.
>     is to summarize successes and failures in the test script and
>     exit with an appropriate error code.
>  
> -There are also a number of mail-specific functions which are useful in
> -writing tests:
> +There are also a number of notmuch-specific auxiliary functions and
> +variables which are useful in writing tests:
>  
>    generate_message
>  
> @@ -212,3 +212,15 @@ writing tests:
>      will initialize the mail database to a known state of 50 sample
>      messages, (culled from the early history of the notmuch mailing
>      list).
> +
> +  notmuch_counter_reset
> +  $notmuch_counter
> +  notmuch_counter

>From the name, I would expect $notmuch_counter to be the counter value
(ignoring the difficulty of implementing that).  Perhaps
$notmuch_counter_command, since it's meant to be bound to
notmuch-command?

notmuch_counter is okay, but maybe notmuch_counter_value?

> +
> +    These allow to count how many times notmuch binary is called.
> +    notmuch_counter_reset() function generates a script that counts
> +    how many times it is called and resets the counter to zero.  The
> +    function sets $notmuch_counter variable to the path to the
> +    generated script that should be called instead of notmuch to do
> +    the counting.  The notmuch_counter() function returns the current
> +    counter value.

It doesn't return the counter value, it prints it.

> diff --git a/test/test-lib.sh b/test/test-lib.sh
> index 93867b0..e3b85d0 100755
> --- a/test/test-lib.sh
> +++ b/test/test-lib.sh
> @@ -864,6 +864,38 @@ test_emacs () {
>  	emacsclient --socket-name="$EMACS_SERVER" --eval "(progn $@)"
>  }
>  
> +# Creates a script that counts how much time it is executed and calls
> +# notmuch.  $notmuch_counter is set to the path to the generated
> +# script.  Use notmuch_counter() function to get the current counter
> +# value.
> +notmuch_counter_reset () {
> +	notmuch_counter="$TMP_DIRECTORY/notmuch_counter"
> +	if [ ! -x "$notmuch_counter" ]; then
> +		notmuch_counter_state_path="$TMP_DIRECTORY/notmuch_counter.state"
> +		cat <<EOF >"$notmuch_counter"

This is totally a stylistic pet peeve, but consider
  cat >"$notmuch_counter" <<EOF

> +#!/bin/sh
> +
> +count=\$(cat "$notmuch_counter_state_path")
> +echo -n \$(expr \$count + 1) > "$notmuch_counter_state_path"
> +
> +exec notmuch "\$@"
> +EOF
> +		chmod +x "$notmuch_counter" || return
> +	fi
> +
> +	echo -n 0 > "$notmuch_counter_state_path" || return

What are the || return's for?

> +}
> +
> +# Returns the current notmuch counter value.
> +notmuch_counter () {
> +	if [ -r "$notmuch_counter_state_path" ]; then
> +		count=$(cat "$notmuch_counter_state_path")
> +	else
> +		count=0
> +	fi
> +	echo -n $count
> +}
> +
>  
>  find_notmuch_path ()
>  {
> -- 
> 1.7.7.3
> 
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch
>