srsLTE/lib/test/srslog/log_channel_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/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 Dummy implementation of the log backend.
class backend_dummy : public detail::log_backend
{
public:
  void start() override {}

  void push(detail::log_entry&& entry) override {}

  bool is_running() const override { return true; }
};

} // namespace

static bool when_log_channel_is_created_then_id_matches_expected_value()
{
  backend_dummy backend;
  sink_dummy s;
  log_channel log("id", s, backend);

  ASSERT_EQ(log.id(), "id");

  return true;
}

static bool when_log_channel_is_disabled_then_enabled_returns_false()
{
  backend_dummy backend;
  sink_dummy s;
  log_channel log("id", s, backend);

  log.set_enabled(false);

  ASSERT_EQ(log.enabled(), false);

  return true;
}

static bool when_log_channel_is_enabled_then_enabled_returns_true()
{
  backend_dummy backend;
  sink_dummy s;
  log_channel log("id", s, backend);

  log.set_enabled(true);

  ASSERT_EQ(log.enabled(), true);

  return true;
}

namespace {

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

  void push(detail::log_entry&& entry) override
  {
    e = std::move(entry);
    ++count;
  }

  bool is_running() const override { return true; }

  unsigned push_invocation_count() const { return count; }

  const detail::log_entry& last_entry() const { return e; }

private:
  unsigned count = 0;
  detail::log_entry e;
};

} // namespace

static bool
when_logging_in_log_channel_then_log_entry_is_pushed_into_the_backend()
{
  backend_spy backend;
  sink_dummy s;
  log_channel log("id", s, backend);

  std::string fmtstring = "test";
  log(fmtstring, 42, "Hello");

  ASSERT_EQ(backend.push_invocation_count(), 1);

  return true;
}

static bool when_logging_in_disabled_log_channel_then_log_entry_is_ignored()
{
  backend_spy backend;
  sink_dummy s;
  log_channel log("id", s, backend);

  log.set_enabled(false);
  std::string fmtstring = "test";
  log(fmtstring, 42, "Hello");

  ASSERT_EQ(backend.push_invocation_count(), 0);

  return true;
}

static bool when_logging_then_filled_in_log_entry_is_pushed_into_the_backend()
{
  backend_spy backend;
  sink_dummy s;

  std::string name = "name";
  char tag = 'A';

  log_channel log("id", s, backend, {name, tag, true});

  std::string fmtstring = "test";
  uint32_t ctx = 10;

  log.set_context(ctx);
  log(fmtstring, 42, "Hello");

  ASSERT_EQ(backend.push_invocation_count(), 1);

  const detail::log_entry& entry = backend.last_entry();
  ASSERT_NE(entry.tp.time_since_epoch().count(), 0);
  ASSERT_EQ(entry.context.value, ctx);
  ASSERT_EQ(entry.context.enabled, true);
  ASSERT_EQ(entry.fmtstring, fmtstring);
  ASSERT_EQ(entry.log_name, name);
  ASSERT_EQ(entry.log_tag, tag);

  return true;
}

static bool
when_logging_with_hex_dump_then_filled_in_log_entry_is_pushed_into_the_backend()
{
  backend_spy backend;
  sink_dummy s;

  std::string name = "name";
  char tag = 'A';

  log_channel log("id", s, backend, {name, tag, true});

  std::string fmtstring = "test";
  uint32_t ctx = 4;

  log.set_context(ctx);
  log.set_hex_dump_max_size(4);
  uint8_t hex[] = {0, 1, 2, 3, 4, 5, 6, 7, 8};
  log(hex, sizeof(hex), fmtstring, 42, "Hello");

  ASSERT_EQ(backend.push_invocation_count(), 1);

  const detail::log_entry& entry = backend.last_entry();
  ASSERT_NE(entry.tp.time_since_epoch().count(), 0);
  ASSERT_EQ(entry.context.value, ctx);
  ASSERT_EQ(entry.context.enabled, true);
  ASSERT_EQ(entry.fmtstring, fmtstring);
  ASSERT_EQ(entry.log_name, name);
  ASSERT_EQ(entry.log_tag, tag);
  ASSERT_EQ(entry.hex_dump.size(), 4);
  ASSERT_EQ(
      std::equal(entry.hex_dump.begin(), entry.hex_dump.end(), std::begin(hex)),
      true);

  return true;
}

static bool
when_hex_array_length_is_less_than_hex_log_max_size_then_array_length_is_used()
{
  backend_spy backend;
  sink_dummy s;

  std::string name = "name";
  char tag = 'A';

  log_channel log("id", s, backend);

  std::string fmtstring = "test";

  log.set_hex_dump_max_size(10);
  uint8_t hex[] = {0, 1, 2};
  log(hex, sizeof(hex), fmtstring, 42, "Hello");

  ASSERT_EQ(backend.push_invocation_count(), 1);

  const detail::log_entry& entry = backend.last_entry();
  ASSERT_EQ(entry.hex_dump.size(), 3);
  ASSERT_EQ(
      std::equal(entry.hex_dump.begin(), entry.hex_dump.end(), std::begin(hex)),
      true);

  return true;
}

int main()
{
  TEST_FUNCTION(when_log_channel_is_created_then_id_matches_expected_value);
  TEST_FUNCTION(when_log_channel_is_disabled_then_enabled_returns_false);
  TEST_FUNCTION(when_log_channel_is_enabled_then_enabled_returns_true);
  TEST_FUNCTION(
      when_logging_in_log_channel_then_log_entry_is_pushed_into_the_backend);
  TEST_FUNCTION(when_logging_in_disabled_log_channel_then_log_entry_is_ignored);
  TEST_FUNCTION(
      when_logging_then_filled_in_log_entry_is_pushed_into_the_backend);
  TEST_FUNCTION(
      when_logging_with_hex_dump_then_filled_in_log_entry_is_pushed_into_the_backend);
  TEST_FUNCTION(
      when_hex_array_length_is_less_than_hex_log_max_size_then_array_length_is_used);

  return 0;
}