Bitcoin Core 30.99.0
P2P Digital Currency
getarg_tests.cpp
Go to the documentation of this file.
1// Copyright (c) 2012-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <common/args.h>
6#include <common/settings.h>
7#include <logging.h>
8#include <test/util/setup_common.h>
9#include <univalue.h>
10#include <util/strencodings.h>
11
12#include <limits>
13#include <string>
14#include <utility>
15#include <vector>
16
17#include <boost/test/unit_test.hpp>
18
19using util::SplitString;
20
21BOOST_FIXTURE_TEST_SUITE(getarg_tests, BasicTestingSetup)
22
23void ResetArgs(ArgsManager& local_args, const std::string& strArg)
24{
25 std::vector<std::string> vecArg;
26 if (strArg.size()) {
27 vecArg = SplitString(strArg, ' ');
28 }
29
30 // Insert dummy executable name:
31 vecArg.insert(vecArg.begin(), "testbitcoin");
32
33 // Convert to char*:
34 std::vector<const char*> vecChar;
35 vecChar.reserve(vecArg.size());
36 for (const std::string& s : vecArg)
37 vecChar.push_back(s.c_str());
38
39 std::string error;
40 BOOST_CHECK(local_args.ParseParameters(vecChar.size(), vecChar.data(), error));
41}
42
43void SetupArgs(ArgsManager& local_args, const std::vector<std::pair<std::string, unsigned int>>& args)
44{
45 for (const auto& arg : args) {
46 local_args.AddArg(arg.first, "", arg.second, OptionsCategory::OPTIONS);
47 }
48}
49
50// Test behavior of GetArg functions when string, integer, and boolean types
51// are specified in the settings.json file. GetArg functions are convenience
52// functions. The GetSetting method can always be used instead of GetArg
53// methods to retrieve original values, and there's not always an objective
54// answer to what GetArg behavior is best in every case. This test makes sure
55// there's test coverage for whatever the current behavior is, so it's not
56// broken or changed unintentionally.
57BOOST_AUTO_TEST_CASE(setting_args)
58{
59 ArgsManager args;
60 SetupArgs(args, {{"-foo", ArgsManager::ALLOW_ANY}});
61
62 auto set_foo = [&](const common::SettingsValue& value) {
63 args.LockSettings([&](common::Settings& settings) {
64 settings.rw_settings["foo"] = value;
65 });
66 };
67
68 set_foo("str");
69 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"str\"");
70 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "str");
71 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
72 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
73 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
74
75 set_foo("99");
76 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"99\"");
77 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "99");
78 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 99);
79 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
80 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
81
82 set_foo("3.25");
83 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"3.25\"");
84 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "3.25");
85 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 3);
86 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
87 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
88
89 set_foo("0");
90 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"0\"");
91 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
92 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
93 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
94 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
95
96 set_foo("");
97 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"\"");
98 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "");
99 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
100 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
101 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
102
103 set_foo(99);
104 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "99");
105 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "99");
106 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 99);
107 BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
108 BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
109
110 set_foo(3.25);
111 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "3.25");
112 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "3.25");
113 BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
114 BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
115 BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
116
117 set_foo(0);
118 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "0");
119 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
120 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
121 BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
122 BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
123
124 set_foo(true);
125 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "true");
126 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "1");
127 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 1);
128 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
129 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
130
131 set_foo(false);
132 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "false");
133 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
134 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
135 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
136 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
137
138 set_foo(UniValue::VOBJ);
139 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "{}");
140 BOOST_CHECK_THROW(args.GetArg("foo", "default"), std::runtime_error);
141 BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
142 BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
143 BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
144
145 set_foo(UniValue::VARR);
146 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "[]");
147 BOOST_CHECK_THROW(args.GetArg("foo", "default"), std::runtime_error);
148 BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
149 BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
150 BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
151
152 set_foo(UniValue::VNULL);
153 BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "null");
154 BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "default");
155 BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 100);
156 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
157 BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
158}
159
160BOOST_AUTO_TEST_CASE(boolarg)
161{
162 ArgsManager local_args;
163
164 const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
165 SetupArgs(local_args, {foo});
166 ResetArgs(local_args, "-foo");
167 BOOST_CHECK(local_args.GetBoolArg("-foo", false));
168 BOOST_CHECK(local_args.GetBoolArg("-foo", true));
169
170 BOOST_CHECK(!local_args.GetBoolArg("-fo", false));
171 BOOST_CHECK(local_args.GetBoolArg("-fo", true));
172
173 BOOST_CHECK(!local_args.GetBoolArg("-fooo", false));
174 BOOST_CHECK(local_args.GetBoolArg("-fooo", true));
175
176 ResetArgs(local_args, "-foo=0");
177 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
178 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
179
180 ResetArgs(local_args, "-foo=1");
181 BOOST_CHECK(local_args.GetBoolArg("-foo", false));
182 BOOST_CHECK(local_args.GetBoolArg("-foo", true));
183
184 // New 0.6 feature: auto-map -nosomething to !-something:
185 ResetArgs(local_args, "-nofoo");
186 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
187 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
188
189 ResetArgs(local_args, "-nofoo=1");
190 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
191 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
192
193 ResetArgs(local_args, "-foo -nofoo"); // -nofoo should win
194 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
195 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
196
197 ResetArgs(local_args, "-foo=1 -nofoo=1"); // -nofoo should win
198 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
199 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
200
201 ResetArgs(local_args, "-foo=0 -nofoo=0"); // -nofoo=0 should win
202 BOOST_CHECK(local_args.GetBoolArg("-foo", false));
203 BOOST_CHECK(local_args.GetBoolArg("-foo", true));
204
205 // New 0.6 feature: treat -- same as -:
206 ResetArgs(local_args, "--foo=1");
207 BOOST_CHECK(local_args.GetBoolArg("-foo", false));
208 BOOST_CHECK(local_args.GetBoolArg("-foo", true));
209
210 ResetArgs(local_args, "--nofoo=1");
211 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
212 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
213}
214
215BOOST_AUTO_TEST_CASE(stringarg)
216{
217 ArgsManager local_args;
218
219 const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
220 const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
221 SetupArgs(local_args, {foo, bar});
222 ResetArgs(local_args, "");
223 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
224 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "eleven");
225
226 ResetArgs(local_args, "-foo -bar");
227 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
228 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "");
229
230 ResetArgs(local_args, "-foo=");
231 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
232 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "");
233
234 ResetArgs(local_args, "-foo=11");
235 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "11");
236 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "11");
237
238 ResetArgs(local_args, "-foo=eleven");
239 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "eleven");
240 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "eleven");
241}
242
243BOOST_AUTO_TEST_CASE(intarg)
244{
245 ArgsManager local_args;
246
247 const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
248 const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
249 SetupArgs(local_args, {foo, bar});
250
251 ResetArgs(local_args, "");
252 BOOST_CHECK(!local_args.GetArg<int64_t>("-foo").has_value());
253 BOOST_CHECK(!local_args.GetArg<uint8_t>("-bar").has_value());
254 BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 11), 11);
255 BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 0), 0);
256 BOOST_CHECK_EQUAL(local_args.GetArg("-bar", uint8_t{222}), 222);
257 BOOST_CHECK_EQUAL(local_args.GetArg("-bar", uint8_t{0}), 0);
258
259 ResetArgs(local_args, "-foo -bar");
260 BOOST_CHECK_EQUAL(local_args.GetArg<int64_t>("-foo"), 0);
261 BOOST_CHECK_EQUAL(local_args.GetArg<uint8_t>("-bar"), 0);
262 BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 11), 0);
263 BOOST_CHECK_EQUAL(local_args.GetArg("-bar", uint8_t{222}), 0);
264
265 // Check under-/overflow behavior.
266 ResetArgs(local_args, "-foo=-9223372036854775809 -bar=9223372036854775808");
267 BOOST_CHECK_EQUAL(local_args.GetArg<int64_t>("-foo"), std::numeric_limits<int64_t>::min());
268 BOOST_CHECK_EQUAL(local_args.GetArg<uint8_t>("-bar"), std::numeric_limits<uint8_t>::max());
269 BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 0), std::numeric_limits<int64_t>::min());
270 BOOST_CHECK_EQUAL(local_args.GetIntArg("-bar", 0), std::numeric_limits<int64_t>::max());
271 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", uint8_t{0}), std::numeric_limits<uint8_t>::min());
272 BOOST_CHECK_EQUAL(local_args.GetArg("-bar", uint8_t{0}), std::numeric_limits<uint8_t>::max());
273
274 ResetArgs(local_args, "-foo=11 -bar=12");
275 BOOST_CHECK_EQUAL(local_args.GetArg<int64_t>("-foo"), 11);
276 BOOST_CHECK_EQUAL(local_args.GetArg<uint8_t>("-bar"), 12);
277 BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 0), 11);
278 BOOST_CHECK_EQUAL(local_args.GetArg("-bar", uint8_t{11}), 12);
279
280 ResetArgs(local_args, "-foo=NaN -bar=NotANumber");
281 BOOST_CHECK_EQUAL(local_args.GetArg<int64_t>("-foo"), 0);
282 BOOST_CHECK_EQUAL(local_args.GetArg<uint8_t>("-bar"), 0);
283 BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 1), 0);
284 BOOST_CHECK_EQUAL(local_args.GetArg("-bar", uint8_t{11}), 0);
285}
286
287BOOST_AUTO_TEST_CASE(patharg)
288{
289 ArgsManager local_args;
290
291 const auto dir = std::make_pair("-dir", ArgsManager::ALLOW_ANY);
292 SetupArgs(local_args, {dir});
293 ResetArgs(local_args, "");
294 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), fs::path{});
295
296 const fs::path root_path{"/"};
297 ResetArgs(local_args, "-dir=/");
298 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), root_path);
299
300 ResetArgs(local_args, "-dir=/.");
301 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), root_path);
302
303 ResetArgs(local_args, "-dir=/./");
304 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), root_path);
305
306 ResetArgs(local_args, "-dir=/.//");
307 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), root_path);
308
309#ifdef WIN32
310 const fs::path win_root_path{"C:\\"};
311 ResetArgs(local_args, "-dir=C:\\");
312 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
313
314 ResetArgs(local_args, "-dir=C:/");
315 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
316
317 ResetArgs(local_args, "-dir=C:\\\\");
318 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
319
320 ResetArgs(local_args, "-dir=C:\\.");
321 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
322
323 ResetArgs(local_args, "-dir=C:\\.\\");
324 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
325
326 ResetArgs(local_args, "-dir=C:\\.\\\\");
327 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
328#endif
329
330 const fs::path absolute_path{"/home/user/.bitcoin"};
331 ResetArgs(local_args, "-dir=/home/user/.bitcoin");
332 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
333
334 ResetArgs(local_args, "-dir=/root/../home/user/.bitcoin");
335 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
336
337 ResetArgs(local_args, "-dir=/home/./user/.bitcoin");
338 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
339
340 ResetArgs(local_args, "-dir=/home/user/.bitcoin/");
341 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
342
343 ResetArgs(local_args, "-dir=/home/user/.bitcoin//");
344 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
345
346 ResetArgs(local_args, "-dir=/home/user/.bitcoin/.");
347 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
348
349 ResetArgs(local_args, "-dir=/home/user/.bitcoin/./");
350 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
351
352 ResetArgs(local_args, "-dir=/home/user/.bitcoin/.//");
353 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
354
355 const fs::path relative_path{"user/.bitcoin"};
356 ResetArgs(local_args, "-dir=user/.bitcoin");
357 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
358
359 ResetArgs(local_args, "-dir=somewhere/../user/.bitcoin");
360 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
361
362 ResetArgs(local_args, "-dir=user/./.bitcoin");
363 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
364
365 ResetArgs(local_args, "-dir=user/.bitcoin/");
366 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
367
368 ResetArgs(local_args, "-dir=user/.bitcoin//");
369 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
370
371 ResetArgs(local_args, "-dir=user/.bitcoin/.");
372 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
373
374 ResetArgs(local_args, "-dir=user/.bitcoin/./");
375 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
376
377 ResetArgs(local_args, "-dir=user/.bitcoin/.//");
378 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
379
380 // Check negated and default argument handling. Specifying an empty argument
381 // is the same as not specifying the argument. This is convenient for
382 // scripting so later command line arguments can override earlier command
383 // line arguments or bitcoin.conf values. Currently the -dir= case cannot be
384 // distinguished from -dir case with no assignment, but #16545 would add the
385 // ability to distinguish these in the future (and treat the no-assign case
386 // like an imperative command or an error).
387 ResetArgs(local_args, "");
388 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{"default"});
389 ResetArgs(local_args, "-dir=override");
390 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{"override"});
391 ResetArgs(local_args, "-dir=");
392 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{"default"});
393 ResetArgs(local_args, "-dir");
394 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{"default"});
395 ResetArgs(local_args, "-nodir");
396 BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{""});
397}
398
399BOOST_AUTO_TEST_CASE(doubledash)
400{
401 ArgsManager local_args;
402
403 const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
404 const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
405 SetupArgs(local_args, {foo, bar});
406 ResetArgs(local_args, "--foo");
407 BOOST_CHECK_EQUAL(local_args.GetBoolArg("-foo", false), true);
408
409 ResetArgs(local_args, "--foo=verbose --bar=1");
410 BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "verbose");
411 BOOST_CHECK_EQUAL(local_args.GetIntArg("-bar", 0), 1);
412}
413
414BOOST_AUTO_TEST_CASE(boolargno)
415{
416 ArgsManager local_args;
417
418 const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
419 const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
420 SetupArgs(local_args, {foo, bar});
421 ResetArgs(local_args, "-nofoo");
422 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
423 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
424
425 ResetArgs(local_args, "-nofoo=1");
426 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
427 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
428
429 ResetArgs(local_args, "-nofoo=0");
430 BOOST_CHECK(local_args.GetBoolArg("-foo", true));
431 BOOST_CHECK(local_args.GetBoolArg("-foo", false));
432
433 ResetArgs(local_args, "-foo --nofoo"); // --nofoo should win
434 BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
435 BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
436
437 ResetArgs(local_args, "-nofoo -foo"); // foo always wins:
438 BOOST_CHECK(local_args.GetBoolArg("-foo", true));
439 BOOST_CHECK(local_args.GetBoolArg("-foo", false));
440}
441
442BOOST_AUTO_TEST_CASE(logargs)
443{
444 ArgsManager local_args;
445
446 const auto okaylog_bool = std::make_pair("-okaylog-bool", ArgsManager::ALLOW_ANY);
447 const auto okaylog_negbool = std::make_pair("-okaylog-negbool", ArgsManager::ALLOW_ANY);
448 const auto okaylog = std::make_pair("-okaylog", ArgsManager::ALLOW_ANY);
449 const auto dontlog = std::make_pair("-dontlog", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE);
450 SetupArgs(local_args, {okaylog_bool, okaylog_negbool, okaylog, dontlog});
451 ResetArgs(local_args, "-okaylog-bool -nookaylog-negbool -okaylog=public -dontlog=private42");
452
453 // Everything logged to debug.log will also append to str
454 std::string str;
455 auto print_connection = LogInstance().PushBackCallback(
456 [&str](const std::string& s) {
457 str += s;
458 });
459
460 // Log the arguments
461 local_args.LogArgs();
462
463 LogInstance().DeleteCallback(print_connection);
464 // Check that what should appear does, and what shouldn't doesn't.
465 BOOST_CHECK(str.find("Command-line arg: okaylog-bool=\"\"") != std::string::npos);
466 BOOST_CHECK(str.find("Command-line arg: okaylog-negbool=false") != std::string::npos);
467 BOOST_CHECK(str.find("Command-line arg: okaylog=\"public\"") != std::string::npos);
468 BOOST_CHECK(str.find("dontlog=****") != std::string::npos);
469 BOOST_CHECK(str.find("private42") == std::string::npos);
470}
471
472BOOST_AUTO_TEST_SUITE_END()
args
ArgsManager & args
Definition: bitcoind.cpp:277
ArgsManager::ALLOW_ANY
@ ALLOW_ANY
disable validation
Definition: args.h:110
ArgsManager::SENSITIVE
@ SENSITIVE
Definition: args.h:126
ArgsManager::GetSetting
common::SettingsValue GetSetting(const std::string &arg) const
Get setting value.
Definition: args.cpp:859
ArgsManager::LockSettings
void LockSettings(Fn &&fn)
Access settings with lock held.
Definition: args.h:425
ArgsManager::GetIntArg
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Definition: args.h:306
ArgsManager::LogArgs
void LogArgs() const
Log the config file options and the command line arguments, useful for troubleshooting.
Definition: args.cpp:890
ArgsManager::GetArg
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:461
ArgsManager::GetBoolArg
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:515
ArgsManager::AddArg
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
Definition: args.cpp:589
ArgsManager::GetPathArg
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
Definition: args.cpp:276
BCLog::Logger::PushBackCallback
std::list< std::function< void(conststd::string &)> >::iterator PushBackCallback(std::function< void(const std::string &)> fun) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Connect a slot to the print signal and return the connection.
Definition: logging.h:200
BCLog::Logger::DeleteCallback
void DeleteCallback(std::list< std::function< void(const std::string &)> >::iterator it) EXCLUSIVE_LOCKS_REQUIRED(!m_cs)
Delete a connection.
Definition: logging.h:208
UniValue::VNULL
@ VNULL
Definition: univalue.h:24
UniValue::VOBJ
@ VOBJ
Definition: univalue.h:24
UniValue::VARR
@ VARR
Definition: univalue.h:24
UniValue::write
std::string write(unsigned int prettyIndent=0, unsigned int indentLevel=0) const
Definition: univalue_write.cpp:30
BOOST_FIXTURE_TEST_SUITE
BOOST_FIXTURE_TEST_SUITE(cuckoocache_tests, BasicTestingSetup)
Test Suite for CuckooCache.
BOOST_AUTO_TEST_SUITE_END
BOOST_AUTO_TEST_SUITE_END()
ResetArgs
void ResetArgs(ArgsManager &local_args, const std::string &strArg)
Definition: getarg_tests.cpp:23
SetupArgs
void SetupArgs(ArgsManager &local_args, const std::vector< std::pair< std::string, unsigned int > > &args)
Definition: getarg_tests.cpp:43
BOOST_AUTO_TEST_CASE
BOOST_AUTO_TEST_CASE(setting_args)
Definition: getarg_tests.cpp:57
LogInstance
BCLog::Logger & LogInstance()
Definition: logging.cpp:26
test_vectors_musig2_generate.s
tuple s
Definition: test_vectors_musig2_generate.py:72
util::SplitString
std::vector< std::string > SplitString(std::string_view str, char sep)
Definition: string.h:149
BOOST_CHECK_THROW
#define BOOST_CHECK_THROW(stmt, excMatch)
Definition: object.cpp:18
BOOST_CHECK_EQUAL
#define BOOST_CHECK_EQUAL(v1, v2)
Definition: object.cpp:17
BOOST_CHECK
#define BOOST_CHECK(expr)
Definition: object.cpp:16
setup_common.h
BasicTestingSetup
Basic testing setup.
Definition: setup_common.h:64
common::Settings
Stored settings.
Definition: settings.h:32
common::Settings::rw_settings
std::map< std::string, SettingsValue > rw_settings
Map of setting name to read-write file setting value.
Definition: settings.h:38
Generated on Sat Feb 21 2026 20:00:33 for Bitcoin Core by doxygen 1.9.4