Skip to content

Commit

Permalink
Merge pull request #166 from AntelopeIO/snapshot_tests_both_modes
Browse files Browse the repository at this point in the history 
Make unit tests run in both Legacy and Savanna (Part 3, snapshot_tests)
  • Loading branch information
@linh2931
linh2931 authored May 20, 2024
2 parents a781609 + a81b8e4 commit 1844666
Showing 1 changed file with 77 additions and 25 deletions.
102 changes: 77 additions & 25 deletions unittests/snapshot_tests.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,10 @@ namespace {
}
}

BOOST_AUTO_TEST_CASE_TEMPLATE(test_exhaustive_snapshot, SNAPSHOT_SUITE, snapshot_suites)
template<typename TESTER, typename SNAPSHOT_SUITE>
void exhaustive_snapshot_test()
{
tester chain;
TESTER chain;

// Create 2 accounts
chain.create_accounts({"snapshot"_n, "snapshot1"_n});
Expand Down Expand Up @@ -252,9 +253,16 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_exhaustive_snapshot, SNAPSHOT_SUITE, snapshot
}
}

BOOST_AUTO_TEST_CASE_TEMPLATE(test_replay_over_snapshot, SNAPSHOT_SUITE, snapshot_suites)
BOOST_AUTO_TEST_CASE_TEMPLATE(test_exhaustive_snapshot, SNAPSHOT_SUITE, snapshot_suites)
{
exhaustive_snapshot_test<legacy_tester, SNAPSHOT_SUITE>();
exhaustive_snapshot_test<savanna_tester, SNAPSHOT_SUITE>();
}

template<typename TESTER, typename SNAPSHOT_SUITE>
void replay_over_snapshot_test()
{
tester chain;
TESTER chain;
const std::filesystem::path parent_path = chain.get_config().blocks_dir.parent_path();

chain.create_account("snapshot"_n);
Expand Down Expand Up @@ -347,9 +355,16 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_replay_over_snapshot, SNAPSHOT_SUITE, snapsho
verify_integrity_hash<SNAPSHOT_SUITE>(*chain.control, *from_block_log_chain.control);
}

BOOST_AUTO_TEST_CASE_TEMPLATE(test_chain_id_in_snapshot, SNAPSHOT_SUITE, snapshot_suites)
BOOST_AUTO_TEST_CASE_TEMPLATE(test_replay_over_snapshot, SNAPSHOT_SUITE, snapshot_suites)
{
replay_over_snapshot_test<legacy_tester, SNAPSHOT_SUITE>();
replay_over_snapshot_test<savanna_tester, SNAPSHOT_SUITE>();
}

template<typename TESTER, typename SNAPSHOT_SUITE>
void chain_id_in_snapshot_test()
{
tester chain;
TESTER chain;
const std::filesystem::path parent_path = chain.get_config().blocks_dir.parent_path();

chain.create_account("snapshot"_n);
Expand All @@ -369,6 +384,12 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_chain_id_in_snapshot, SNAPSHOT_SUITE, snapsho
verify_integrity_hash<SNAPSHOT_SUITE>(*chain.control, *snap_chain.control);
}

BOOST_AUTO_TEST_CASE_TEMPLATE(test_chain_id_in_snapshot, SNAPSHOT_SUITE, snapshot_suites)
{
chain_id_in_snapshot_test<legacy_tester, SNAPSHOT_SUITE>();
chain_id_in_snapshot_test<savanna_tester, SNAPSHOT_SUITE>();
}

