Warn unrecognised sections in the config file #14708

AkioNak · 2018-11-12T06:19:39Z

This PR intends to resolve #14702.

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-warning messages if unrecognized section names are
present in the config file after checking section only args.

note: Currentry, followings are out of scope of this PR.

Empty section name or option name can describe.
e.g. [] , .a=b, =c
Multiple period characters can exist in the section name and option name.
e.g. [c.d.e], [..], f.g.h.i=j, ..=k

promag

Tested ACK but I'd like to get feedback on my comments, looks like it has unnecessary changes.

src/util/system.cpp

src/util/system.h

src/util/system.cpp

AkioNak · 2018-11-12T15:28:22Z

@promag Thank you for your reviewing. I will address what you pointed out soon.

AkioNak · 2018-11-13T10:01:15Z

@promag I've fixed what you pointed out. Please re-review :-)

promag

Thanks, looks good to me, just adding 2 small comments for your consideration.

src/util/system.cpp

DrahtBot · 2018-11-13T15:20:24Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#14045 (WIP: refactor: Fix the chainparamsbase -> util circular dependency by Empact)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

maflcko

utACK 23e3619c924560f31a01f5cdb31b4bda9df93324 (Could squash commits?)

maflcko · 2018-11-15T18:49:02Z

src/util/system.h

@@ -170,6 +171,11 @@ class ArgsManager
     */
    void WarnForSectionOnlyArgs();


For completeness, could make this const as well?

maflcko · 2018-11-15T18:57:46Z

src/util/system.cpp

