[PATCH v3] test: Test thread linking in all possible delivery orders
authorAustin Clements <amdragon@MIT.EDU>
Wed, 9 Jul 2014 21:15:38 +0000 (17:15 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:03:28 +0000 (10:03 -0800)
47/12c717de7e15c3a43f6448da9ee932e20da10d [new file with mode: 0644]

diff --git a/47/12c717de7e15c3a43f6448da9ee932e20da10d b/47/12c717de7e15c3a43f6448da9ee932e20da10d
new file mode 100644 (file)
index 0000000..50dc2eb
--- /dev/null
@@ -0,0 +1,245 @@
+Return-Path: <amdragon@mit.edu>\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 1E6DD431FB6\r
+       for <notmuch@notmuchmail.org>; Wed,  9 Jul 2014 14:15:56 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 nVgLjLuoMOiq for <notmuch@notmuchmail.org>;\r
+       Wed,  9 Jul 2014 14:15:48 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-2.mit.edu (dmz-mailsec-scanner-2.mit.edu\r
+       [18.9.25.13])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 49118431FAF\r
+       for <notmuch@notmuchmail.org>; Wed,  9 Jul 2014 14:15:48 -0700 (PDT)\r
+X-AuditID: 1209190d-f79c06d000002f07-42-53bdb10305cf\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-2.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 43.B3.12039.301BDB35; Wed,  9 Jul 2014 17:15:47 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id s69LFhD0004402; \r
+       Wed, 9 Jul 2014 17:15:44 -0400\r
+Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s69LFf9V024982\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Wed, 9 Jul 2014 17:15:42 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1X4zDJ-0005GS-8K; Wed, 09 Jul 2014 17:15:41 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v3] test: Test thread linking in all possible delivery orders\r
+Date: Wed,  9 Jul 2014 17:15:38 -0400\r
+Message-Id: <1404940538-19711-1-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 2.0.0\r
+In-Reply-To: <87wqehaw69.fsf@qmul.ac.uk>\r
+References: <87wqehaw69.fsf@qmul.ac.uk>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFjrKIsWRmVeSWpSXmKPExsUixG6nrsu8cW+wwetV6hY3WrsZLVbP5bG4\r
+       fnMmswOzx85Zd9k9nq26xeyx5dB75gDmKC6blNSczLLUIn27BK6M/6seMRactahYskChgfGY\r
+       bhcjJ4eEgIlEw7FrLBC2mMSFe+vZuhi5OIQEZjNJ3N/wlQnC2cAocW//K6jMYSaJ5s71UJm5\r
+       jBLPr+9kA+lnE9CQ2LZ/OSOILSIgLbHz7mxWEJtZIFbi2vUDYDuEBXwllhxuA6rh4GARUJU4\r
+       0cYLEuYVcJCYuHINK8QZchINNz6BjeQEGrnv0xpmEFtIQF3i/b49zBMY+RcwMqxilE3JrdLN\r
+       TczMKU5N1i1OTszLSy3SNdLLzSzRS00p3cQICi1OSd4djO8OKh1iFOBgVOLh1ejaGyzEmlhW\r
+       XJl7iFGSg0lJlPf8UqAQX1J+SmVGYnFGfFFpTmrxIUYJDmYlEd5bJUA53pTEyqrUonyYlDQH\r
+       i5I471trq2AhgfTEktTs1NSC1CKYrAwHh5IEr+cGoEbBotT01Iq0zJwShDQTByfIcB6g4R/W\r
+       gwwvLkjMLc5Mh8ifYlSUEue9sA4oIQCSyCjNg+uFxf4rRnGgV4R5g0BW8ADTBlz3K6DBTECD\r
+       rS32gAwuSURISTUwnvXOfnP6f7Ypf5N0o8fPlVx6Surh6+QLuYV1Q3+HLfzaa2DwQK32Bdfy\r
+       dbO+vWSNZu9/6XM6RDJUq5F9dYro9pJlLEqiO1+9ZNCrOzdNifmS7k0TlW9z+uW0emRij0TV\r
+       R94JrXx2/96R7KMpPmsOLd+jcV5zAnuspk53pvP5OmuLP8X8Wx2UWIozEg21mIuKEwGoCJfG\r
+       2AIAAA==\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: Wed, 09 Jul 2014 21:15:56 -0000\r
+\r
+These tests deliver all possible (single-root) four-message threads in\r
+all possible orders and check that notmuch successfully links them\r
+into threads.  These tests supersede and replace the previous and much\r
+less thorough "T260-thread-order" tests.\r
+\r
+There are two variants of the test: one delivers messages that\r
+reference only their immediate parent and the other delivers messages\r
+that reference all of their parents.  The latter test is currently\r
+known-broken.\r
+---\r
+This version addresses Mark's review by using a completely different\r
+thread tree generation algorithm that directly generates distinct\r
+trees.  This algorithm is a little longer, so I pulled it out into its\r
+own script.  Since v2, I also realized we already had an equivalent\r
+hand-written, but far less thorough test in T260-thread-order, so this\r
+version simply replaces that test.\r
+\r
+Separately, I have an implementation of my ghost message proposal,\r
+which fixes the known-broken test introduced in this patch (among\r
+other things).  I'll send that once I've cleaned it up a bit.\r
+\r
+ test/T260-thread-order.sh | 86 +++++++++++++++++++++++++++++++++++------------\r
+ test/gen-threads.py       | 33 ++++++++++++++++++\r
+ 2 files changed, 98 insertions(+), 21 deletions(-)\r
+ create mode 100644 test/gen-threads.py\r
+\r
+diff --git a/test/T260-thread-order.sh b/test/T260-thread-order.sh\r
+index 6c3a4b3..b435d79 100755\r
+--- a/test/T260-thread-order.sh\r
++++ b/test/T260-thread-order.sh\r
+@@ -2,31 +2,75 @@\r
+ test_description="threading when messages received out of order"\r
+ . ./test-lib.sh\r
\r
+-test_begin_subtest "Adding initial child message"\r
+-generate_message [body]=foo "[in-reply-to]=\<parent-id\>" [subject]=brokenthreadtest '[date]="Sat, 01 Jan 2000 12:00:00 -0000"'\r
+-output=$(NOTMUCH_NEW)\r
+-test_expect_equal "$output" "Added 1 new message to the database."\r
++# Generate all single-root four message thread structures.  We'll use\r
++# this for multiple tests below.\r
++THREADS=$(python ${TEST_DIRECTORY}/gen-threads.py 4)\r
++nthreads=$(wc -l <<< "$THREADS")\r
\r
+-test_begin_subtest "Searching returns the message"\r
+-output=$(notmuch search foo | notmuch_search_sanitize)\r
+-test_expect_equal "$output" "thread:XXX   2000-01-01 [1/1] Notmuch Test Suite; brokenthreadtest (inbox unread)"\r
++test_begin_subtest "Messages with one parent get linked in all delivery orders"\r
++# In the first variant, this delivers messages that reference only\r
++# their immediate parent.  Hence, we should only expect threads to be\r
++# fully joined at the end.\r
++for ((n = 0; n < 4; n++)); do\r
++    # Deliver the n'th message of every thread\r
++    thread=0\r
++    while read -a parents; do\r
++        parent=${parents[$n]}\r
++        generate_message \\r
++            [id]=m$n@t$thread [in-reply-to]="\<m$parent@t$thread\>" \\r
++            [subject]=p$thread [from]=m$n\r
++        thread=$((thread + 1))\r
++    done <<< "$THREADS"\r
++    notmuch new > /dev/null\r
++done\r
++output=$(notmuch search --sort=newest-first '*' | notmuch_search_sanitize)\r
++expected=$(for ((i = 0; i < $nthreads; i++)); do\r
++        echo "thread:XXX   2001-01-05 [4/4] m3, m2, m1, m0; p$i (inbox unread)"\r
++    done)\r
++test_expect_equal "$output" "$expected"\r
\r
+-test_begin_subtest "Adding second child message"\r
+-generate_message [body]=foo "[in-reply-to]=\<parent-id\>" [subject]=brokenthreadtest '[date]="Sat, 01 Jan 2000 12:00:00 -0000"'\r
+-output=$(NOTMUCH_NEW)\r
+-test_expect_equal "$output" "Added 1 new message to the database."\r
++test_begin_subtest "Messages with all parents get linked in all delivery orders"\r
++test_subtest_known_broken\r
++# Here we do the same thing as the previous test, but each message\r
++# references all of its parents.  Since every message references the\r
++# root of the thread, each thread should always be fully joined.  This\r
++# is currently broken because of the bug detailed in\r
++# id:8738h7kv2q.fsf@qmul.ac.uk.\r
++rm ${MAIL_DIR}/*\r
++notmuch new > /dev/null\r
++output=""\r
++expected=""\r
++for ((n = 0; n < 4; n++)); do\r
++    # Deliver the n'th message of every thread\r
++    thread=0\r
++    while read -a parents; do\r
++        references=""\r
++        parent=${parents[$n]}\r
++        while [[ $parent != None ]]; do\r
++            references="<m$parent@t$thread> $references"\r
++            parent=${parents[$parent]}\r
++        done\r
\r
+-test_begin_subtest "Searching returns both messages in one thread"\r
+-output=$(notmuch search foo | notmuch_search_sanitize)\r
+-test_expect_equal "$output" "thread:XXX   2000-01-01 [2/2] Notmuch Test Suite; brokenthreadtest (inbox unread)"\r
++        generate_message \\r
++            [id]=m$n@t$thread [references]="'$references'" \\r
++            [subject]=p$thread [from]=m$n\r
++        thread=$((thread + 1))\r
++    done <<< "$THREADS"\r
++    notmuch new > /dev/null\r
\r
+-test_begin_subtest "Adding parent message"\r
+-generate_message [body]=foo [id]=parent-id [subject]=brokenthreadtest '[date]="Sat, 01 Jan 2000 12:00:00 -0000"'\r
+-output=$(NOTMUCH_NEW)\r
+-test_expect_equal "$output" "Added 1 new message to the database."\r
++    output="$output\r
++$(notmuch search --sort=newest-first '*' | notmuch_search_sanitize)"\r
\r
+-test_begin_subtest "Searching returns all three messages in one thread"\r
+-output=$(notmuch search foo | notmuch_search_sanitize)\r
+-test_expect_equal "$output" "thread:XXX   2000-01-01 [3/3] Notmuch Test Suite; brokenthreadtest (inbox unread)"\r
++    # Construct expected output\r
++    template="thread:XXX   2001-01-05 [$((n+1))/$((n+1))]"\r
++    for ((m = n; m > 0; m--)); do\r
++        template="$template m$m,"\r
++    done\r
++    expected="$expected\r
++$(for ((i = 0; i < $nthreads; i++)); do\r
++        echo "$template m0; p$i (inbox unread)"\r
++    done)"\r
++done\r
++test_expect_equal "$output" "$expected"\r
\r
+ test_done\r
+diff --git a/test/gen-threads.py b/test/gen-threads.py\r
+new file mode 100644\r
+index 0000000..9fbb847\r
+--- /dev/null\r
++++ b/test/gen-threads.py\r
+@@ -0,0 +1,33 @@\r
++# Generate all possible single-root message thread structures of size\r
++# argv[1].  Each output line is a thread structure, where the n'th\r
++# field is either a number giving the parent of message n or "None"\r
++# for the root.\r
++\r
++import sys\r
++from itertools import chain, combinations\r
++\r
++def subsets(s):\r
++    return chain.from_iterable(combinations(s, r) for r in range(len(s)+1))\r
++\r
++nodes = set(range(int(sys.argv[1])))\r
++\r
++# Queue of (tree, free, to_expand) where tree is a {node: parent}\r
++# dictionary, free is a set of unattached nodes, and to_expand is\r
++# itself a queue of nodes in the tree that need to be expanded.\r
++# The queue starts with all single-node trees.\r
++queue = [({root: None}, nodes - {root}, (root,)) for root in nodes]\r
++\r
++# Process queue\r
++while queue:\r
++    tree, free, to_expand = queue.pop()\r
++\r
++    if len(to_expand) == 0:\r
++        # Only print full-sized trees\r
++        if len(free) == 0:\r
++            print(" ".join(map(str, [msg[1] for msg in sorted(tree.items())])))\r
++    else:\r
++        # Expand node to_expand[0] with each possible set of children\r
++        for children in subsets(free):\r
++            ntree = dict(tree, **{child: to_expand[0] for child in children})\r
++            nfree = free.difference(children)\r
++            queue.append((ntree, nfree, to_expand[1:] + tuple(children)))\r
+-- \r
+2.0.0\r
+\r