[PATCH] Compact tests and error handling

[PATCH] Compact tests and error handling

[Ben Gamari]

Here are a few patches adding a test case and some more user feedback on
rename failure during compaction.

Cheers,

- Ben

[PATCH 1/3] test: Add compact test

[Ben Gamari]

Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>
---
 test/compact      | 35 +++++++++++++++++++++++++++++++++++
 test/notmuch-test |  1 +
 2 files changed, 36 insertions(+)
 create mode 100755 test/compact

diff --git a/test/compact b/test/compact
new file mode 100755
index 0000000..54e85ab
--- /dev/null
+++ b/test/compact
@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+test_description='"notmuch compact"'
+. ./test-lib.sh
+
+add_message '[subject]=One'
+add_message '[subject]=Two'
+add_message '[subject]=Three'
+
+notmuch tag +tag1 \*
+notmuch tag +tag2 subject:Two
+notmuch tag -tag1 +tag3 subject:Three
+
+test_begin_subtest "Compacting"
+notmuch compact
+test_expect_success "compact" "notmuch compact"
+
+notmuch search \*
+output=$(notmuch search \* | notmuch_search_sanitize)
+test_expect_equal "$output" "\
+thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; One (inbox tag1 unread)
+thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Two (inbox tag1 tag2 unread)
+thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Three (inbox tag3 unread)"
+
+test_begin_subtest "Restoring backup"
+rm -Rf ${TEST_TMPDIR}/mail/xapian
+mv ${TEST_TMPDIR}/mail/xapian.old ${TEST_TMPDIR}/mail/xapian
+
+notmuch search \*
+output=$(notmuch search \* | notmuch_search_sanitize)
+test_expect_equal "$output" "\
+thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; One (inbox tag1 unread)
+thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Two (inbox tag1 tag2 unread)
+thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; Three (inbox tag3 unread)"
+
+test_done
diff --git a/test/notmuch-test b/test/notmuch-test
index aa28bb0..ec94baf 100755
--- a/test/notmuch-test
+++ b/test/notmuch-test
@@ -19,6 +19,7 @@ cd $(dirname "$0")
 TESTS="
   basic
   help-test
+  compact
   config
   setup
   new
-- 
1.8.1.2

[PATCH 2/3] compact: Give user more feedback on failure renaming

[Ben Gamari]

Provide the user with instructions after we fail to move the old
un-compacted database out of the way.

Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>
---
 lib/database.cc | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/lib/database.cc b/lib/database.cc
