Move ExternalIPsConfig to its own file.

ovalenti · ovalenti · commit 2e17cf498660 · 2025-05-20T18:59:09.000+02:00
diff --git a/collector/lib/CollectorConfig.cpp b/collector/lib/CollectorConfig.cpp
@@ -544,54 +544,4 @@ std::pair<option::ArgStatus, std::string> CollectorConfig::CheckConfiguration(co
   return std::make_pair(ARG_OK, "");
 }
 
-CollectorConfig::ExternalIPsConfig::ExternalIPsConfig(std::optional<sensor::CollectorConfig> runtime_config, bool default_enabled) {
-  if (!runtime_config.has_value()) {
-    direction_enabled_ = default_enabled ? Direction::BOTH : Direction::NONE;
-    return;
-  }
-
-  // At this point we know runtime_config has a value, we can access it directly
-  const auto& external_ips = runtime_config->networking().external_ips();
-  if (external_ips.enabled() != sensor::ExternalIpsEnabled::ENABLED) {
-    direction_enabled_ = Direction::NONE;
-    return;
-  }
-
-  switch (external_ips.direction()) {
-    case sensor::ExternalIpsDirection::INGRESS:
-      direction_enabled_ = Direction::INGRESS;
-      break;
-    case sensor::ExternalIpsDirection::EGRESS:
-      direction_enabled_ = Direction::EGRESS;
-      break;
-    default:
-      direction_enabled_ = Direction::BOTH;
-      break;
-  }
-}
-
-std::ostream& operator<<(std::ostream& os, const collector::CollectorConfig::ExternalIPsConfig& config) {
-  os << "direction(";
-
-  switch (config.GetDirection()) {
-    case CollectorConfig::ExternalIPsConfig::Direction::NONE:
-      os << "NONE";
-      break;
-    case CollectorConfig::ExternalIPsConfig::Direction::INGRESS:
-      os << "INGRESS";
-      break;
-    case CollectorConfig::ExternalIPsConfig::Direction::EGRESS:
-      os << "EGRESS";
-      break;
-    case CollectorConfig::ExternalIPsConfig::Direction::BOTH:
-      os << "BOTH";
-      break;
-    default:
-      os << "invalid";
-      break;
-  }
-
-  return os << ")";
-}
-
 }  // namespace collector
diff --git a/collector/lib/CollectorConfig.h b/collector/lib/CollectorConfig.h
@@ -14,6 +14,7 @@
 #include <internalapi/sensor/collector.pb.h>
 
 #include "CollectionMethod.h"
+#include "ExternalIPsConfig.h"
 #include "HostConfig.h"
 #include "Logging.h"
 #include "NetworkConnection.h"
@@ -94,32 +95,6 @@ class CollectorConfig {
   bool ImportUsers() const { return import_users_; }
   bool CollectConnectionStatus() const { return collect_connection_status_; }
 
-  // Encapsulates the configuration of the External-IPs feature
-  class ExternalIPsConfig {
-   public:
-    enum Direction {
-      NONE = 0,
-      INGRESS = 1 << 0,
-      EGRESS = 1 << 1,
-      BOTH = INGRESS | EGRESS,
-    };
-
-    // Are External-IPs enabled in the provided direction ?
-    bool IsEnabled(Direction direction) { return (direction & direction_enabled_) == direction; }
-
-    // Direction in which External-IPs are enabled
-    Direction GetDirection() const { return direction_enabled_; }
-
-    // Extract the External-IPs configuration from the provided runtime-conf.
-    // If the runtime-configuration is unset then 'default_enabled' is used
-    // as a fallback to enable in both directions.
-    // 'runtime_config' should be locked prior to calling.
-    ExternalIPsConfig(std::optional<sensor::CollectorConfig> runtime_config, bool default_enabled);
-
-   private:
-    Direction direction_enabled_;
-  };
-
   // EnableExternalIPs will check for the existence
   // of a runtime configuration, and defer to that value
   // otherwise, we rely on the feature flag (env var)
@@ -287,6 +262,5 @@ class CollectorConfig {
 };
 
 std::ostream& operator<<(std::ostream& os, const CollectorConfig& c);
-std::ostream& operator<<(std::ostream& os, const collector::CollectorConfig::ExternalIPsConfig& config);
 
 }  // end namespace collector
