Skip to content

Commit 425bb30

Browse files
committed
refactor: Add util_CheckValue test
Test GetSetting and GetArg type coercion, negation, and default value handling. Test is expanded later to cover other flags besides ALLOW_ANY when they are implemented in bitcoin/bitcoin#16545 This commit does not change behavior.
1 parent 0fa5435 commit 425bb30

File tree

1 file changed

+108
-0
lines changed

1 file changed

+108
-0
lines changed

src/test/util_tests.cpp

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
#include <util/system.h>
66

77
#include <clientversion.h>
8+
#include <optional.h>
89
#include <sync.h>
910
#include <test/util/setup_common.h>
1011
#include <test/util.h>
@@ -189,12 +190,119 @@ struct TestArgsManager : public ArgsManager
189190
AddArg(arg.first, "", arg.second, OptionsCategory::OPTIONS);
190191
}
191192
}
193+
using ArgsManager::GetSetting;
194+
using ArgsManager::GetSettingsList;
192195
using ArgsManager::ReadConfigStream;
193196
using ArgsManager::cs_args;
194197
using ArgsManager::m_network;
195198
using ArgsManager::m_settings;
196199
};
197200

201+
//! Test GetSetting and GetArg type coercion, negation, and default value handling.
202+
class CheckValueTest : public TestChain100Setup
203+
{
204+
public:
205+
struct Expect {
206+
util::SettingsValue setting;
207+
bool default_string = false;
208+
bool default_int = false;
209+
bool default_bool = false;
210+
const char* string_value = nullptr;
211+
Optional<int64_t> int_value;
212+
Optional<bool> bool_value;
213+
Optional<std::vector<std::string>> list_value;
214+
const char* error = nullptr;
215+
216+
Expect(util::SettingsValue s) : setting(std::move(s)) {}
217+
Expect& DefaultString() { default_string = true; return *this; }
218+
Expect& DefaultInt() { default_int = true; return *this; }
219+
Expect& DefaultBool() { default_bool = true; return *this; }
220+
Expect& String(const char* s) { string_value = s; return *this; }
221+
Expect& Int(int64_t i) { int_value = i; return *this; }
222+
Expect& Bool(bool b) { bool_value = b; return *this; }
223+
Expect& List(std::vector<std::string> m) { list_value = std::move(m); return *this; }
224+
Expect& Error(const char* e) { error = e; return *this; }
225+
};
226+
227+
void CheckValue(unsigned int flags, const char* arg, const Expect& expect)
228+
{
229+
TestArgsManager test;
230+
test.SetupArgs({{"-value", flags}});
231+
const char* argv[] = {"ignored", arg};
232+
std::string error;
233+
bool success = test.ParseParameters(arg ? 2 : 1, (char**)argv, error);
234+
235+
BOOST_CHECK_EQUAL(test.GetSetting("-value").write(), expect.setting.write());
236+
auto settings_list = test.GetSettingsList("-value");
237+
if (expect.setting.isNull() || expect.setting.isFalse()) {
238+
BOOST_CHECK_EQUAL(settings_list.size(), 0);
239+
} else {
240+
BOOST_CHECK_EQUAL(settings_list.size(), 1);
241+
BOOST_CHECK_EQUAL(settings_list[0].write(), expect.setting.write());
242+
}
243+
244+
if (expect.error) {
245+
BOOST_CHECK(!success);
246+
BOOST_CHECK_NE(error.find(expect.error), std::string::npos);
247+
} else {
248+
BOOST_CHECK(success);
249+
BOOST_CHECK_EQUAL(error, "");
250+
}
251+
252+
if (expect.default_string) {
253+
BOOST_CHECK_EQUAL(test.GetArg("-value", "zzzzz"), "zzzzz");
254+
} else if (expect.string_value) {
255+
BOOST_CHECK_EQUAL(test.GetArg("-value", "zzzzz"), expect.string_value);
256+
} else {
257+
BOOST_CHECK(!success);
258+
}
259+
260+
if (expect.default_int) {
261+
BOOST_CHECK_EQUAL(test.GetArg("-value", 99999), 99999);
262+
} else if (expect.int_value) {
263+
BOOST_CHECK_EQUAL(test.GetArg("-value", 99999), *expect.int_value);
264+
} else {
265+
BOOST_CHECK(!success);
266+
}
267+
268+
if (expect.default_bool) {
269+
BOOST_CHECK_EQUAL(test.GetBoolArg("-value", false), false);
270+
BOOST_CHECK_EQUAL(test.GetBoolArg("-value", true), true);
271+
} else if (expect.bool_value) {
272+
BOOST_CHECK_EQUAL(test.GetBoolArg("-value", false), *expect.bool_value);
273+
BOOST_CHECK_EQUAL(test.GetBoolArg("-value", true), *expect.bool_value);
274+
} else {
275+
BOOST_CHECK(!success);
276+
}
277+
278+
if (expect.list_value) {
279+
auto l = test.GetArgs("-value");
280+
BOOST_CHECK_EQUAL_COLLECTIONS(l.begin(), l.end(), expect.list_value->begin(), expect.list_value->end());
281+
} else {
282+
BOOST_CHECK(!success);
283+
}
284+
}
285+
};
286+
287+
BOOST_FIXTURE_TEST_CASE(util_CheckValue, CheckValueTest)
288+
{
289+
using M = ArgsManager;
290+
291+
CheckValue(M::ALLOW_ANY, nullptr, Expect{{}}.DefaultString().DefaultInt().DefaultBool().List({}));
292+
CheckValue(M::ALLOW_ANY, "-novalue", Expect{false}.String("0").Int(0).Bool(false).List({}));
293+
CheckValue(M::ALLOW_ANY, "-novalue=", Expect{false}.String("0").Int(0).Bool(false).List({}));
294+
CheckValue(M::ALLOW_ANY, "-novalue=0", Expect{true}.String("1").Int(1).Bool(true).List({"1"}));
295+
CheckValue(M::ALLOW_ANY, "-novalue=1", Expect{false}.String("0").Int(0).Bool(false).List({}));
296+
CheckValue(M::ALLOW_ANY, "-novalue=2", Expect{false}.String("0").Int(0).Bool(false).List({}));
297+
CheckValue(M::ALLOW_ANY, "-novalue=abc", Expect{true}.String("1").Int(1).Bool(true).List({"1"}));
298+
CheckValue(M::ALLOW_ANY, "-value", Expect{""}.String("").Int(0).Bool(true).List({""}));
299+
CheckValue(M::ALLOW_ANY, "-value=", Expect{""}.String("").Int(0).Bool(true).List({""}));
300+
CheckValue(M::ALLOW_ANY, "-value=0", Expect{"0"}.String("0").Int(0).Bool(false).List({"0"}));
301+
CheckValue(M::ALLOW_ANY, "-value=1", Expect{"1"}.String("1").Int(1).Bool(true).List({"1"}));
302+
CheckValue(M::ALLOW_ANY, "-value=2", Expect{"2"}.String("2").Int(2).Bool(true).List({"2"}));
303+
CheckValue(M::ALLOW_ANY, "-value=abc", Expect{"abc"}.String("abc").Int(0).Bool(false).List({"abc"}));
304+
}
305+
198306
BOOST_AUTO_TEST_CASE(util_ParseParameters)
199307
{
200308
TestArgsManager testArgs;

0 commit comments

Comments
 (0)