Add Connection mock and refactor client

Author: MPogotsky

CMakeHelpers.cmake

@@ -26,10 +26,11 @@ endmacro()
 
 # Helper macro to find google test library
 macro(helper_FIND_GTEST_LIBS)
-    find_package(GTest REQUIRED)
-    if(NOT GTest_FOUND)
-        message("Gtets not found. Tests won`t compile.")
-    else()
-        include_directories(${GTEST_INCLUDE_DIRS})
-    endif()
+    include(FetchContent)
+    FetchContent_Declare(
+      googletest
+      URL https://github.com/google/googletest/archive/refs/heads/main.zip
+    )
+    # Download and make gtest/gmock available
+    FetchContent_MakeAvailable(googletest)
 endmacro()

test/CMakeLists.txt

@@ -7,6 +7,7 @@ set( SOURCES
     TestXStationClientStream.cpp
 )
 
+add_subdirectory(mocks)
 add_executable( tests
     ${SOURCES}
 )
@@ -20,13 +21,16 @@ target_compile_options(tests PRIVATE
     -Wno-missing-field-initializers
 )
 
+target_include_directories(tests PRIVATE mocks)
 target_link_libraries(tests PRIVATE 
     ${GTEST_LIBRARIES}
     Boost::system
     Boost::url
     Boost::json
     Xapi
-    GTest::gtest_main
+    gtest
+    gtest_main
+    test_mocks
 )
 
 include(GoogleTest)

test/mocks/CMakeLists.txt

@@ -0,0 +1,8 @@
+set (TEST_MOCK_LIB test_mocks)
+
+set (TEST_MOCK_LIB_PUBLIC_H
+    MockConnection.hpp
+)
+
+add_library(${TEST_MOCK_LIB} INTERFACE ${TEST_MOCK_LIB_PUBLIC_H})
+target_link_libraries(${TEST_MOCK_LIB} INTERFACE gmock gmock_main)

test/mocks/MockConnection.hpp

@@ -0,0 +1,23 @@
+#pragma once
+
+#include <gmock/gmock.h>
+#include <boost/asio.hpp>
+#include <boost/json.hpp>
+#include <boost/url.hpp>
+#include "xapi/IConnection.hpp"
+
+class MockConnection : public xapi::internals::IConnection
+{
+public:
+    // Mock the connect method
+    MOCK_METHOD((boost::asio::awaitable<void>), connect, (const boost::url &url), (override));
+
+    // Mock the disconnect method
+    MOCK_METHOD((boost::asio::awaitable<void>), disconnect, (), (override));
+
+    // Mock the makeRequest method
+    MOCK_METHOD((boost::asio::awaitable<void>), makeRequest, (const boost::json::object &command), (override));
+
+    // Mock the waitResponse method
+    MOCK_METHOD((boost::asio::awaitable<boost::json::object>), waitResponse, (), (override));
+};

xapi/CMakeLists.txt

