mirror of https://github.com/bitcoin/bitcoin.git
73 lines
2.6 KiB
Python
Executable File
73 lines
2.6 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# Copyright (c) 2020-2022 The Bitcoin Core developers
|
|
# Distributed under the MIT software license, see the accompanying
|
|
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
"""Test per-peer message capture capability.
|
|
|
|
Additionally, the output of contrib/message-capture/message-capture-parser.py should be verified manually.
|
|
"""
|
|
|
|
import glob
|
|
from io import BytesIO
|
|
import os
|
|
|
|
from test_framework.p2p import P2PDataStore, MESSAGEMAP
|
|
from test_framework.test_framework import BitcoinTestFramework
|
|
from test_framework.util import assert_equal
|
|
|
|
TIME_SIZE = 8
|
|
LENGTH_SIZE = 4
|
|
MSGTYPE_SIZE = 12
|
|
|
|
def mini_parser(dat_file: str) -> None:
|
|
"""Parse a data file created by CaptureMessageToFile.
|
|
|
|
From the data file we'll only check the structure.
|
|
|
|
We won't care about things like:
|
|
- Deserializing the payload of the message
|
|
- This is managed by the deserialize methods in test_framework.messages
|
|
- The order of the messages
|
|
- There's no reason why we can't, say, change the order of the messages in the handshake
|
|
- Message Type
|
|
- We can add new message types
|
|
|
|
We're ignoring these because they're simply too brittle to test here.
|
|
"""
|
|
with open(dat_file, 'rb') as f_in:
|
|
# This should have at least one message in it
|
|
assert os.fstat(f_in.fileno()).st_size >= TIME_SIZE + LENGTH_SIZE + MSGTYPE_SIZE
|
|
while True:
|
|
tmp_header_raw = f_in.read(TIME_SIZE + LENGTH_SIZE + MSGTYPE_SIZE)
|
|
if not tmp_header_raw:
|
|
break
|
|
tmp_header = BytesIO(tmp_header_raw)
|
|
tmp_header.read(TIME_SIZE) # skip the timestamp field
|
|
msgtype = tmp_header.read(MSGTYPE_SIZE).rstrip(b'\x00')
|
|
assert msgtype in MESSAGEMAP
|
|
length: int = int.from_bytes(tmp_header.read(LENGTH_SIZE), "little")
|
|
data = f_in.read(length)
|
|
assert_equal(len(data), length)
|
|
|
|
|
|
|
|
class MessageCaptureTest(BitcoinTestFramework):
|
|
def set_test_params(self):
|
|
self.num_nodes = 1
|
|
self.extra_args = [["-capturemessages"]]
|
|
self.setup_clean_chain = True
|
|
|
|
def run_test(self):
|
|
capturedir = self.nodes[0].chain_path / "message_capture"
|
|
# Connect a node so that the handshake occurs
|
|
self.nodes[0].add_p2p_connection(P2PDataStore())
|
|
self.nodes[0].disconnect_p2ps()
|
|
recv_file = glob.glob(os.path.join(capturedir, "*/msgs_recv.dat"))[0]
|
|
mini_parser(recv_file)
|
|
sent_file = glob.glob(os.path.join(capturedir, "*/msgs_sent.dat"))[0]
|
|
mini_parser(sent_file)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
MessageCaptureTest().main()
|