icinga2/test/base-io-engine.cpp

// SPDX-FileCopyrightText: 2024 Icinga GmbH <https://icinga.com>
// SPDX-License-Identifier: GPL-2.0-or-later

#include "base/io-engine.hpp"
#include "base/utility.hpp"
#include <boost/asio.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <BoostTestTargetConfig.h>
#include <thread>

using namespace icinga;

BOOST_AUTO_TEST_SUITE(base_io_engine)

BOOST_AUTO_TEST_CASE(timeout_run)
{
	boost::asio::io_context io;
	boost::asio::io_context::strand strand (io);
	int called = 0;

	IoEngine::SpawnCoroutine(strand, [&](boost::asio::yield_context yc) {
		boost::asio::deadline_timer timer (io);

		Timeout timeout (strand, boost::posix_time::millisec(300), [&called] { ++called; });
		BOOST_CHECK_EQUAL(called, 0);

		timer.expires_from_now(boost::posix_time::millisec(200));
		timer.async_wait(yc);
		BOOST_CHECK_EQUAL(called, 0);

		timer.expires_from_now(boost::posix_time::millisec(200));
		timer.async_wait(yc);
	});

	std::thread eventLoop ([&io] { io.run(); });
	io.run();
	eventLoop.join();

	BOOST_CHECK_EQUAL(called, 1);
}

BOOST_AUTO_TEST_CASE(timeout_cancelled)
{
	boost::asio::io_context io;
	boost::asio::io_context::strand strand (io);
	int called = 0;

	IoEngine::SpawnCoroutine(strand, [&](boost::asio::yield_context yc) {
		boost::asio::deadline_timer timer (io);
		Timeout timeout (strand, boost::posix_time::millisec(300), [&called] { ++called; });

		timer.expires_from_now(boost::posix_time::millisec(200));
		timer.async_wait(yc);

		timeout.Cancel();
		BOOST_CHECK_EQUAL(called, 0);

		timer.expires_from_now(boost::posix_time::millisec(200));
		timer.async_wait(yc);
	});

	std::thread eventLoop ([&io] { io.run(); });
	io.run();
	eventLoop.join();

	BOOST_CHECK_EQUAL(called, 0);
}

BOOST_AUTO_TEST_CASE(timeout_scope)
{
	boost::asio::io_context io;
	boost::asio::io_context::strand strand (io);
	int called = 0;

	IoEngine::SpawnCoroutine(strand, [&](boost::asio::yield_context yc) {
		boost::asio::deadline_timer timer (io);

		{
			Timeout timeout (strand, boost::posix_time::millisec(300), [&called] { ++called; });

			timer.expires_from_now(boost::posix_time::millisec(200));
			timer.async_wait(yc);
		}

		BOOST_CHECK_EQUAL(called, 0);

		timer.expires_from_now(boost::posix_time::millisec(200));
		timer.async_wait(yc);
	});

	std::thread eventLoop ([&io] { io.run(); });
	io.run();
	eventLoop.join();

	BOOST_CHECK_EQUAL(called, 0);
}

BOOST_AUTO_TEST_CASE(timeout_due_cancelled)
{
	boost::asio::io_context io;
	boost::asio::io_context::strand strand (io);
	int called = 0;

	IoEngine::SpawnCoroutine(strand, [&](boost::asio::yield_context yc) {
		boost::asio::deadline_timer timer (io);
		Timeout timeout (strand, boost::posix_time::millisec(300), [&called] { ++called; });

		// Give the timeout enough time to become due while blocking its strand to prevent it from actually running...
		Utility::Sleep(0.4);

		BOOST_CHECK_EQUAL(called, 0);

		// ... so that this shall still work:
		timeout.Cancel();

		BOOST_CHECK_EQUAL(called, 0);

		timer.expires_from_now(boost::posix_time::millisec(100));
		timer.async_wait(yc);
	});

	std::thread eventLoop ([&io] { io.run(); });
	io.run();
	eventLoop.join();

	BOOST_CHECK_EQUAL(called, 0);
}

BOOST_AUTO_TEST_CASE(timeout_due_scope)
{
	boost::asio::io_context io;
	boost::asio::io_context::strand strand (io);
	int called = 0;

	IoEngine::SpawnCoroutine(strand, [&](boost::asio::yield_context yc) {
		boost::asio::deadline_timer timer (io);

		{
			Timeout timeout (strand, boost::posix_time::millisec(300), [&called] { ++called; });

			// Give the timeout enough time to become due while blocking its strand to prevent it from actually running...
			Utility::Sleep(0.4);

			BOOST_CHECK_EQUAL(called, 0);
		} // ... so that Timeout#~Timeout() shall still work here.

		BOOST_CHECK_EQUAL(called, 0);

		timer.expires_from_now(boost::posix_time::millisec(100));
		timer.async_wait(yc);
	});

	std::thread eventLoop ([&io] { io.run(); });
	io.run();
	eventLoop.join();

	BOOST_CHECK_EQUAL(called, 0);
}

BOOST_AUTO_TEST_SUITE_END()