Merge #14020: Add tests for RPC help

6af6d9b23d test: Add tests for RPC help (João Barbosa)

Pull request description:

  At the moment the new test checks for:
   - invalid usages
   - expected output for unknown command
   - current RPC command titles (derived from command categories) — this prevents adding wrong RPC categories and new categories must be added to the test

Tree-SHA512: f987535d001b1cd300656588602b1634099ea68a1dd2282180c30fa56caf7f990be9e2dc86c7431dfcf7fd686d0299a8d4935df178a2c9f0fb6fbebcba748eb5

2 files changed, 32 insertions, 0 deletions

diff --git a/test/functional/rpc_help.py b/test/functional/rpc_help.py
new file mode 100755
index 0000000000..e878ded258
--- /dev/null
+++ b/test/functional/rpc_help.py
@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+# Copyright (c) 2018 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
+
+class HelpRpcTest(BitcoinTestFramework):
+    def set_test_params(self):
+        self.num_nodes = 1
+
+    def run_test(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('==')]
+        assert_equal(titles, ['Blockchain', 'Control', 'Generating', 'Mining', 'Network', 'Rawtransactions', 'Util', 'Wallet', 'Zmq'])
+
+if __name__ == '__main__':
+    HelpRpcTest().main()
diff --git a/test/functional/test_runner.py b/test/functional/test_runner.py
index feea2a327a..13c687fd92 100755
--- a/test/functional/test_runner.py
+++ b/test/functional/test_runner.py
@@ -152,6 +152,7 @@ BASE_SCRIPTS = [
     'p2p_node_network_limited.py',
     'feature_blocksdir.py',
     'feature_config_args.py',
+    'rpc_help.py',
     'feature_help.py',
     # Don't append tests at the end to avoid merge conflicts
     # Put them in a random line within the section that fits their approximate run-time