monero/tests/unit_tests/test_peerlist.cpp

// Copyright (c) 2014-2023, The Monero Project
// 
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
// 
// 1. Redistributions of source code must retain the above copyright notice, this list of
//    conditions and the following disclaimer.
// 
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
//    of conditions and the following disclaimer in the documentation and/or other
//    materials provided with the distribution.
// 
// 3. Neither the name of the copyright holder nor the names of its contributors may be
//    used to endorse or promote products derived from this software without specific
//    prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers

#include "gtest/gtest.h"

#include "common/util.h"
#include "p2p/net_peerlist.h"
#include "net/net_utils_base.h"

TEST(peer_list, peer_list_general)
{
  nodetool::peerlist_manager plm;
  plm.init(nodetool::peerlist_types{}, false);
#define MAKE_IPV4_ADDRESS(a,b,c,d,e) epee::net_utils::ipv4_network_address{MAKE_IP(a,b,c,d),e}
#define ADD_GRAY_NODE(addr_, id_, last_seen_) {  nodetool::peerlist_entry ple; ple.last_seen=last_seen_;ple.adr = addr_; ple.id = id_;plm.append_with_peer_gray(ple);}  
#define ADD_WHITE_NODE(addr_, id_, last_seen_) {  nodetool::peerlist_entry ple;ple.last_seen=last_seen_; ple.adr = addr_; ple.id = id_;plm.append_with_peer_white(ple);}  

#define PRINT_HEAD(step) {std::vector<nodetool::peerlist_entry> bs_head; bool r = plm.get_peerlist_head(bs_head, 100);std::cout << "step " << step << ": " << bs_head.size() << std::endl;}

  ADD_GRAY_NODE(MAKE_IPV4_ADDRESS(123,43,12,1, 8080), 121241, 34345);
  ADD_GRAY_NODE(MAKE_IPV4_ADDRESS(123,43,12,2, 8080), 121241, 34345);
  ADD_GRAY_NODE(MAKE_IPV4_ADDRESS(123,43,12,3, 8080), 121241, 34345);
  ADD_GRAY_NODE(MAKE_IPV4_ADDRESS(123,43,12,4, 8080), 121241, 34345);
  ADD_GRAY_NODE(MAKE_IPV4_ADDRESS(123,43,12,5, 8080), 121241, 34345);

  ADD_WHITE_NODE(MAKE_IPV4_ADDRESS(123,43,12,1, 8080), 121241, 34345);
  ADD_WHITE_NODE(MAKE_IPV4_ADDRESS(123,43,12,2, 8080), 121241, 34345);
  ADD_WHITE_NODE(MAKE_IPV4_ADDRESS(123,43,12,3, 8080), 121241, 34345);
  ADD_WHITE_NODE(MAKE_IPV4_ADDRESS(123,43,12,4, 8080), 121241, 34345);

  size_t gray_list_size = plm.get_gray_peers_count();
  ASSERT_EQ(gray_list_size, 1);

  std::vector<nodetool::peerlist_entry> bs_head;
  bool r = plm.get_peerlist_head(bs_head, 100);
  std::cout << bs_head.size() << std::endl;
  ASSERT_TRUE(r);

  ASSERT_EQ(bs_head.size(), 4);


  ADD_GRAY_NODE(MAKE_IPV4_ADDRESS(123,43,12,5, 8080), 121241, 34345);
  ASSERT_EQ(plm.get_gray_peers_count(), 1);
  ASSERT_EQ(plm.get_white_peers_count(), 4);
}


TEST(peer_list, merge_peer_lists)
{
  //([^ \t]*)\t([^ \t]*):([^ \t]*) \tlast_seen: d(\d+)\.h(\d+)\.m(\d+)\.s(\d+)\n
  //ADD_NODE_TO_PL("\2", \3, 0x\1, (1353346618 -(\4*60*60*24+\5*60*60+\6*60+\7 )));\n
  nodetool::peerlist_manager plm;
  plm.init(nodetool::peerlist_types{}, false);
  std::vector<nodetool::peerlist_entry> outer_bs;
#define ADD_NODE_TO_PL(ip_, port_, id_, timestamp_) {  nodetool::peerlist_entry ple; epee::string_tools::get_ip_int32_from_string(ple.adr.ip, ip_); ple.last_seen = timestamp_; ple.adr.port = port_; ple.id = id_;outer_bs.push_back(ple);}  
}

namespace
{
  bool check_empty(nodetool::peerlist_storage& peers, std::initializer_list<epee::net_utils::zone> zones)
  {
    bool pass = false;
    for (const epee::net_utils::zone zone : zones)
    {
      const nodetool::peerlist_types types{peers.take_zone(zone)};
      EXPECT_TRUE(types.white.empty());
      EXPECT_TRUE(types.gray.empty());
      EXPECT_TRUE(types.anchor.empty());
      pass = (types.white.empty() && types.gray.empty() && types.anchor.empty());
    }
    return pass;
  }
}

TEST(peerlist_storage, store)
{

  using address_type = epee::net_utils::address_type;
  using zone = epee::net_utils::zone;

  nodetool::peerlist_storage peers{};
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::public_, zone::tor, zone::i2p}));

  std::string buffer{};
  {
    nodetool::peerlist_types types{};
    types.white.push_back({epee::net_utils::ipv4_network_address{1000, 10}, 44, 55});
    types.white.push_back({net::tor_address::unknown(), 64, 75});
    types.gray.push_back({net::tor_address::unknown(), 99, 88});
    types.gray.push_back({epee::net_utils::ipv4_network_address{2000, 20}, 84, 45});
    types.anchor.push_back({epee::net_utils::ipv4_network_address{999, 654}, 444, 555});
    types.anchor.push_back({net::tor_address::unknown(), 14, 33});
    types.anchor.push_back({net::tor_address::unknown(), 24, 22});

    std::ostringstream stream{};
    EXPECT_TRUE(peers.store(stream, types));
    buffer = stream.str();
  }
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::public_, zone::tor, zone::i2p}));
  {
    std::istringstream stream{buffer};
    boost::optional<nodetool::peerlist_storage> read_peers =
      nodetool::peerlist_storage::open(stream, true);
    ASSERT_TRUE(bool(read_peers));
    peers = std::move(*read_peers);
  }
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::i2p}));

  nodetool::peerlist_types types = peers.take_zone(zone::public_);
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::public_, zone::i2p}));

  ASSERT_EQ(1u, types.white.size());
  ASSERT_EQ(address_type::ipv4, types.white[0].adr.get_type_id());
  EXPECT_EQ(1000u, types.white[0].adr.template as<epee::net_utils::ipv4_network_address>().ip());
  EXPECT_EQ(10u, types.white[0].adr.template as<epee::net_utils::ipv4_network_address>().port());
  EXPECT_EQ(44u, types.white[0].id);
  EXPECT_EQ(55u, types.white[0].last_seen);

  ASSERT_EQ(1u, types.gray.size());
  ASSERT_EQ(address_type::ipv4, types.gray[0].adr.get_type_id());
  EXPECT_EQ(2000u, types.gray[0].adr.template as<epee::net_utils::ipv4_network_address>().ip());
  EXPECT_EQ(20u, types.gray[0].adr.template as<epee::net_utils::ipv4_network_address>().port());
  EXPECT_EQ(84u, types.gray[0].id);
  EXPECT_EQ(45u, types.gray[0].last_seen);

  ASSERT_EQ(1u, types.anchor.size());
  ASSERT_EQ(address_type::ipv4, types.anchor[0].adr.get_type_id());
  EXPECT_EQ(999u, types.anchor[0].adr.template as<epee::net_utils::ipv4_network_address>().ip());
  EXPECT_EQ(654u, types.anchor[0].adr.template as<epee::net_utils::ipv4_network_address>().port());
  EXPECT_EQ(444u, types.anchor[0].id);
  EXPECT_EQ(555u, types.anchor[0].first_seen);
  {
    std::ostringstream stream{};
    EXPECT_TRUE(peers.store(stream, types));
    buffer = stream.str();
  }
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::public_, zone::i2p}));

  types = peers.take_zone(zone::tor);
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::public_, zone::i2p, zone::tor}));

  ASSERT_EQ(1u, types.white.size());
  ASSERT_EQ(address_type::tor, types.white[0].adr.get_type_id());
  EXPECT_STREQ(net::tor_address::unknown_str(), types.white[0].adr.template as<net::tor_address>().host_str());
  EXPECT_EQ(0u, types.white[0].adr.template as<net::tor_address>().port());
  EXPECT_EQ(64u, types.white[0].id);
  EXPECT_EQ(75u, types.white[0].last_seen);

  ASSERT_EQ(1u, types.gray.size());
  ASSERT_EQ(address_type::tor, types.gray[0].adr.get_type_id());
  EXPECT_STREQ(net::tor_address::unknown_str(), types.gray[0].adr.template as<net::tor_address>().host_str());
  EXPECT_EQ(0u, types.gray[0].adr.template as<net::tor_address>().port());
  EXPECT_EQ(99u, types.gray[0].id);
  EXPECT_EQ(88u, types.gray[0].last_seen);

  ASSERT_EQ(2u, types.anchor.size());
  ASSERT_EQ(address_type::tor, types.anchor[0].adr.get_type_id());
  EXPECT_STREQ(net::tor_address::unknown_str(), types.anchor[0].adr.template as<net::tor_address>().host_str());
  EXPECT_EQ(0u, types.anchor[0].adr.template as<net::tor_address>().port());
  EXPECT_EQ(14u, types.anchor[0].id);
  EXPECT_EQ(33u, types.anchor[0].first_seen);
  ASSERT_EQ(address_type::tor, types.anchor[1].adr.get_type_id());
  EXPECT_STREQ(net::tor_address::unknown_str(), types.anchor[1].adr.template as<net::tor_address>().host_str());
  EXPECT_EQ(0u, types.anchor[1].adr.template as<net::tor_address>().port());
  EXPECT_EQ(24u, types.anchor[1].id);
  EXPECT_EQ(22u, types.anchor[1].first_seen);

  {
    std::istringstream stream{buffer};
    boost::optional<nodetool::peerlist_storage> read_peers =
      nodetool::peerlist_storage::open(stream, true);
    ASSERT_TRUE(bool(read_peers));
    peers = std::move(*read_peers);
  }
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::i2p}));

  types = peers.take_zone(zone::public_);
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::public_, zone::i2p}));

  ASSERT_EQ(1u, types.white.size());
  ASSERT_EQ(address_type::ipv4, types.white[0].adr.get_type_id());
  EXPECT_EQ(1000u, types.white[0].adr.template as<epee::net_utils::ipv4_network_address>().ip());
  EXPECT_EQ(10u, types.white[0].adr.template as<epee::net_utils::ipv4_network_address>().port());
  EXPECT_EQ(44u, types.white[0].id);
  EXPECT_EQ(55u, types.white[0].last_seen);

  ASSERT_EQ(1u, types.gray.size());
  ASSERT_EQ(address_type::ipv4, types.gray[0].adr.get_type_id());
  EXPECT_EQ(2000u, types.gray[0].adr.template as<epee::net_utils::ipv4_network_address>().ip());
  EXPECT_EQ(20u, types.gray[0].adr.template as<epee::net_utils::ipv4_network_address>().port());
  EXPECT_EQ(84u, types.gray[0].id);
  EXPECT_EQ(45u, types.gray[0].last_seen);

  ASSERT_EQ(1u, types.anchor.size());
  ASSERT_EQ(address_type::ipv4, types.anchor[0].adr.get_type_id());
  EXPECT_EQ(999u, types.anchor[0].adr.template as<epee::net_utils::ipv4_network_address>().ip());
  EXPECT_EQ(654u, types.anchor[0].adr.template as<epee::net_utils::ipv4_network_address>().port());
  EXPECT_EQ(444u, types.anchor[0].id);
  EXPECT_EQ(555u, types.anchor[0].first_seen);

  types = peers.take_zone(zone::tor);
  EXPECT_TRUE(check_empty(peers, {zone::invalid, zone::public_, zone::i2p, zone::tor}));

  ASSERT_EQ(1u, types.white.size());
  ASSERT_EQ(address_type::tor, types.white[0].adr.get_type_id());
  EXPECT_STREQ(net::tor_address::unknown_str(), types.white[0].adr.template as<net::tor_address>().host_str());
  EXPECT_EQ(0u, types.white[0].adr.template as<net::tor_address>().port());
  EXPECT_EQ(64u, types.white[0].id);
  EXPECT_EQ(75u, types.white[0].last_seen);

  ASSERT_EQ(1u, types.gray.size());
  ASSERT_EQ(address_type::tor, types.gray[0].adr.get_type_id());
  EXPECT_STREQ(net::tor_address::unknown_str(), types.gray[0].adr.template as<net::tor_address>().host_str());
  EXPECT_EQ(0u, types.gray[0].adr.template as<net::tor_address>().port());
  EXPECT_EQ(99u, types.gray[0].id);
  EXPECT_EQ(88u, types.gray[0].last_seen);

  ASSERT_EQ(2u, types.anchor.size());
  ASSERT_EQ(address_type::tor, types.anchor[0].adr.get_type_id());
  EXPECT_STREQ(net::tor_address::unknown_str(), types.anchor[0].adr.template as<net::tor_address>().host_str());
  EXPECT_EQ(0u, types.anchor[0].adr.template as<net::tor_address>().port());
  EXPECT_EQ(14u, types.anchor[0].id);
  EXPECT_EQ(33u, types.anchor[0].first_seen);
  ASSERT_EQ(address_type::tor, types.anchor[1].adr.get_type_id());
  EXPECT_STREQ(net::tor_address::unknown_str(), types.anchor[1].adr.template as<net::tor_address>().host_str());
  EXPECT_EQ(0u, types.anchor[1].adr.template as<net::tor_address>().port());
  EXPECT_EQ(24u, types.anchor[1].id);
  EXPECT_EQ(22u, types.anchor[1].first_seen);
}