Refactor common RPC test code to BitcoinTestFramework base class

Inspired by #3956, with a little more flexibility built in. I didn't touch rpcbind_test.py, because it only runs on Linux.
10 years ago · e8097f7df1
6 changed files with 334 additions and 500 deletions
--- a/qa/rpc-tests/README.md
+++ b/qa/rpc-tests/README.md
@ -6,8 +6,8 @@ Git subtree of [https://github.com/jgarzik/python-bitcoinrpc](https://github.com
 Changes to python-bitcoinrpc should be made upstream, and then
 pulled here using git subtree.

-### [skeleton.py](skeleton.py)
-Copy this to create new regression tests.
+### [test_framework.py](test_framework.py)
+Base class for new regression tests.

 ### [listtransactions.py](listtransactions.py)
 Tests for the listtransactions RPC call.
--- a/qa/rpc-tests/listtransactions.py
+++ b/qa/rpc-tests/listtransactions.py
@ -5,17 +5,7 @@

 # Exercise the listtransactions API

-# Add python-bitcoinrpc to module search path:
-import os
-import sys
-sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "python-bitcoinrpc"))
-
-import json
-import shutil
-import subprocess
-import tempfile
-import traceback
-
+from test_framework import BitcoinTestFramework
 from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
 from util import *

@ -41,7 +31,9 @@ def check_array_result(object_array, to_match, expected):
    if num_matched == 0:
        raise AssertionError("No objects matched %s"%(str(to_match)))

-def run_test(nodes):
+class ListTransactionsTest(BitcoinTestFramework):
+
+    def run_test(self, nodes):
        # Simple send, 0 to 1:
        txid = nodes[0].sendtoaddress(nodes[1].getnewaddress(), 0.1)
        sync_mempools(nodes)
@ -100,57 +92,6 @@ def run_test(nodes):
                           {"category":"receive","amount":Decimal("0.44")},
                           {"txid":txid, "account" : "toself"} )

-
-def main():
-    import optparse
-
-    parser = optparse.OptionParser(usage="%prog [options]")
-    parser.add_option("--nocleanup", dest="nocleanup", default=False, action="store_true",
-                      help="Leave bitcoinds and test.* datadir on exit or error")
-    parser.add_option("--srcdir", dest="srcdir", default="../../src",
-                      help="Source directory containing bitcoind/bitcoin-cli (default: %default%)")
-    parser.add_option("--tmpdir", dest="tmpdir", default=tempfile.mkdtemp(prefix="test"),
-                      help="Root directory for datadirs")
-    (options, args) = parser.parse_args()
-
-    os.environ['PATH'] = options.srcdir+":"+os.environ['PATH']
-
-    check_json_precision()
-
-    success = False
-    nodes = []
-    try:
-        print("Initializing test directory "+options.tmpdir)
-        if not os.path.isdir(options.tmpdir):
-            os.makedirs(options.tmpdir)
-        initialize_chain(options.tmpdir)
-
-        nodes = start_nodes(2, options.tmpdir)
-        connect_nodes(nodes[1], 0)
-        sync_blocks(nodes)
-
-        run_test(nodes)
-
-        success = True
-
-    except AssertionError as e:
-        print("Assertion failed: "+e.message)
-    except Exception as e:
-        print("Unexpected exception caught during testing: "+str(e))
-        traceback.print_tb(sys.exc_info()[2])
-
-    if not options.nocleanup:
-        print("Cleaning up")
-        stop_nodes(nodes)
-        wait_bitcoinds()
-        shutil.rmtree(options.tmpdir)
-
-    if success:
-        print("Tests successful")
-        sys.exit(0)
-    else:
-        print("Failed")
-        sys.exit(1)
-
 if __name__ == '__main__':
-    main()
+    ListTransactionsTest().main()
+
--- a/qa/rpc-tests/receivedby.py
+++ b/qa/rpc-tests/receivedby.py
@ -3,23 +3,13 @@
 # Distributed under the MIT/X11 software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.

