mirror of
https://github.com/dashpay/dash.git
synced 2024-12-25 20:12:57 +01:00
56c3f844dc
127b4608e9dbb8217c74c9332e82fcec8c326fa8 test: Check if specified config file cannot be opened (nthumann) 6bb54708e6457f21596793a7149dc6dfea1dc871 util: Check if specified config file cannot be opened (nthumann) Pull request description: Fixes https://github.com/bitcoin/bitcoin/issues/22612. When running e.g. `./src/bitcoind -datadir=/tmp/bitcoin -regtest -conf=/tmp/bitcoin/regtest/bitcoin.conf` and the specified config cannot be opened (doesn't exist, permission denied, ...), the initialization silently uses the default config. As voidburn already noted: > I can't think of a situation in which a config file is specified explicitly (in the startup options, as per service unit linked above), but inaccessible, where the fail condition should be to keep booting using defaults instead. With this patch applied, the initialization will fail immediately, if the specified config file cannot be opened. If no config file is explicitly specified, the behavior is unchanged. This not only affects `bitcoind`, but also `bitcoin-cli` and `bitcoin-qt`. In the example below the datadir is accessible, but the config file is not due to insufficient permissions: ``` $ ./src/bitcoind -datadir=/tmp/bitcoin -regtest --debug=1 -conf=/tmp/bitcoin/regtest/bitcoin.conf Error: Error reading configuration file: specified config file "/tmp/bitcoin/regtest/bitcoin.conf" could not be opened. ``` ACKs for top commit: 0xB10C: ACK 127b4608e9dbb8217c74c9332e82fcec8c326fa8 Zero-1729: tACK 127b4608e9dbb8217c74c9332e82fcec8c326fa8 theStack: Tested ACK 127b4608e9dbb8217c74c9332e82fcec8c326fa8 Tree-SHA512: 4fe487921485426f1d1da8d256c388af517b984b639d776aec7b159b3e23b669824093d3bdd31139d9415ed5f5de405b3e6a51b110c8ab471f12b9c99ac67cc1
270 lines
14 KiB
Python
Executable File
270 lines
14 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# Copyright (c) 2017-2020 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
|
|
import time
|
|
|
|
from test_framework.test_framework import BitcoinTestFramework
|
|
from test_framework import util
|
|
|
|
|
|
class ConfArgsTest(BitcoinTestFramework):
|
|
def set_test_params(self):
|
|
self.setup_clean_chain = True
|
|
self.num_nodes = 1
|
|
self.supports_cli = False
|
|
self.wallet_names = []
|
|
|
|
def test_config_file_parser(self):
|
|
self.stop_node(0)
|
|
|
|
inc_conf_file_path = os.path.join(self.nodes[0].datadir, 'include.conf')
|
|
with open(os.path.join(self.nodes[0].datadir, 'dash.conf'), 'a', encoding='utf-8') as conf:
|
|
conf.write('includeconf={}\n'.format(inc_conf_file_path))
|
|
|
|
self.nodes[0].assert_start_raises_init_error(
|
|
expected_msg='Error: Error parsing command line arguments: Invalid parameter -dash_cli=1',
|
|
extra_args=['-dash_cli=1'],
|
|
)
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('dash_conf=1\n')
|
|
with self.nodes[0].assert_debug_log(expected_msgs=['Ignoring unknown configuration value dash_conf']):
|
|
self.start_node(0)
|
|
self.stop_node(0)
|
|
|
|
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: Error reading configuration file: parse error on line 1: -dash=1, options in configuration file must be specified without leading -')
|
|
|
|
if self.is_wallet_compiled():
|
|
with open(inc_conf_file_path, 'w', encoding='utf8') as conf:
|
|
conf.write("wallet=foo\n")
|
|
self.nodes[0].assert_start_raises_init_error(expected_msg='Error: Config setting for -wallet only applied on %s network when in [%s] section.' % (self.chain, self.chain))
|
|
|
|
main_conf_file_path = os.path.join(self.options.tmpdir, 'node0', 'dash_main.conf')
|
|
util.write_config(main_conf_file_path, n=0, chain='', extra_config='includeconf={}\n'.format(inc_conf_file_path))
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('acceptnonstdtxn=1\n')
|
|
self.nodes[0].assert_start_raises_init_error(extra_args=["-conf={}".format(main_conf_file_path)], expected_msg='Error: acceptnonstdtxn is not currently supported for main chain')
|
|
|
|
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: 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: 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('server=1\nrpcuser=someuser\nmain.rpcpassword=some#pass')
|
|
self.nodes[0].assert_start_raises_init_error(expected_msg='Error: 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('server=1\nrpcuser=someuser\n[main]\nrpcpassword=some#pass')
|
|
self.nodes[0].assert_start_raises_init_error(expected_msg='Error: Error reading configuration file: parse error on line 4, using # in rpcpassword can be ambiguous and should be avoided')
|
|
|
|
inc_conf_file2_path = os.path.join(self.nodes[0].datadir, 'include2.conf')
|
|
with open(os.path.join(self.nodes[0].datadir, 'dash.conf'), 'a', encoding='utf-8') as conf:
|
|
conf.write('includeconf={}\n'.format(inc_conf_file2_path))
|
|
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('testnot.datadir=1\n')
|
|
with open(inc_conf_file2_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('[testnet]\n')
|
|
self.restart_node(0)
|
|
self.nodes[0].stop_node(expected_stderr='Warning: ' + inc_conf_file_path + ':1 Section [testnot] is not recognized.' + os.linesep + inc_conf_file2_path + ':1 Section [testnet] is not recognized.')
|
|
|
|
with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('') # clear
|
|
with open(inc_conf_file2_path, 'w', encoding='utf-8') as conf:
|
|
conf.write('') # clear
|
|
|
|
def test_invalid_command_line_options(self):
|
|
self.nodes[0].assert_start_raises_init_error(
|
|
expected_msg='Error: No proxy server specified. Use -proxy=<ip> or -proxy=<ip:port>.',
|
|
extra_args=['-proxy'],
|
|
)
|
|
|
|
def test_log_buffer(self):
|
|
self.stop_node(0)
|
|
with self.nodes[0].assert_debug_log(expected_msgs=['Warning: parsed potentially confusing double-negative -connect=0\n']):
|
|
self.start_node(0, extra_args=['-noconnect=0'])
|
|
|
|
def test_args_log(self):
|
|
self.stop_node(0)
|
|
self.log.info('Test config args logging')
|
|
with self.nodes[0].assert_debug_log(
|
|
expected_msgs=[
|
|
'Command-line arg: addnode="some.node"',
|
|
'Command-line arg: rpcauth=****',
|
|
'Command-line arg: rpcbind=****',
|
|
'Command-line arg: rpcpassword=****',
|
|
'Command-line arg: rpcuser=****',
|
|
'Command-line arg: torpassword=****',
|
|
'Config file arg: %s="1"' % self.chain,
|
|
'Config file arg: [%s] server="1"' % self.chain,
|
|
],
|
|
unexpected_msgs=[
|
|
'alice:f7efda5c189b999524f151318c0c86$d5b51b3beffbc0',
|
|
'127.1.1.1',
|
|
'secret-rpcuser',
|
|
'secret-torpassword',
|
|
]):
|
|
self.start_node(0, extra_args=[
|
|
'-addnode=some.node',
|
|
'-rpcauth=alice:f7efda5c189b999524f151318c0c86$d5b51b3beffbc0',
|
|
'-rpcbind=127.1.1.1',
|
|
'-rpcpassword=',
|
|
'-rpcuser=secret-rpcuser',
|
|
'-torpassword=secret-torpassword',
|
|
])
|
|
|
|
def test_networkactive(self):
|
|
self.log.info('Test -networkactive option')
|
|
self.stop_node(0)
|
|
with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: true\n']):
|
|
self.start_node(0)
|
|
|
|
self.stop_node(0)
|
|
with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: true\n']):
|
|
self.start_node(0, extra_args=['-networkactive'])
|
|
|
|
self.stop_node(0)
|
|
with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: true\n']):
|
|
self.start_node(0, extra_args=['-networkactive=1'])
|
|
|
|
self.stop_node(0)
|
|
with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: false\n']):
|
|
self.start_node(0, extra_args=['-networkactive=0'])
|
|
|
|
self.stop_node(0)
|
|
with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: false\n']):
|
|
self.start_node(0, extra_args=['-nonetworkactive'])
|
|
|
|
self.stop_node(0)
|
|
with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: false\n']):
|
|
self.start_node(0, extra_args=['-nonetworkactive=1'])
|
|
|
|
def test_seed_peers(self):
|
|
self.log.info('Test seed peers')
|
|
default_data_dir = self.nodes[0].datadir
|
|
# Only regtest has no fixed seeds. To avoid connections to random
|
|
# nodes, regtest is the only network where it is safe to enable
|
|
# -fixedseeds in tests
|
|
util.assert_equal(self.nodes[0].getblockchaininfo()['chain'],'regtest')
|
|
self.stop_node(0)
|
|
|
|
# No peers.dat exists and -dnsseed=1
|
|
# We expect the node will use DNS Seeds, but Regtest mode has 0 DNS seeds
|
|
# So after 60 seconds, the node should fallback to fixed seeds (this is a slow test)
|
|
assert not os.path.exists(os.path.join(default_data_dir, "peers.dat"))
|
|
start = int(time.time())
|
|
with self.nodes[0].assert_debug_log(expected_msgs=[
|
|
"Loaded 0 addresses from peers.dat",
|
|
"0 addresses found from DNS seeds",
|
|
"opencon thread start", # Ensure ThreadOpenConnections::start time is properly set
|
|
]):
|
|
self.start_node(0, extra_args=['-dnsseed=1', '-fixedseeds=1', f'-mocktime={start}'])
|
|
with self.nodes[0].assert_debug_log(expected_msgs=[
|
|
"Adding fixed seeds as 60 seconds have passed and addrman is empty",
|
|
]):
|
|
self.nodes[0].setmocktime(start + 65)
|
|
self.stop_node(0)
|
|
|
|
# No peers.dat exists and -dnsseed=0
|
|
# We expect the node will fallback immediately to fixed seeds
|
|
assert not os.path.exists(os.path.join(default_data_dir, "peers.dat"))
|
|
start = time.time()
|
|
with self.nodes[0].assert_debug_log(expected_msgs=[
|
|
"Loaded 0 addresses from peers.dat",
|
|
"DNS seeding disabled",
|
|
"Adding fixed seeds as -dnsseed=0, -addnode is not provided and all -seednode(s) attempted\n",
|
|
]):
|
|
self.start_node(0, extra_args=['-dnsseed=0', '-fixedseeds=1'])
|
|
assert time.time() - start < 60
|
|
self.stop_node(0)
|
|
|
|
# No peers.dat exists and dns seeds are disabled.
|
|
# We expect the node will not add fixed seeds when explicitly disabled.
|
|
assert not os.path.exists(os.path.join(default_data_dir, "peers.dat"))
|
|
start = time.time()
|
|
with self.nodes[0].assert_debug_log(expected_msgs=[
|
|
"Loaded 0 addresses from peers.dat",
|
|
"DNS seeding disabled",
|
|
"Fixed seeds are disabled",
|
|
]):
|
|
self.start_node(0, extra_args=['-dnsseed=0', '-fixedseeds=0'])
|
|
assert time.time() - start < 60
|
|
self.stop_node(0)
|
|
|
|
# No peers.dat exists and -dnsseed=0, but a -addnode is provided
|
|
# We expect the node will allow 60 seconds prior to using fixed seeds
|
|
assert not os.path.exists(os.path.join(default_data_dir, "peers.dat"))
|
|
start = int(time.time())
|
|
with self.nodes[0].assert_debug_log(expected_msgs=[
|
|
"Loaded 0 addresses from peers.dat",
|
|
"DNS seeding disabled",
|
|
"opencon thread start", # Ensure ThreadOpenConnections::start time is properly set
|
|
]):
|
|
self.start_node(0, extra_args=['-dnsseed=0', '-fixedseeds=1', '-addnode=fakenodeaddr', f'-mocktime={start}'])
|
|
with self.nodes[0].assert_debug_log(expected_msgs=[
|
|
"Adding fixed seeds as 60 seconds have passed and addrman is empty",
|
|
]):
|
|
self.nodes[0].setmocktime(start + 65)
|
|
|
|
def run_test(self):
|
|
self.test_log_buffer()
|
|
self.test_args_log()
|
|
self.test_seed_peers()
|
|
self.test_networkactive()
|
|
|
|
|
|
self.test_config_file_parser()
|
|
self.test_invalid_command_line_options()
|
|
|
|
# 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, "dash.conf")
|
|
|
|
# datadir needs to be set before [chain] 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)
|
|
|
|
self.nodes[0].assert_start_raises_init_error(['-conf=' + conf_file], 'Error: Error reading configuration file: specified data directory "' + new_data_dir + '" does not exist.')
|
|
|
|
# Check that an explicitly specified config file that cannot be opened fails
|
|
none_existent_conf_file = os.path.join(default_data_dir, "none_existent_dash.conf")
|
|
self.nodes[0].assert_start_raises_init_error(['-conf=' + none_existent_conf_file], 'Error: Error reading configuration file: specified config file "' + none_existent_conf_file + '" could not be opened.')
|
|
|
|
# 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])
|
|
self.stop_node(0)
|
|
assert os.path.exists(os.path.join(new_data_dir, self.chain, 'blocks'))
|
|
|
|
# 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])
|
|
assert os.path.exists(os.path.join(new_data_dir_2, self.chain, 'blocks'))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
ConfArgsTest().main()
|