Add comparison tool test runner, built on mininode

comptool.py creates a tool for running a test suite on top of the mininode p2p
framework.  It supports two types of tests: those for which we expect certain
behavior (acceptance or rejection of a block or transaction) and those for
which we are just comparing that the behavior of 2 or more nodes is the same.

blockstore.py defines BlockStore and TxStore, which provide db-backed maps
between block/tx hashes and the corresponding block or tx.

blocktools.py defines utility functions for creating and manipulating blocks
and transactions.

invalidblockrequest.py is an example test in the comptool framework, which
tests the behavior of a single node when sent two different types of invalid
blocks (a block with a duplicated transaction and a block with a bad coinbase
value).

1 files changed, 330 insertions, 0 deletions

diff --git a/qa/rpc-tests/comptool.py b/qa/rpc-tests/comptool.py
new file mode 100755
index 0000000000..6125bae51e
--- /dev/null
+++ b/qa/rpc-tests/comptool.py
@@ -0,0 +1,330 @@
+#!/usr/bin/env python2
+#
+# Distributed under the MIT/X11 software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+#
+
+from mininode import *
+from blockstore import BlockStore, TxStore
+from util import p2p_port
+
+'''
+This is a tool for comparing two or more bitcoinds to each other
+using a script provided.
+
+To use, create a class that implements get_tests(), and pass it in
+as the test generator to TestManager.  get_tests() should be a python
+generator that returns TestInstance objects.  See below for definition.
+'''
+
+# TestNode behaves as follows:
+# Configure with a BlockStore and TxStore
+# on_inv: log the message but don't request
+# on_headers: log the chain tip
+# on_pong: update ping response map (for synchronization)
+# on_getheaders: provide headers via BlockStore
+# on_getdata: provide blocks via BlockStore
+
+class TestNode(NodeConnCB):
+
+    def __init__(self, block_store, tx_store):
+        NodeConnCB.__init__(self)
+        self.create_callback_map()
+        self.conn = None
+        self.bestblockhash = None
+        self.block_store = block_store
+        self.block_request_map = {}
+        self.tx_store = tx_store
+        self.tx_request_map = {}
+
+        # When the pingmap is non-empty we're waiting for 
+        # a response
+        self.pingMap = {} 
+        self.lastInv = []
+
+    def add_connection(self, conn):
+        self.conn = conn
+
+    def on_headers(self, conn, message):
+        if len(message.headers) > 0:
+            best_header = message.headers[-1]
+            best_header.calc_sha256()
+            self.bestblockhash = best_header.sha256
+
+    def on_getheaders(self, conn, message):
+        response = self.block_store.headers_for(message.locator, message.hashstop)
+        if response is not None:
+            conn.send_message(response)
+
+    def on_getdata(self, conn, message):
+        [conn.send_message(r) for r in self.block_store.get_blocks(message.inv)]
+        [conn.send_message(r) for r in self.tx_store.get_transactions(message.inv)]
+
+        for i in message.inv:
+            if i.type == 1:
+                self.tx_request_map[i.hash] = True
+            elif i.type == 2:
+                self.block_request_map[i.hash] = True
+
+    def on_inv(self, conn, message):
+        self.lastInv = [x.hash for x in message.inv]
+
+    def on_pong(self, conn, message):
+        try:
+            del self.pingMap[message.nonce]
+        except KeyError:
+            raise AssertionError("Got pong for unknown ping [%s]" % repr(message))
+
+    def send_inv(self, obj):
+        mtype = 2 if isinstance(obj, CBlock) else 1
+        self.conn.send_message(msg_inv([CInv(mtype, obj.sha256)]))
+
+    def send_getheaders(self):
+        # We ask for headers from their last tip.
+        m = msg_getheaders()
+        m.locator = self.block_store.get_locator(self.bestblockhash)
+        self.conn.send_message(m)
+
+    # This assumes BIP31
+    def send_ping(self, nonce):
+        self.pingMap[nonce] = True
+        self.conn.send_message(msg_ping(nonce))
+
+    def received_ping_response(self, nonce):
+        return nonce not in self.pingMap
+
+    def send_mempool(self):
+        self.lastInv = []
+        self.conn.send_message(msg_mempool())
+
+# TestInstance:
+#
+# Instances of these are generated by the test generator, and fed into the
+# comptool.
+#
+# "blocks_and_transactions" should be an array of [obj, True/False/None]:
+#  - obj is either a CBlock or a CTransaction, and 
+#  - the second value indicates whether the object should be accepted
+#    into the blockchain or mempool (for tests where we expect a certain
+#    answer), or "None" if we don't expect a certain answer and are just
+#    comparing the behavior of the nodes being tested.
+# sync_every_block: if True, then each block will be inv'ed, synced, and
+#    nodes will be tested based on the outcome for the block.  If False,
+#    then inv's accumulate until all blocks are processed (or max inv size
+#    is reached) and then sent out in one inv message.  Then the final block
+#    will be synced across all connections, and the outcome of the final 
+#    block will be tested.
+# sync_every_tx: analagous to behavior for sync_every_block, except if outcome
+#    on the final tx is None, then contents of entire mempool are compared
+#    across all connections.  (If outcome of final tx is specified as true
+#    or false, then only the last tx is tested against outcome.)
+
+class TestInstance(object):
+    def __init__(self, objects=[], sync_every_block=True, sync_every_tx=False):
+        self.blocks_and_transactions = objects
+        self.sync_every_block = sync_every_block
+        self.sync_every_tx = sync_every_tx
+
+class TestManager(object):
+
+    def __init__(self, testgen, datadir):
+        self.test_generator = testgen
+        self.connections    = []
+        self.block_store    = BlockStore(datadir)
+        self.tx_store       = TxStore(datadir)
+        self.ping_counter   = 1
+
+    def add_all_connections(self, nodes):
+        for i in range(len(nodes)):
+            # Create a p2p connection to each node
+            self.connections.append(NodeConn('127.0.0.1', p2p_port(i), 
+                        nodes[i], TestNode(self.block_store, self.tx_store)))
+            # Make sure the TestNode (callback class) has a reference to its
+            # associated NodeConn
+            self.connections[-1].cb.add_connection(self.connections[-1])
+
+    def wait_for_verack(self):
+        sleep_time = 0.05
+        max_tries = 10 / sleep_time  # Wait at most 10 seconds
+        while max_tries > 0:
+            done = True
+            for c in self.connections:
+                if c.cb.verack_received is False:
+                    done = False
+                    break
+            if done:
+                break
+            time.sleep(sleep_time)
+
+    def wait_for_pings(self, counter):
+        received_pongs = False
+        while received_pongs is not True:
+            time.sleep(0.05)
+            received_pongs = True
+            for c in self.connections:
+                if c.cb.received_ping_response(counter) is not True:
+                    received_pongs = False
+                    break
+
+    # sync_blocks: Wait for all connections to request the blockhash given
+    # then send get_headers to find out the tip of each node, and synchronize
+    # the response by using a ping (and waiting for pong with same nonce).
+    def sync_blocks(self, blockhash, num_blocks):
+        # Wait for nodes to request block (50ms sleep * 20 tries * num_blocks)
+        max_tries = 20*num_blocks
+        while max_tries > 0:
+            results = [ blockhash in c.cb.block_request_map and
+                        c.cb.block_request_map[blockhash] for c in self.connections ]
+            if False not in results:
+                break
+            time.sleep(0.05)
+            max_tries -= 1
+
+        # --> error if not requested
+        if max_tries == 0:
+            # print [ c.cb.block_request_map for c in self.connections ]
+            raise AssertionError("Not all nodes requested block")
+        # --> Answer request (we did this inline!)
+
+        # Send getheaders message
+        [ c.cb.send_getheaders() for c in self.connections ]
+
+        # Send ping and wait for response -- synchronization hack
+        [ c.cb.send_ping(self.ping_counter) for c in self.connections ]
+        self.wait_for_pings(self.ping_counter)
+        self.ping_counter += 1
+
+    # Analogous to sync_block (see above)
+    def sync_transaction(self, txhash, num_events):
+        # Wait for nodes to request transaction (50ms sleep * 20 tries * num_events)
+        max_tries = 20*num_events
+        while max_tries > 0:
+            results = [ txhash in c.cb.tx_request_map and
+                        c.cb.tx_request_map[txhash] for c in self.connections ]
+            if False not in results:
+                break
+            time.sleep(0.05)
+            max_tries -= 1
+
+        # --> error if not requested
+        if max_tries == 0:
+            # print [ c.cb.tx_request_map for c in self.connections ]
+            raise AssertionError("Not all nodes requested transaction")
+        # --> Answer request (we did this inline!)
+
+        # Get the mempool
+        [ c.cb.send_mempool() for c in self.connections ]
+
+        # Send ping and wait for response -- synchronization hack
+        [ c.cb.send_ping(self.ping_counter) for c in self.connections ]
+        self.wait_for_pings(self.ping_counter)
+        self.ping_counter += 1
+
+        # Sort inv responses from each node
+        [ c.cb.lastInv.sort() for c in self.connections ]
+
+    # Verify that the tip of each connection all agree with each other, and
+    # with the expected outcome (if given)
+    def check_results(self, blockhash, outcome):
+        for c in self.connections:
+            if outcome is None:
+                if c.cb.bestblockhash != self.connections[0].cb.bestblockhash:
+                    return False
+            elif ((c.cb.bestblockhash == blockhash) != outcome):
+                # print c.cb.bestblockhash, blockhash, outcome
+                return False
+        return True
+
+    # Either check that the mempools all agree with each other, or that
+    # txhash's presence in the mempool matches the outcome specified.
+    # This is somewhat of a strange comparison, in that we're either comparing
+    # a particular tx to an outcome, or the entire mempools altogether;
+    # perhaps it would be useful to add the ability to check explicitly that
+    # a particular tx's existence in the mempool is the same across all nodes.
+    def check_mempool(self, txhash, outcome):
+        for c in self.connections:
+            if outcome is None:
+                # Make sure the mempools agree with each other
+                if c.cb.lastInv != self.connections[0].cb.lastInv:
+                    # print c.rpc.getrawmempool()
+                    return False
+            elif ((txhash in c.cb.lastInv) != outcome):
+                # print c.rpc.getrawmempool(), c.cb.lastInv
+                return False
+        return True
+
+    def run(self):
+        # Wait until verack is received
+        self.wait_for_verack()
+
+        test_number = 1
+        for test_instance in self.test_generator.get_tests():
+            # We use these variables to keep track of the last block
+            # and last transaction in the tests, which are used
+            # if we're not syncing on every block or every tx.
+            [ block, block_outcome ] = [ None, None ]
+            [ tx, tx_outcome ] = [ None, None ]
+            invqueue = []
+
+            for b_or_t, outcome in test_instance.blocks_and_transactions:
+                # Determine if we're dealing with a block or tx
+                if isinstance(b_or_t, CBlock):  # Block test runner
+                    block = b_or_t
+                    block_outcome = outcome
+                    # Add to shared block_store, set as current block
+                    self.block_store.add_block(block)
+                    for c in self.connections:
+                        c.cb.block_request_map[block.sha256] = False
+                    # Either send inv's to each node and sync, or add
+                    # to invqueue for later inv'ing.
+                    if (test_instance.sync_every_block):
+                        [ c.cb.send_inv(block) for c in self.connections ]
+                        self.sync_blocks(block.sha256, 1)
+                        if (not self.check_results(block.sha256, outcome)):
+                            raise AssertionError("Test failed at test %d" % test_number)
+                    else:
+                        invqueue.append(CInv(2, block.sha256))
+                else:  # Tx test runner
+                    assert(isinstance(b_or_t, CTransaction))
+                    tx = b_or_t
+                    tx_outcome = outcome
+                    # Add to shared tx store
+                    self.tx_store.add_transaction(tx)
+                    for c in self.connections:
+                        c.cb.tx_request_map[tx.sha256] = False
+                    # Again, either inv to all nodes or save for later
+                    if (test_instance.sync_every_tx):
+                        [ c.cb.send_inv(tx) for c in self.connections ]
+                        self.sync_transaction(tx.sha256, 1)
+                        if (not self.check_mempool(tx.sha256, outcome)):
+                            raise AssertionError("Test failed at test %d" % test_number)
+                    else:
+                        invqueue.append(CInv(1, tx.sha256))
+                # Ensure we're not overflowing the inv queue
+                if len(invqueue) == MAX_INV_SZ:
+                    [ c.sb.send_message(msg_inv(invqueue)) for c in self.connections ]
+                    invqueue = []
+
+            # Do final sync if we weren't syncing on every block or every tx.
+            if (not test_instance.sync_every_block and block is not None):
+                if len(invqueue) > 0:
+                    [ c.send_message(msg_inv(invqueue)) for c in self.connections ]
+                    invqueue = []
+                self.sync_blocks(block.sha256,
+                                 len(test_instance.blocks_and_transactions))
+                if (not self.check_results(block.sha256, block_outcome)):
+                    raise AssertionError("Block test failed at test %d" % test_number)
+            if (not test_instance.sync_every_tx and tx is not None):
+                if len(invqueue) > 0:
+                    [ c.send_message(msg_inv(invqueue)) for c in self.connections ]
+                    invqueue = []
+                self.sync_transaction(tx.sha256, len(test_instance.blocks_and_transactions))
+                if (not self.check_mempool(tx.sha256, tx_outcome)):
+                    raise AssertionError("Mempool test failed at test %d" % test_number)
+
+            print "Test %d: PASS" % test_number, [ c.rpc.getblockcount() for c in self.connections ]
+            test_number += 1
+
+        self.block_store.close()
+        self.tx_store.close()
+        [ c.disconnect_node() for c in self.connections ]