forked from dashpay/dash
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge bitcoin#10267: New -includeconf argument for including external…
… configuration files 25b7ab9 doc: Add release notes for -includeconf (Karl-Johan Alm) 0f0badd test: Test includeconf parameter. (Karl-Johan Alm) 629ff8c -includeconf=<path> support in config handler, for including external configuration files (Karl-Johan Alm) Pull request description: Fixes: bitcoin#10071. Done: - adds `-includeconf=<path>`, where `<path>` is relative to `datadir` or to the path of the file being read, if in a file - protects against circular includes - updates help docs ~~~Thoughts:~~~ - ~~~I am not sure how to test this in a neat manner. Feedback on this would be nice. Will dig/think though.~~~ Tree-SHA512: cb31f1b2f69fbc0890d264948eb2e501ac05cf12f5e06a5942f9c1539eb15ea8dc3cae817f4073aecb2fcc21d0386747f14f89d990772003a76e2a6d25642553
- Loading branch information
Showing
10 changed files
with
121 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
#!/usr/bin/env python3 | ||
# Copyright (c) 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. | ||
"""Tests the includeconf argument | ||
Verify that: | ||
1. adding includeconf to the configuration file causes the includeconf | ||
file to be loaded in the correct order. | ||
2. includeconf cannot be used as a command line argument. | ||
3. includeconf cannot be used recursively (ie includeconf can only | ||
be used from the base config file). | ||
4. multiple includeconf arguments can be specified in the main config | ||
file. | ||
""" | ||
import os | ||
import tempfile | ||
|
||
from test_framework.test_framework import BitcoinTestFramework, assert_equal | ||
|
||
class IncludeConfTest(BitcoinTestFramework): | ||
def set_test_params(self): | ||
self.setup_clean_chain = False | ||
self.num_nodes = 1 | ||
|
||
def setup_chain(self): | ||
super().setup_chain() | ||
# Create additional config files | ||
# - tmpdir/node0/relative.conf | ||
with open(os.path.join(self.options.tmpdir, "node0", "relative.conf"), "w", encoding="utf8") as f: | ||
f.write("uacomment=relative\n") | ||
# - tmpdir/node0/relative2.conf | ||
with open(os.path.join(self.options.tmpdir, "node0", "relative2.conf"), "w", encoding="utf8") as f: | ||
f.write("uacomment=relative2\n") | ||
with open(os.path.join(self.options.tmpdir, "node0", "dash.conf"), "a", encoding='utf8') as f: | ||
f.write("uacomment=main\nincludeconf=relative.conf\n") | ||
|
||
def run_test(self): | ||
self.log.info("-includeconf works from config file. subversion should end with 'main; relative)/'") | ||
|
||
subversion = self.nodes[0].getnetworkinfo()["subversion"] | ||
assert subversion.endswith("main; relative)/") | ||
|
||
self.log.info("-includeconf cannot be used as command-line arg. subversion should still end with 'main; relative)/'") | ||
self.stop_node(0) | ||
with tempfile.SpooledTemporaryFile(max_size=2**16) as log_stderr: | ||
self.start_node(0, extra_args=["-includeconf=relative2.conf"], stderr=log_stderr) | ||
|
||
subversion = self.nodes[0].getnetworkinfo()["subversion"] | ||
assert subversion.endswith("main; relative)/") | ||
log_stderr.seek(0) | ||
stderr = log_stderr.read().decode('utf-8').strip() | ||
assert_equal(stderr, 'warning: -includeconf cannot be used from commandline; ignoring -includeconf=relative2.conf') | ||
|
||
self.log.info("-includeconf cannot be used recursively. subversion should end with 'main; relative)/'") | ||
with open(os.path.join(self.options.tmpdir, "node0", "relative.conf"), "a", encoding="utf8") as f: | ||
f.write("includeconf=relative2.conf\n") | ||
|
||
self.restart_node(0) | ||
|
||
subversion = self.nodes[0].getnetworkinfo()["subversion"] | ||
assert subversion.endswith("main; relative)/") | ||
|
||
self.log.info("multiple -includeconf args can be used from the base config file. subversion should end with 'main; relative; relative2)/'") | ||
with open(os.path.join(self.options.tmpdir, "node0", "relative.conf"), "w", encoding="utf8") as f: | ||
f.write("uacomment=relative\n") | ||
|
||
with open(os.path.join(self.options.tmpdir, "node0", "dash.conf"), "a", encoding='utf8') as f: | ||
f.write("includeconf=relative2.conf\n") | ||
|
||
self.restart_node(0) | ||
|
||
subversion = self.nodes[0].getnetworkinfo()["subversion"] | ||
assert subversion.endswith("main; relative; relative2)/") | ||
|
||
if __name__ == '__main__': | ||
IncludeConfTest().main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters