Merge #15051: Tests: IsReachable is the inverse of IsLimited (DRY). Includes unit tests

6dc4593db1ccfb8745b2daa42f457981ae08dba9 IsReachable is the inverse of IsLimited (DRY). Includes unit tests (marcaiaf)

Pull request description:

  IsReachable is the inverse of IsLimited, but the implementation is duplicated (DRY)

  - Changed the implementation accordingly.
  - Added unit tests to document behavior and relationship
  - My modification in net.cpp  applies only to IsReachable.
  - Applied clang-format-diffpy

  Created new pull request to avoid the mess with:
  https://github.com/bitcoin/bitcoin/pull/15044

  Checked with supposedly conflicting PRs mentioned in the old PR. No conflicts with the specific changes in this PR.

Tree-SHA512: b132dec6cc2c788ebe4f63f228d78f441614e156743b17adebc990de0180a5872874d2724c86eeaa470b4521918bd137b0e33ebcaae77c5efc1f0d56104f6c87

2 files changed, 91 insertions, 4 deletions

diff --git a/src/net.cpp b/src/net.cpp
index 03ee7af5e4..86e5225839 100644
--- a/src/net.cpp
+++ b/src/net.cpp
@@ -295,15 +295,13 @@ bool IsLocal(const CService& addr)
 /** check whether a given network is one we can probably connect to */
 bool IsReachable(enum Network net)
 {
-    LOCK(cs_mapLocalHost);
-    return !vfLimited[net];
+    return !IsLimited(net);
 }
 
 /** check whether a given address is in a network we can probably connect to */
 bool IsReachable(const CNetAddr& addr)
 {
-    enum Network net = addr.GetNetwork();
-    return IsReachable(net);
+    return IsReachable(addr.GetNetwork());
 }
 
 
diff --git a/src/test/net_tests.cpp b/src/test/net_tests.cpp
index e7a3c96343..4dc394b86d 100644
--- a/src/test/net_tests.cpp
+++ b/src/test/net_tests.cpp
@@ -227,4 +227,93 @@ BOOST_AUTO_TEST_CASE(ipv4_peer_with_ipv6_addrMe_test)
     BOOST_CHECK(1);
 }
 
+
+BOOST_AUTO_TEST_CASE(LimitedAndReachable_Network)
+{
+    SetLimited(NET_IPV4, true);
+    SetLimited(NET_IPV6, true);
+    SetLimited(NET_ONION, true);
+
+    BOOST_CHECK_EQUAL(IsLimited(NET_IPV4), true);
+    BOOST_CHECK_EQUAL(IsLimited(NET_IPV6), true);
+    BOOST_CHECK_EQUAL(IsLimited(NET_ONION), true);
+
+    BOOST_CHECK_EQUAL(IsReachable(NET_IPV4), false);
+    BOOST_CHECK_EQUAL(IsReachable(NET_IPV6), false);
+    BOOST_CHECK_EQUAL(IsReachable(NET_ONION), false);
+
+
+    SetLimited(NET_IPV4, false);
+    SetLimited(NET_IPV6, false);
+    SetLimited(NET_ONION, false);
+
+    BOOST_CHECK_EQUAL(IsLimited(NET_IPV4), false);
+    BOOST_CHECK_EQUAL(IsLimited(NET_IPV6), false);
+    BOOST_CHECK_EQUAL(IsLimited(NET_ONION), false);
+
+    BOOST_CHECK_EQUAL(IsReachable(NET_IPV4), true);
+    BOOST_CHECK_EQUAL(IsReachable(NET_IPV6), true);
+    BOOST_CHECK_EQUAL(IsReachable(NET_ONION), true);
+}
+
+BOOST_AUTO_TEST_CASE(LimitedAndReachable_NetworkCaseUnroutableAndInternal)
+{
+    BOOST_CHECK_EQUAL(IsLimited(NET_UNROUTABLE), false);
+    BOOST_CHECK_EQUAL(IsLimited(NET_INTERNAL), false);
+
+    BOOST_CHECK_EQUAL(IsReachable(NET_UNROUTABLE), true);
+    BOOST_CHECK_EQUAL(IsReachable(NET_INTERNAL), true);
+
+    SetLimited(NET_UNROUTABLE, true);
+    SetLimited(NET_INTERNAL, true);
+
+    BOOST_CHECK_EQUAL(IsLimited(NET_UNROUTABLE), false); // Ignored for both networks
+    BOOST_CHECK_EQUAL(IsLimited(NET_INTERNAL), false);
+
+    BOOST_CHECK_EQUAL(IsReachable(NET_UNROUTABLE), true);
+    BOOST_CHECK_EQUAL(IsReachable(NET_INTERNAL), true);
+}
+
+CNetAddr UtilBuildAddress(unsigned char p1, unsigned char p2, unsigned char p3, unsigned char p4)
+{
+    unsigned char ip[] = {p1, p2, p3, p4};
+
+    struct sockaddr_in sa;
+    memset(&sa, 0, sizeof(sockaddr_in)); // initialize the memory block
+    memcpy(&(sa.sin_addr), &ip, sizeof(ip));
+    return CNetAddr(sa.sin_addr);
+}
+
+
+BOOST_AUTO_TEST_CASE(LimitedAndReachable_CNetAddr)
+{
+    CNetAddr addr = UtilBuildAddress(0x001, 0x001, 0x001, 0x001); // 1.1.1.1
+
+    SetLimited(NET_IPV4, false);
+    BOOST_CHECK_EQUAL(IsLimited(addr), false);
+    BOOST_CHECK_EQUAL(IsReachable(addr), true);
+
+    SetLimited(NET_IPV4, true);
+    BOOST_CHECK_EQUAL(IsLimited(addr), true);
+    BOOST_CHECK_EQUAL(IsReachable(addr), false);
+
+    SetLimited(NET_IPV4, false); // have to reset this, because this is stateful.
+}
+
+
+BOOST_AUTO_TEST_CASE(LocalAddress_BasicLifecycle)
+{
+    CService addr = CService(UtilBuildAddress(0x002, 0x001, 0x001, 0x001), 1000); // 2.1.1.1:1000
+
+    SetLimited(NET_IPV4, false);
+
+    BOOST_CHECK_EQUAL(IsLocal(addr), false);
+    BOOST_CHECK_EQUAL(AddLocal(addr, 1000), true);
+    BOOST_CHECK_EQUAL(IsLocal(addr), true);
+
+    RemoveLocal(addr);
+    BOOST_CHECK_EQUAL(IsLocal(addr), false);
+}
+
+
 BOOST_AUTO_TEST_SUITE_END()