3fb09b9889
In the config file, sections are specified by square bracket pair "[]"$, or included in the option name itself which separated by a period"(.)". Typicaly, [testnet] is not a correct section name and specified options in that section are ignored but user cannot recognize what is happen. So, add some log/stderr-warning messages if unrecognized section names are present in the config file after checking section only args.
91 lines
4.5 KiB
Python
Executable file
91 lines
4.5 KiB
Python
Executable file
#!/usr/bin/env python3
|
|
# Copyright (c) 2017-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 various command line arguments and configuration file parameters."""
|
|
|
|
import os
|
|
|
|
from test_framework.test_framework import BitcoinTestFramework
|
|
|
|
|
|
class ConfArgsTest(BitcoinTestFramework):
|
|
def set_test_params(self):
|
|
self.setup_clean_chain = True
|
|
self.num_nodes = 1
|
|
|
|
def test_config_file_parser(self):
|
|
# Assume node is stopped
|
|
|
|
inc_conf_file_path = os.path.join(self.nodes[0].datadir, 'include.conf')
|
|
with open(os.path.join(self.nodes[0].datadir, 'bitcoin.conf'), 'a', encoding='utf-8') as conf:
|
|
conf.write('includeconf={}\n'.format(inc_conf_file_path))
|
|
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('-dash=1\n')
|
|
self.nodes[0].assert_start_raises_init_error(expected_msg='Error reading configuration file: parse error on line 1: -dash=1, options in configuration file must be specified without leading -')
|
|
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('nono\n')
|
|
self.nodes[0].assert_start_raises_init_error(expected_msg='Error reading configuration file: parse error on line 1: nono, if you intended to specify a negated option, use nono=1 instead')
|
|
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('server=1\nrpcuser=someuser\nrpcpassword=some#pass')
|
|
self.nodes[0].assert_start_raises_init_error(expected_msg='Error reading configuration file: parse error on line 3, using # in rpcpassword can be ambiguous and should be avoided')
|
|
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('testnot.datadir=1\n[testnet]\n')
|
|
self.restart_node(0)
|
|
self.nodes[0].stop_node(expected_stderr='Warning: Section [testnet] is not recognized.' + os.linesep + 'Warning: Section [testnot] is not recognized.')
|
|
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('') # clear
|
|
|
|
def run_test(self):
|
|
self.stop_node(0)
|
|
|
|
self.test_config_file_parser()
|
|
|
|
# Remove the -datadir argument so it doesn't override the config file
|
|
self.nodes[0].args = [arg for arg in self.nodes[0].args if not arg.startswith("-datadir")]
|
|
|
|
default_data_dir = self.nodes[0].datadir
|
|
new_data_dir = os.path.join(default_data_dir, 'newdatadir')
|
|
new_data_dir_2 = os.path.join(default_data_dir, 'newdatadir2')
|
|
|
|
# Check that using -datadir argument on non-existent directory fails
|
|
self.nodes[0].datadir = new_data_dir
|
|
self.nodes[0].assert_start_raises_init_error(['-datadir=' + new_data_dir], 'Error: Specified data directory "' + new_data_dir + '" does not exist.')
|
|
|
|
# Check that using non-existent datadir in conf file fails
|
|
conf_file = os.path.join(default_data_dir, "bitcoin.conf")
|
|
|
|
# datadir needs to be set before [regtest] section
|
|
conf_file_contents = open(conf_file, encoding='utf8').read()
|
|
with open(conf_file, 'w', encoding='utf8') as f:
|
|
f.write("datadir=" + new_data_dir + "\n")
|
|
f.write(conf_file_contents)
|
|
|
|
# Temporarily disabled, because this test would access the user's home dir (~/.bitcoin)
|
|
#self.nodes[0].assert_start_raises_init_error(['-conf=' + conf_file], 'Error reading configuration file: specified data directory "' + new_data_dir + '" does not exist.')
|
|
|
|
# Create the directory and ensure the config file now works
|
|
os.mkdir(new_data_dir)
|
|
# Temporarily disabled, because this test would access the user's home dir (~/.bitcoin)
|
|
#self.start_node(0, ['-conf='+conf_file, '-wallet=w1'])
|
|
#self.stop_node(0)
|
|
#assert os.path.exists(os.path.join(new_data_dir, 'regtest', 'blocks'))
|
|
#if self.is_wallet_compiled():
|
|
#assert os.path.exists(os.path.join(new_data_dir, 'regtest', 'wallets', 'w1'))
|
|
|
|
# Ensure command line argument overrides datadir in conf
|
|
os.mkdir(new_data_dir_2)
|
|
self.nodes[0].datadir = new_data_dir_2
|
|
self.start_node(0, ['-datadir='+new_data_dir_2, '-conf='+conf_file, '-wallet=w2'])
|
|
assert os.path.exists(os.path.join(new_data_dir_2, 'regtest', 'blocks'))
|
|
if self.is_wallet_compiled():
|
|
assert os.path.exists(os.path.join(new_data_dir_2, 'regtest', 'wallets', 'w2'))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
ConfArgsTest().main()
|