refactor(OCPP): Move ConnectivityManager from v2 to common namespace

* Move ConnectivityManager to common namespace for reuse across OCPP versions
* Refactor constructor to accept logging and message callbacks via setters instead of constructor parameters
* Add ChargePoint constructor accepting shared ConnectivityManagerInterface for external injection
* Add validation that MessageLogging instance is provided to websocket at construction

Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>

Author: Pietfried

lib/everest/ocpp/doc/networkconnectivity/README.md

@@ -14,8 +14,8 @@ be activated before it is possible to connect to this interface. To do this, you
 
 In the implementation of this callback, you have to create a promise and return the future to the promise:
 ```cpp
-std::promise<ocpp::v2::ConfigNetworkResult> promise();
-std::future<ocpp::v2::ConfigNetworkResult> future = promise.get_future();
+std::promise<ocpp::ConfigNetworkResult> promise();
+std::future<ocpp::ConfigNetworkResult> future = promise.get_future();
 return future;
 ```
 

…include/ocpp/v2/connectivity_manager.hpp …ude/ocpp/common/connectivity_manager.hpplib/everest/ocpp/include/ocpp/v2/connectivity_manager.hpp renamed to lib/everest/ocpp/include/ocpp/common/connectivity_manager.hpp lib/everest/ocpp/include/ocpp/v2/connectivity_manager.hpp renamed to lib/everest/ocpp/include/ocpp/common/connectivity_manager.hpp

@@ -10,10 +10,11 @@
 #include <functional>
 #include <future>
 #include <optional>