static auto get_extra_args() {
bool save_snapshot = false;
bool generate_log = false;
Expand All @@ -386,7 +407,8 @@ static auto get_extra_args() {
return std::make_tuple(save_snapshot, generate_log);
}

BOOST_AUTO_TEST_CASE_TEMPLATE(test_compatible_versions, SNAPSHOT_SUITE, snapshot_suites)
template<typename TESTER, typename SNAPSHOT_SUITE>
void compatible_versions_test()
{
const uint32_t legacy_default_max_inline_action_size = 4 * 1024;
bool save_snapshot = false;
Expand All @@ -397,7 +419,7 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_compatible_versions, SNAPSHOT_SUITE, snapshot
if (generate_log) {
///< Begin deterministic code to generate blockchain for comparison

tester chain(setup_policy::none, db_read_mode::HEAD, {legacy_default_max_inline_action_size});
TESTER chain(setup_policy::none, db_read_mode::HEAD, {legacy_default_max_inline_action_size});
chain.create_account("snapshot"_n);
chain.produce_blocks(1);
chain.set_code("snapshot"_n, test_contracts::snapshot_test_wasm());
Expand All @@ -423,7 +445,7 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_compatible_versions, SNAPSHOT_SUITE, snapshot
std::filesystem::create_directories(config.blocks_dir);
std::filesystem::copy(source_log_dir / "blocks.log", config.blocks_dir / "blocks.log");
std::filesystem::copy(source_log_dir / "blocks.index", config.blocks_dir / "blocks.index");
tester base_chain(config, *genesis);
TESTER base_chain(config, *genesis);

std::string current_version = "v7";

Expand Down Expand Up @@ -459,17 +481,26 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_compatible_versions, SNAPSHOT_SUITE, snapshot
// now the test should pass.
// 5. add the 3 new snapshot files in git.
// -------------------------------------------------------------------------------------------------------------
if (save_snapshot)
{
// create a latest snapshot
auto latest_writer = SNAPSHOT_SUITE::get_writer();
base_chain.control->write_snapshot(latest_writer);
auto latest = SNAPSHOT_SUITE::finalize(latest_writer);

SNAPSHOT_SUITE::write_to_file("snap_" + current_version, latest);
// Only want to save one snapshot, use Savanna as that is the latest
if constexpr (std::is_same_v<TESTER, savanna_tester>) {
if (save_snapshot)
{
// create a latest snapshot
auto latest_writer = SNAPSHOT_SUITE::get_writer();
base_chain.control->write_snapshot(latest_writer);
auto latest = SNAPSHOT_SUITE::finalize(latest_writer);

SNAPSHOT_SUITE::write_to_file("snap_" + current_version, latest);
}
}
}

BOOST_AUTO_TEST_CASE_TEMPLATE(test_compatible_versions, SNAPSHOT_SUITE, snapshot_suites)
{
compatible_versions_test<legacy_tester, SNAPSHOT_SUITE>();
compatible_versions_test<savanna_tester, SNAPSHOT_SUITE>();
}

/*
When WTMSIG changes were introduced in 1.8.x, the snapshot had to be able
to store more than a single producer key.
Expand All @@ -484,7 +515,8 @@ The fix is to save block.log and its corresponding snapshot with infight
schedule changes, load the snapshot and replay the block.log on the new
version, and verify their integrity.
*/
BOOST_AUTO_TEST_CASE_TEMPLATE(test_pending_schedule_snapshot, SNAPSHOT_SUITE, snapshot_suites)
template<typename TESTER, typename SNAPSHOT_SUITE>
void pending_schedule_snapshot_test()
{
static_assert(chain_snapshot_header::minimum_compatible_version <= 2, "version 2 unit test is no longer needed. Please clean up data files");

Expand All @@ -499,7 +531,7 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_pending_schedule_snapshot, SNAPSHOT_SUITE, sn
std::filesystem::create_directories(config.blocks_dir);
std::filesystem::copy(source_log_dir / "blocks.log", config.blocks_dir / "blocks.log");
std::filesystem::copy(source_log_dir / "blocks.index", config.blocks_dir / "blocks.index");
tester blockslog_chain(config, *genesis);
TESTER blockslog_chain(config, *genesis);

// consruct a chain by loading the saved snapshot
auto ordinal = 0;
Expand All @@ -522,9 +554,16 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_pending_schedule_snapshot, SNAPSHOT_SUITE, sn
verify_integrity_hash<SNAPSHOT_SUITE>(*blockslog_chain.control, *latest_chain.control);
}

BOOST_AUTO_TEST_CASE_TEMPLATE(test_restart_with_existing_state_and_truncated_block_log, SNAPSHOT_SUITE, snapshot_suites)
BOOST_AUTO_TEST_CASE_TEMPLATE(test_pending_schedule_snapshot, SNAPSHOT_SUITE, snapshot_suites)
{
pending_schedule_snapshot_test<legacy_tester, SNAPSHOT_SUITE>();
pending_schedule_snapshot_test<savanna_tester, SNAPSHOT_SUITE>();
}

template<typename TESTER, typename SNAPSHOT_SUITE>
void restart_with_existing_state_and_truncated_block_log_test()
{
tester chain;
TESTER chain;
const std::filesystem::path parent_path = chain.get_config().blocks_dir.parent_path();

chain.create_account("snapshot"_n);
Expand Down Expand Up @@ -606,10 +645,16 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(test_restart_with_existing_state_and_truncated_blo

}

BOOST_AUTO_TEST_CASE(json_snapshot_validity_test)
BOOST_AUTO_TEST_CASE_TEMPLATE(test_restart_with_existing_state_and_truncated_block_log, SNAPSHOT_SUITE, snapshot_suites)
{
restart_with_existing_state_and_truncated_block_log_test<legacy_tester, SNAPSHOT_SUITE>();
restart_with_existing_state_and_truncated_block_log_test<savanna_tester, SNAPSHOT_SUITE>();
}

BOOST_AUTO_TEST_CASE_TEMPLATE( json_snapshot_validity_test, TESTER, testers )
{
auto ordinal = 0;
tester chain;
TESTER chain;

// prep the chain
chain.create_account("snapshot"_n);
Expand Down Expand Up @@ -670,12 +715,13 @@ BOOST_AUTO_TEST_CASE(json_snapshot_validity_test)
remove(json_snap_path);
}

BOOST_AUTO_TEST_CASE_TEMPLATE(jumbo_row, SNAPSHOT_SUITE, snapshot_suites)
template<typename TESTER, typename SNAPSHOT_SUITE>
void jumbo_row_test()
{
fc::temp_directory tempdir;
auto config = tester::default_config(tempdir);
config.first.state_size = 64*1024*1024;
tester chain(config.first, config.second);
TESTER chain(config.first, config.second);
chain.execute_setup_policy(setup_policy::full);

chain.create_accounts({"jumbo"_n});
Expand Down Expand Up @@ -703,4 +749,10 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(jumbo_row, SNAPSHOT_SUITE, snapshot_suites)
snapshotted_tester sst(chain.get_config(), SNAPSHOT_SUITE::get_reader(snapshot), 0);
}

BOOST_AUTO_TEST_CASE_TEMPLATE(jumbo_row, SNAPSHOT_SUITE, snapshot_suites)
{
jumbo_row_test<legacy_tester, SNAPSHOT_SUITE>();
jumbo_row_test<savanna_tester, SNAPSHOT_SUITE>();
}

BOOST_AUTO_TEST_SUITE_END()

0 comments on commit 1844666

Please sign in to comment.