index 06f1c0a..57c2292 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -922,7 +922,14 @@ notmuch_database_compact (const char* path,
 
     if (old_xapian_path != NULL) {
 	if (rename(xapian_path, old_xapian_path)) {
-	    fprintf (stderr, "Error moving old database out of the way\n");
+	    fprintf (stderr, "Error moving old database out of the way: %s\n",
+		     strerror(errno));
+	    fprintf (stderr, "\n");
+	    fprintf (stderr, "Old database: %s\n", xapian_path);
+	    fprintf (stderr, "Compacted database: %s\n", compact_xapian_path);
+	    fprintf (stderr, "\n");
+	    fprintf (stderr, "At this point it's probably best to remove the compacted database,\n");
+	    fprintf (stderr, "find the cause of this error, and try compacting again.\n");
 	    ret = NOTMUCH_STATUS_FILE_ERROR;
 	    goto DONE;
 	}
-- 
1.8.1.2

[PATCH 3/3] compact: Provide user with more error feedback

[Ben Gamari]

Provide instructions on what to do when we couldn't move the compacted
database into place.

Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>
---
 lib/database.cc | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/lib/database.cc b/lib/database.cc
index 57c2292..6f9fed1 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -938,7 +938,23 @@ notmuch_database_compact (const char* path,
     }
 
     if (rename(compact_xapian_path, xapian_path)) {
-	fprintf (stderr, "Error moving compacted database\n");
+	fprintf (stderr, "Error moving compacted database into place: %s\n", strerror(errno));
+	fprintf (stderr, "\n");
+	fprintf (stderr, "Encountered error %s while moving the compacted database,\n",
+		 strerror(errno));
+	fprintf (stderr, "\n");
+	fprintf (stderr, "    %s\n", compact_xapian_path);
+	fprintf (stderr, "\n");
+	fprintf (stderr, "to\n");
+	fprintf (stderr, "\n");
+	fprintf (stderr, "    %s\n", xapian_path);
+	fprintf (stderr, "\n");
+	fprintf (stderr, "Please identify the reason for this and move the compacted database into place manually.\n");
+	if (backup_path != NULL) {
+	    fprintf (stderr, "Otherwise, you can revert to the backup database located at,\n");
+	    fprintf (stderr, "\n");
+	    fprintf (stderr, "    %s\n", backup_path);
+	}
 	ret = NOTMUCH_STATUS_FILE_ERROR;
 	goto DONE;
     }
-- 
1.8.1.2

Re: [PATCH 1/3] test: Add compact test

[David Bremner]

Hi Ben;

Thanks for writing these tests. I have some proposed changes. I didn't
understand why you called notmuch search twice, and for whatever reason
test_begin_subtest doesn't pair up with test_expect_success

diff --git a/test/compact b/test/compact
index 54e85ab..5bb5cea 100755
--- a/test/compact
+++ b/test/compact
@@ -10,11 +10,9 @@ notmuch tag +tag1 \*
 notmuch tag +tag2 subject:Two
 notmuch tag -tag1 +tag3 subject:Three
 
-test_begin_subtest "Compacting"
-notmuch compact
-test_expect_success "compact" "notmuch compact"
+test_expect_success "Running compact" "notmuch compact"
 
-notmuch search \*
+test_begin_subtest "Compact preserves database"
 output=$(notmuch search \* | notmuch_search_sanitize)
 test_expect_equal "$output" "\
 thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; One (inbox tag1 unread)
@@ -25,7 +23,6 @@ test_begin_subtest "Restoring backup"
 rm -Rf ${TEST_TMPDIR}/mail/xapian
 mv ${TEST_TMPDIR}/mail/xapian.old ${TEST_TMPDIR}/mail/xapian
 
-notmuch search \*
 output=$(notmuch search \* | notmuch_search_sanitize)
 test_expect_equal "$output" "\
 thread:XXX   2001-01-05 [1/1] Notmuch Test Suite; One (inbox tag1 unread)

Re: [PATCH 3/3] compact: Provide user with more error feedback

[Tomi Ollila]

On Tue, Oct 15 2013, Ben Gamari <bgamari.foss@gmail.com> wrote:

> Provide instructions on what to do when we couldn't move the compacted
> database into place.
>
> Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>
> ---
>  lib/database.cc | 18 +++++++++++++++++-
>  1 file changed, 17 insertions(+), 1 deletion(-)
>
> diff --git a/lib/database.cc b/lib/database.cc
> index 57c2292..6f9fed1 100644
> --- a/lib/database.cc
> +++ b/lib/database.cc
> @@ -938,7 +938,23 @@ notmuch_database_compact (const char* path,
>      }
>  
>      if (rename(compact_xapian_path, xapian_path)) {
> -	fprintf (stderr, "Error moving compacted database\n");
> +	fprintf (stderr, "Error moving compacted database into place: %s\n", strerror(errno));
> +	fprintf (stderr, "\n");
> +	fprintf (stderr, "Encountered error %s while moving the compacted database,\n",
> +		 strerror(errno));

At this point 'errno' may have changed, so the above error string might not
be the same. Maybe removing the '%s ' part altogether as inserting the part
looks a bit strange...

> +	fprintf (stderr, "\n");
> +	fprintf (stderr, "    %s\n", compact_xapian_path);
> +	fprintf (stderr, "\n");
> +	fprintf (stderr, "to\n");
> +	fprintf (stderr, "\n");
> +	fprintf (stderr, "    %s\n", xapian_path);
> +	fprintf (stderr, "\n");
> +	fprintf (stderr, "Please identify the reason for this and move the compacted database into place manually.\n");
> +	if (backup_path != NULL) {
> +	    fprintf (stderr, "Otherwise, you can revert to the backup database located at,\n");

the commas (,) here and a few lines above looks a bit strange to me. 

> +	    fprintf (stderr, "\n");
> +	    fprintf (stderr, "    %s\n", backup_path);

Maybe saying something how to do this revert would be enlightening to the
user... (i.e. mentioning that backup_path needs to be moved as xapian_path).


> +	}

>  	ret = NOTMUCH_STATUS_FILE_ERROR;
>  	goto DONE;
>      }
> -- 

Tomi

Re: [PATCH] Compact tests and error handling

[David Bremner]

Ben Gamari <bgamari.foss@gmail.com> writes:

> Here are a few patches adding a test case and some more user feedback on
> rename failure during compaction.
>

Hi Ben;

I'd like to include this series in the next release, freezing on
Nov. 8. Will you have a chance to revise it before then?

d

Re: [PATCH] Compact tests and error handling

[Ben Gamari]

[-- Attachment #1: Type: text/plain, Size: 467 bytes --]

David Bremner <david@tethera.net> writes:

> Ben Gamari <bgamari.foss@gmail.com> writes:
>
>> Here are a few patches adding a test case and some more user feedback on
>> rename failure during compaction.
>>
>
> Hi Ben;
>
> I'd like to include this series in the next release, freezing on
> Nov. 8. Will you have a chance to revise it before then?
>
Yes, I actually have the set sitting around waiting to be sent out. I'll
take care of this right now.

Cheers,

- Ben

[-- Attachment #2: Type: application/pgp-signature, Size: 489 bytes --]