-# Exercise the listtransactions API
-
-# Add python-bitcoinrpc to module search path:
-
-import os
-import sys
-sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "python-bitcoinrpc"))
-
-import json
-import shutil
-import subprocess
-import tempfile
-import traceback
+# Exercise the listreceivedbyaddress API

+from test_framework import BitcoinTestFramework
 from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
 from util import *

+
 def get_sub_array_from_array(object_array, to_match):
    '''
        Finds and returns a sub array from an array of arrays.
@ -62,7 +52,9 @@ def check_array_result(object_array, to_match, expected, should_not_find = False
    if num_matched > 0 and should_not_find == True:
        raise AssertionError("Objects was matched %s"%(str(to_match)))

-def run_test(nodes):
+class ReceivedByTest(BitcoinTestFramework):
+
+    def run_test(self, nodes):
        '''
        listreceivedbyaddress Test
        '''
@ -170,56 +162,5 @@ def run_test(nodes):
        if balance != Decimal("0.0"):
            raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))

-def main():
-    import optparse
-
-    parser = optparse.OptionParser(usage="%prog [options]")
-    parser.add_option("--nocleanup", dest="nocleanup", default=False, action="store_true",
-                      help="Leave bitcoinds and test.* datadir on exit or error")
-    parser.add_option("--srcdir", dest="srcdir", default="../../src",
-                      help="Source directory containing bitcoind/bitcoin-cli (default: %default%)")
-    parser.add_option("--tmpdir", dest="tmpdir", default=tempfile.mkdtemp(prefix="test"),
-                      help="Root directory for datadirs")
-    (options, args) = parser.parse_args()
-
-    os.environ['PATH'] = options.srcdir+":"+os.environ['PATH']
-
-    check_json_precision()
-
-    success = False
-    nodes = []
-    try:
-        print("Initializing test directory "+options.tmpdir)
-        if not os.path.isdir(options.tmpdir):
-            os.makedirs(options.tmpdir)
-        initialize_chain(options.tmpdir)
-
-        nodes = start_nodes(2, options.tmpdir)
-        connect_nodes(nodes[1], 0)
-        sync_blocks(nodes)
-
-        run_test(nodes)
-
-        success = True
-
-    except AssertionError as e:
-        print("Assertion failed: "+e.message)
-    except Exception as e:
-        print("Unexpected exception caught during testing: "+str(e))
-        traceback.print_tb(sys.exc_info()[2])
-
-    if not options.nocleanup:
-        print("Cleaning up")
-        stop_nodes(nodes)
-        wait_bitcoinds()
-        shutil.rmtree(options.tmpdir)
-
-    if success:
-        print("Tests successful")
-        sys.exit(0)
-    else:
-        print("Failed")
-        sys.exit(1)
-
 if __name__ == '__main__':
-    main()
+    ReceivedByTest().main()
--- a/qa/rpc-tests/skeleton.py
+++ b/qa/rpc-tests/skeleton.py
@ -1,83 +0,0 @@
-#!/usr/bin/env python
-# Copyright (c) 2014 The Bitcoin Core developers
-# Distributed under the MIT/X11 software license, see the accompanying
-# file COPYING or http://www.opensource.org/licenses/mit-license.php.
-
-# Skeleton for python-based regression tests using
-# JSON-RPC
-
-
-# Add python-bitcoinrpc to module search path:
-import os
-import sys
-sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "python-bitcoinrpc"))
-
-import json
-import shutil
-import subprocess
-import tempfile
-import traceback
-
-from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
-from util import *
-
-
-def run_test(nodes):
-    # Replace this as appropriate
-    for node in nodes:
-        assert_equal(node.getblockcount(), 200)
-        assert_equal(node.getbalance(), 25*50)
-
-def main():
-    import optparse
-
-    parser = optparse.OptionParser(usage="%prog [options]")
-    parser.add_option("--nocleanup", dest="nocleanup", default=False, action="store_true",
-                      help="Leave bitcoinds and test.* datadir on exit or error")
-    parser.add_option("--srcdir", dest="srcdir", default="../../src",
-                      help="Source directory containing bitcoind/bitcoin-cli (default: %default%)")
-    parser.add_option("--tmpdir", dest="tmpdir", default=tempfile.mkdtemp(prefix="test"),
-                      help="Root directory for datadirs")
-    (options, args) = parser.parse_args()
-
-    os.environ['PATH'] = options.srcdir+":"+os.environ['PATH']
-
-    check_json_precision()
-
-    success = False
-    nodes = []
-    try:
-        print("Initializing test directory "+options.tmpdir)
-        if not os.path.isdir(options.tmpdir):
-            os.makedirs(options.tmpdir)
-        initialize_chain(options.tmpdir)
-
-        nodes = start_nodes(2, options.tmpdir)
-        connect_nodes(nodes[1], 0)
-        sync_blocks(nodes)
-
-        run_test(nodes)
-
-        success = True
-
-    except AssertionError as e:
-        print("Assertion failed: "+e.message)
-    except Exception as e:
-        print("Unexpected exception caught during testing: "+str(e))
-        traceback.print_tb(sys.exc_info()[2])
-
-    if not options.nocleanup:
-        print("Cleaning up")
-        stop_nodes(nodes)
-        wait_bitcoinds()
-        shutil.rmtree(options.tmpdir)
-
-    if success:
-        print("Tests successful")
-        sys.exit(0)
-    else:
-        print("Failed")
-        sys.exit(1)
-
-if __name__ == '__main__':
-    main()
--- a/qa/rpc-tests/smartfees.py
+++ b/qa/rpc-tests/smartfees.py
@ -4,23 +4,14 @@
 # Test fee estimation code
 #

-# Add python-bitcoinrpc to module search path:
-import os
-import sys
-sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "python-bitcoinrpc"))
-
-import json
-import random
-import shutil
-import subprocess
-import tempfile
-import traceback
-
+from test_framework import BitcoinTestFramework
 from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
 from util import *

+class EstimateFeeTest(BitcoinTestFramework):

-def run_test(nodes, test_dir):
+    def setup_network(self, test_dir):
+        nodes = []
        nodes.append(start_node(0, test_dir,
                            ["-debug=mempool", "-debug=estimatefee"]))
        # Node1 mines small-but-not-tiny blocks, and allows free transactions.
@ -40,7 +31,10 @@ def run_test(nodes, test_dir):
        connect_nodes(nodes[2], 0)

        sync_blocks(nodes)
+        return nodes
        
+
+    def run_test(self, nodes):
        # Prime the memory pool with pairs of transactions
        # (high-priority, random fee and zero-priority, random fee)
        min_fee = Decimal("0.001")
@ -90,53 +84,6 @@ def run_test(nodes, test_dir):
        final_estimates = [ nodes[0].estimatefee(i) for i in range(1,20) ]
        print("Final fee estimates: "+str([ str(e) for e in final_estimates]))

-def main():
-    import optparse
-
-    parser = optparse.OptionParser(usage="%prog [options]")
-    parser.add_option("--nocleanup", dest="nocleanup", default=False, action="store_true",
-                      help="Leave bitcoinds and test.* datadir on exit or error")
-    parser.add_option("--srcdir", dest="srcdir", default="../../src",
-                      help="Source directory containing bitcoind/bitcoin-cli (default: %default%)")
-    parser.add_option("--tmpdir", dest="tmpdir", default=tempfile.mkdtemp(prefix="test"),
-                      help="Root directory for datadirs")
-    (options, args) = parser.parse_args()
-
-    os.environ['PATH'] = options.srcdir+":"+os.environ['PATH']
-
-    check_json_precision()
-
-    success = False
-    nodes = []
-    try:
-        print("Initializing test directory "+options.tmpdir)
-        print("  node0 running at: 127.0.0.1:%d"%(p2p_port(0)))
-        if not os.path.isdir(options.tmpdir):
-            os.makedirs(options.tmpdir)
-        initialize_chain(options.tmpdir)
-
-        run_test(nodes, options.tmpdir)
-
-        success = True
-
-    except AssertionError as e:
-        print("Assertion failed: "+e.message)
-    except Exception as e:
-        print("Unexpected exception caught during testing: "+str(e))
-        traceback.print_tb(sys.exc_info()[2])
-
-    if not options.nocleanup:
-        print("Cleaning up")
-        stop_nodes(nodes)
-        wait_bitcoinds()
-        shutil.rmtree(options.tmpdir)
-
-    if success:
-        print("Tests successful")
-        sys.exit(0)
-    else:
-        print("Failed")
-        sys.exit(1)

 if __name__ == '__main__':
-    main()
+    EstimateFeeTest().main()
--- a/qa/rpc-tests/test_framework.py
+++ b/qa/rpc-tests/test_framework.py
@ -0,0 +1,88 @@
+#!/usr/bin/env python
+# Copyright (c) 2014 The Bitcoin Core developers
+# Distributed under the MIT/X11 software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+# Base class for RPC testing
+
+# Add python-bitcoinrpc to module search path:
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "python-bitcoinrpc"))
+
+import shutil
+import tempfile
+import traceback
+
+from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
+from util import *
+
+
+class BitcoinTestFramework(object):
+
+    # These may be over-ridden by subclasses:
+    def run_test(self, nodes):
+            assert_equal(node.getblockcount(), 200)
+            assert_equal(node.getbalance(), 25*50)
+
+    def add_options(self, parser):
+        pass
+
+    def setup_chain(self, tmp_directory):
+        print("Initializing test directory "+tmp_directory)
+        initialize_chain(tmp_directory)
+
+    def setup_network(self, tmp_directory):
+        nodes = start_nodes(2, tmp_directory)
+        connect_nodes(nodes[1], 0)
+        sync_blocks(nodes)
+        return nodes
+
+    def main(self):
+        import optparse
+
+        parser = optparse.OptionParser(usage="%prog [options]")
+        parser.add_option("--nocleanup", dest="nocleanup", default=False, action="store_true",
+                          help="Leave bitcoinds and test.* datadir on exit or error")
+        parser.add_option("--srcdir", dest="srcdir", default="../../src",
+                          help="Source directory containing bitcoind/bitcoin-cli (default: %default%)")
+        parser.add_option("--tmpdir", dest="tmpdir", default=tempfile.mkdtemp(prefix="test"),
+                          help="Root directory for datadirs")
+        self.add_options(parser)
+        (self.options, self.args) = parser.parse_args()
+
+        os.environ['PATH'] = self.options.srcdir+":"+os.environ['PATH']
+
+        check_json_precision()
+
+        success = False
+        nodes = []
+        try:
+            if not os.path.isdir(self.options.tmpdir):
+                os.makedirs(self.options.tmpdir)
+            self.setup_chain(self.options.tmpdir)
+
+            nodes = self.setup_network(self.options.tmpdir)
+
+            self.run_test(nodes)
+
+            success = True
+
+        except AssertionError as e:
+            print("Assertion failed: "+e.message)
+        except Exception as e:
+            print("Unexpected exception caught during testing: "+str(e))
+            traceback.print_tb(sys.exc_info()[2])
+
+        if not self.options.nocleanup:
+            print("Cleaning up")
+            stop_nodes(nodes)
+            wait_bitcoinds()
+            shutil.rmtree(self.options.tmpdir)
+
+        if success:
+            print("Tests successful")
+            sys.exit(0)
+        else:
+            print("Failed")
+            sys.exit(1)