srsLTE/lib/test/srslog/event_trace_test.cpp

/*
 * Copyright 2013-2020 Software Radio Systems Limited
 *
 * This file is part of srsLTE.
 *
 * srsLTE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * srsLTE is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * A copy of the GNU Affero General Public License can be found in
 * the LICENSE file in the top-level directory of this distribution
 * and at http://www.gnu.org/licenses/.
 *
 */

#include "srslte/srslog/event_trace.h"
#include "srslte/srslog/log_channel.h"
#include "srslte/srslog/sink.h"
#include "testing_helpers.h"

using namespace srslog;

namespace {

/// A Dummy implementation of a sink.
class sink_dummy : public sink
{
public:
  detail::error_string write(detail::memory_buffer buffer) override
  {
    return {};
  }

  detail::error_string flush() override { return {}; }
};

/// A Spy implementation of a log backend. Tests can query if the push method
/// has been invoked.
class backend_spy : public detail::log_backend
{
public:
  void start() override {}

  void push(detail::log_entry&& entry) override
  {
    std::string result = fmt::vsprintf(entry.fmtstring, std::move(entry.store));
    ++count;
  }

  bool is_running() const override { return true; }

  void reset() { count = 0; }

  unsigned push_invocation_count() const { return count; }

private:
  unsigned count = 0;
};

} // namespace

static bool
when_tracing_with_duration_event_then_two_events_are_generated(backend_spy& spy)
{
  trace_duration_begin("a", "b");
  ASSERT_EQ(spy.push_invocation_count(), 1);

  trace_duration_end("a", "b");
  ASSERT_EQ(spy.push_invocation_count(), 2);

  return true;
}

static bool
when_tracing_with_complete_event_then_one_event_is_generated(backend_spy& spy)
{
  {
    trace_complete_event("a", "b");
  }
  ASSERT_EQ(spy.push_invocation_count(), 1);

  return true;
}

int main()
{
  sink_dummy s;
  backend_spy backend;
  log_channel c("test", s, backend);

  // Inject our spy into the framework.
  event_trace_init(c);

  TEST_FUNCTION(when_tracing_with_duration_event_then_two_events_are_generated,
                backend);
  backend.reset();
  TEST_FUNCTION(when_tracing_with_complete_event_then_one_event_is_generated,
                backend);

  return 0;
}