Define LOOPBACK_INTERFACE constant instead of helper function

Author: nycrat

src/shared/constants.h

@@ -22,6 +22,13 @@ static const std::unordered_map<int, std::string> ROBOT_MULTICAST_CHANNELS = {
     {12, "ff02::c3d0:42d2:bb12"}, {13, "ff02::c3d0:42d2:bb13"},
     {14, "ff02::c3d0:42d2:bb14"}, {15, "ff02::c3d0:42d2:bb15"}};
 
+// the name of the loopback network interface, which differs across platforms
+#ifdef __APPLE__
+static const std::string LOOPBACK_INTERFACE = "lo0";
+#else
+static const std::string LOOPBACK_INTERFACE = "lo";
+#endif
+
 // PlotJuggler's default host and port
 static const std::string PLOTJUGGLER_GUI_DEFAULT_HOST        = "ff02::c3d0:42d2:aaaa";
 static const short unsigned int PLOTJUGGLER_GUI_DEFAULT_PORT = 9870;

src/software/logger/BUILD

@@ -146,7 +146,6 @@ cc_library(
     deps = [
         "//proto:visualization_cc_proto",
         "//shared:constants",
-        "//software/networking/udp:network_utils",
         "//software/networking/udp:threaded_udp_sender",
         "@g3log",
         "@protobuf//:json_util",

src/software/logger/plotjuggler_sink.h

@@ -4,8 +4,8 @@
 #include <string>
 
 #include "proto/visualization.pb.h"
+#include "shared/constants.h"
 #include "software/logger/custom_logging_levels.h"
-#include "software/networking/udp/network_utils.h"
 #include "software/networking/udp/threaded_udp_sender.h"
 
 
@@ -21,7 +21,7 @@ class PlotJugglerSink
      *
      * @param interface The interface to send Plotjuggler UDP packets on
      */
-    PlotJugglerSink(const std::string& interface = getLoopbackInterfaceName());
+    PlotJugglerSink(const std::string& interface = LOOPBACK_INTERFACE);
 
     ~PlotJugglerSink() = default;
 

src/software/networking/udp/BUILD

@@ -17,6 +17,7 @@ cc_test(
     ],
     deps = [
         ":network_utils",
+        "//shared:constants",
         "//shared/test_util:tbots_gtest_main",
     ],
 )
@@ -67,8 +68,8 @@ cc_test(
         "threaded_proto_udp_listener_test.cpp",
     ],
     deps = [
-        ":network_utils",
         ":threaded_proto_udp_listener",
+        "//shared:constants",
         "//shared/test_util:tbots_gtest_main",
         "@protobuf//:empty_cc_proto",
     ],
@@ -90,8 +91,8 @@ cc_test(
         "threaded_proto_udp_sender_test.cpp",
     ],
     deps = [
-        ":network_utils",
         ":threaded_proto_udp_sender",
+        "//shared:constants",
         "//shared/test_util:tbots_gtest_main",
         "@protobuf//:empty_cc_proto",
     ],

src/software/networking/udp/network_utils.cpp

@@ -2,15 +2,6 @@
 
 #include <arpa/inet.h>
 
-std::string getLoopbackInterfaceName()
-{
-#ifdef __APPLE__
-    return "lo0";
-#else
-    return "lo";
-#endif
-}
-
 std::optional<std::string> getLocalIp(const std::string& interface, bool ipv4)
 {
     struct ifaddrs* ifAddrStruct = nullptr;

src/software/networking/udp/network_utils.h

@@ -5,13 +5,6 @@
 #include <optional>
 #include <string>
 
-/**
- * Get the name of the loopback network interface for the current platform.
- *
- * @return the loopback interface name for the current platform
- */
-std::string getLoopbackInterfaceName();
-
 /**
  * Given an interface, get the IP address associated with that interface
  *

src/software/networking/udp/network_utils_test.cpp

@@ -2,9 +2,11 @@
 
 #include <gtest/gtest.h>
 
+#include "shared/constants.h"
+
 TEST(NetworkUtilsTest, getLocalIpValidInterface)
 {
-    std::string interface               = getLoopbackInterfaceName();
+    std::string interface               = LOOPBACK_INTERFACE;
     std::optional<std::string> local_ip = getLocalIp(interface, true);
     EXPECT_TRUE(local_ip);
     EXPECT_EQ(local_ip.value(), "127.0.0.1");

src/software/networking/udp/threaded_proto_udp_listener_test.cpp

@@ -3,8 +3,8 @@
 #include <gtest/gtest.h>
 
 #include "google/protobuf/empty.pb.h"
+#include "shared/constants.h"
 #include "software/networking/tbots_network_exception.h"
-#include "software/networking/udp/network_utils.h"
 
 TEST(ThreadedProtoUdpListenerTest, error_finding_local_ip_address)
 {
@@ -19,12 +19,12 @@ TEST(ThreadedProtoUdpListenerTest, error_creating_socket)
     // This will always fail because it requires root privileges to open this port
     EXPECT_THROW(
         ThreadedProtoUdpListener<google::protobuf::Empty>(
-            "224.5.23.1", 1023, getLoopbackInterfaceName(), [](const auto&) {}, true),
+            "224.5.23.1", 1023, LOOPBACK_INTERFACE, [](const auto&) {}, true),
         TbotsNetworkException);
 }
 
 TEST(ThreadedProtoUdpListenerTest, no_error_creating_socket)
 {
     ThreadedProtoUdpListener<google::protobuf::Empty>(
-        "224.5.23.0", 40000, getLoopbackInterfaceName(), [](const auto&) {}, true);
+        "224.5.23.0", 40000, LOOPBACK_INTERFACE, [](const auto&) {}, true);
 }

src/software/networking/udp/threaded_proto_udp_sender_test.cpp

@@ -3,8 +3,8 @@
 #include <gtest/gtest.h>
 
 #include "google/protobuf/empty.pb.h"
+#include "shared/constants.h"
 #include "software/networking/tbots_network_exception.h"
-#include "software/networking/udp/network_utils.h"
 
 TEST(ThreadedProtoUdpSenderTest, error_finding_local_ip_address)
 {
@@ -16,5 +16,5 @@ TEST(ThreadedProtoUdpSenderTest, error_finding_local_ip_address)
 TEST(ThreadedProtoUdpSenderTest, no_error_creating_socket)
 {
     ThreadedProtoUdpSender<google::protobuf::Empty>("224.5.23.1", 40000,
-                                                    getLoopbackInterfaceName(), true);
+                                                    LOOPBACK_INTERFACE, true);
 }