diff --git a/collector/lib/ExternalIPsConfig.cpp b/collector/lib/ExternalIPsConfig.cpp
@@ -0,0 +1,55 @@
+#include "ExternalIPsConfig.h"
+
+namespace collector {
+
+ExternalIPsConfig::ExternalIPsConfig(std::optional<sensor::CollectorConfig> runtime_config, bool default_enabled) {
+  if (!runtime_config.has_value()) {
+    direction_enabled_ = default_enabled ? Direction::BOTH : Direction::NONE;
+    return;
+  }
+
+  // At this point we know runtime_config has a value, we can access it directly
+  const auto& external_ips = runtime_config->networking().external_ips();
+  if (external_ips.enabled() != sensor::ExternalIpsEnabled::ENABLED) {
+    direction_enabled_ = Direction::NONE;
+    return;
+  }
+
+  switch (external_ips.direction()) {
+    case sensor::ExternalIpsDirection::INGRESS:
+      direction_enabled_ = Direction::INGRESS;
+      break;
+    case sensor::ExternalIpsDirection::EGRESS:
+      direction_enabled_ = Direction::EGRESS;
+      break;
+    default:
+      direction_enabled_ = Direction::BOTH;
+      break;
+  }
+}
+
+std::ostream& operator<<(std::ostream& os, const ExternalIPsConfig& config) {
+  os << "direction(";
+
+  switch (config.GetDirection()) {
+    case ExternalIPsConfig::Direction::NONE:
+      os << "NONE";
+      break;
+    case ExternalIPsConfig::Direction::INGRESS:
+      os << "INGRESS";
+      break;
+    case ExternalIPsConfig::Direction::EGRESS:
+      os << "EGRESS";
+      break;
+    case ExternalIPsConfig::Direction::BOTH:
+      os << "BOTH";
+      break;
+    default:
+      os << "invalid";
+      break;
+  }
+
+  return os << ")";
+}
+
+}  // namespace collector
diff --git a/collector/lib/ExternalIPsConfig.h b/collector/lib/ExternalIPsConfig.h
@@ -0,0 +1,40 @@
+#pragma once
+
+#include <optional>
+#include <ostream>
+
+#include <internalapi/sensor/collector.pb.h>
+
+namespace collector {
+
+// Encapsulates the configuration of the External-IPs feature
+class ExternalIPsConfig {
+ public:
+  enum Direction {
+    NONE = 0,
+    INGRESS = 1 << 0,
+    EGRESS = 1 << 1,
+    BOTH = INGRESS | EGRESS,
+  };
+
+  // Are External-IPs enabled in the provided direction ?
+  bool IsEnabled(Direction direction) const { return (direction & direction_enabled_) == direction; }
+
+  // Direction in which External-IPs are enabled
+  Direction GetDirection() const { return direction_enabled_; }
+
+  // Extract the External-IPs configuration from the provided runtime-conf.
+  // If the runtime-configuration is unset then 'default_enabled' is used
+  // as a fallback to enable in both directions.
+  // 'runtime_config' should be locked prior to calling.
+  ExternalIPsConfig(std::optional<sensor::CollectorConfig> runtime_config, bool default_enabled);
+
+  ExternalIPsConfig() : direction_enabled_(Direction::NONE) {}
+
+ private:
+  Direction direction_enabled_;
+};
+
+std::ostream& operator<<(std::ostream& os, const ExternalIPsConfig& config);
+
+}  // end namespace collector
diff --git a/collector/lib/NetworkStatusNotifier.cpp b/collector/lib/NetworkStatusNotifier.cpp
@@ -16,8 +16,6 @@ namespace collector {
 
 namespace {
 
-using Direction = CollectorConfig::ExternalIPsConfig::Direction;
-
 storage::L4Protocol TranslateL4Protocol(L4Proto proto) {
   switch (proto) {
     case L4Proto::TCP:
@@ -227,7 +225,7 @@ void NetworkStatusNotifier::RunSingle(IDuplexClientWriter<sensor::NetworkConnect
   auto next_scrape = std::chrono::system_clock::now();
   int64_t time_at_last_scrape = NowMicros();
 
-  CollectorConfig::ExternalIPsConfig prevEnableExternalIPs = config_.ExternalIPsConf();
+  ExternalIPsConfig prevEnableExternalIPs = config_.ExternalIPsConf();
 
   while (writer->Sleep(next_scrape)) {
     CLOG(DEBUG) << "Starting network status notification";
@@ -244,12 +242,12 @@ void NetworkStatusNotifier::RunSingle(IDuplexClientWriter<sensor::NetworkConnect
     const sensor::NetworkConnectionInfoMessage* msg;
     ConnMap new_conn_state, delta_conn;
     AdvertisedEndpointMap new_cep_state;
-    CollectorConfig::ExternalIPsConfig externalIPsConfig = config_.ExternalIPsConf();
+    ExternalIPsConfig externalIPsConfig = config_.ExternalIPsConf();
 
     WITH_TIMER(CollectorStats::net_fetch_state) {
       conn_tracker_->EnableExternalIPs(
-          externalIPsConfig.IsEnabled(Direction::INGRESS),
-          externalIPsConfig.IsEnabled(Direction::EGRESS));
+          externalIPsConfig.IsEnabled(ExternalIPsConfig::Direction::INGRESS),
+          externalIPsConfig.IsEnabled(ExternalIPsConfig::Direction::EGRESS));
 
       new_conn_state = conn_tracker_->FetchConnState(true, true);
       if (config_.EnableAfterglow()) {
diff --git a/collector/test/CollectorConfigTest.cpp b/collector/test/CollectorConfigTest.cpp
@@ -8,7 +8,7 @@
 #include "gtest/gtest.h"
 
 using namespace testing;
-using Direction = collector::CollectorConfig::ExternalIPsConfig::Direction;
+using Direction = collector::ExternalIPsConfig::Direction;
 
 namespace collector {
 
@@ -149,7 +149,7 @@ TEST(CollectorConfigTest, TestEnableExternalIpsRuntimeConfig) {
   external_ips_config->set_enabled(sensor::ExternalIpsEnabled::ENABLED);
   config.SetRuntimeConfig(runtime_config);
 
-  EXPECT_EQ(CollectorConfig::ExternalIPsConfig::Direction::BOTH, config.ExternalIPsConf().GetDirection());
+  EXPECT_EQ(Direction::BOTH, config.ExternalIPsConf().GetDirection());
   EXPECT_TRUE(config.ExternalIPsConf().IsEnabled(Direction::INGRESS));
   EXPECT_TRUE(config.ExternalIPsConf().IsEnabled(Direction::EGRESS));
   EXPECT_TRUE(config.ExternalIPsConf().IsEnabled(Direction::BOTH));
diff --git a/collector/test/ConfigLoaderTest.cpp b/collector/test/ConfigLoaderTest.cpp
@@ -11,7 +11,7 @@
 
 namespace collector {
 using namespace google::protobuf::util;
-using Direction = CollectorConfig::ExternalIPsConfig::Direction;
+using Direction = ExternalIPsConfig::Direction;
 
 std::string ErrorsToString(const std::vector<ParserError>& errors) {
   std::stringstream ss;
