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.

1 files changed, 111 insertions, 170 deletions

diff --git a/qa/rpc-tests/receivedby.py b/qa/rpc-tests/receivedby.py
index 7f2d79b3c1..61f5e0452b 100755
--- 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,164 +52,115 @@ 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):
-    '''
-        listreceivedbyaddress Test
-    '''
-    # Send from node 0 to 1
-    addr = nodes[1].getnewaddress()
-    txid = nodes[0].sendtoaddress(addr, 0.1)
-    sync_mempools(nodes)
-    
-    #Check not listed in listreceivedbyaddress because has 0 confirmations
-    check_array_result(nodes[1].listreceivedbyaddress(),
-                       {"address":addr},
-                       { },
-                       True)
-    #Bury Tx under 10 block so it will be returned by listreceivedbyaddress
-    nodes[1].setgenerate(True, 10)
-    sync_blocks(nodes)
-    check_array_result(nodes[1].listreceivedbyaddress(),
-                       {"address":addr},
-                       {"address":addr, "account":"", "amount":Decimal("0.1"), "confirmations":10, "txids":[txid,]})
-    #With min confidence < 10
-    check_array_result(nodes[1].listreceivedbyaddress(5),
-                       {"address":addr},
-                       {"address":addr, "account":"", "amount":Decimal("0.1"), "confirmations":10, "txids":[txid,]})
-    #With min confidence > 10, should not find Tx
-    check_array_result(nodes[1].listreceivedbyaddress(11),{"address":addr},{ },True)
-
-    #Empty Tx
-    addr = nodes[1].getnewaddress()
-    check_array_result(nodes[1].listreceivedbyaddress(0,True),
-                       {"address":addr},
-                       {"address":addr, "account":"", "amount":0, "confirmations":0, "txids":[]})
-
-    '''
-        getreceivedbyaddress Test
-    '''
-    # Send from node 0 to 1
-    addr = nodes[1].getnewaddress()
-    txid = nodes[0].sendtoaddress(addr, 0.1)
-    sync_mempools(nodes)
-
-    #Check balance is 0 because of 0 confirmations
-    balance = nodes[1].getreceivedbyaddress(addr)
-    if balance != Decimal("0.0"):
-        raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
-
-    #Check balance is 0.1
-    balance = nodes[1].getreceivedbyaddress(addr,0)
-    if balance != Decimal("0.1"):
-        raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
-
-    #Bury Tx under 10 block so it will be returned by the default getreceivedbyaddress
-    nodes[1].setgenerate(True, 10)
-    sync_blocks(nodes)
-    balance = nodes[1].getreceivedbyaddress(addr)
-    if balance != Decimal("0.1"):
-        raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
+class ReceivedByTest(BitcoinTestFramework):
 
-    '''
-        listreceivedbyaccount + getreceivedbyaccount Test
-    '''
-    #set pre-state
-    addrArr = nodes[1].getnewaddress()
-    account = nodes[1].getaccount(addrArr)
-    received_by_account_json = get_sub_array_from_array(nodes[1].listreceivedbyaccount(),{"account":account})
-    if len(received_by_account_json) == 0:
-        raise AssertionError("No accounts found in node")
-    balance_by_account = rec_by_accountArr = nodes[1].getreceivedbyaccount(account)
-
-    txid = nodes[0].sendtoaddress(addr, 0.1)
-
-    # listreceivedbyaccount should return received_by_account_json because of 0 confirmations
-    check_array_result(nodes[1].listreceivedbyaccount(),
-                   {"account":account},
-                   received_by_account_json)
-
-    # getreceivedbyaddress should return same balance because of 0 confirmations
-    balance = nodes[1].getreceivedbyaccount(account)
-    if balance != balance_by_account:
-        raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))
-
-    nodes[1].setgenerate(True, 10)
-    sync_blocks(nodes)
-    # listreceivedbyaccount should return updated account balance
-    check_array_result(nodes[1].listreceivedbyaccount(),
-                       {"account":account},
-                       {"account":received_by_account_json["account"], "amount":(received_by_account_json["amount"] + Decimal("0.1"))})
-
-    # getreceivedbyaddress should return updates balance
-    balance = nodes[1].getreceivedbyaccount(account)
-    if balance != balance_by_account + Decimal("0.1"):
-        raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))
-
-    #Create a new account named "mynewaccount" that has a 0 balance
-    nodes[1].getaccountaddress("mynewaccount")
-    received_by_account_json = get_sub_array_from_array(nodes[1].listreceivedbyaccount(0,True),{"account":"mynewaccount"})
-    if len(received_by_account_json) == 0:
-        raise AssertionError("No accounts found in node")
-
-    # Test includeempty of listreceivedbyaccount
-    if received_by_account_json["amount"] != Decimal("0.0"):
-        raise AssertionError("Wrong balance returned by listreceivedbyaccount, %0.2f"%(received_by_account_json["amount"]))
-
-    # Test getreceivedbyaccount for 0 amount accounts
-    balance = nodes[1].getreceivedbyaccount("mynewaccount")
-    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)
+    def run_test(self, nodes):
+        '''
+        listreceivedbyaddress Test
+        '''
+        # Send from node 0 to 1
+        addr = nodes[1].getnewaddress()
+        txid = nodes[0].sendtoaddress(addr, 0.1)
+        sync_mempools(nodes)
+
+        #Check not listed in listreceivedbyaddress because has 0 confirmations
+        check_array_result(nodes[1].listreceivedbyaddress(),
+                           {"address":addr},
+                           { },
+                           True)
+        #Bury Tx under 10 block so it will be returned by listreceivedbyaddress
+        nodes[1].setgenerate(True, 10)
         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)