+
 namespace ocpp {
 namespace v2 {
-
 class DeviceModelAbstract;
+}
 
 /// \brief The result of a configuration of a network profile.
 struct ConfigNetworkResult {
@@ -22,15 +23,24 @@ struct ConfigNetworkResult {
 };
 
 using WebsocketConnectionCallback =
-    std::function<void(int configuration_slot, const NetworkConnectionProfile& network_connection_profile,
+    std::function<void(int configuration_slot, const ocpp::v2::NetworkConnectionProfile& network_connection_profile,
                        const OcppProtocolVersion version)>;
 using WebsocketConnectionFailedCallback = std::function<void(ConnectionFailedReason reason)>;
 using ConfigureNetworkConnectionProfileCallback = std::function<std::future<ConfigNetworkResult>(
-    const std::int32_t configuration_slot, const NetworkConnectionProfile& network_connection_profile)>;
+    const std::int32_t configuration_slot, const ocpp::v2::NetworkConnectionProfile& network_connection_profile)>;
 
 class ConnectivityManagerInterface {
 public:
     virtual ~ConnectivityManagerInterface() = default;
+
+    /// \brief Set the \p callback that is called when a message is received from the websocket
+    ///
+    virtual void set_message_callback(const std::function<void(const std::string& message)>& callback) = 0;
+
+    /// \brief Set the logger \p logging
+    ///
+    virtual void set_logging(std::shared_ptr<MessageLogging> logging) = 0;
+
     /// \brief Set the websocket \p authorization_key
     ///
     virtual void set_websocket_authorization_key(const std::string& authorization_key) = 0;
@@ -63,7 +73,7 @@ class ConnectivityManagerInterface {
     /// \brief Gets the cached NetworkConnectionProfile based on the given \p configuration_slot.
     /// This returns the value from the cached network connection profiles.
     /// \return Returns a profile if the slot is found
-    virtual std::optional<NetworkConnectionProfile>
+    virtual std::optional<ocpp::v2::NetworkConnectionProfile>
     get_network_connection_profile(const std::int32_t configuration_slot) const = 0;
 
     /// \brief Get the priority of the given configuration slot.
@@ -107,7 +117,7 @@ class ConnectivityManagerInterface {
     ///
     /// \param ocpp_interface The interface that is disconnected.
     ///
-    virtual void on_network_disconnected(OCPPInterfaceEnum ocpp_interface) = 0;
+    virtual void on_network_disconnected(ocpp::v2::OCPPInterfaceEnum ocpp_interface) = 0;
 
     /// \brief Called when the charging station certificate is changed
     ///
@@ -120,7 +130,7 @@ class ConnectivityManagerInterface {
 class ConnectivityManager : public ConnectivityManagerInterface {
 private:
     /// \brief Reference to the device model
-    DeviceModelAbstract& device_model;
+    ocpp::v2::DeviceModelAbstract& device_model;
     /// \brief Pointer to the evse security class
     std::shared_ptr<EvseSecurity> evse_security;
     /// \brief Pointer to the logger
@@ -144,32 +154,33 @@ class ConnectivityManager : public ConnectivityManagerInterface {
     std::int32_t active_network_configuration_priority;
     int last_known_security_level;
     /// @brief Local cached network connection profiles
-    std::vector<SetNetworkProfileRequest> cached_network_connection_profiles;
+    std::vector<ocpp::v2::SetNetworkProfileRequest> cached_network_connection_profiles;
     /// @brief local cached network connection priorities
     std::vector<std::int32_t> network_connection_slots;
     OcppProtocolVersion connected_ocpp_version;
 
 public:
-    ConnectivityManager(DeviceModelAbstract& device_model, std::shared_ptr<EvseSecurity> evse_security,
-                        std::shared_ptr<MessageLogging> logging,
-                        const std::function<void(const std::string& message)>& message_callback);
+    ConnectivityManager(ocpp::v2::DeviceModelAbstract& device_model, std::shared_ptr<EvseSecurity> evse_security);
 
+    void set_message_callback(const std::function<void(const std::string& message)>& callback) override;
+    void set_logging(std::shared_ptr<MessageLogging> logging) override;
     void set_websocket_authorization_key(const std::string& authorization_key) override;
     void set_websocket_connection_options(const WebsocketConnectionOptions& connection_options) override;
     void set_websocket_connection_options_without_reconnect() override;
     void set_websocket_connected_callback(WebsocketConnectionCallback callback) override;
     void set_websocket_disconnected_callback(WebsocketConnectionCallback callback) override;
     void set_websocket_connection_failed_callback(WebsocketConnectionFailedCallback callback) override;
     void set_configure_network_connection_profile_callback(ConfigureNetworkConnectionProfileCallback callback) override;
-    std::optional<NetworkConnectionProfile>
+    std::optional<ocpp::v2::NetworkConnectionProfile>
     get_network_connection_profile(const std::int32_t configuration_slot) const override;
-    std::optional<std::int32_t> get_priority_from_configuration_slot(const int configuration_slot) const override;
+    std::optional<std::int32_t>
+    get_priority_from_configuration_slot(const std::int32_t configuration_slot) const override;
     const std::vector<int>& get_network_connection_slots() const override;
     bool is_websocket_connected() override;
     void connect(std::optional<std::int32_t> network_profile_slot = std::nullopt) override;
     void disconnect() override;
     bool send_to_websocket(const std::string& message) override;
-    void on_network_disconnected(OCPPInterfaceEnum ocpp_interface) override;
+    void on_network_disconnected(ocpp::v2::OCPPInterfaceEnum ocpp_interface) override;
     void on_charging_station_certificate_changed() override;
     void confirm_successful_connection() override;
 
@@ -190,7 +201,7 @@ class ConnectivityManager : public ConnectivityManagerInterface {
     /// \return The network configuration containing the network interface to use, nullptr if the request failed or the
     /// callback is not configured
     std::optional<ConfigNetworkResult>
-    handle_configure_network_connection_profile_callback(int slot, const NetworkConnectionProfile& profile);
+    handle_configure_network_connection_profile_callback(int slot, const ocpp::v2::NetworkConnectionProfile& profile);
 
     /// \brief Function invoked when the web socket connected with the \p security_profile
     ///
@@ -237,5 +248,4 @@ class ConnectivityManager : public ConnectivityManagerInterface {
     void remove_network_connection_profiles_below_actual_security_profile();
 };
 
-} // namespace v2
 } // namespace ocpp

lib/everest/ocpp/include/ocpp/v2/charge_point.hpp

@@ -89,6 +89,28 @@ class ChargePointInterface {
     /// The handlers
     /// @{
 
+    ///
+    /// \brief Shall be called when a websocket connection has been established in case the connectivity_handler is
+    /// provided exernally.
+    /// \param configuration_slot The network profile slot used for the connection.
+    /// \param network_connection_profile The network connection profile used for the connection.
+    virtual void on_websocket_connected(const int configuration_slot,
+                                        const NetworkConnectionProfile& network_connection_profile,
+                                        const OcppProtocolVersion ocpp_version) = 0;
+
+    ///
+    /// \brief Shall be called when a websocket connection has been disconnected in case the connectivity_handler is
+    /// provided externally.
+    /// \param configuration_slot The network profile slot used for the connection.
+    /// \param network_connection_profile The network connection profile used for the connection.
+    virtual void on_websocket_disconnected(const int configuration_slot,
+                                           const NetworkConnectionProfile& network_connection_profile) = 0;
+
+    /// \brief Shall be called when a websocket connection attempt has failed in case the connectivity_handler is
+    /// provided externally.
+    /// \param reason The reason why the connection failed.
+    virtual void on_websocket_connection_failed(ConnectionFailedReason reason) = 0;
+
     ///
     /// \brief Can be called when a network is disconnected, for example when an ethernet cable is removed.
     ///
@@ -345,7 +367,7 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
 private:
     std::shared_ptr<DeviceModelAbstract> device_model;
     std::unique_ptr<EvseManager> evse_manager;
-    std::unique_ptr<ConnectivityManager> connectivity_manager;
+    std::shared_ptr<ConnectivityManagerInterface> connectivity_manager;
 
     std::unique_ptr<MessageDispatcherInterface<MessageType>> message_dispatcher;
 
@@ -412,12 +434,7 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
     // internal helper functions
     void initialize(const std::map<std::int32_t, std::int32_t>& evse_connector_structure,
                     const std::string& message_log_path);
-    void websocket_connected_callback(const int configuration_slot,
-                                      const NetworkConnectionProfile& network_connection_profile,
-                                      const OcppProtocolVersion ocpp_version);
-    void websocket_disconnected_callback(const int configuration_slot,
-                                         const NetworkConnectionProfile& network_connection_profile);
-    void websocket_connection_failed(ConnectionFailedReason reason);
+    OcspUpdater make_ocsp_updater();
     void update_dm_availability_state(const std::int32_t evse_id, const std::int32_t connector_id,
                                       const ConnectorStatusEnum status);
 
@@ -463,6 +480,22 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
     /// @name Constructors for 2.0.1
     /// @{
 
+    /// \brief Construct a new ChargePoint object
+    /// \param evse_connector_structure Map that defines the structure of EVSE and connectors of the chargepoint. The
+    /// key represents the id of the EVSE and the value represents the number of connectors for this EVSE. The ids of
+    /// the EVSEs have to increment starting with 1.
+    /// \param device_model device model instance
+    /// \param database_handler database handler instance
+    /// \param evse_security Pointer to evse_security that manages security related operations
+    /// \param connectivity_manager connectivity manager instance
+    /// \param message_log_path Path to where logfiles are written to
+    /// \param callbacks Callbacks that will be registered for ChargePoint
+    ChargePoint(const std::map<int32_t, int32_t>& evse_connector_structure,
+                std::shared_ptr<DeviceModelAbstract> device_model, std::shared_ptr<DatabaseHandler> database_handler,
+                const std::shared_ptr<EvseSecurity> evse_security,
+                const std::shared_ptr<ConnectivityManagerInterface> connectivity_manager,
+                const std::string& message_log_path, const Callbacks& callbacks);
+
     /// \brief Construct a new ChargePoint object
     /// \param evse_connector_structure Map that defines the structure of EVSE and connectors of the chargepoint. The
     /// key represents the id of the EVSE and the value represents the number of connectors for this EVSE. The ids of
@@ -527,6 +560,12 @@ class ChargePoint : public ChargePointInterface, private ocpp::ChargingStationBa
     void connect_websocket(std::optional<std::int32_t> network_profile_slot = std::nullopt) override;
     void disconnect_websocket() override;
 
+    void on_websocket_connected(const int configuration_slot,
+                                const NetworkConnectionProfile& network_connection_profile,
+                                const OcppProtocolVersion ocpp_version) override;
+    void on_websocket_disconnected(const int configuration_slot,
+                                   const NetworkConnectionProfile& network_connection_profile) override;
+    void on_websocket_connection_failed(ConnectionFailedReason reason) override;
     void on_network_disconnected(OCPPInterfaceEnum ocpp_interface) override;
 
     void on_firmware_update_status_notification(std::int32_t request_id,

lib/everest/ocpp/include/ocpp/v2/charge_point_callbacks.hpp

@@ -3,7 +3,7 @@
 #include <cstdint>
 #include <memory>
 
-#include <ocpp/v2/connectivity_manager.hpp>
+#include <ocpp/common/connectivity_manager.hpp>
 #include <ocpp/v2/device_model.hpp>
 
 #include <ocpp/v2/messages/BootNotification.hpp>

lib/everest/ocpp/include/ocpp/v2/functional_blocks/functional_block_context.hpp

@@ -8,10 +8,10 @@
 
 namespace ocpp {
 class EvseSecurity;
+class ConnectivityManagerInterface;
 
 namespace v2 {
 class DeviceModelAbstract;
-class ConnectivityManagerInterface;
 class EvseManagerInterface;
 class DatabaseHandlerInterface;
 class ComponentStateManagerInterface;

lib/everest/ocpp/include/ocpp/v2/message_dispatcher.hpp

@@ -3,8 +3,8 @@
 
 #pragma once
 
+#include <ocpp/common/connectivity_manager.hpp>
 #include <ocpp/common/message_dispatcher.hpp>
-#include <ocpp/v2/connectivity_manager.hpp>
 #include <ocpp/v2/device_model_abstract.hpp>
 
 namespace ocpp {

lib/everest/ocpp/lib/CMakeLists.txt

@@ -21,6 +21,7 @@ target_sources(ocpp
     PRIVATE
         ocpp/common/call_types.cpp
         ocpp/common/charging_station_base.cpp
+        ocpp/common/connectivity_manager.cpp
         ocpp/common/ocpp_logging.cpp
         ocpp/common/schemas.cpp
         ocpp/common/types.cpp
@@ -89,7 +90,6 @@ if(LIBOCPP_ENABLE_V2)
             ocpp/v2/types.cpp
             ocpp/v2/utils.cpp
             ocpp/v2/component_state_manager.cpp
-            ocpp/v2/connectivity_manager.cpp
             ocpp/v2/message_dispatcher.cpp
             ocpp/v2/functional_blocks/authorization.cpp
             ocpp/v2/functional_blocks/availability.cpp

…cpp/lib/ocpp/v2/connectivity_manager.cpp …lib/ocpp/common/connectivity_manager.cpplib/everest/ocpp/lib/ocpp/v2/connectivity_manager.cpp renamed to lib/everest/ocpp/lib/ocpp/common/connectivity_manager.cpp lib/everest/ocpp/lib/ocpp/v2/connectivity_manager.cpp renamed to lib/everest/ocpp/lib/ocpp/common/connectivity_manager.cpp

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright 2020 - 2024 Pionix GmbH and Contributors to EVerest
 
-#include <ocpp/v2/connectivity_manager.hpp>
+#include <ocpp/common/connectivity_manager.hpp>
 
 #include <everest/logging.hpp>
 #include <ocpp/v2/ctrlr_component_variables.hpp>
@@ -17,23 +17,37 @@ constexpr std::int32_t default_network_config_timeout_seconds = 60;
 } // namespace
 
 namespace ocpp {
-namespace v2 {
 
-ConnectivityManager::ConnectivityManager(DeviceModelAbstract& device_model, std::shared_ptr<EvseSecurity> evse_security,
-                                         std::shared_ptr<MessageLogging> logging,
-                                         const std::function<void(const std::string& message)>& message_callback) :
+using NetworkConnectionProfile = ocpp::v2::NetworkConnectionProfile;
+using AttributeEnum = ocpp::v2::AttributeEnum;
+using DeviceModel = ocpp::v2::DeviceModel;
+using OCPPInterfaceEnum = ocpp::v2::OCPPInterfaceEnum;
+using SetNetworkProfileRequest = ocpp::v2::SetNetworkProfileRequest;
+namespace ControllerComponentVariables = ocpp::v2::ControllerComponentVariables;
+
+ConnectivityManager::ConnectivityManager(ocpp::v2::DeviceModelAbstract& device_model,
+                                         std::shared_ptr<EvseSecurity> evse_security) :
     device_model{device_model},
     evse_security{evse_security},
-    logging{logging},
+    message_callback([](const std::string& message) {
+        EVLOG_warning << "No message callback set in ConnectivityManager. Dropping message: " << message;
+    }),
     websocket{nullptr},
-    message_callback{message_callback},
     wants_to_be_connected{false},
     active_network_configuration_priority{0},
     last_known_security_level{0},
     connected_ocpp_version{OcppProtocolVersion::Unknown} {
     cache_network_connection_profiles();
 }
 
+void ConnectivityManager::set_message_callback(const std::function<void(const std::string& message)>& callback) {
+    this->message_callback = callback;
+}
+
+void ConnectivityManager::set_logging(std::shared_ptr<MessageLogging> logging) {
+    this->logging = logging;
+}
+
 void ConnectivityManager::set_websocket_authorization_key(const std::string& authorization_key) {
     if (this->websocket != nullptr) {
         this->websocket->set_authorization_key(authorization_key);
@@ -338,7 +352,7 @@ ConnectivityManager::get_ws_connection_options(const std::int32_t configuration_
             this->device_model.get_value<std::string>(ControllerComponentVariables::SecurityCtrlrIdentity),
             network_connection_profile.securityProfile);
 
-        const auto ocpp_versions = utils::get_ocpp_protocol_versions(
+        const auto ocpp_versions = ocpp::v2::utils::get_ocpp_protocol_versions(
             this->device_model.get_value<std::string>(ControllerComponentVariables::SupportedOcppVersions));
 
         WebsocketConnectionOptions connection_options{
@@ -525,5 +539,4 @@ void ConnectivityManager::remove_network_connection_profiles_below_actual_securi
                                  AttributeEnum::Actual, new_network_priority, VARIABLE_ATTRIBUTE_VALUE_SOURCE_INTERNAL);
 }
 
-} // namespace v2
 } // namespace ocpp

lib/everest/ocpp/lib/ocpp/common/websocket/websocket.cpp

@@ -16,6 +16,11 @@ namespace ocpp {
 Websocket::Websocket(const WebsocketConnectionOptions& connection_options, std::shared_ptr<EvseSecurity> evse_security,
                      std::shared_ptr<MessageLogging> logging) :
     logging(logging) {
+
+    if (logging == nullptr) {
+        throw std::runtime_error("Websocket requires a valid MessageLogging instance");
+    }
+
     this->websocket = std::make_unique<WebsocketLibwebsockets>(connection_options, evse_security);
 }