mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-09-12 13:42:10 +02:00
e8691056c0
Using `&&` in `BOOST_CHECK` is problematic as failures will not indicate which condition failed. By unrolling these checks, the user knows exactly which expression is the failing case. As an example, here is a line that would be particularly hard to debug if it failed: ``` src/test/net_tests.cpp BOOST_CHECK((*ret)[1] && (*ret)[1]->m_type == "headers" && std::ranges::equal((*ret)[1]->m_recv, MakeByteSpan(msg_data_2))); ``` If any one of these conditions fail, the whole expression fails, with no values printed or indication as to which condition failed. This is also required when using test macros that support value decomposition, which requires `&&` and `||` are `delete`. Examples include `BOOST_TEST`, doctest, Catch2, etc. ref: https://catch2-temp.readthedocs.io/en/latest/assertions.html#other-limitations ref: https://fekir.info/post/decomposing-an-expression/
293 lines
11 KiB
C++
293 lines
11 KiB
C++
// Copyright (c) 2014-present 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 <chain.h>
|
|
#include <test/util/random.h>
|
|
#include <test/util/setup_common.h>
|
|
|
|
#include <algorithm>
|
|
#include <vector>
|
|
#include <utility>
|
|
|
|
#include <boost/test/unit_test.hpp>
|
|
|
|
#define SKIPLIST_LENGTH 300000
|
|
|
|
BOOST_FIXTURE_TEST_SUITE(skiplist_tests, BasicTestingSetup)
|
|
|
|
BOOST_AUTO_TEST_CASE(skiplist_test)
|
|
{
|
|
std::vector<CBlockIndex> vIndex(SKIPLIST_LENGTH);
|
|
|
|
for (int i=0; i<SKIPLIST_LENGTH; i++) {
|
|
vIndex[i].nHeight = i;
|
|
vIndex[i].pprev = (i == 0) ? nullptr : &vIndex[i - 1];
|
|
vIndex[i].BuildSkip();
|
|
}
|
|
|
|
for (int i=0; i<SKIPLIST_LENGTH; i++) {
|
|
if (i > 0) {
|
|
BOOST_CHECK(vIndex[i].pskip == &vIndex[vIndex[i].pskip->nHeight]);
|
|
BOOST_CHECK(vIndex[i].pskip->nHeight < i);
|
|
} else {
|
|
BOOST_CHECK(vIndex[i].pskip == nullptr);
|
|
}
|
|
}
|
|
|
|
for (int i=0; i < 1000; i++) {
|
|
int from = m_rng.randrange(SKIPLIST_LENGTH - 1);
|
|
int to = m_rng.randrange(from + 1);
|
|
|
|
BOOST_CHECK(vIndex[SKIPLIST_LENGTH - 1].GetAncestor(from) == &vIndex[from]);
|
|
BOOST_CHECK(vIndex[from].GetAncestor(to) == &vIndex[to]);
|
|
BOOST_CHECK(vIndex[from].GetAncestor(0) == vIndex.data());
|
|
}
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(getlocator_test)
|
|
{
|
|
// Build a main chain 100000 blocks long.
|
|
std::vector<uint256> vHashMain(100000);
|
|
std::vector<CBlockIndex> vBlocksMain(100000);
|
|
for (unsigned int i=0; i<vBlocksMain.size(); i++) {
|
|
vHashMain[i] = ArithToUint256(i); // Set the hash equal to the height, so we can quickly check the distances.
|
|
vBlocksMain[i].nHeight = i;
|
|
vBlocksMain[i].pprev = i ? &vBlocksMain[i - 1] : nullptr;
|
|
vBlocksMain[i].phashBlock = &vHashMain[i];
|
|
vBlocksMain[i].BuildSkip();
|
|
BOOST_CHECK_EQUAL((int)UintToArith256(vBlocksMain[i].GetBlockHash()).GetLow64(), vBlocksMain[i].nHeight);
|
|
BOOST_CHECK(vBlocksMain[i].pprev == nullptr || vBlocksMain[i].nHeight == vBlocksMain[i].pprev->nHeight + 1);
|
|
}
|
|
|
|
// Build a branch that splits off at block 49999, 50000 blocks long.
|
|
std::vector<uint256> vHashSide(50000);
|
|
std::vector<CBlockIndex> vBlocksSide(50000);
|
|
for (unsigned int i=0; i<vBlocksSide.size(); i++) {
|
|
vHashSide[i] = ArithToUint256(i + 50000 + (arith_uint256(1) << 128)); // Add 1<<128 to the hashes, so GetLow64() still returns the height.
|
|
vBlocksSide[i].nHeight = i + 50000;
|
|
vBlocksSide[i].pprev = i ? &vBlocksSide[i - 1] : (vBlocksMain.data()+49999);
|
|
vBlocksSide[i].phashBlock = &vHashSide[i];
|
|
vBlocksSide[i].BuildSkip();
|
|
BOOST_CHECK_EQUAL((int)UintToArith256(vBlocksSide[i].GetBlockHash()).GetLow64(), vBlocksSide[i].nHeight);
|
|
BOOST_CHECK(vBlocksSide[i].pprev == nullptr || vBlocksSide[i].nHeight == vBlocksSide[i].pprev->nHeight + 1);
|
|
}
|
|
|
|
// Build a CChain for the main branch.
|
|
CChain chain;
|
|
chain.SetTip(vBlocksMain.back());
|
|
|
|
// Test 100 random starting points for locators.
|
|
for (int n=0; n<100; n++) {
|
|
int r = m_rng.randrange(150000);
|
|
CBlockIndex* tip = (r < 100000) ? &vBlocksMain[r] : &vBlocksSide[r - 100000];
|
|
CBlockLocator locator = GetLocator(tip);
|
|
|
|
// The first result must be the block itself, the last one must be genesis.
|
|
BOOST_CHECK(locator.vHave.front() == tip->GetBlockHash());
|
|
BOOST_CHECK(locator.vHave.back() == vBlocksMain[0].GetBlockHash());
|
|
|
|
// Entries 1 through 11 (inclusive) go back one step each.
|
|
for (unsigned int i = 1; i < 12 && i < locator.vHave.size() - 1; i++) {
|
|
BOOST_CHECK_EQUAL(UintToArith256(locator.vHave[i]).GetLow64(), tip->nHeight - i);
|
|
}
|
|
|
|
// The further ones (excluding the last one) go back with exponential steps.
|
|
unsigned int dist = 2;
|
|
for (unsigned int i = 12; i < locator.vHave.size() - 1; i++) {
|
|
BOOST_CHECK_EQUAL(UintToArith256(locator.vHave[i - 1]).GetLow64() - UintToArith256(locator.vHave[i]).GetLow64(), dist);
|
|
dist *= 2;
|
|
}
|
|
}
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(findearliestatleast_test)
|
|
{
|
|
std::vector<uint256> vHashMain(100000);
|
|
std::vector<CBlockIndex> vBlocksMain(100000);
|
|
for (unsigned int i=0; i<vBlocksMain.size(); i++) {
|
|
vHashMain[i] = ArithToUint256(i); // Set the hash equal to the height
|
|
vBlocksMain[i].nHeight = i;
|
|
vBlocksMain[i].pprev = i ? &vBlocksMain[i - 1] : nullptr;
|
|
vBlocksMain[i].phashBlock = &vHashMain[i];
|
|
vBlocksMain[i].BuildSkip();
|
|
if (i < 10) {
|
|
vBlocksMain[i].nTime = i;
|
|
vBlocksMain[i].nTimeMax = i;
|
|
} else {
|
|
// randomly choose something in the range [MTP, MTP*2]
|
|
int64_t medianTimePast = vBlocksMain[i].GetMedianTimePast();
|
|
int r{int(m_rng.randrange(medianTimePast))};
|
|
vBlocksMain[i].nTime = uint32_t(r + medianTimePast);
|
|
vBlocksMain[i].nTimeMax = std::max(vBlocksMain[i].nTime, vBlocksMain[i-1].nTimeMax);
|
|
}
|
|
}
|
|
// Check that we set nTimeMax up correctly.
|
|
unsigned int curTimeMax = 0;
|
|
for (unsigned int i=0; i<vBlocksMain.size(); ++i) {
|
|
curTimeMax = std::max(curTimeMax, vBlocksMain[i].nTime);
|
|
BOOST_CHECK(curTimeMax == vBlocksMain[i].nTimeMax);
|
|
}
|
|
|
|
// Build a CChain for the main branch.
|
|
CChain chain;
|
|
chain.SetTip(vBlocksMain.back());
|
|
|
|
// Verify that FindEarliestAtLeast is correct.
|
|
for (unsigned int i=0; i<10000; ++i) {
|
|
// Pick a random element in vBlocksMain.
|
|
int r = m_rng.randrange(vBlocksMain.size());
|
|
int64_t test_time = vBlocksMain[r].nTime;
|
|
CBlockIndex* ret = chain.FindEarliestAtLeast(test_time, 0);
|
|
BOOST_CHECK(ret->nTimeMax >= test_time);
|
|
BOOST_CHECK((ret->pprev==nullptr) || ret->pprev->nTimeMax < test_time);
|
|
BOOST_CHECK(vBlocksMain[r].GetAncestor(ret->nHeight) == ret);
|
|
}
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(findearliestatleast_edge_test)
|
|
{
|
|
std::list<CBlockIndex> blocks;
|
|
for (const unsigned int timeMax : {100, 100, 100, 200, 200, 200, 300, 300, 300}) {
|
|
CBlockIndex* prev = blocks.empty() ? nullptr : &blocks.back();
|
|
blocks.emplace_back();
|
|
blocks.back().nHeight = prev ? prev->nHeight + 1 : 0;
|
|
blocks.back().pprev = prev;
|
|
blocks.back().BuildSkip();
|
|
blocks.back().nTimeMax = timeMax;
|
|
}
|
|
|
|
CChain chain;
|
|
chain.SetTip(blocks.back());
|
|
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(50, 0)->nHeight, 0);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(100, 0)->nHeight, 0);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(150, 0)->nHeight, 3);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(200, 0)->nHeight, 3);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(250, 0)->nHeight, 6);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(300, 0)->nHeight, 6);
|
|
BOOST_CHECK(!chain.FindEarliestAtLeast(350, 0));
|
|
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(0, 0)->nHeight, 0);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(-1, 0)->nHeight, 0);
|
|
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(std::numeric_limits<int64_t>::min(), 0)->nHeight, 0);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(-int64_t(std::numeric_limits<unsigned int>::max()) - 1, 0)->nHeight, 0);
|
|
BOOST_CHECK(!chain.FindEarliestAtLeast(std::numeric_limits<int64_t>::max(), 0));
|
|
BOOST_CHECK(!chain.FindEarliestAtLeast(std::numeric_limits<unsigned int>::max(), 0));
|
|
BOOST_CHECK(!chain.FindEarliestAtLeast(int64_t(std::numeric_limits<unsigned int>::max()) + 1, 0));
|
|
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(0, -1)->nHeight, 0);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(0, 0)->nHeight, 0);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(0, 3)->nHeight, 3);
|
|
BOOST_CHECK_EQUAL(chain.FindEarliestAtLeast(0, 8)->nHeight, 8);
|
|
BOOST_CHECK(!chain.FindEarliestAtLeast(0, 9));
|
|
|
|
CBlockIndex* ret1 = chain.FindEarliestAtLeast(100, 2);
|
|
BOOST_CHECK(ret1->nTimeMax >= 100);
|
|
BOOST_CHECK(ret1->nHeight == 2);
|
|
BOOST_CHECK(!chain.FindEarliestAtLeast(300, 9));
|
|
CBlockIndex* ret2 = chain.FindEarliestAtLeast(200, 4);
|
|
BOOST_CHECK(ret2->nTimeMax >= 200);
|
|
BOOST_CHECK(ret2->nHeight == 4);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(build_skip_height_test)
|
|
{
|
|
// clang-format off
|
|
const std::pair<int, int> TEST_DATA[]{
|
|
// EVEN values: the rightmost set bit is zeroed
|
|
// Various even values with at least 2 bits set
|
|
{ 0b00010010 ,
|
|
0b00010000 },
|
|
{ 0b00100010 ,
|
|
0b00100000 },
|
|
{ 0b01000010 ,
|
|
0b01000000 },
|
|
{ 0b00010100 ,
|
|
0b00010000 },
|
|
{ 0b00011000 ,
|
|
0b00010000 },
|
|
{ 0b10101010 ,
|
|
0b10101000 },
|
|
// ODD values: the 2nd and 3rd set bits are zeroed
|
|
// Various odd values with at least 4 bits set
|
|
{ 0b10010011 ,
|
|
0b10000001 },
|
|
{ 0b10100011 ,
|
|
0b10000001 },
|
|
{ 0b11000011 ,
|
|
0b10000001 },
|
|
{ 0b10010101 ,
|
|
0b10000001 },
|
|
{ 0b10011001 ,
|
|
0b10000001 },
|
|
{ 0b10101011 ,
|
|
0b10100001 },
|
|
// Some longer random values (even and odd)
|
|
{ 0b0001011101101000 ,
|
|
0b0001011101100000 },
|
|
{ 0b0001011101101001 ,
|
|
0b0001011101000001 },
|
|
{ 0b0110101101011000 ,
|
|
0b0110101101010000 },
|
|
{ 0b0110101101011001 ,
|
|
0b0110101101000001 },
|
|
// All values 1-20
|
|
{ 1, 0 },
|
|
{ 2, 0 },
|
|
{ 3, 1 },
|
|
{ 4, 0 },
|
|
{ 5, 1 },
|
|
{ 6, 4 },
|
|
{ 7, 1 },
|
|
{ 8, 0 },
|
|
{ 9, 1 },
|
|
{ 10, 8 },
|
|
{ 11, 1 },
|
|
{ 12, 8 },
|
|
{ 13, 1 },
|
|
{ 14, 12 },
|
|
{ 15, 9 },
|
|
{ 16, 0 },
|
|
{ 17, 1 },
|
|
{ 18, 16 },
|
|
{ 19, 1 },
|
|
{ 20, 16 },
|
|
};
|
|
// clang-format on
|
|
|
|
// Test `CBlockIndex::BuildSkip()` and that the skip height conforms to expected logic.
|
|
// It tests that:
|
|
// - `pprev` field is set (to an earlier block index),
|
|
// - the skip is to the index as dictated by the `GetSkipHeight()` bit-manipulation logic,
|
|
// - `GetAncestor()` works as expected (indirectly).
|
|
|
|
// Build a chain (up to the highest test input value)
|
|
const auto max_test_input{std::ranges::max_element(TEST_DATA, [](auto& a, auto& b) { return a.first < b.first; })};
|
|
const int chain_size{max_test_input->first + 1};
|
|
std::vector<CBlockIndex> block_index(chain_size);
|
|
for (auto i{0}; i < chain_size; ++i) {
|
|
// pprev and nHeight are used by BuildSkip()
|
|
block_index[i].pprev = i == 0 ? nullptr : &block_index[i - 1];
|
|
block_index[i].nHeight = i;
|
|
block_index[i].BuildSkip();
|
|
BOOST_CHECK(block_index[i].pskip || i == 0);
|
|
}
|
|
|
|
for (auto& [input, expected] : TEST_DATA) {
|
|
BOOST_REQUIRE_LT(input, chain_size);
|
|
BOOST_REQUIRE_GT(input, 0);
|
|
BOOST_REQUIRE_LT(expected, input);
|
|
BOOST_REQUIRE(block_index[input].pskip);
|
|
|
|
const int skip_height{block_index[input].pskip->nHeight};
|
|
BOOST_CHECK_EQUAL(skip_height, expected);
|
|
}
|
|
|
|
// Special value: height 0 (genesis) has no skip
|
|
BOOST_CHECK(!block_index[0].pskip);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_SUITE_END()
|