merge bitcoin#21310: fix sync-up by matching notification to generated block

This commit is contained in:
Kittywhiskers Van Gogh 2021-02-27 18:32:48 +01:00
parent 7b0c725c59
commit 3ac3714957
No known key found for this signature in database
GPG Key ID: 30CD0C065E5C4AAD

View File

@ -68,6 +68,31 @@ class ZMQSubscriber:
return (hash, label, mempool_sequence) return (hash, label, mempool_sequence)
class ZMQTestSetupBlock:
"""Helper class for setting up a ZMQ test via the "sync up" procedure.
Generates a block on the specified node on instantiation and provides a
method to check whether a ZMQ notification matches, i.e. the event was
caused by this generated block. Assumes that a notification either contains
the generated block's hash, it's (coinbase) transaction id, the raw block or
raw transaction data.
"""
def __init__(self, node):
self.block_hash = node.generate(1)[0]
coinbase = node.getblock(self.block_hash, 2)['tx'][0]
self.tx_hash = coinbase['txid']
self.raw_tx = coinbase['hex']
self.raw_block = node.getblock(self.block_hash, 0)
def caused_notification(self, notification):
return (
self.block_hash in notification
or self.tx_hash in notification
or self.raw_block in notification
or self.raw_tx in notification
)
class ZMQTest (BitcoinTestFramework): class ZMQTest (BitcoinTestFramework):
def set_test_params(self): def set_test_params(self):
self.num_nodes = 2 self.num_nodes = 2
@ -117,17 +142,18 @@ class ZMQTest (BitcoinTestFramework):
# Ensure that all zmq publisher notification interfaces are ready by # Ensure that all zmq publisher notification interfaces are ready by
# running the following "sync up" procedure: # running the following "sync up" procedure:
# 1. Generate a block on the node # 1. Generate a block on the node
# 2. Try to receive a notification on all subscribers # 2. Try to receive the corresponding notification on all subscribers
# 3. If all subscribers get a message within the timeout (1 second), # 3. If all subscribers get the message within the timeout (1 second),
# we are done, otherwise repeat starting from step 1 # we are done, otherwise repeat starting from step 1
for sub in subscribers: for sub in subscribers:
sub.socket.set(zmq.RCVTIMEO, 1000) sub.socket.set(zmq.RCVTIMEO, 1000)
while True: while True:
self.nodes[0].generate(1) test_block = ZMQTestSetupBlock(self.nodes[0])
recv_failed = False recv_failed = False
for sub in subscribers: for sub in subscribers:
try: try:
sub.receive() while not test_block.caused_notification(sub.receive().hex()):
self.log.debug("Ignoring sync-up notification for previously generated block.")
except zmq.error.Again: except zmq.error.Again:
self.log.debug("Didn't receive sync-up notification, trying again.") self.log.debug("Didn't receive sync-up notification, trying again.")
recv_failed = True recv_failed = True
@ -345,7 +371,7 @@ class ZMQTest (BitcoinTestFramework):
block_count = self.nodes[0].getblockcount() block_count = self.nodes[0].getblockcount()
best_hash = self.nodes[0].getbestblockhash() best_hash = self.nodes[0].getbestblockhash()
self.nodes[0].invalidateblock(best_hash) self.nodes[0].invalidateblock(best_hash)
sleep(2) # Bit of room to make sure transaction things happened sleep(2) # Bit of room to make sure transaction things happened
# Make sure getrawmempool mempool_sequence results aren't "queued" but immediately reflective # Make sure getrawmempool mempool_sequence results aren't "queued" but immediately reflective
# of the time they were gathered. # of the time they were gathered.
@ -393,8 +419,8 @@ class ZMQTest (BitcoinTestFramework):
assert_equal(label, "A") assert_equal(label, "A")
# More transactions to be simply mined # More transactions to be simply mined
for i in range(len(more_tx)): for i in range(len(more_tx)):
assert_equal((more_tx[i], "A", mempool_seq), seq.receive_sequence()) assert_equal((more_tx[i], "A", mempool_seq), seq.receive_sequence())
mempool_seq += 1 mempool_seq += 1
mempool_seq += 1 mempool_seq += 1
assert_equal((tip, "C", None), seq.receive_sequence()) assert_equal((tip, "C", None), seq.receive_sequence())
@ -403,7 +429,7 @@ class ZMQTest (BitcoinTestFramework):
assert_equal((orig_txid_2, "A", mempool_seq), seq.receive_sequence()) assert_equal((orig_txid_2, "A", mempool_seq), seq.receive_sequence())
mempool_seq += 1 mempool_seq += 1
self.nodes[0].generatetoaddress(1, ADDRESS_BCRT1_UNSPENDABLE) self.nodes[0].generatetoaddress(1, ADDRESS_BCRT1_UNSPENDABLE)
self.sync_all() # want to make sure we didn't break "consensus" for other tests self.sync_all() # want to make sure we didn't break "consensus" for other tests
def test_mempool_sync(self): def test_mempool_sync(self):
""" """