2017-11-28 15:38:46 +01:00
|
|
|
#!/usr/bin/env python3
|
2020-04-16 19:14:08 +02:00
|
|
|
# Copyright (c) 2017-2020 The Bitcoin Core developers
|
2017-11-28 15:38:46 +01:00
|
|
|
# Distributed under the MIT software license, see the accompanying
|
|
|
|
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
"""Test debug logging."""
|
|
|
|
|
|
|
|
import os
|
|
|
|
|
|
|
|
from test_framework.test_framework import BitcoinTestFramework
|
2018-03-28 15:37:09 +02:00
|
|
|
from test_framework.test_node import ErrorMatch
|
|
|
|
|
2017-11-28 15:38:46 +01:00
|
|
|
|
|
|
|
class LoggingTest(BitcoinTestFramework):
|
|
|
|
def set_test_params(self):
|
|
|
|
self.num_nodes = 1
|
|
|
|
self.setup_clean_chain = True
|
|
|
|
|
2018-03-27 06:35:35 +02:00
|
|
|
def relative_log_path(self, name):
|
2019-08-22 18:17:31 +02:00
|
|
|
return os.path.join(self.nodes[0].datadir, self.chain, name)
|
2018-03-27 06:35:35 +02:00
|
|
|
|
2017-11-28 15:38:46 +01:00
|
|
|
def run_test(self):
|
|
|
|
# test default log file name
|
2018-03-27 06:35:35 +02:00
|
|
|
default_log_path = self.relative_log_path("debug.log")
|
|
|
|
assert os.path.isfile(default_log_path)
|
2017-11-28 15:38:46 +01:00
|
|
|
|
|
|
|
# test alternative log file name in datadir
|
|
|
|
self.restart_node(0, ["-debuglogfile=foo.log"])
|
2018-03-27 06:35:35 +02:00
|
|
|
assert os.path.isfile(self.relative_log_path("foo.log"))
|
2017-11-28 15:38:46 +01:00
|
|
|
|
|
|
|
# test alternative log file name outside datadir
|
|
|
|
tempname = os.path.join(self.options.tmpdir, "foo.log")
|
|
|
|
self.restart_node(0, ["-debuglogfile=%s" % tempname])
|
|
|
|
assert os.path.isfile(tempname)
|
|
|
|
|
|
|
|
# check that invalid log (relative) will cause error
|
2018-03-27 06:35:35 +02:00
|
|
|
invdir = self.relative_log_path("foo")
|
2017-12-01 02:49:28 +01:00
|
|
|
invalidname = os.path.join("foo", "foo.log")
|
2017-11-28 15:38:46 +01:00
|
|
|
self.stop_node(0)
|
2019-02-02 02:00:02 +01:00
|
|
|
exp_stderr = r"Error: Could not open debug log file \S+$"
|
2018-03-28 15:37:09 +02:00
|
|
|
self.nodes[0].assert_start_raises_init_error(["-debuglogfile=%s" % (invalidname)], exp_stderr, match=ErrorMatch.FULL_REGEX)
|
2017-12-01 02:49:28 +01:00
|
|
|
assert not os.path.isfile(os.path.join(invdir, "foo.log"))
|
|
|
|
|
|
|
|
# check that invalid log (relative) works after path exists
|
|
|
|
self.stop_node(0)
|
|
|
|
os.mkdir(invdir)
|
|
|
|
self.start_node(0, ["-debuglogfile=%s" % (invalidname)])
|
|
|
|
assert os.path.isfile(os.path.join(invdir, "foo.log"))
|
2017-11-28 15:38:46 +01:00
|
|
|
|
|
|
|
# check that invalid log (absolute) will cause error
|
|
|
|
self.stop_node(0)
|
2017-12-01 02:49:28 +01:00
|
|
|
invdir = os.path.join(self.options.tmpdir, "foo")
|
|
|
|
invalidname = os.path.join(invdir, "foo.log")
|
2018-03-28 15:37:09 +02:00
|
|
|
self.nodes[0].assert_start_raises_init_error(["-debuglogfile=%s" % invalidname], exp_stderr, match=ErrorMatch.FULL_REGEX)
|
2017-12-01 02:49:28 +01:00
|
|
|
assert not os.path.isfile(os.path.join(invdir, "foo.log"))
|
|
|
|
|
|
|
|
# check that invalid log (absolute) works after path exists
|
|
|
|
self.stop_node(0)
|
|
|
|
os.mkdir(invdir)
|
|
|
|
self.start_node(0, ["-debuglogfile=%s" % (invalidname)])
|
|
|
|
assert os.path.isfile(os.path.join(invdir, "foo.log"))
|
2017-11-28 15:38:46 +01:00
|
|
|
|
2018-03-27 06:35:35 +02:00
|
|
|
# check that -nodebuglogfile disables logging
|
|
|
|
self.stop_node(0)
|
|
|
|
os.unlink(default_log_path)
|
|
|
|
assert not os.path.isfile(default_log_path)
|
|
|
|
self.start_node(0, ["-nodebuglogfile"])
|
|
|
|
assert not os.path.isfile(default_log_path)
|
|
|
|
|
|
|
|
# just sanity check no crash here
|
2020-06-22 00:32:32 +02:00
|
|
|
self.restart_node(0, ["-debuglogfile=%s" % os.devnull])
|
2018-03-27 06:35:35 +02:00
|
|
|
|
2017-11-28 15:38:46 +01:00
|
|
|
|
|
|
|
if __name__ == '__main__':
|
|
|
|
LoggingTest().main()
|