ttl_test.cc

#include <chrono>

#include "source/common/config/ttl.h"

#include "test/mocks/event/mocks.h"
#include "test/test_common/simulated_time_system.h"

#include "gtest/gtest.h"

namespace Envoy {
namespace Config {
namespace {

class TtlManagerTest : public testing::Test {
public:
  TtlManagerTest() { test_time_.setSystemTime(std::chrono::milliseconds(0)); }
  Event::MockDispatcher dispatcher_;
  Event::SimulatedTimeSystem test_time_;
};

TEST_F(TtlManagerTest, BasicUsage) {
  absl::optional<std::vector<std::string>> maybe_expired;
  auto cb = [&](const auto& expired) { maybe_expired = expired; };
  auto ttl_timer = new Event::MockTimer(&dispatcher_);
  TtlManager ttl(cb, dispatcher_, dispatcher_.timeSource());

  EXPECT_CALL(*ttl_timer, enableTimer(std::chrono::milliseconds(1), _));
  EXPECT_CALL(*ttl_timer, enabled());
  ttl.add(std::chrono::milliseconds(1), "hello");

  // Adding another expiration after the first one should not update the timer.
  EXPECT_CALL(*ttl_timer, enabled());
  ttl.add(std::chrono::milliseconds(5), "not hello");

  // Advance time by 3 ms, this should only trigger the first TTL.
  test_time_.setSystemTime(std::chrono::milliseconds(3));
  EXPECT_CALL(*ttl_timer, enabled());
  EXPECT_CALL(*ttl_timer, enableTimer(std::chrono::milliseconds(2), _));
  ttl_timer->invokeCallback();
  EXPECT_EQ(maybe_expired.value(), std::vector<std::string>({"hello"}));

  // Add in a TTL entry that comes before the scheduled timer run, this should update the timer.
  EXPECT_CALL(*ttl_timer, enabled());
  EXPECT_CALL(*ttl_timer, enableTimer(std::chrono::milliseconds(1), _));
  ttl.add(std::chrono::milliseconds(1), "hello");

  // Clearing the first TTL entry should reset the timer to match the next in line.
  EXPECT_CALL(*ttl_timer, enabled());
  EXPECT_CALL(*ttl_timer, enableTimer(std::chrono::milliseconds(2), _));
  ttl.clear("hello");

  // Removing all the TTLs should disable the timer.
  EXPECT_CALL(*ttl_timer, disableTimer());
  ttl.clear("not hello");
}

TEST_F(TtlManagerTest, ScopedUpdate) {
  absl::optional<std::vector<std::string>> maybe_expired;
  auto cb = [&](const auto& expired) { maybe_expired = expired; };
  auto ttl_timer = new Event::MockTimer(&dispatcher_);
  TtlManager ttl(cb, dispatcher_, dispatcher_.timeSource());

  {
    const auto scoped = ttl.scopedTtlUpdate();
    ttl.add(std::chrono::milliseconds(1), "hello");
    ttl.add(std::chrono::milliseconds(5), "not hello");

    // There should only be a single update due to the scoping.
    EXPECT_CALL(*ttl_timer, enableTimer(std::chrono::milliseconds(1), _));
    EXPECT_CALL(*ttl_timer, enabled());
  }

  {
    const auto scoped = ttl.scopedTtlUpdate();
    ttl.clear("hello");
    ttl.clear("not hello");

    // There should only be a single update due to the scoping.
    EXPECT_CALL(*ttl_timer, disableTimer());
  }
}
} // namespace
} // namespace Config
} // namespace Envoy