common: make LogChannel mockable

Adding LoggerSinkSet, an abstract API that enables unit-testing
of OSD components that emit cluster-log messages, and trapping the
logs.

First usage example is in the Scrubber backend unit-tests.
The log "implementation" there (note the error counter that
can be used to determine tests success):

 class MockLog : public LoggerSinkSet {
 public:
  void warn(std::stringstream& s) override
  {
    std::cout << "\n<<warn>> " << s.str() << std::endl;
  }
  void error(std::stringstream& s) override
  {
    err_count++;
    std::cout << "\n<<error>> " << s.str() << std::endl;
  }
  ...

Signed-off-by: Ronen Friedman <rfriedma@redhat.com>

diff --git a/src/common/LogClient.h b/src/common/LogClient.h
index 73c0d4279b70fdc24c1e6b64d4cd8419cb01768a..507fd9a9e25c9ff018b78b7bd74354a24c809e0b 100644 (file)
--- a/src/common/LogClient.h
+++ b/src/common/LogClient.h
@@ -60,7 +60,7 @@ struct clog_targets_conf_t {
  * Past queueing the LogEntry, the LogChannel is done with the whole thing.
  * LogClient will deal with sending and handling of LogEntries.
  */
-class LogChannel : public OstreamTemp::OstreamTempSink
+class LogChannel : public LoggerSinkSet
 {
 public:
 
@@ -70,10 +70,10 @@ public:
              const std::string &facility,
              const std::string &prio);
 
-  OstreamTemp debug() {
+  OstreamTemp debug() final {
     return OstreamTemp(CLOG_DEBUG, this);
   }
-  void debug(std::stringstream &s) {
+  void debug(std::stringstream &s) final {
     do_log(CLOG_DEBUG, s);
   }
   /**
@@ -93,28 +93,28 @@ public:
         ceph_abort();
     }
   }
-  OstreamTemp info() {
+  OstreamTemp info() final {
     return OstreamTemp(CLOG_INFO, this);
   }
-  void info(std::stringstream &s) {
+  void info(std::stringstream &s) final {
     do_log(CLOG_INFO, s);
   }
-  OstreamTemp warn() {
+  OstreamTemp warn() final {
     return OstreamTemp(CLOG_WARN, this);
   }
-  void warn(std::stringstream &s) {
+  void warn(std::stringstream &s) final {
     do_log(CLOG_WARN, s);
   }
-  OstreamTemp error() {
+  OstreamTemp error() final {
     return OstreamTemp(CLOG_ERROR, this);
   }
-  void error(std::stringstream &s) {
+  void error(std::stringstream &s) final {
     do_log(CLOG_ERROR, s);
   }
-  OstreamTemp sec() {
+  OstreamTemp sec() final {
     return OstreamTemp(CLOG_SEC, this);
   }
-  void sec(std::stringstream &s) {
+  void sec(std::stringstream &s) final {
     do_log(CLOG_SEC, s);
   }
 
@@ -162,8 +162,8 @@ public:
    */
   clog_targets_conf_t parse_client_options(CephContext* conf_cct);
 
-  void do_log(clog_type prio, std::stringstream& ss);
-  void do_log(clog_type prio, const std::string& s);
+  void do_log(clog_type prio, std::stringstream& ss) final;
+  void do_log(clog_type prio, const std::string& s) final;
 
 private:
   CephContext *cct;

diff --git a/src/common/ostream_temp.h b/src/common/ostream_temp.h
index 722b189cd31ff84089600797698ac79dad64bdc1..73e9e3f258399942d518e62f672d40056b74c675 100644 (file)
--- a/src/common/ostream_temp.h
+++ b/src/common/ostream_temp.h
@@ -37,3 +37,20 @@ private:
   OstreamTempSink *parent;
   std::stringstream ss;
 };
+
+class LoggerSinkSet : public OstreamTemp::OstreamTempSink {
+public:
+  virtual void info(std::stringstream &s) = 0;
+  virtual void warn(std::stringstream &s) = 0;
+  virtual void error(std::stringstream &s) = 0;
+  virtual void sec(std::stringstream &s) = 0;
+  virtual void debug(std::stringstream &s) = 0;
+  virtual OstreamTemp info() = 0;
+  virtual OstreamTemp warn() = 0;
+  virtual OstreamTemp error() = 0;
+  virtual OstreamTemp sec() = 0;
+  virtual OstreamTemp debug() = 0;
+  virtual void do_log(clog_type prio, std::stringstream& ss) = 0;
+  virtual void do_log(clog_type prio, const std::string& ss) = 0;
+  virtual ~LoggerSinkSet() {};
+};

diff --git a/src/crimson/common/logclient.h b/src/crimson/common/logclient.h
index ccf24c2b6a3433aba62931362d9e952c23d619aa..ab9b25091fff8e2f442eb89e0500e14672deaac5 100644 (file)
--- a/src/crimson/common/logclient.h
+++ b/src/crimson/common/logclient.h
@@ -58,7 +58,7 @@ int parse_log_client_options(CephContext *cct,
  * Past queueing the LogEntry, the LogChannel is done with the whole thing.
  * LogClient will deal with sending and handling of LogEntries.
  */
-class LogChannel : public OstreamTemp::OstreamTempSink
+class LogChannel : public LoggerSinkSet
 {
 public:
   LogChannel(LogClient *lc, const std::string &channel);
@@ -68,7 +68,7 @@ public:
   OstreamTemp debug() {
     return OstreamTemp(CLOG_DEBUG, this);
   }
-  void debug(std::stringstream &s) {
+  void debug(std::stringstream &s) final {
     do_log(CLOG_DEBUG, s);
   }
   /**
@@ -88,28 +88,28 @@ public:
         ceph_abort();
     }
   }
-  OstreamTemp info() {
+  OstreamTemp info() final {
     return OstreamTemp(CLOG_INFO, this);
   }
-  void info(std::stringstream &s) {
+  void info(std::stringstream &s) final {
     do_log(CLOG_INFO, s);
   }
-  OstreamTemp warn() {
+  OstreamTemp warn() final {
     return OstreamTemp(CLOG_WARN, this);
   }
-  void warn(std::stringstream &s) {
+  void warn(std::stringstream &s) final {
     do_log(CLOG_WARN, s);
   }
-  OstreamTemp error() {
+  OstreamTemp error() final {
     return OstreamTemp(CLOG_ERROR, this);
   }
-  void error(std::stringstream &s) {
+  void error(std::stringstream &s) final {
     do_log(CLOG_ERROR, s);
   }
-  OstreamTemp sec() {
+  OstreamTemp sec() final {
     return OstreamTemp(CLOG_SEC, this);
   }
-  void sec(std::stringstream &s) {
+  void sec(std::stringstream &s) final {
     do_log(CLOG_SEC, s);
   }
 
@@ -163,8 +163,8 @@ public:
                     uuid_d &fsid,
                     std::string &host);
 
-  void do_log(clog_type prio, std::stringstream& ss);
-  void do_log(clog_type prio, const std::string& s);
+  void do_log(clog_type prio, std::stringstream& ss) final;
+  void do_log(clog_type prio, const std::string& s) final;
 
 private:
   LogClient *parent;