Merge pull request #258 from nicklewis/use-ostream-not-ofstream

beechtom · web-flow · commit 33c93478c3fc · 2021-11-02T11:46:59.000-07:00
(PCP-906) Use std::ostream instead of std::ofstream for logstream
diff --git a/lib/inc/cpp-pcp-client/connector/client_metadata.hpp b/lib/inc/cpp-pcp-client/connector/client_metadata.hpp
@@ -27,7 +27,7 @@ class LIBCPP_PCP_CLIENT_EXPORT ClientMetadata {
     uint32_t pong_timeouts_before_retry;
     long pong_timeout_ms;
     leatherman::logging::log_level loglevel{};
-    std::ofstream* logstream;
+    std::ostream* logstream;
 
     /// Throws a connection_config_error in case: the client
     /// certificate file does not exist or is invalid; it fails to
@@ -72,7 +72,7 @@ class LIBCPP_PCP_CLIENT_EXPORT ClientMetadata {
                    std::string _crl,
                    std::string proxy,
                    leatherman::logging::log_level loglevel,
-                   std::ofstream* logstream,
+                   std::ostream* logstream,
                    long _ws_connection_timeout_ms,
                    uint32_t _pong_timeouts_before_retry,
                    long _pong_timeout_ms);
diff --git a/lib/inc/cpp-pcp-client/connector/connection.hpp b/lib/inc/cpp-pcp-client/connector/connection.hpp
@@ -122,7 +122,7 @@ class LIBCPP_PCP_CLIENT_EXPORT Connection {
 
     /// WebSocket++ logging configuration
     void setWebSocketLogLevel(leatherman::logging::log_level loglevel);
-    void setWebSocketLogStream(std::ofstream* logstream);
+    void setWebSocketLogStream(std::ostream* logstream);
 
     /// Check the state of the WebSocket connection; in case it's not
     /// open, try to re-open it.
diff --git a/lib/inc/cpp-pcp-client/connector/connector_base.hpp b/lib/inc/cpp-pcp-client/connector/connector_base.hpp
@@ -72,7 +72,7 @@ class LIBCPP_PCP_CLIENT_EXPORT ConnectorBase {
         std::string client_crl_path,
         std::string ws_proxy,
         leatherman::logging::log_level loglevel,
-        std::ofstream* logstream,
+        std::ostream* logstream,
         long ws_connection_timeout_ms,
         uint32_t pong_timeouts_before_retry,
         long ws_pong_timeout_ms);
diff --git a/lib/inc/cpp-pcp-client/connector/v1/connector.hpp b/lib/inc/cpp-pcp-client/connector/v1/connector.hpp
@@ -115,7 +115,7 @@ class LIBCPP_PCP_CLIENT_EXPORT Connector : public ConnectorBase {
               std::string client_crl_path,
               std::string ws_proxy,
               leatherman::logging::log_level loglevel,
-              std::ofstream* logstream,
+              std::ostream* logstream,
               long ws_connection_timeout_ms = 5000,
               uint32_t association_timeout_s = 15,
               uint32_t association_request_ttl_s = 10,  // Unused
diff --git a/lib/inc/cpp-pcp-client/connector/v2/connector.hpp b/lib/inc/cpp-pcp-client/connector/v2/connector.hpp
@@ -102,7 +102,7 @@ class LIBCPP_PCP_CLIENT_EXPORT Connector : public ConnectorBase {
               std::string client_crl_path,
               std::string ws_proxy,
               leatherman::logging::log_level loglevel,
-              std::ofstream* logstream,
+              std::ostream* logstream,
               long ws_connection_timeout_ms = 5000,
               uint32_t pong_timeouts_before_retry = 3,
               long ws_pong_timeout_ms = 5000);
diff --git a/lib/src/connector/client_metadata.cc b/lib/src/connector/client_metadata.cc
@@ -193,7 +193,7 @@ ClientMetadata::ClientMetadata(std::string _client_type,
                                std::string _crl,
                                std::string _proxy,
                                lth_log::log_level _loglevel,
-                               std::ofstream* _logstream,
+                               std::ostream* _logstream,
                                long _ws_connection_timeout_ms,
                                uint32_t _pong_timeouts_before_retry,
                                long _pong_timeout_ms)
diff --git a/lib/src/connector/connection.cc b/lib/src/connector/connection.cc
@@ -191,7 +191,7 @@ void Connection::setWebSocketLogLevel(lth_log::log_level loglevel)
     }
 }
 
-void Connection::setWebSocketLogStream(std::ofstream* logstream)
+void Connection::setWebSocketLogStream(std::ostream* logstream)
 {
     if (logstream != nullptr) {
       endpoint_->get_alog().set_ostream(logstream);
diff --git a/lib/src/connector/connector_base.cc b/lib/src/connector/connector_base.cc
@@ -113,7 +113,7 @@ ConnectorBase::ConnectorBase(std::vector<std::string> broker_ws_uris,
                              std::string client_crl_path,
                              std::string ws_proxy,
                              lth_log::log_level loglevel,
-                             std::ofstream* logstream,
+                             std::ostream* logstream,
                              long ws_connection_timeout_ms,
                              uint32_t pong_timeouts_before_retry,
                              long ws_pong_timeout_ms)
diff --git a/lib/src/connector/v1/connector.cc b/lib/src/connector/v1/connector.cc
@@ -270,7 +270,7 @@ Connector::Connector(std::vector<std::string> broker_ws_uris,
                      std::string client_crl_path,
                      std::string ws_proxy,
                      lth_log::log_level loglevel,
-                     std::ofstream* logstream,
+                     std::ostream* logstream,
                      long ws_connection_timeout_ms,
                      uint32_t association_timeout_s,
                      uint32_t association_request_ttl_s,
diff --git a/lib/src/connector/v2/connector.cc b/lib/src/connector/v2/connector.cc
@@ -213,7 +213,7 @@ Connector::Connector(std::vector<std::string> broker_ws_uris,
                      std::string client_crl_path,
                      std::string ws_proxy,
                      lth_log::log_level loglevel,
-                     std::ofstream* logstream,
+                     std::ostream* logstream,
                      long ws_connection_timeout_ms,
                      uint32_t pong_timeouts_before_retry,
                      long ws_pong_timeout_ms)
diff --git a/lib/tests/unit/connector/connection_test.cc b/lib/tests/unit/connector/connection_test.cc
@@ -10,6 +10,11 @@
 
 #include <cpp-pcp-client/util/chrono.hpp>
 
+#include <boost/nowide/iostream.hpp>
+
+#define LEATHERMAN_LOGGING_NAMESPACE "puppetlabs.cpp_pcp_client.test"
+#include <leatherman/logging/logging.hpp>
+
 #include <leatherman/util/timer.hpp>
 
 #include <memory>
@@ -36,8 +41,9 @@ TEST_CASE("Connection::connect errors", "[connection]") {
 
 TEST_CASE("Connection timings", "[connection]") {
     ClientMetadata c_m { "test_client", getCaPath(), getCertPath(),
-                         getKeyPath(), WS_TIMEOUT_MS,
-                         PONG_TIMEOUTS_BEFORE_RETRY, PONG_LONG_TIMEOUT_MS };
+                         getKeyPath(), std::string{}, std::string{},
+                         leatherman::logging::log_level::error, &boost::nowide::cout,
+                         WS_TIMEOUT_MS, PONG_TIMEOUTS_BEFORE_RETRY, PONG_LONG_TIMEOUT_MS };
 
     SECTION("can stringify timings") {
         Connection connection { "wss://localhost:8142/pcp", c_m };

Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ void Connection::setWebSocketLogLevel(lth_log::log_level loglevel)`
`191`	`191`	`}`
`192`	`192`	`}`
`193`	`193`
`194`		`-void Connection::setWebSocketLogStream(std::ofstream* logstream)`
	`194`	`+void Connection::setWebSocketLogStream(std::ostream* logstream)`
`195`	`195`	`{`
`196`	`196`	`if (logstream != nullptr) {`
`197`	`197`	`endpoint_->get_alog().set_ostream(logstream);`