github/bitcoin
1
Fork 0
mirror of https://github.com/bitcoin/bitcoin synced 2024-09-27 04:20:02 +02:00
Code Releases Activity
b767e6bd47
bitcoin/src/test/getarg_tests.cpp
TheCharlatan db77f87c63
scripted-diff: move settings to common namespace 
-BEGIN VERIFY SCRIPT-
sed -i 's/namespace\ util/namespace\ common/g' src/common/settings.cpp src/common/settings.h
sed -i 's/util\:\:GetSetting/common\:\:GetSetting/g' $( git grep -l 'util\:\:GetSetting')
sed -i 's/util\:\:Setting/common\:\:Setting/g' $( git grep -l 'util\:\:Setting')
sed -i 's/util\:\:FindKey/common\:\:FindKey/g' $( git grep -l 'util\:\:FindKey')
sed -i 's/util\:\:ReadSettings/common\:\:ReadSettings/g' $( git grep -l 'util\:\:ReadSettings')
sed -i 's/util\:\:WriteSettings/common\:\:WriteSettings/g' $( git grep -l 'util\:\:WriteSettings')
-END VERIFY SCRIPT-
2023-05-30 17:26:51 +02:00

456 lines
18 KiB
C++
Raw Blame History

// Copyright (c) 2012-2022 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#include <common/args.h>
#include <common/settings.h>
#include <logging.h>
#include <test/util/setup_common.h>
#include <univalue.h>
#include <util/strencodings.h>
#include <limits>
#include <string>
#include <utility>
#include <vector>
#include <boost/test/unit_test.hpp>
BOOST_FIXTURE_TEST_SUITE(getarg_tests, BasicTestingSetup)
void ResetArgs(ArgsManager& local_args, const std::string& strArg)
{
std::vector<std::string> vecArg;
if (strArg.size()) {
vecArg = SplitString(strArg, ' ');
}
// Insert dummy executable name:
vecArg.insert(vecArg.begin(), "testbitcoin");
// Convert to char*:
std::vector<const char*> vecChar;
vecChar.reserve(vecArg.size());
for (const std::string& s : vecArg)
vecChar.push_back(s.c_str());
std::string error;
BOOST_CHECK(local_args.ParseParameters(vecChar.size(), vecChar.data(), error));
}
void SetupArgs(ArgsManager& local_args, const std::vector<std::pair<std::string, unsigned int>>& args)
{
for (const auto& arg : args) {
local_args.AddArg(arg.first, "", arg.second, OptionsCategory::OPTIONS);
}
}
// Test behavior of GetArg functions when string, integer, and boolean types
// are specified in the settings.json file. GetArg functions are convenience
// functions. The GetSetting method can always be used instead of GetArg
// methods to retrieve original values, and there's not always an objective
// answer to what GetArg behavior is best in every case. This test makes sure
// there's test coverage for whatever the current behavior is, so it's not
// broken or changed unintentionally.
BOOST_AUTO_TEST_CASE(setting_args)
{
ArgsManager args;
SetupArgs(args, {{"-foo", ArgsManager::ALLOW_ANY}});
auto set_foo = [&](const common::SettingsValue& value) {
args.LockSettings([&](common::Settings& settings) {
settings.rw_settings["foo"] = value;
});
};
set_foo("str");
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"str\"");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "str");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
set_foo("99");
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"99\"");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "99");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 99);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
set_foo("3.25");
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"3.25\"");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "3.25");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 3);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
set_foo("0");
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"0\"");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
set_foo("");
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "\"\"");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
set_foo(99);
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "99");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "99");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 99);
BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
set_foo(3.25);
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "3.25");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "3.25");
BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
set_foo(0);
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "0");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
set_foo(true);
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "true");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "1");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 1);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), true);
set_foo(false);
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "false");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "0");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 0);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), false);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
set_foo(UniValue::VOBJ);
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "{}");
BOOST_CHECK_THROW(args.GetArg("foo", "default"), std::runtime_error);
BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
set_foo(UniValue::VARR);
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "[]");
BOOST_CHECK_THROW(args.GetArg("foo", "default"), std::runtime_error);
BOOST_CHECK_THROW(args.GetIntArg("foo", 100), std::runtime_error);
BOOST_CHECK_THROW(args.GetBoolArg("foo", true), std::runtime_error);
BOOST_CHECK_THROW(args.GetBoolArg("foo", false), std::runtime_error);
set_foo(UniValue::VNULL);
BOOST_CHECK_EQUAL(args.GetSetting("foo").write(), "null");
BOOST_CHECK_EQUAL(args.GetArg("foo", "default"), "default");
BOOST_CHECK_EQUAL(args.GetIntArg("foo", 100), 100);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", true), true);
BOOST_CHECK_EQUAL(args.GetBoolArg("foo", false), false);
}
BOOST_AUTO_TEST_CASE(boolarg)
{
ArgsManager local_args;
const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
SetupArgs(local_args, {foo});
ResetArgs(local_args, "-foo");
BOOST_CHECK(local_args.GetBoolArg("-foo", false));
BOOST_CHECK(local_args.GetBoolArg("-foo", true));
BOOST_CHECK(!local_args.GetBoolArg("-fo", false));
BOOST_CHECK(local_args.GetBoolArg("-fo", true));
BOOST_CHECK(!local_args.GetBoolArg("-fooo", false));
BOOST_CHECK(local_args.GetBoolArg("-fooo", true));
ResetArgs(local_args, "-foo=0");
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
ResetArgs(local_args, "-foo=1");
BOOST_CHECK(local_args.GetBoolArg("-foo", false));
BOOST_CHECK(local_args.GetBoolArg("-foo", true));
// New 0.6 feature: auto-map -nosomething to !-something:
ResetArgs(local_args, "-nofoo");
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
ResetArgs(local_args, "-nofoo=1");
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
ResetArgs(local_args, "-foo -nofoo"); // -nofoo should win
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
ResetArgs(local_args, "-foo=1 -nofoo=1"); // -nofoo should win
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
ResetArgs(local_args, "-foo=0 -nofoo=0"); // -nofoo=0 should win
BOOST_CHECK(local_args.GetBoolArg("-foo", false));
BOOST_CHECK(local_args.GetBoolArg("-foo", true));
// New 0.6 feature: treat -- same as -:
ResetArgs(local_args, "--foo=1");
BOOST_CHECK(local_args.GetBoolArg("-foo", false));
BOOST_CHECK(local_args.GetBoolArg("-foo", true));
ResetArgs(local_args, "--nofoo=1");
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
}
BOOST_AUTO_TEST_CASE(stringarg)
{
ArgsManager local_args;
const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
SetupArgs(local_args, {foo, bar});
ResetArgs(local_args, "");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "eleven");
ResetArgs(local_args, "-foo -bar");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "");
ResetArgs(local_args, "-foo=");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "");
ResetArgs(local_args, "-foo=11");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "11");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "11");
ResetArgs(local_args, "-foo=eleven");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "eleven");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", "eleven"), "eleven");
}
BOOST_AUTO_TEST_CASE(intarg)
{
ArgsManager local_args;
const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
SetupArgs(local_args, {foo, bar});
ResetArgs(local_args, "");
BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 11), 11);
BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 0), 0);
ResetArgs(local_args, "-foo -bar");
BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 11), 0);
BOOST_CHECK_EQUAL(local_args.GetIntArg("-bar", 11), 0);
// Check under-/overflow behavior.
ResetArgs(local_args, "-foo=-9223372036854775809 -bar=9223372036854775808");
BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 0), std::numeric_limits<int64_t>::min());
BOOST_CHECK_EQUAL(local_args.GetIntArg("-bar", 0), std::numeric_limits<int64_t>::max());
ResetArgs(local_args, "-foo=11 -bar=12");
BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 0), 11);
BOOST_CHECK_EQUAL(local_args.GetIntArg("-bar", 11), 12);
ResetArgs(local_args, "-foo=NaN -bar=NotANumber");
BOOST_CHECK_EQUAL(local_args.GetIntArg("-foo", 1), 0);
BOOST_CHECK_EQUAL(local_args.GetIntArg("-bar", 11), 0);
}
BOOST_AUTO_TEST_CASE(patharg)
{
ArgsManager local_args;
const auto dir = std::make_pair("-dir", ArgsManager::ALLOW_ANY);
SetupArgs(local_args, {dir});
ResetArgs(local_args, "");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), fs::path{});
const fs::path root_path{"/"};
ResetArgs(local_args, "-dir=/");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), root_path);
ResetArgs(local_args, "-dir=/.");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), root_path);
ResetArgs(local_args, "-dir=/./");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), root_path);
ResetArgs(local_args, "-dir=/.//");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), root_path);
#ifdef WIN32
const fs::path win_root_path{"C:\\"};
ResetArgs(local_args, "-dir=C:\\");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
ResetArgs(local_args, "-dir=C:/");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
ResetArgs(local_args, "-dir=C:\\\\");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
ResetArgs(local_args, "-dir=C:\\.");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
ResetArgs(local_args, "-dir=C:\\.\\");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
ResetArgs(local_args, "-dir=C:\\.\\\\");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), win_root_path);
#endif
const fs::path absolute_path{"/home/user/.bitcoin"};
ResetArgs(local_args, "-dir=/home/user/.bitcoin");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
ResetArgs(local_args, "-dir=/root/../home/user/.bitcoin");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
ResetArgs(local_args, "-dir=/home/./user/.bitcoin");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
ResetArgs(local_args, "-dir=/home/user/.bitcoin/");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
ResetArgs(local_args, "-dir=/home/user/.bitcoin//");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
ResetArgs(local_args, "-dir=/home/user/.bitcoin/.");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
ResetArgs(local_args, "-dir=/home/user/.bitcoin/./");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
ResetArgs(local_args, "-dir=/home/user/.bitcoin/.//");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), absolute_path);
const fs::path relative_path{"user/.bitcoin"};
ResetArgs(local_args, "-dir=user/.bitcoin");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
ResetArgs(local_args, "-dir=somewhere/../user/.bitcoin");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
ResetArgs(local_args, "-dir=user/./.bitcoin");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
ResetArgs(local_args, "-dir=user/.bitcoin/");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
ResetArgs(local_args, "-dir=user/.bitcoin//");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
ResetArgs(local_args, "-dir=user/.bitcoin/.");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
ResetArgs(local_args, "-dir=user/.bitcoin/./");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
ResetArgs(local_args, "-dir=user/.bitcoin/.//");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir"), relative_path);
// Check negated and default argument handling. Specifying an empty argument
// is the same as not specifying the argument. This is convenient for
// scripting so later command line arguments can override earlier command
// line arguments or bitcoin.conf values. Currently the -dir= case cannot be
// distinguished from -dir case with no assignment, but #16545 would add the
// ability to distinguish these in the future (and treat the no-assign case
// like an imperative command or an error).
ResetArgs(local_args, "");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{"default"});
ResetArgs(local_args, "-dir=override");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{"override"});
ResetArgs(local_args, "-dir=");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{"default"});
ResetArgs(local_args, "-dir");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{"default"});
ResetArgs(local_args, "-nodir");
BOOST_CHECK_EQUAL(local_args.GetPathArg("-dir", "default"), fs::path{""});
}
BOOST_AUTO_TEST_CASE(doubledash)
{
ArgsManager local_args;
const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
SetupArgs(local_args, {foo, bar});
ResetArgs(local_args, "--foo");
BOOST_CHECK_EQUAL(local_args.GetBoolArg("-foo", false), true);
ResetArgs(local_args, "--foo=verbose --bar=1");
BOOST_CHECK_EQUAL(local_args.GetArg("-foo", ""), "verbose");
BOOST_CHECK_EQUAL(local_args.GetIntArg("-bar", 0), 1);
}
BOOST_AUTO_TEST_CASE(boolargno)
{
ArgsManager local_args;
const auto foo = std::make_pair("-foo", ArgsManager::ALLOW_ANY);
const auto bar = std::make_pair("-bar", ArgsManager::ALLOW_ANY);
SetupArgs(local_args, {foo, bar});
ResetArgs(local_args, "-nofoo");
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
ResetArgs(local_args, "-nofoo=1");
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
ResetArgs(local_args, "-nofoo=0");
BOOST_CHECK(local_args.GetBoolArg("-foo", true));
BOOST_CHECK(local_args.GetBoolArg("-foo", false));
ResetArgs(local_args, "-foo --nofoo"); // --nofoo should win
BOOST_CHECK(!local_args.GetBoolArg("-foo", true));
BOOST_CHECK(!local_args.GetBoolArg("-foo", false));
ResetArgs(local_args, "-nofoo -foo"); // foo always wins:
BOOST_CHECK(local_args.GetBoolArg("-foo", true));
BOOST_CHECK(local_args.GetBoolArg("-foo", false));
}
BOOST_AUTO_TEST_CASE(logargs)
{
ArgsManager local_args;
const auto okaylog_bool = std::make_pair("-okaylog-bool", ArgsManager::ALLOW_ANY);
const auto okaylog_negbool = std::make_pair("-okaylog-negbool", ArgsManager::ALLOW_ANY);
const auto okaylog = std::make_pair("-okaylog", ArgsManager::ALLOW_ANY);
const auto dontlog = std::make_pair("-dontlog", ArgsManager::ALLOW_ANY | ArgsManager::SENSITIVE);
SetupArgs(local_args, {okaylog_bool, okaylog_negbool, okaylog, dontlog});
ResetArgs(local_args, "-okaylog-bool -nookaylog-negbool -okaylog=public -dontlog=private42");
// Everything logged to debug.log will also append to str
std::string str;
auto print_connection = LogInstance().PushBackCallback(
[&str](const std::string& s) {
str += s;
});
// Log the arguments
local_args.LogArgs();
LogInstance().DeleteCallback(print_connection);
// Check that what should appear does, and what shouldn't doesn't.
BOOST_CHECK(str.find("Command-line arg: okaylog-bool=\"\"") != std::string::npos);
BOOST_CHECK(str.find("Command-line arg: okaylog-negbool=false") != std::string::npos);
BOOST_CHECK(str.find("Command-line arg: okaylog=\"public\"") != std::string::npos);
BOOST_CHECK(str.find("dontlog=****") != std::string::npos);
BOOST_CHECK(str.find("private42") == std::string::npos);
}
BOOST_AUTO_TEST_SUITE_END()
View Git Blame Copy Permalink