+        G_CONFIG_SECTIONS.begin(), G_CONFIG_SECTIONS.end(),
+        std::inserter(diff, diff.end()));
+    for (const auto& name : diff) {
+        LogPrintf("Warning: Section [%s] is not recognized.\n", name);


Hmm. This only ends up in the debug log. However, I think that warnings could as well be printed out. (See how InitError() does it.)

Not sure if that suggestion makes sense, but if applied you could probably also write a test case like this:

diff --git a/test/functional/feature_config_args.py b/test/functional/feature_config_args.py index 88a9aadc7b..55ef46d253 100755 --- a/test/functional/feature_config_args.py +++ b/test/functional/feature_config_args.py @@ -33,6 +33,11 @@ class ConfArgsTest(BitcoinTestFramework): 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('testneettt.datadir=1') + self.restart_node(0) + self.nodes[0].stop_node(expected_stderr='Warning: Section [testneettt] is not recognized.') + with open(inc_conf_file_path, 'w', encoding='utf-8') as conf: conf.write('') # clear

@MarcoFalke Thanks for your suggestion. I think it will be more useful. I'll try it.

I could not write a test case for WarnForSectionOnlyArgs().
Because I could not found simple way that how to produce the situation that WarnForSectionOnlyArgs() warn and to continue to run through the test.

maflcko · 2018-11-16T19:26:14Z

src/util/system.cpp

@@ -398,7 +399,30 @@ void ArgsManager::WarnForSectionOnlyArgs()
        if (!found_result.first) continue;

        // otherwise, issue a warning
-        LogPrintf("Warning: Config setting for %s only applied on %s network when in [%s] section.\n", arg, m_network, m_network);
+        const std::string msg = strprintf("Config setting for %s only applied on %s network when in [%s] section.", arg, m_network, m_network);
+        uiInterface.ThreadSafeMessageBox(msg, "", CClientUIInterface::MSG_WARNING);


Putting this here smells a bit. You could either move ui_interface to the libbitcoin_util or pass the warnings up to the caller?

Probably want to pass it up as per travis:

A new circular dependency in the form of "ui_interface -> util/system -> ui_interface" appears to have been introduced.

Addressed. Please re-review.

maflcko · 2018-11-19T14:53:39Z

utACK ecfc35ce9bfb297f01344f565bfa771bf3c6ac72. Thanks for fixing up all the feedback!

maflcko · 2018-11-19T21:22:52Z

Appveyor fails with AssertionError: Unexpected stderr Warning: Section [regtest] is not recognized. != .

maflcko

I haven't looked at the appveyor failure but it could be caused by static initialization issues based on ordering (a global is initialized on another globals value, but before the other global was initialized). So maybe G_CONFIG_SECTIONS is just the set with the empty string in it on appveyor?

Could at least rule that out by trying the refactoring I suggested in this review.

src/util/system.cpp

test/functional/feature_config_args.py

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.

maflcko · 2018-11-20T21:09:11Z

re-utACK 3fb09b9

Only change was the suggested refactoring to fix the appveyor build.

3fb09b9 Warn unrecognized sections in the config file (Akio Nakamura) Pull request description: This PR intends to resolve #14702. 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-warning messages if unrecognized section names are present in the config file after checking section only args. note: Currentry, followings are out of scope of this PR. 1) Empty section name or option name can describe. e.g. [] , .a=b, =c 2) Multiple period characters can exist in the section name and option name. e.g. [c.d.e], [..], f.g.h.i=j, ..=k Tree-SHA512: 2cea02a0525feb40320613989a75cd7b7b1bd12158d5e6f3174ca77e6a25bb84425dd8812f62483df9fc482045c7b5402d69bc714430518b1847d055a2dc304b

promag · 2018-11-21T18:46:37Z

utACK 3fb09b9.

…y calls to InitWarning 6bbdb20 squashme: connect thru node interface (João Barbosa) a0f8df3 qt: Call noui_connect to prevent boost::signals2::no_slots_error in early calls to InitWarning (João Barbosa) Pull request description: Adding the following to `bitcoin.conf` ``` [xxx] disablewallet=1 ``` And running `bitcoin-qt` gives: ``` libc++abi.dylib: terminating with uncaught exception of type boost::exception_detail::clone_impl<boost::exception_detail::error_info_injector<boost::signals2::no_slots_error> >: boost::signals2::no_slots_error ``` Fixes regression in bitcoin#14708. Tree-SHA512: 7c158376fad6ebcd80fc0dbe549d5b6e893fb82e7dc1e455825633d7f91b14dc34493487cab7642152e88f9eaf99bfa91988972d600e9fb289cf26afd64aff8a

1a7ba84 Fix lack of warning of unrecognized section names (Akio Nakamura) Pull request description: In bitcoin#14708, It was introduced that to warn when unrecognized section names are exist in the config file. But ```m_config_sections.clear()``` in ```ArgsManager::ReadConfigStream()``` is called every time when reading each configuration file, so it can warn about only last reading file if ```includeconf``` exists. This PR fix lack of warning by collecting all section names by moving ```m_config_sections.clear()``` to ```ArgsManager::ReadConfigFiles()``` . Also add a test code to confirm this situation. Tree-SHA512: 26aa0cbe3e4ae2e58cbe73d4492ee5cf465fd4c3e5df2c8ca7e282b627df9e637267af1e3816386b1dc6db2398b31936925ce0e432219fec3a9b3398f01e3e65

Summary: 3fb09b9889665a24b34f25e9d1385a05058a28b7 Warn unrecognized sections in the config file (Akio Nakamura) Pull request description: This PR intends to resolve #14702. 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-warning messages if unrecognized section names are present in the config file after checking section only args. note: Currentry, followings are out of scope of this PR. 1) Empty section name or option name can describe. e.g. [] , .a=b, =c 2) Multiple period characters can exist in the section name and option name. e.g. [c.d.e], [..], f.g.h.i=j, ..=k Tree-SHA512: 2cea02a0525feb40320613989a75cd7b7b1bd12158d5e6f3174ca77e6a25bb84425dd8812f62483df9fc482045c7b5402d69bc714430518b1847d055a2dc304b --- This is a backport of Core [[bitcoin/bitcoin#14708 | PR14708]] Test Plan: ninja test_runner.py feature_config_args.py Reviewers: deadalnix, O1 Bitcoin ABC, #bitcoin_abc Reviewed By: deadalnix, O1 Bitcoin ABC, #bitcoin_abc Differential Revision: https://reviews.bitcoinabc.org/D5756

3fb09b9 Warn unrecognized sections in the config file (Akio Nakamura) Pull request description: This PR intends to resolve bitcoin#14702. 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-warning messages if unrecognized section names are present in the config file after checking section only args. note: Currentry, followings are out of scope of this PR. 1) Empty section name or option name can describe. e.g. [] , .a=b, =c 2) Multiple period characters can exist in the section name and option name. e.g. [c.d.e], [..], f.g.h.i=j, ..=k Tree-SHA512: 2cea02a0525feb40320613989a75cd7b7b1bd12158d5e6f3174ca77e6a25bb84425dd8812f62483df9fc482045c7b5402d69bc714430518b1847d055a2dc304b

3fb09b9 Warn unrecognized sections in the config file (Akio Nakamura) Pull request description: This PR intends to resolve bitcoin#14702. 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-warning messages if unrecognized section names are present in the config file after checking section only args. note: Currentry, followings are out of scope of this PR. 1) Empty section name or option name can describe. e.g. [] , .a=b, =c 2) Multiple period characters can exist in the section name and option name. e.g. [c.d.e], [..], f.g.h.i=j, ..=k Tree-SHA512: 2cea02a0525feb40320613989a75cd7b7b1bd12158d5e6f3174ca77e6a25bb84425dd8812f62483df9fc482045c7b5402d69bc714430518b1847d055a2dc304b # Conflicts: # test/functional/feature_config_args.py

…y calls to InitWarning 6bbdb20 squashme: connect thru node interface (João Barbosa) a0f8df3 qt: Call noui_connect to prevent boost::signals2::no_slots_error in early calls to InitWarning (João Barbosa) Pull request description: Adding the following to `bitcoin.conf` ``` [xxx] disablewallet=1 ``` And running `bitcoin-qt` gives: ``` libc++abi.dylib: terminating with uncaught exception of type boost::exception_detail::clone_impl<boost::exception_detail::error_info_injector<boost::signals2::no_slots_error> >: boost::signals2::no_slots_error ``` Fixes regression in bitcoin#14708. Tree-SHA512: 7c158376fad6ebcd80fc0dbe549d5b6e893fb82e7dc1e455825633d7f91b14dc34493487cab7642152e88f9eaf99bfa91988972d600e9fb289cf26afd64aff8a

3fb09b9 Warn unrecognized sections in the config file (Akio Nakamura) Pull request description: This PR intends to resolve bitcoin#14702. 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-warning messages if unrecognized section names are present in the config file after checking section only args. note: Currentry, followings are out of scope of this PR. 1) Empty section name or option name can describe. e.g. [] , .a=b, =c 2) Multiple period characters can exist in the section name and option name. e.g. [c.d.e], [..], f.g.h.i=j, ..=k Tree-SHA512: 2cea02a0525feb40320613989a75cd7b7b1bd12158d5e6f3174ca77e6a25bb84425dd8812f62483df9fc482045c7b5402d69bc714430518b1847d055a2dc304b

1a7ba84 Fix lack of warning of unrecognized section names (Akio Nakamura) Pull request description: In bitcoin#14708, It was introduced that to warn when unrecognized section names are exist in the config file. But ```m_config_sections.clear()``` in ```ArgsManager::ReadConfigStream()``` is called every time when reading each configuration file, so it can warn about only last reading file if ```includeconf``` exists. This PR fix lack of warning by collecting all section names by moving ```m_config_sections.clear()``` to ```ArgsManager::ReadConfigFiles()``` . Also add a test code to confirm this situation. Tree-SHA512: 26aa0cbe3e4ae2e58cbe73d4492ee5cf465fd4c3e5df2c8ca7e282b627df9e637267af1e3816386b1dc6db2398b31936925ce0e432219fec3a9b3398f01e3e65

fanquake added the Utils/log/libs label Nov 12, 2018

promag reviewed Nov 12, 2018

View reviewed changes

src/util/system.cpp Outdated Show resolved Hide resolved

src/util/system.cpp Outdated Show resolved Hide resolved

src/util/system.h Outdated Show resolved Hide resolved

src/util/system.h Outdated Show resolved Hide resolved

src/util/system.cpp Outdated Show resolved Hide resolved

AkioNak force-pushed the warn_unrecognized_section branch from f14ddd2 to 7b8728a Compare November 13, 2018 09:50

promag reviewed Nov 13, 2018

View reviewed changes

src/util/system.cpp Outdated Show resolved Hide resolved

src/util/system.cpp Outdated Show resolved Hide resolved

maflcko approved these changes Nov 15, 2018

View reviewed changes

AkioNak force-pushed the warn_unrecognized_section branch from 23e3619 to 7009611 Compare November 16, 2018 11:07

DrahtBot added the Needs rebase label Nov 16, 2018

AkioNak force-pushed the warn_unrecognized_section branch from 7009611 to f2092bf Compare November 16, 2018 11:28

DrahtBot removed the Needs rebase label Nov 16, 2018

maflcko reviewed Nov 16, 2018

View reviewed changes

fanquake mentioned this pull request Nov 17, 2018

Check for invalid prefixes in config file #14746

Closed

AkioNak force-pushed the warn_unrecognized_section branch from f2092bf to ecfc35c Compare November 19, 2018 11:23

maflcko reviewed Nov 19, 2018

View reviewed changes

src/util/system.cpp Outdated Show resolved Hide resolved

AkioNak force-pushed the warn_unrecognized_section branch from ecfc35c to a04e3bd Compare November 20, 2018 02:56

AkioNak commented Nov 20, 2018

View reviewed changes

test/functional/feature_config_args.py Outdated Show resolved Hide resolved

AkioNak force-pushed the warn_unrecognized_section branch from a04e3bd to f38903c Compare November 20, 2018 08:16

AkioNak force-pushed the warn_unrecognized_section branch from f38903c to 3fb09b9 Compare November 20, 2018 09:31

maflcko added this to the 0.18.0 milestone Nov 20, 2018

laanwj merged commit 3fb09b9 into bitcoin:master Nov 21, 2018

promag mentioned this pull request Nov 22, 2018

gui: Fix boost::signals2::no_slots_error in early calls to InitWarning #14783

Merged

AkioNak deleted the warn_unrecognized_section branch December 6, 2018 02:03

AkioNak mentioned this pull request Feb 4, 2019

Fix lack of warning of unrecognized section names #15335

Merged

bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Warn unrecognised sections in the config file #14708

Warn unrecognised sections in the config file #14708

AkioNak commented Nov 12, 2018

promag left a comment

AkioNak commented Nov 12, 2018

AkioNak commented Nov 13, 2018

promag left a comment

DrahtBot commented Nov 13, 2018

maflcko left a comment

maflcko Nov 15, 2018

AkioNak Nov 16, 2018

AkioNak Nov 16, 2018

maflcko Nov 15, 2018

AkioNak Nov 16, 2018

AkioNak Nov 16, 2018

AkioNak Nov 16, 2018

maflcko Nov 16, 2018

maflcko Nov 16, 2018

AkioNak Nov 19, 2018

maflcko commented Nov 19, 2018

maflcko commented Nov 19, 2018

maflcko left a comment

maflcko commented Nov 20, 2018

promag commented Nov 21, 2018

		@@ -170,6 +171,11 @@ class ArgsManager
		*/
		void WarnForSectionOnlyArgs();

Warn unrecognised sections in the config file #14708

Warn unrecognised sections in the config file #14708

Conversation

AkioNak commented Nov 12, 2018

promag left a comment

Choose a reason for hiding this comment

AkioNak commented Nov 12, 2018

AkioNak commented Nov 13, 2018

promag left a comment

Choose a reason for hiding this comment

DrahtBot commented Nov 13, 2018

Conflicts

maflcko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maflcko commented Nov 19, 2018

maflcko commented Nov 19, 2018

maflcko left a comment

Choose a reason for hiding this comment

maflcko commented Nov 20, 2018

promag commented Nov 21, 2018