Merge #18597: test: Extend wallet_dump test to cover comments

555567a test: Extend wallet_dump test to cover comments (MarcoFalke)

Pull request description:

ACKs for top commit:
  ryanofsky:
    Code review ACK 555567a. Nice new checks in this test. I confirmed this catches the missing FormatISO8601DateTime call you discovered in bitcoin/bitcoin#17954 (comment)

Tree-SHA512: 71aa23dd039f3bcdee642b01151edd1a0d44f48cedd070f5858148c8cb8abd6f5edfd212daeba38e35c843da5ea6c799e5a952105fdecedac355a5a843c05a84

Author: MarcoFalke

test/functional/wallet_dump.py

@@ -3,7 +3,9 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 """Test the dumpwallet RPC."""
+import datetime
 import os
+import time
 
 from test_framework.test_framework import BitcoinTestFramework
 from test_framework.util import (
@@ -18,6 +20,7 @@ def read_dump(file_name, addrs, script_addrs, hd_master_addr_old):
     Also check that the old hd_master is inactive
     """
     with open(file_name, encoding='utf8') as inputfile:
+        found_comments = []
         found_legacy_addr = 0
         found_p2sh_segwit_addr = 0
         found_bech32_addr = 0
@@ -26,8 +29,12 @@ def read_dump(file_name, addrs, script_addrs, hd_master_addr_old):
         found_addr_rsv = 0
         hd_master_addr_ret = None
         for line in inputfile:
-            # only read non comment lines
-            if line[0] != "#" and len(line) > 10:
+            line = line.strip()
+            if not line:
+                continue
+            if line[0] == '#':
+                found_comments.append(line)
+            else:
                 # split out some data
                 key_date_label, comment = line.split("#")
                 key_date_label = key_date_label.split(" ")
@@ -82,7 +89,7 @@ def read_dump(file_name, addrs, script_addrs, hd_master_addr_old):
                         found_script_addr += 1
                         break
 
-        return found_legacy_addr, found_p2sh_segwit_addr, found_bech32_addr, found_script_addr, found_addr_chg, found_addr_rsv, hd_master_addr_ret
+        return found_comments, found_legacy_addr, found_p2sh_segwit_addr, found_bech32_addr, found_script_addr, found_addr_chg, found_addr_rsv, hd_master_addr_ret
 
 
 class WalletDumpTest(BitcoinTestFramework):
@@ -122,12 +129,36 @@ def run_test(self):
         # its capacity
         self.nodes[0].keypoolrefill()
 
-        # dump unencrypted wallet
+        self.log.info('Mine a block one second before the wallet is dumped')
+        dump_time = int(time.time())
+        self.nodes[0].setmocktime(dump_time - 1)
+        self.nodes[0].generate(1)
+        self.nodes[0].setmocktime(dump_time)
+        dump_time_str = '# * Created on {}Z'.format(
+            datetime.datetime.fromtimestamp(
+                dump_time,
+                tz=datetime.timezone.utc,
+            ).replace(tzinfo=None).isoformat())
+        dump_best_block_1 = '# * Best block at time of backup was {} ({}),'.format(
+            self.nodes[0].getblockcount(),
+            self.nodes[0].getbestblockhash(),
+        )
+        dump_best_block_2 = '#   mined on {}Z'.format(
+            datetime.datetime.fromtimestamp(
+                dump_time - 1,
+                tz=datetime.timezone.utc,
+            ).replace(tzinfo=None).isoformat())
+
+        self.log.info('Dump unencrypted wallet')
         result = self.nodes[0].dumpwallet(wallet_unenc_dump)
         assert_equal(result['filename'], wallet_unenc_dump)
 
-        found_legacy_addr, found_p2sh_segwit_addr, found_bech32_addr, found_script_addr, found_addr_chg, found_addr_rsv, hd_master_addr_unenc = \
+        found_comments, found_legacy_addr, found_p2sh_segwit_addr, found_bech32_addr, found_script_addr, found_addr_chg, found_addr_rsv, hd_master_addr_unenc = \
             read_dump(wallet_unenc_dump, addrs, [multisig_addr], None)
+        assert '# End of dump' in found_comments  # Check that file is not corrupt
+        assert_equal(dump_time_str, next(c for c in found_comments if c.startswith('# * Created on')))
+        assert_equal(dump_best_block_1, next(c for c in found_comments if c.startswith('# * Best block')))
+        assert_equal(dump_best_block_2, next(c for c in found_comments if c.startswith('#   mined on')))
         assert_equal(found_legacy_addr, test_addr_count)  # all keys must be in the dump
         assert_equal(found_p2sh_segwit_addr, test_addr_count)  # all keys must be in the dump
         assert_equal(found_bech32_addr, test_addr_count)  # all keys must be in the dump
@@ -142,8 +173,12 @@ def run_test(self):
         self.nodes[0].keypoolrefill()
         self.nodes[0].dumpwallet(wallet_enc_dump)
 
-        found_legacy_addr, found_p2sh_segwit_addr, found_bech32_addr, found_script_addr, found_addr_chg, found_addr_rsv, _ = \
+        found_comments, found_legacy_addr, found_p2sh_segwit_addr, found_bech32_addr, found_script_addr, found_addr_chg, found_addr_rsv, _ = \
             read_dump(wallet_enc_dump, addrs, [multisig_addr], hd_master_addr_unenc)
+        assert '# End of dump' in found_comments  # Check that file is not corrupt
+        assert_equal(dump_time_str, next(c for c in found_comments if c.startswith('# * Created on')))
+        assert_equal(dump_best_block_1, next(c for c in found_comments if c.startswith('# * Best block')))
+        assert_equal(dump_best_block_2, next(c for c in found_comments if c.startswith('#   mined on')))
         assert_equal(found_legacy_addr, test_addr_count)  # all keys must be in the dump
         assert_equal(found_p2sh_segwit_addr, test_addr_count)  # all keys must be in the dump
         assert_equal(found_bech32_addr, test_addr_count)  # all keys must be in the dump