@@ -1,6 +1,7 @@
 set(XAPI_PUBLIC_H
     Enums.hpp
     Exceptions.hpp
+    IConnection.hpp
     Connection.hpp
     XStationClient.hpp
     XStationClientStream.hpp

xapi/Connection.hpp

@@ -8,12 +8,9 @@
  * establishing and managing connections, making requests, and handling responses.
  */
 
-#include <boost/asio.hpp>
-#include <boost/asio/cancellation_signal.hpp>
+#include "IConnection.hpp"
 #include <boost/beast.hpp>
 #include <boost/beast/websocket/ssl.hpp>
-#include <boost/json.hpp>
-#include <boost/url.hpp>
 #include <chrono>
 #include <string>
 
@@ -29,7 +26,7 @@ namespace internals
  * The Connection class encapsulates the functionality for establishing an SSL connection,
  * sending requests, and receiving responses.
  */
-class Connection
+class Connection : public IConnection
 {
   public:
     Connection() = delete;
@@ -47,42 +44,41 @@ class Connection
      */
     explicit Connection(boost::asio::io_context &ioContext);
 
-    virtual ~Connection();
+    virtual ~Connection() override;
 
     /**
      * @brief Asynchronously establishes secure WebSocket connection to the server.
      * @param url The URL to connect to.
      * @return An awaitable void.
      * @throw xapi::exception::ConnectionClosed if the connection fails.
      */
-    boost::asio::awaitable<void> connect(const boost::url &url);
+    boost::asio::awaitable<void> connect(const boost::url &url) override;
 
     /**
      * @brief Asynchronously disconnects from the server.
      * @return An awaitable void.
      */
-    boost::asio::awaitable<void> disconnect();
+    boost::asio::awaitable<void> disconnect() override;
 
     /**
      * @brief Makes an asynchronous request to the server.
      * @param command The command to send as a JSON value.
      * @return An awaitable void.
      * @throw xapi::exception::ConnectionClosed if the request fails.
      */
-    boost::asio::awaitable<void> makeRequest(const boost::json::object &command);
+    boost::asio::awaitable<void> makeRequest(const boost::json::object &command) override;
 
     /**
      * @brief Waits for a response from the server.
      * @return An awaitable boost::json::object with response from the server.
      * @throw xapi::exception::ConnectionClosed if the response fails.
      */
-    boost::asio::awaitable<boost::json::object> waitResponse();
+    boost::asio::awaitable<boost::json::object> waitResponse() override;
 
-  protected:
+  private:
     // The IO context for asynchronous operations.
     boost::asio::io_context &m_ioContext;
 
-  private:
     /**
      * @brief Establishes an SSL connection asynchronously.
      * @param results The resolved endpoints to attempt to connect to.

xapi/IConnection.hpp

@@ -0,0 +1,54 @@
+#pragma once
+
+/**
+ * @file IConnection.hpp
+ * @brief Declaration of the Connection interface.
+ */
+
+#include <boost/asio.hpp>
+#include <boost/asio/cancellation_signal.hpp>
+#include <boost/json.hpp>
+#include <boost/url.hpp>
+
+namespace xapi
+{
+namespace internals
+{
+
+class IConnection
+{
+  public:
+    virtual ~IConnection() = default;
+
+    /**
+     * @brief Asynchronously establishes secure WebSocket connection to the server.
+     * @param url The URL to connect to.
+     * @return An awaitable void.
+     * @throw xapi::exception::ConnectionClosed if the connection fails.
+     */
+    virtual boost::asio::awaitable<void> connect(const boost::url &url) = 0;
+
+    /**
+     * @brief Asynchronously disconnects from the server.
+     * @return An awaitable void.
+     */
+    virtual boost::asio::awaitable<void> disconnect() = 0;
+
+    /**
+     * @brief Makes an asynchronous request to the server.
+     * @param command The command to send as a JSON value.
+     * @return An awaitable void.
+     * @throw xapi::exception::ConnectionClosed if the request fails.
+     */
+    virtual boost::asio::awaitable<void> makeRequest(const boost::json::object &command) = 0;
+
+    /**
+     * @brief Waits for a response from the server.
+     * @return An awaitable boost::json::object with response from the server.
+     * @throw xapi::exception::ConnectionClosed if the response fails.
+     */
+    virtual boost::asio::awaitable<boost::json::object> waitResponse() = 0;
+};
+
+} // namespace internals
+} // namespace xapi

xapi/XStationClient.cpp

@@ -8,7 +8,7 @@ const std::unordered_set<std::string> XStationClient::m_knownAccountTypes = {"de
 
 XStationClient::XStationClient(boost::asio::io_context &ioContext, const std::string &accountId,
                                const std::string &password, const std::string &accountType)
-    : Connection(ioContext), m_accountId(accountId), m_password(password),
+    : m_ioContext(ioContext), m_connection(std::make_unique<internals::Connection>(ioContext)), m_accountId(accountId), m_password(password),
       m_accountType(accountType), m_safeMode(true), m_streamSessionId("")
 {
 }
@@ -25,7 +25,7 @@ boost::asio::awaitable<void> XStationClient::login() {
     validateAccountType(m_accountType);
 
     const boost::url socketUrl = boost::urls::format("wss://ws.xtb.com/{}", m_accountType);
-    co_await connect(socketUrl);
+    co_await m_connection->connect(socketUrl);
 
     boost::json::object command = {
         {"command", "login"},
@@ -48,7 +48,7 @@ boost::asio::awaitable<void> XStationClient::logout() {
         {"command", "logout"}
     };
     co_await request(command);
-    co_await disconnect();
+    co_await m_connection->disconnect();
 
 }
 
@@ -366,8 +366,8 @@ boost::asio::awaitable<boost::json::object> XStationClient::tradeTransactionStat
 
 boost::asio::awaitable<boost::json::object> XStationClient::request(const boost::json::object &command)
 {
-    co_await makeRequest(command);
-    auto result = co_await waitResponse();
+    co_await m_connection->makeRequest(command);
+    auto result = co_await m_connection->waitResponse();
     co_return result;
 }
 

xapi/XStationClient.hpp

@@ -23,7 +23,7 @@ namespace xapi
  * from xAPI. It is built on top of the Connection class, which handles the
  * low-level details of establishing and maintaining a connection.
  */
-class XStationClient : protected internals::Connection
+class XStationClient final
 {
   public:
     XStationClient() = delete;
@@ -67,7 +67,7 @@ class XStationClient : protected internals::Connection
      */
     explicit XStationClient(boost::asio::io_context &ioContext, const boost::json::object &accountCredentials);
 
-    ~XStationClient() override = default;
+    ~XStationClient() = default;
 
     /**
      * @brief Opens connection to the server and logs in.
@@ -153,6 +153,9 @@ class XStationClient : protected internals::Connection
 
   protected:
 
+    boost::asio::io_context &m_ioContext;
+    std::unique_ptr<internals::IConnection> m_connection;
+
     const std::string m_accountId;
     const std::string m_password;
     const std::string m_accountType;