[tor-commits] [tor/master] relay: Add IP version tests for circuit extends

[nickm at torproject.org]

commit cab05a84cd1504bc4929207a1f33b266744e5dca
Author: teor <teor at torproject.org>
Date:   Wed Apr 29 20:10:14 2020 +1000

    relay: Add IP version tests for circuit extends
    
    Add IPv4-only and IPv6-only tests for
    circuit_open_connection_for_extend().
    
    Part of 33817.
---
 src/feature/relay/router.c   |  4 ++--
 src/feature/relay/router.h   |  3 ++-
 src/test/test_circuitbuild.c | 48 +++++++++++++++++++++++++++++++++++++-------
 3 files changed, 45 insertions(+), 10 deletions(-)

diff --git a/src/feature/relay/router.c b/src/feature/relay/router.c
index 89e232ccc..b0a56012d 100644
--- a/src/feature/relay/router.c
+++ b/src/feature/relay/router.c
@@ -1491,8 +1491,8 @@ router_get_advertised_ipv6_or_ap(const or_options_t *options,
 }
 
 /** Returns true if this router has an advertised IPv6 ORPort. */
-bool
-router_has_advertised_ipv6_orport(const or_options_t *options)
+MOCK_IMPL(bool,
+router_has_advertised_ipv6_orport,(const or_options_t *options))
 {
   tor_addr_port_t ipv6_ap;
   router_get_advertised_ipv6_or_ap(options, &ipv6_ap);
diff --git a/src/feature/relay/router.h b/src/feature/relay/router.h
index c3a93cc0a..1a262a679 100644
--- a/src/feature/relay/router.h
+++ b/src/feature/relay/router.h
@@ -68,7 +68,8 @@ uint16_t router_get_active_listener_port_by_type_af(int listener_type,
 uint16_t router_get_advertised_or_port(const or_options_t *options);
 void router_get_advertised_ipv6_or_ap(const or_options_t *options,
                                       tor_addr_port_t *ipv6_ap_out);
-bool router_has_advertised_ipv6_orport(const or_options_t *options);
+MOCK_DECL(bool, router_has_advertised_ipv6_orport,(
+                                             const or_options_t *options));
 uint16_t router_get_advertised_or_port_by_af(const or_options_t *options,
                                              sa_family_t family);
 uint16_t router_get_advertised_dir_port(const or_options_t *options,
diff --git a/src/test/test_circuitbuild.c b/src/test/test_circuitbuild.c
index a26109ed8..5ae7dbf97 100644
--- a/src/test/test_circuitbuild.c
+++ b/src/test/test_circuitbuild.c
@@ -30,6 +30,7 @@
 #include "feature/client/entrynodes.h"
 #include "feature/nodelist/nodelist.h"
 #include "feature/relay/circuitbuild_relay.h"
+#include "feature/relay/router.h"
 #include "feature/relay/routermode.h"
 
 #include "feature/nodelist/node_st.h"
@@ -848,11 +849,27 @@ mock_channel_connect_for_circuit(const tor_addr_t *addr,
   return mock_channel_connect_nchan;
 }
 
-/* Test the different cases in circuit_open_connection_for_extend(). */
+static bool
+mock_router_has_advertised_ipv6_orport(const or_options_t *options)
+{
+  (void)options;
+  return 1;
+}
+
+/* Test the different cases in circuit_open_connection_for_extend().
+ * Chooses different IP addresses depending on the first character in arg:
+ *  - 4: IPv4
+ *  - 6: IPv6
+ *  - d: IPv4 and IPv6 (dual-stack)
+ */
 static void
 test_circuit_open_connection_for_extend(void *arg)
 {
-  (void)arg;
+  const char ip_version = ((const char *)arg)[0];
+  const bool use_ipv4 = (ip_version == '4' || ip_version == 'd');
+  const bool use_ipv6 = (ip_version == '6' || ip_version == 'd');
+  tor_assert(use_ipv4 || use_ipv6);
+
   extend_cell_t *ec = tor_malloc_zero(sizeof(extend_cell_t));
   circuit_t *circ = tor_malloc_zero(sizeof(circuit_t));
   channel_t *fake_n_chan = tor_malloc_zero(sizeof(channel_t));
@@ -867,6 +884,9 @@ test_circuit_open_connection_for_extend(void *arg)
   mock_channel_connect_calls = 0;
   mock_channel_connect_nchan = NULL;
 
+  MOCK(router_has_advertised_ipv6_orport,
+       mock_router_has_advertised_ipv6_orport);
+
   setup_full_capture_of_logs(LOG_INFO);
 
 #ifndef ALL_BUGS_ARE_FATAL
@@ -929,10 +949,14 @@ test_circuit_open_connection_for_extend(void *arg)
 #endif /* !defined(ALL_BUGS_ARE_FATAL) */
 
   /* Set up valid addresses */
-  tor_addr_parse(&ec->orport_ipv4.addr, PUBLIC_IPV4);
-  ec->orport_ipv4.port = VALID_PORT;
-  tor_addr_parse(&ec->orport_ipv6.addr, PUBLIC_IPV6);
-  ec->orport_ipv6.port = VALID_PORT;
+  if (use_ipv4) {
+    tor_addr_parse(&ec->orport_ipv4.addr, PUBLIC_IPV4);
+    ec->orport_ipv4.port = VALID_PORT;
+  }
+  if (use_ipv6) {
+    tor_addr_parse(&ec->orport_ipv6.addr, PUBLIC_IPV6);
+    ec->orport_ipv6.port = VALID_PORT;
+  }
 
   /* Succeed, but don't try to open a connection */
   mock_circuit_close_calls = 0;
@@ -1001,6 +1025,8 @@ test_circuit_open_connection_for_extend(void *arg)
   or_options_free(fake_options);
   mocked_options = NULL;
 
+  UNMOCK(router_has_advertised_ipv6_orport);
+
   tor_free(ec);
   tor_free(circ->n_hop);
   tor_free(circ->n_chan_create_cell);
@@ -1414,6 +1440,12 @@ test_onionskin_answer(void *arg)
 #define TEST_CIRCUIT(name, flags) \
   { #name, test_circuit_ ## name, flags, NULL, NULL }
 
+#ifndef COCCI
+#define TEST_CIRCUIT_PASSTHROUGH(name, flags, arg) \
+  { #name "/" arg, test_circuit_ ## name, flags, \
+    &passthrough_setup, (void *)(arg) }
+#endif
+
 struct testcase_t circuitbuild_tests[] = {
   TEST_NEW_ROUTE_LEN(noexit, 0),
   TEST_NEW_ROUTE_LEN(safe_exit, 0),
@@ -1425,7 +1457,9 @@ struct testcase_t circuitbuild_tests[] = {
   TEST_CIRCUIT(extend_state_valid, TT_FORK),
   TEST_CIRCUIT(extend_add_ed25519, TT_FORK),
   TEST_CIRCUIT(extend_lspec_valid, TT_FORK),
-  TEST_CIRCUIT(open_connection_for_extend, TT_FORK),
+  TEST_CIRCUIT_PASSTHROUGH(open_connection_for_extend, TT_FORK, "4"),
+  TEST_CIRCUIT_PASSTHROUGH(open_connection_for_extend, TT_FORK, "6"),
+  TEST_CIRCUIT_PASSTHROUGH(open_connection_for_extend, TT_FORK, "dual-stack"),
   TEST_CIRCUIT(extend, TT_FORK),
 
   TEST(onionskin_answer, TT_FORK, NULL, NULL),