You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
133 lines
5.2 KiB
133 lines
5.2 KiB
#!/usr/bin/env python3
|
|
# Copyright (c) 2018-2021 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 RPC help output."""
|
|
|
|
from test_framework.test_framework import BitcoinTestFramework
|
|
from test_framework.util import assert_equal, assert_raises_rpc_error
|
|
|
|
from collections import defaultdict
|
|
import os
|
|
import re
|
|
|
|
|
|
def parse_string(s):
|
|
assert s[0] == '"'
|
|
assert s[-1] == '"'
|
|
return s[1:-1]
|
|
|
|
|
|
def process_mapping(fname):
|
|
"""Find and parse conversion table in implementation file `fname`."""
|
|
cmds = []
|
|
in_rpcs = False
|
|
with open(fname, "r", encoding="utf8") as f:
|
|
for line in f:
|
|
line = line.rstrip()
|
|
if not in_rpcs:
|
|
if line == 'static const CRPCConvertParam vRPCConvertParams[] =':
|
|
in_rpcs = True
|
|
else:
|
|
if line.startswith('};'):
|
|
in_rpcs = False
|
|
elif '{' in line and '"' in line:
|
|
m = re.search(r'{ *("[^"]*"), *([0-9]+) *, *("[^"]*") *},', line)
|
|
assert m, 'No match to table expression: %s' % line
|
|
name = parse_string(m.group(1))
|
|
idx = int(m.group(2))
|
|
argname = parse_string(m.group(3))
|
|
cmds.append((name, idx, argname))
|
|
assert not in_rpcs and cmds
|
|
return cmds
|
|
|
|
|
|
class HelpRpcTest(BitcoinTestFramework):
|
|
def set_test_params(self):
|
|
self.num_nodes = 1
|
|
self.supports_cli = False
|
|
|
|
def run_test(self):
|
|
self.test_client_conversion_table()
|
|
self.test_categories()
|
|
self.dump_help()
|
|
if self.is_wallet_compiled():
|
|
self.wallet_help()
|
|
|
|
def test_client_conversion_table(self):
|
|
file_conversion_table = os.path.join(self.config["environment"]["SRCDIR"], 'src', 'rpc', 'client.cpp')
|
|
mapping_client = process_mapping(file_conversion_table)
|
|
# Ignore echojson in client table
|
|
mapping_client = [m for m in mapping_client if m[0] != 'echojson']
|
|
|
|
mapping_server = self.nodes[0].help("dump_all_command_conversions")
|
|
# Filter all RPCs whether they need conversion
|
|
mapping_server_conversion = [tuple(m[:3]) for m in mapping_server if not m[3]]
|
|
|
|
# Only check if all RPC methods have been compiled (i.e. wallet is enabled)
|
|
if self.is_wallet_compiled() and sorted(mapping_client) != sorted(mapping_server_conversion):
|
|
raise AssertionError("RPC client conversion table ({}) and RPC server named arguments mismatch!\n{}".format(
|
|
file_conversion_table,
|
|
set(mapping_client).symmetric_difference(mapping_server_conversion),
|
|
))
|
|
|
|
# Check for conversion difference by argument name.
|
|
# It is preferable for API consistency that arguments with the same name
|
|
# have the same conversion, so bin by argument name.
|
|
all_methods_by_argname = defaultdict(list)
|
|
converts_by_argname = defaultdict(list)
|
|
for m in mapping_server:
|
|
all_methods_by_argname[m[2]].append(m[0])
|
|
converts_by_argname[m[2]].append(m[3])
|
|
|
|
for argname, convert in converts_by_argname.items():
|
|
if all(convert) != any(convert):
|
|
# Only allow dummy to fail consistency check
|
|
assert argname == 'dummy', ('WARNING: conversion mismatch for argument named %s (%s)' % (argname, list(zip(all_methods_by_argname[argname], converts_by_argname[argname]))))
|
|
|
|
def test_categories(self):
|
|
node = self.nodes[0]
|
|
|
|
# wrong argument count
|
|
assert_raises_rpc_error(-1, 'help', node.help, 'foo', 'bar')
|
|
|
|
# invalid argument
|
|
assert_raises_rpc_error(-1, 'JSON value is not a string as expected', node.help, 0)
|
|
|
|
# help of unknown command
|
|
assert_equal(node.help('foo'), 'help: unknown command: foo')
|
|
|
|
# command titles
|
|
titles = [line[3:-3] for line in node.help().splitlines() if line.startswith('==')]
|
|
|
|
components = ['Blockchain', 'Control', 'Generating', 'Mining', 'Network', 'Rawtransactions', 'Util']
|
|
|
|
if self.is_wallet_compiled():
|
|
components.append('Wallet')
|
|
|
|
if self.is_external_signer_compiled():
|
|
components.append('Signer')
|
|
|
|
if self.is_zmq_compiled():
|
|
components.append('Zmq')
|
|
|
|
assert_equal(titles, sorted(components))
|
|
|
|
def dump_help(self):
|
|
dump_dir = os.path.join(self.options.tmpdir, 'rpc_help_dump')
|
|
os.mkdir(dump_dir)
|
|
calls = [line.split(' ', 1)[0] for line in self.nodes[0].help().splitlines() if line and not line.startswith('==')]
|
|
for call in calls:
|
|
with open(os.path.join(dump_dir, call), 'w', encoding='utf-8') as f:
|
|
# Make sure the node can generate the help at runtime without crashing
|
|
f.write(self.nodes[0].help(call))
|
|
|
|
def wallet_help(self):
|
|
assert 'getnewaddress ( "label" "address_type" )' in self.nodes[0].help('getnewaddress')
|
|
self.restart_node(0, extra_args=['-nowallet=1'])
|
|
assert 'getnewaddress ( "label" "address_type" )' in self.nodes[0].help('getnewaddress')
|
|
|
|
|
|
if __name__ == '__main__':
|
|
HelpRpcTest().main()
|