+        check_array_result(nodes[1].listreceivedbyaddress(),
+                           {"address":addr},
+                           {"address":addr, "account":"", "amount":Decimal("0.1"), "confirmations":10, "txids":[txid,]})
+        #With min confidence < 10
+        check_array_result(nodes[1].listreceivedbyaddress(5),
+                           {"address":addr},
+                           {"address":addr, "account":"", "amount":Decimal("0.1"), "confirmations":10, "txids":[txid,]})
+        #With min confidence > 10, should not find Tx
+        check_array_result(nodes[1].listreceivedbyaddress(11),{"address":addr},{ },True)
+
+        #Empty Tx
+        addr = nodes[1].getnewaddress()
+        check_array_result(nodes[1].listreceivedbyaddress(0,True),
+                           {"address":addr},
+                           {"address":addr, "account":"", "amount":0, "confirmations":0, "txids":[]})
+
+        '''
+            getreceivedbyaddress Test
+        '''
+        # Send from node 0 to 1
+        addr = nodes[1].getnewaddress()
+        txid = nodes[0].sendtoaddress(addr, 0.1)
+        sync_mempools(nodes)
+
+        #Check balance is 0 because of 0 confirmations
+        balance = nodes[1].getreceivedbyaddress(addr)
+        if balance != Decimal("0.0"):
+            raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
+
+        #Check balance is 0.1
+        balance = nodes[1].getreceivedbyaddress(addr,0)
+        if balance != Decimal("0.1"):
+            raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
+
+        #Bury Tx under 10 block so it will be returned by the default getreceivedbyaddress
+        nodes[1].setgenerate(True, 10)
+        sync_blocks(nodes)
+        balance = nodes[1].getreceivedbyaddress(addr)
+        if balance != Decimal("0.1"):
+            raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
+
+        '''
+            listreceivedbyaccount + getreceivedbyaccount Test
+        '''
+        #set pre-state
+        addrArr = nodes[1].getnewaddress()
+        account = nodes[1].getaccount(addrArr)
+        received_by_account_json = get_sub_array_from_array(nodes[1].listreceivedbyaccount(),{"account":account})
+        if len(received_by_account_json) == 0:
+            raise AssertionError("No accounts found in node")
+        balance_by_account = rec_by_accountArr = nodes[1].getreceivedbyaccount(account)
+
+        txid = nodes[0].sendtoaddress(addr, 0.1)
+
+        # listreceivedbyaccount should return received_by_account_json because of 0 confirmations
+        check_array_result(nodes[1].listreceivedbyaccount(),
+                           {"account":account},
+                           received_by_account_json)
+
+        # getreceivedbyaddress should return same balance because of 0 confirmations
+        balance = nodes[1].getreceivedbyaccount(account)
+        if balance != balance_by_account:
+            raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))
+
+        nodes[1].setgenerate(True, 10)
+        sync_blocks(nodes)
+        # listreceivedbyaccount should return updated account balance
+        check_array_result(nodes[1].listreceivedbyaccount(),
+                           {"account":account},
+                           {"account":received_by_account_json["account"], "amount":(received_by_account_json["amount"] + Decimal("0.1"))})
+
+        # getreceivedbyaddress should return updates balance
+        balance = nodes[1].getreceivedbyaccount(account)
+        if balance != balance_by_account + Decimal("0.1"):
+            raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))
+
+        #Create a new account named "mynewaccount" that has a 0 balance
+        nodes[1].getaccountaddress("mynewaccount")
+        received_by_account_json = get_sub_array_from_array(nodes[1].listreceivedbyaccount(0,True),{"account":"mynewaccount"})
+        if len(received_by_account_json) == 0:
+            raise AssertionError("No accounts found in node")
+
+        # Test includeempty of listreceivedbyaccount
+        if received_by_account_json["amount"] != Decimal("0.0"):
+            raise AssertionError("Wrong balance returned by listreceivedbyaccount, %0.2f"%(received_by_account_json["amount"]))
+
+        # Test getreceivedbyaccount for 0 amount accounts
+        balance = nodes[1].getreceivedbyaccount("mynewaccount")
+        if balance != Decimal("0.0"):
+            raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))
 
 if __name__ == '__main__':
-    main()
+    ReceivedByTest().main()