Differential D4436 Diff 16531 src/seeder/test/seeder_tests.cpp

Changeset View

Standalone View

src/seeder/test/seeder_tests.cpp

	// Copyright (c) 2019 The Bitcoin developers			// Copyright (c) 2019 The Bitcoin developers
	// Distributed under the MIT software license, see the accompanying			// Distributed under the MIT software license, see the accompanying
	// file COPYING or http://www.opensource.org/licenses/mit-license.php.			// file COPYING or http://www.opensource.org/licenses/mit-license.php.

	#define BOOST_TEST_MODULE Bitcoin Seeder Test Suite			#define BOOST_TEST_MODULE Bitcoin Seeder Test Suite

				#include <chainparams.h>
				#include <protocol.h>
				#include <seeder/bitcoin.h>
				#include <seeder/db.h>
				#include <serialize.h>
				#include <streams.h>
				#include <util/system.h>
				#include <version.h>

				#include <memory>
				#include <string>
				#include <vector>

				const std::function<std::string(const char *)> G_TRANSLATION_FUN = nullptr;

	#include <boost/test/unit_test.hpp>			#include <boost/test/unit_test.hpp>

	BOOST_AUTO_TEST_SUITE(seeder_tests)			static const unsigned short SERVICE_PORT = 18444;
				static const int SEEDER_INIT_VERSION = 0;
				// After the 1000th addr, the seeder will only add one more address per addr
				// message.
				static const int ADDR_SOFT_CAP = 1000;

				enum AddrCapacity : bool {
				Full = true,
				NotFull = false,
				};

				static CDataStream
				CreateVersionMessage(int64_t now, CAddress addrTo, CAddress addrFrom,
				int32_t start_height, uint32_t nVersion,
				uint64_t nonce = 0,
				std::string user_agent = "/bitcoin-cash-seeder:0.15/") {
				CDataStream payload(SER_NETWORK, 0);
				payload.SetVersion(nVersion);
				ServiceFlags serviceflags = ServiceFlags(NODE_NETWORK);
				payload << nVersion << uint64_t(serviceflags) << now << addrTo << addrFrom
				<< nonce << user_agent << start_height;
				return payload;
				}

				static CDataStream CreateAddrMessage(std::vector<CAddress> sendAddrs,
				uint32_t nVersion = INIT_PROTO_VERSION) {
				CDataStream payload(SER_NETWORK, 0);
				payload.SetVersion(nVersion);
				payload << sendAddrs;
				return payload;
				}

				class TestCSeederNode : public CSeederNode {
				public:
				TestCSeederNode(const CService &service, std::vector<CAddress> *vAddrIn)
				: CSeederNode(service, vAddrIn) {
				SelectParams(CBaseChainParams::REGTEST);
				}

				void TestProcessMessage(const std::string &strCommand, CDataStream &message,
				AddrCapacity addrCap) {
				bool ret = CSeederNode::ProcessMessage(strCommand, message);
				BOOST_CHECK_EQUAL(ret, bool(addrCap));
				}
				};

				struct SeederTestingSetup {
				SeederTestingSetup() {
				CNetAddr ip;
				ip.SetInternal("bitcoin.test");
				CService service = {ip, SERVICE_PORT};
				vAddr.emplace_back(service, ServiceFlags());
				testNode = std::make_unique<TestCSeederNode>(service, &vAddr);
				}

				std::vector<CAddress> vAddr;
				std::unique_ptr<TestCSeederNode> testNode;
				};

				BOOST_FIXTURE_TEST_SUITE(seeder_tests, SeederTestingSetup)

				BOOST_AUTO_TEST_CASE(seeder_node_version_test) {
				CService serviceFrom;
				CAddress addrFrom(serviceFrom,
				ServiceFlags(NODE_NETWORK \| NODE_BITCOIN_CASH));

				CDataStream versionMessage =
				CreateVersionMessage(time(nullptr), vAddr[0], addrFrom,
				GetRequireHeight(), INIT_PROTO_VERSION);

	BOOST_AUTO_TEST_CASE(test_stub) {			// Verify the version is set as the initial value
	BOOST_CHECK_EQUAL(true, true);			BOOST_CHECK_EQUAL(testNode->CSeederNode::GetClientVersion(),
				SEEDER_INIT_VERSION);
				testNode->TestProcessMessage(NetMsgType::VERSION, versionMessage,
				AddrCapacity::NotFull);
				// Verify the version has been updated
				BOOST_CHECK_EQUAL(testNode->CSeederNode::GetClientVersion(),
				versionMessage.GetVersion());
				}

				BOOST_AUTO_TEST_CASE(seeder_node_addr_test) {
				// vAddrs starts with 1 entry.
				std::vector<CAddress> sendAddrs(ADDR_SOFT_CAP - 1, vAddr[0]);

				// Happy path
				// addrs are added normally to vAddr until ADDR_SOFT_CAP is reached.
				// Add addrs up to the soft cap.
				CDataStream addrMessage = CreateAddrMessage(sendAddrs);
				BOOST_CHECK_EQUAL(1, vAddr.size());
				testNode->TestProcessMessage(NetMsgType::ADDR, addrMessage,
				AddrCapacity::NotFull);
				BOOST_CHECK_EQUAL(ADDR_SOFT_CAP, vAddr.size());

				// ADDR_SOFT_CAP is exceeded
				sendAddrs.resize(1);
				addrMessage = CreateAddrMessage(sendAddrs);
				testNode->TestProcessMessage(NetMsgType::ADDR, addrMessage,
				AddrCapacity::Full);
				BOOST_CHECK_EQUAL(ADDR_SOFT_CAP + 1, vAddr.size());

				// Test the seeder's behavior after ADDR_SOFT_CAP addrs
				// Only one addr per ADDR message will be added, the rest are ignored
				size_t expectedSize = vAddr.size() + 1;
				for (size_t i = 1; i < 10; i++) {
				sendAddrs.resize(i, sendAddrs[0]);
				addrMessage = CreateAddrMessage(sendAddrs);
				testNode->TestProcessMessage(NetMsgType::ADDR, addrMessage,
				AddrCapacity::Full);
				FabienUnsubmitted Not Done Inline Actions I still think that `Full` is inaccurate here, as you can still add new addresses, only the addition rate is limited to 1. Same goes for `ADDR_SOFT_CAP`, I understand cap as a boundary but maybe I'm wrong with this one. Fabien: I still think that `Full` is inaccurate here, as you can still add new addresses, only the…
				BOOST_CHECK_EQUAL(expectedSize, vAddr.size());
				++expectedSize;
				}
	}			}

	BOOST_AUTO_TEST_SUITE_END()			BOOST_AUTO_TEST_SUITE_END()