Add unit test NextString, ForEachNoDup functions

Remove testcase generating code from util_SettingsMerge so it can be reused in
new tests.

The hash value expected in util_SettingsMerge changes as a result of this, but
only because the testcases are generated in a different order, not because any
cases are added or removed. It is possible to verify this with:

    SETTINGS_MERGE_TEST_OUT=new.txt test/test_bitcoin --run_test=util_tests/util_SettingsMerge
    git checkout HEAD~1
    make test/test_bitcoin
    SETTINGS_MERGE_TEST_OUT=old.txt test/test_bitcoin --run_test=util_tests/util_SettingsMerge
    diff -u <(sort old.txt) <(sort new.txt)

The new output is a little more readable, with simpler testcases sorted first.
This commit is contained in:
Russell Yanofsky 2019-05-06 11:52:13 -04:00
parent 05bfee3451
commit 4b331159df
2 changed files with 40 additions and 35 deletions

View file

@ -34,5 +34,37 @@ std::string getnewaddress(CWallet& w);
/** Returns the generated coin */ /** Returns the generated coin */
CTxIn generatetoaddress(const std::string& address); CTxIn generatetoaddress(const std::string& address);
/**
* Increment a string. Useful to enumerate all fixed length strings with
* characters in [min_char, max_char].
*/
template <typename CharType, size_t StringLength>
bool NextString(CharType (&string)[StringLength], CharType min_char, CharType max_char)
{
for (CharType& elem : string) {
bool has_next = elem != max_char;
elem = elem < min_char || elem >= max_char ? min_char : CharType(elem + 1);
if (has_next) return true;
}
return false;
}
/**
* Iterate over string values and call function for each string without
* successive duplicate characters.
*/
template <typename CharType, size_t StringLength, typename Fn>
void ForEachNoDup(CharType (&string)[StringLength], CharType min_char, CharType max_char, Fn&& fn) {
for (bool has_next = true; has_next; has_next = NextString(string, min_char, max_char)) {
int prev = -1;
bool skip_string = false;
for (CharType c : string) {
if (c == prev) skip_string = true;
if (skip_string || c < min_char || c > max_char) break;
prev = c;
}
if (!skip_string) fn();
}
}
#endif // BITCOIN_TEST_UTIL_H #endif // BITCOIN_TEST_UTIL_H

View file

@ -7,6 +7,7 @@
#include <clientversion.h> #include <clientversion.h>
#include <primitives/transaction.h> #include <primitives/transaction.h>
#include <sync.h> #include <sync.h>
#include <test/util.h>
#include <util/strencodings.h> #include <util/strencodings.h>
#include <util/moneystr.h> #include <util/moneystr.h>
#include <test/setup_common.h> #include <test/setup_common.h>
@ -605,15 +606,17 @@ struct SettingsMergeTestingSetup : public BasicTestingSetup {
//! debugging to make test results easier to understand. //! debugging to make test results easier to understand.
static constexpr int MAX_ACTIONS = 3; static constexpr int MAX_ACTIONS = 3;
enum Action { SET = 0, NEGATE, SECTION_SET, SECTION_NEGATE, END }; enum Action { NONE, SET, NEGATE, SECTION_SET, SECTION_NEGATE };
using ActionList = Action[MAX_ACTIONS]; using ActionList = Action[MAX_ACTIONS];
//! Enumerate all possible test configurations. //! Enumerate all possible test configurations.
template <typename Fn> template <typename Fn>
void ForEachMergeSetup(Fn&& fn) void ForEachMergeSetup(Fn&& fn)
{ {
ForEachActionList([&](const ActionList& arg_actions) { ActionList arg_actions = {};
ForEachActionList([&](const ActionList& conf_actions) { ForEachNoDup(arg_actions, SET, SECTION_NEGATE, [&] {
ActionList conf_actions = {};
ForEachNoDup(conf_actions, SET, SECTION_NEGATE, [&] {
for (bool soft_set : {false, true}) { for (bool soft_set : {false, true}) {
for (bool force_set : {false, true}) { for (bool force_set : {false, true}) {
for (const std::string& section : {CBaseChainParams::MAIN, CBaseChainParams::TESTNET}) { for (const std::string& section : {CBaseChainParams::MAIN, CBaseChainParams::TESTNET}) {
@ -629,36 +632,6 @@ struct SettingsMergeTestingSetup : public BasicTestingSetup {
}); });
} }
//! Enumerate interesting combinations of actions.
template <typename Fn>
void ForEachActionList(Fn&& fn)
{
ActionList actions = {SET};
for (bool done = false; !done;) {
int prev_action = -1;
bool skip_actions = false;
for (Action action : actions) {
if ((prev_action == END && action != END) || (prev_action != END && action == prev_action)) {
// To cut down list of enumerated settings, skip enumerating
// settings with ignored actions after an END, and settings that
// repeat the same action twice in a row.
skip_actions = true;
break;
}
prev_action = action;
}
if (!skip_actions) fn(actions);
done = true;
for (Action& action : actions) {
action = Action(action < END ? action + 1 : 0);
if (action) {
done = false;
break;
}
}
}
}
//! Translate actions into a list of <key>=<value> setting strings. //! Translate actions into a list of <key>=<value> setting strings.
std::vector<std::string> GetValues(const ActionList& actions, std::vector<std::string> GetValues(const ActionList& actions,
const std::string& section, const std::string& section,
@ -668,7 +641,7 @@ struct SettingsMergeTestingSetup : public BasicTestingSetup {
std::vector<std::string> values; std::vector<std::string> values;
int suffix = 0; int suffix = 0;
for (Action action : actions) { for (Action action : actions) {
if (action == END) break; if (action == NONE) break;
std::string prefix; std::string prefix;
if (action == SECTION_SET || action == SECTION_NEGATE) prefix = section + "."; if (action == SECTION_SET || action == SECTION_NEGATE) prefix = section + ".";
if (action == SET || action == SECTION_SET) { if (action == SET || action == SECTION_SET) {
@ -801,7 +774,7 @@ BOOST_FIXTURE_TEST_CASE(util_SettingsMerge, SettingsMergeTestingSetup)
// Results file is formatted like: // Results file is formatted like:
// //
// <input> || <IsArgSet/IsArgNegated/GetArg output> | <GetArgs output> | <GetUnsuitable output> // <input> || <IsArgSet/IsArgNegated/GetArg output> | <GetArgs output> | <GetUnsuitable output>
BOOST_CHECK_EQUAL(out_sha_hex, "f4281d9bff4c0b398ff118386e3a40caa6bac7645e17b296d6a10b95bff632ae"); BOOST_CHECK_EQUAL(out_sha_hex, "b835eef5977d69114eb039a976201f8c7121f34fe2b7ea2b73cafb516e5c9dc8");
} }
BOOST_AUTO_TEST_CASE(util_FormatMoney) BOOST_AUTO_TEST_CASE(util_FormatMoney)