Changeset View
Changeset View
Standalone View
Standalone View
test/functional/rpc_help.py
| #!/usr/bin/env python3 | #!/usr/bin/env python3 | ||||
| # Copyright (c) 2018 The Bitcoin Core developers | # Copyright (c) 2018 The Bitcoin Core developers | ||||
| # Distributed under the MIT software license, see the accompanying | # Distributed under the MIT software license, see the accompanying | ||||
| # file COPYING or http://www.opensource.org/licenses/mit-license.php. | # file COPYING or http://www.opensource.org/licenses/mit-license.php. | ||||
| """Test RPC help output.""" | """Test RPC help output.""" | ||||
| from test_framework.test_framework import BitcoinTestFramework | from test_framework.test_framework import BitcoinTestFramework | ||||
| from test_framework.util import assert_equal, assert_raises_rpc_error | from test_framework.util import assert_equal, assert_raises_rpc_error | ||||
| import os | |||||
| class HelpRpcTest(BitcoinTestFramework): | class HelpRpcTest(BitcoinTestFramework): | ||||
| def set_test_params(self): | def set_test_params(self): | ||||
| self.num_nodes = 1 | self.num_nodes = 1 | ||||
| def run_test(self): | def run_test(self): | ||||
| self.test_categories() | |||||
| self.dump_help() | |||||
| def test_categories(self): | |||||
| node = self.nodes[0] | node = self.nodes[0] | ||||
| # wrong argument count | # wrong argument count | ||||
| assert_raises_rpc_error(-1, 'help', node.help, 'foo', 'bar') | assert_raises_rpc_error(-1, 'help', node.help, 'foo', 'bar') | ||||
| # invalid argument | # invalid argument | ||||
| assert_raises_rpc_error(-1, | assert_raises_rpc_error(-1, | ||||
| 'JSON value is not a string as expected', node.help, 0) | 'JSON value is not a string as expected', node.help, 0) | ||||
| Show All 10 Lines | def test_categories(self): | ||||
| if self.is_wallet_compiled(): | if self.is_wallet_compiled(): | ||||
| components.append('Wallet') | components.append('Wallet') | ||||
| if self.is_zmq_compiled(): | if self.is_zmq_compiled(): | ||||
| components.append('Zmq') | components.append('Zmq') | ||||
| assert_equal(titles, components) | assert_equal(titles, 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)) | |||||
| if __name__ == '__main__': | if __name__ == '__main__': | ||||
| HelpRpcTest().main() | HelpRpcTest().main() | ||||