2016-03-19 20:58:06 +01:00
#!/usr/bin/env python3
# Copyright (c) 2014-2016 The Bitcoin Core developers
2014-10-23 03:48:19 +02:00
# Distributed under the MIT software license, see the accompanying
2014-07-08 18:07:23 +02:00
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
2017-01-18 00:34:40 +01:00
""" Base class for RPC testing. """
2014-07-08 18:07:23 +02:00
2017-02-16 20:01:45 +01:00
from collections import deque
2017-05-18 22:36:39 +02:00
from enum import Enum
2016-05-09 19:55:49 +02:00
import logging
import optparse
2014-07-08 18:07:23 +02:00
import os
import shutil
2017-03-23 21:49:02 +01:00
import subprocess
import sys
2014-07-08 18:07:23 +02:00
import tempfile
2017-03-21 15:05:59 +01:00
import time
2017-06-07 17:44:17 +02:00
import traceback
2014-07-08 18:07:23 +02:00
2015-10-11 07:41:19 +02:00
from . util import (
2017-03-23 21:49:02 +01:00
PortSeed ,
MAX_NODES ,
bitcoind_processes ,
check_json_precision ,
2015-10-11 07:41:19 +02:00
connect_nodes_bi ,
2017-03-23 21:49:02 +01:00
disable_mocktime ,
2017-04-03 15:34:04 +02:00
disconnect_nodes ,
2017-03-23 21:49:02 +01:00
enable_coverage ,
enable_mocktime ,
get_mocktime ,
get_rpc_proxy ,
initialize_datadir ,
2017-06-05 19:50:25 +02:00
get_datadir_path ,
2017-03-23 21:49:02 +01:00
log_filename ,
p2p_port ,
rpc_url ,
set_node_times ,
2017-05-08 17:04:58 +02:00
_start_node ,
_start_nodes ,
_stop_node ,
_stop_nodes ,
2015-10-11 07:41:19 +02:00
sync_blocks ,
sync_mempools ,
2017-03-23 21:49:02 +01:00
wait_for_bitcoind_start ,
2015-10-11 07:41:19 +02:00
)
2016-05-09 19:55:49 +02:00
from . authproxy import JSONRPCException
2014-07-08 18:07:23 +02:00
2017-05-18 22:36:39 +02:00
class TestStatus ( Enum ) :
PASSED = 1
FAILED = 2
SKIPPED = 3
TEST_EXIT_PASSED = 0
TEST_EXIT_FAILED = 1
TEST_EXIT_SKIPPED = 77
2014-07-08 18:07:23 +02:00
class BitcoinTestFramework ( object ) :
2017-03-23 22:48:29 +01:00
""" Base class for a bitcoin test script.
Individual bitcoin test scripts should subclass this class and override the following methods :
- __init__ ( )
- add_options ( )
- setup_chain ( )
- setup_network ( )
- run_test ( )
The main ( ) method should not be overridden .
This class also contains various public and private helper methods . """
# Methods to override in subclass test scripts.
2016-05-14 13:01:31 +02:00
def __init__ ( self ) :
self . num_nodes = 4
self . setup_clean_chain = False
self . nodes = None
2014-07-08 18:07:23 +02:00
def add_options ( self , parser ) :
pass
2014-10-20 14:14:04 +02:00
def setup_chain ( self ) :
2017-06-07 17:44:17 +02:00
self . log . info ( " Initializing test directory " + self . options . tmpdir )
2016-05-14 13:01:31 +02:00
if self . setup_clean_chain :
2017-03-23 21:49:02 +01:00
self . _initialize_chain_clean ( self . options . tmpdir , self . num_nodes )
2016-05-14 13:01:31 +02:00
else :
2017-03-23 21:49:02 +01:00
self . _initialize_chain ( self . options . tmpdir , self . num_nodes , self . options . cachedir )
2015-01-14 12:45:11 +01:00
2017-04-03 15:34:04 +02:00
def setup_network ( self ) :
self . setup_nodes ( )
2014-10-20 14:14:04 +02:00
# Connect the nodes as a "chain". This allows us
# to split the network between nodes 1 and 2 to get
# two halves that can work on competing chains.
2017-04-03 15:34:04 +02:00
for i in range ( self . num_nodes - 1 ) :
connect_nodes_bi ( self . nodes , i , i + 1 )
2014-10-20 14:14:04 +02:00
self . sync_all ( )
2017-03-23 22:48:29 +01:00
def setup_nodes ( self ) :
extra_args = None
if hasattr ( self , " extra_args " ) :
extra_args = self . extra_args
2017-05-08 17:04:58 +02:00
self . nodes = _start_nodes ( self . num_nodes , self . options . tmpdir , extra_args )
2017-04-03 15:34:04 +02:00
2017-03-23 22:48:29 +01:00
def run_test ( self ) :
raise NotImplementedError
2014-10-20 14:14:04 +02:00
2017-03-23 22:48:29 +01:00
# Main function. This should not be overridden by the subclass test scripts.
2014-07-08 18:07:23 +02:00
def main ( self ) :
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 " )
2015-04-23 14:19:00 +02:00
parser . add_option ( " --noshutdown " , dest = " noshutdown " , default = False , action = " store_true " ,
help = " Don ' t stop bitcoinds after the test execution " )
2017-06-07 17:44:17 +02:00
parser . add_option ( " --srcdir " , dest = " srcdir " , default = os . path . normpath ( os . path . dirname ( os . path . realpath ( __file__ ) ) + " /../../../src " ) ,
2015-04-23 14:19:00 +02:00
help = " Source directory containing bitcoind/bitcoin-cli (default: %d efault) " )
2017-06-07 17:44:17 +02:00
parser . add_option ( " --cachedir " , dest = " cachedir " , default = os . path . normpath ( os . path . dirname ( os . path . realpath ( __file__ ) ) + " /../../cache " ) ,
2016-08-07 23:06:27 +02:00
help = " Directory for caching pregenerated datadirs " )
2017-05-18 23:33:33 +02:00
parser . add_option ( " --tmpdir " , dest = " tmpdir " , help = " Root directory for datadirs " )
2017-02-15 17:36:46 +01:00
parser . add_option ( " -l " , " --loglevel " , dest = " loglevel " , default = " INFO " ,
help = " log events at this level and higher to the console. Can be set to DEBUG, INFO, WARNING, ERROR or CRITICAL. Passing --loglevel DEBUG will output all logs to console. Note that logs at all levels are always written to the test_framework.log file in the temporary test directory. " )
2014-10-23 19:11:20 +02:00
parser . add_option ( " --tracerpc " , dest = " trace_rpc " , default = False , action = " store_true " ,
help = " Print out all RPC calls as they are made " )
2016-05-09 19:55:49 +02:00
parser . add_option ( " --portseed " , dest = " port_seed " , default = os . getpid ( ) , type = ' int ' ,
help = " The seed to use for assigning port numbers (default: current process id) " )
2015-10-11 07:41:19 +02:00
parser . add_option ( " --coveragedir " , dest = " coveragedir " ,
help = " Write tested RPC commands into this directory " )
2017-05-01 21:12:49 +02:00
parser . add_option ( " --configfile " , dest = " configfile " ,
help = " Location of the test framework config file " )
2014-07-08 18:07:23 +02:00
self . add_options ( parser )
( self . options , self . args ) = parser . parse_args ( )
2015-10-11 07:41:19 +02:00
if self . options . coveragedir :
enable_coverage ( self . options . coveragedir )
2016-05-09 19:55:49 +02:00
PortSeed . n = self . options . port_seed
2017-06-07 17:44:17 +02:00
os . environ [ ' PATH ' ] = self . options . srcdir + " : " + self . options . srcdir + " /qt: " + os . environ [ ' PATH ' ]
2014-07-08 18:07:23 +02:00
check_json_precision ( )
2017-02-15 17:36:46 +01:00
# Set up temp directory and start logging
2017-05-18 23:33:33 +02:00
if self . options . tmpdir :
os . makedirs ( self . options . tmpdir , exist_ok = False )
else :
self . options . tmpdir = tempfile . mkdtemp ( prefix = " test " )
2017-02-15 17:36:46 +01:00
self . _start_logging ( )
2017-05-18 22:36:39 +02:00
success = TestStatus . FAILED
2017-02-15 17:36:46 +01:00
2014-07-08 18:07:23 +02:00
try :
2014-10-20 14:14:04 +02:00
self . setup_chain ( )
self . setup_network ( )
self . run_test ( )
2017-05-18 22:36:39 +02:00
success = TestStatus . PASSED
2014-07-09 03:24:40 +02:00
except JSONRPCException as e :
2017-02-15 17:36:46 +01:00
self . log . exception ( " JSONRPC error " )
2017-05-18 22:36:39 +02:00
except SkipTest as e :
self . log . warning ( " Test Skipped: %s " % e . message )
success = TestStatus . SKIPPED
2014-07-08 18:07:23 +02:00
except AssertionError as e :
2017-02-15 17:36:46 +01:00
self . log . exception ( " Assertion failed " )
2016-04-13 09:24:07 +02:00
except KeyError as e :
2017-02-15 17:36:46 +01:00
self . log . exception ( " Key error " )
2014-07-08 18:07:23 +02:00
except Exception as e :
2017-02-15 17:36:46 +01:00
self . log . exception ( " Unexpected exception caught during testing " )
2016-04-27 22:29:52 +02:00
except KeyboardInterrupt as e :
2017-02-15 17:36:46 +01:00
self . log . warning ( " Exiting after keyboard interrupt " )
2014-07-08 18:07:23 +02:00
2015-04-23 14:19:00 +02:00
if not self . options . noshutdown :
2017-02-15 17:36:46 +01:00
self . log . info ( " Stopping nodes " )
2017-05-18 22:36:39 +02:00
if self . nodes :
self . stop_nodes ( )
2015-04-23 14:19:00 +02:00
else :
2017-02-15 17:36:46 +01:00
self . log . info ( " Note: bitcoinds were not stopped and may still be running " )
2015-04-20 11:50:33 +02:00
2017-05-18 22:36:39 +02:00
if not self . options . nocleanup and not self . options . noshutdown and success != TestStatus . FAILED :
2017-02-15 17:36:46 +01:00
self . log . info ( " Cleaning up " )
2014-07-08 18:07:23 +02:00
shutil . rmtree ( self . options . tmpdir )
2016-05-24 17:35:06 +02:00
else :
2017-02-15 17:36:46 +01:00
self . log . warning ( " Not cleaning up dir %s " % self . options . tmpdir )
2016-11-30 17:16:05 +01:00
if os . getenv ( " PYTHON_DEBUG " , " " ) :
# Dump the end of the debug logs, to aid in debugging rare
# travis failures.
import glob
2017-02-16 20:01:45 +01:00
filenames = [ self . options . tmpdir + " /test_framework.log " ]
filenames + = glob . glob ( self . options . tmpdir + " /node*/regtest/debug.log " )
2016-11-30 17:16:05 +01:00
MAX_LINES_TO_PRINT = 1000
2017-02-16 20:01:45 +01:00
for fn in filenames :
try :
with open ( fn , ' r ' ) as f :
2017-06-07 17:44:17 +02:00
print ( " From " , fn , " : " )
2017-02-16 20:01:45 +01:00
print ( " " . join ( deque ( f , MAX_LINES_TO_PRINT ) ) )
except OSError :
print ( " Opening file %s failed. " % fn )
traceback . print_exc ( )
2017-05-18 22:36:39 +02:00
if success == TestStatus . PASSED :
2017-02-15 17:36:46 +01:00
self . log . info ( " Tests successful " )
2017-05-18 22:36:39 +02:00
sys . exit ( TEST_EXIT_PASSED )
elif success == TestStatus . SKIPPED :
self . log . info ( " Test skipped " )
sys . exit ( TEST_EXIT_SKIPPED )
2014-07-08 18:07:23 +02:00
else :
2017-02-15 17:36:46 +01:00
self . log . error ( " Test failed. Test logging available at %s /test_framework.log " , self . options . tmpdir )
logging . shutdown ( )
2017-05-18 22:36:39 +02:00
sys . exit ( TEST_EXIT_FAILED )
2015-04-28 18:39:47 +02:00
2017-03-23 22:48:29 +01:00
# Public helper methods. These can be accessed by the subclass test scripts.
def start_node ( self , i , dirname , extra_args = None , rpchost = None , timewait = None , binary = None , stderr = None ) :
2017-05-08 17:04:58 +02:00
return _start_node ( i , dirname , extra_args , rpchost , timewait , binary , stderr )
2017-03-23 22:48:29 +01:00
def start_nodes ( self , num_nodes , dirname , extra_args = None , rpchost = None , timewait = None , binary = None ) :
2017-05-08 17:04:58 +02:00
return _start_nodes ( num_nodes , dirname , extra_args , rpchost , timewait , binary )
2017-03-23 22:48:29 +01:00
def stop_node ( self , num_node ) :
2017-05-08 17:04:58 +02:00
_stop_node ( self . nodes [ num_node ] , num_node )
2017-03-23 22:48:29 +01:00
def stop_nodes ( self ) :
2017-05-08 17:04:58 +02:00
_stop_nodes ( self . nodes )
2017-03-23 22:48:29 +01:00
def split_network ( self ) :
"""
Split the network of four nodes into nodes 0 / 1 and 2 / 3.
"""
disconnect_nodes ( self . nodes [ 1 ] , 2 )
disconnect_nodes ( self . nodes [ 2 ] , 1 )
self . sync_all ( [ self . nodes [ : 2 ] , self . nodes [ 2 : ] ] )
def join_network ( self ) :
"""
Join the ( previously split ) network halves together .
"""
connect_nodes_bi ( self . nodes , 1 , 2 )
self . sync_all ( )
def sync_all ( self , node_groups = None ) :
if not node_groups :
node_groups = [ self . nodes ]
for group in node_groups :
sync_blocks ( group )
sync_mempools ( group )
# Private helper methods. These should not be accessed by the subclass test scripts.
2017-02-15 17:36:46 +01:00
def _start_logging ( self ) :
# Add logger and logging handlers
self . log = logging . getLogger ( ' TestFramework ' )
self . log . setLevel ( logging . DEBUG )
# Create file handler to log all messages
fh = logging . FileHandler ( self . options . tmpdir + ' /test_framework.log ' )
fh . setLevel ( logging . DEBUG )
# Create console handler to log messages to stderr. By default this logs only error messages, but can be configured with --loglevel.
ch = logging . StreamHandler ( sys . stdout )
# User can provide log level as a number or string (eg DEBUG). loglevel was caught as a string, so try to convert it to an int
ll = int ( self . options . loglevel ) if self . options . loglevel . isdigit ( ) else self . options . loglevel . upper ( )
ch . setLevel ( ll )
# Format logs the same as bitcoind's debug.log with microprecision (so log files can be concatenated and sorted)
2017-06-07 17:44:17 +02:00
formatter = logging . Formatter ( fmt = ' %(asctime)s . %(msecs)03d 000 %(name)s ( %(levelname)s ): %(message)s ' , datefmt = ' % Y- % m- %d % H: % M: % S ' )
2017-03-21 15:05:59 +01:00
formatter . converter = time . gmtime
2017-02-15 17:36:46 +01:00
fh . setFormatter ( formatter )
ch . setFormatter ( formatter )
# add the handlers to the logger
self . log . addHandler ( fh )
self . log . addHandler ( ch )
if self . options . trace_rpc :
rpc_logger = logging . getLogger ( " BitcoinRPC " )
rpc_logger . setLevel ( logging . DEBUG )
rpc_handler = logging . StreamHandler ( sys . stdout )
rpc_handler . setLevel ( logging . DEBUG )
rpc_logger . addHandler ( rpc_handler )
2015-04-28 18:39:47 +02:00
2017-03-23 21:49:02 +01:00
def _initialize_chain ( self , test_dir , num_nodes , cachedir ) :
""" Initialize a pre-mined blockchain for use by the test.
Create a cache of a 200 - block - long chain ( with wallet ) for MAX_NODES
Afterward , create num_nodes copies from the cache . """
assert num_nodes < = MAX_NODES
create_cache = False
for i in range ( MAX_NODES ) :
if not os . path . isdir ( os . path . join ( cachedir , ' node ' + str ( i ) ) ) :
create_cache = True
break
if create_cache :
self . log . debug ( " Creating data directories from cached datadir " )
# find and delete old cache directories if any exist
for i in range ( MAX_NODES ) :
if os . path . isdir ( os . path . join ( cachedir , " node " + str ( i ) ) ) :
shutil . rmtree ( os . path . join ( cachedir , " node " + str ( i ) ) )
# Create cache directories, run bitcoinds:
for i in range ( MAX_NODES ) :
datadir = initialize_datadir ( cachedir , i )
args = [ os . getenv ( " BITCOIND " , " bitcoind " ) , " -server " , " -keypool=1 " , " -datadir= " + datadir , " -discover=0 " ]
if i > 0 :
args . append ( " -connect=127.0.0.1: " + str ( p2p_port ( 0 ) ) )
bitcoind_processes [ i ] = subprocess . Popen ( args )
self . log . debug ( " initialize_chain: bitcoind started, waiting for RPC to come up " )
2017-06-05 19:50:25 +02:00
wait_for_bitcoind_start ( bitcoind_processes [ i ] , datadir , i )
2017-03-23 21:49:02 +01:00
self . log . debug ( " initialize_chain: RPC successfully started " )
2017-03-23 21:56:45 +01:00
self . nodes = [ ]
2017-03-23 21:49:02 +01:00
for i in range ( MAX_NODES ) :
try :
2017-06-05 19:50:25 +02:00
self . nodes . append ( get_rpc_proxy ( rpc_url ( get_datadir_path ( cachedir , i ) , i ) , i ) )
2017-03-23 21:49:02 +01:00
except :
self . log . exception ( " Error connecting to node %d " % i )
sys . exit ( 1 )
# Create a 200-block-long chain; each of the 4 first nodes
# gets 25 mature blocks and 25 immature.
# Note: To preserve compatibility with older versions of
# initialize_chain, only 4 nodes will generate coins.
#
# blocks are created with timestamps 10 minutes apart
# starting from 2010 minutes in the past
enable_mocktime ( )
block_time = get_mocktime ( ) - ( 201 * 10 * 60 )
for i in range ( 2 ) :
for peer in range ( 4 ) :
for j in range ( 25 ) :
2017-03-23 21:56:45 +01:00
set_node_times ( self . nodes , block_time )
self . nodes [ peer ] . generate ( 1 )
2017-03-23 21:49:02 +01:00
block_time + = 10 * 60
# Must sync before next peer starts generating blocks
2017-03-23 21:56:45 +01:00
sync_blocks ( self . nodes )
2017-03-23 21:49:02 +01:00
# Shut them down, and clean up cache directories:
2017-03-23 21:56:45 +01:00
self . stop_nodes ( )
self . nodes = [ ]
2017-03-23 21:49:02 +01:00
disable_mocktime ( )
for i in range ( MAX_NODES ) :
os . remove ( log_filename ( cachedir , i , " debug.log " ) )
os . remove ( log_filename ( cachedir , i , " db.log " ) )
os . remove ( log_filename ( cachedir , i , " peers.dat " ) )
os . remove ( log_filename ( cachedir , i , " fee_estimates.dat " ) )
for i in range ( num_nodes ) :
from_dir = os . path . join ( cachedir , " node " + str ( i ) )
to_dir = os . path . join ( test_dir , " node " + str ( i ) )
shutil . copytree ( from_dir , to_dir )
initialize_datadir ( test_dir , i ) # Overwrite port/rpcport in bitcoin.conf
def _initialize_chain_clean ( self , test_dir , num_nodes ) :
""" Initialize empty blockchain for use by the test.
Create an empty blockchain and num_nodes wallets .
Useful if a test case wants complete control over initialization . """
for i in range ( num_nodes ) :
initialize_datadir ( test_dir , i )
2015-04-28 18:39:47 +02:00
class ComparisonTestFramework ( BitcoinTestFramework ) :
2017-06-07 17:44:17 +02:00
""" Test framework for doing p2p comparison testing
Sets up some bitcoind binaries :
- 1 binary : test binary
- 2 binaries : 1 test binary , 1 ref binary
- n > 2 binaries : 1 test binary , n - 1 ref binaries """
2015-04-28 18:39:47 +02:00
def __init__ ( self ) :
2016-05-14 13:01:31 +02:00
super ( ) . __init__ ( )
2015-04-28 18:39:47 +02:00
self . num_nodes = 2
2016-05-14 13:01:31 +02:00
self . setup_clean_chain = True
2015-04-28 18:39:47 +02:00
def add_options ( self , parser ) :
2015-04-29 15:18:33 +02:00
parser . add_option ( " --testbinary " , dest = " testbinary " ,
default = os . getenv ( " BITCOIND " , " bitcoind " ) ,
2015-04-28 18:39:47 +02:00
help = " bitcoind binary to test " )
2015-04-29 15:18:33 +02:00
parser . add_option ( " --refbinary " , dest = " refbinary " ,
default = os . getenv ( " BITCOIND " , " bitcoind " ) ,
2015-04-28 18:39:47 +02:00
help = " bitcoind binary to use for reference nodes (if any) " )
def setup_network ( self ) :
2017-06-28 14:53:20 +02:00
extra_args = [ [ ' -whitelist=127.0.0.1 ' ] ] * self . num_nodes
if hasattr ( self , " extra_args " ) :
extra_args = self . extra_args
2017-03-23 21:56:45 +01:00
self . nodes = self . start_nodes (
2017-06-28 14:53:20 +02:00
self . num_nodes , self . options . tmpdir , extra_args ,
2015-10-11 07:41:19 +02:00
binary = [ self . options . testbinary ] +
2017-06-07 17:44:17 +02:00
[ self . options . refbinary ] * ( self . num_nodes - 1 ) )
class SkipTest ( Exception ) :
""" This exception is raised to skip a test """
def __init__ ( self , message ) :
self . message = message