boost_mqtt5/test/integration/executors.cpp

//
// Copyright (c) 2023-2024 Ivica Siladic, Bruno Iljazovic, Korina Simicevic
//
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)
//

#include <boost/test/unit_test.hpp>

#include <cstdint>
#include <chrono>
#include <string>
#include <vector>

#include <boost/asio/bind_executor.hpp>
#include <boost/asio/bind_immediate_executor.hpp>
#include <boost/asio/detached.hpp>
#include <boost/asio/io_context.hpp>
#include <boost/asio/strand.hpp>
#include <boost/asio/steady_timer.hpp>

#include <boost/asio/ip/tcp.hpp>

#include <async_mqtt5/impl/codecs/message_encoders.hpp>

#include <async_mqtt5.hpp>

#include "test_common/message_exchange.hpp"
#include "test_common/test_stream.hpp"

using namespace async_mqtt5;

BOOST_AUTO_TEST_SUITE(executors)

BOOST_AUTO_TEST_CASE(bind_executor) {
	using test::after;
	using namespace std::chrono_literals;

	constexpr int expected_handlers_called = 8;
	int handlers_called = 0;

	// packets
	auto connect = encoders::encode_connect(
		"", std::nullopt, std::nullopt, 60, false, {}, std::nullopt
	);
	auto connack = encoders::encode_connack(false, reason_codes::success.value(), {});
	auto publish_0 = encoders::encode_publish(
		0, "t_0", "p_0", qos_e::at_most_once, retain_e::no, dup_e::no, {}
	);
	auto publish_1 = encoders::encode_publish(
		1, "t_1", "p_1", qos_e::at_least_once, retain_e::no, dup_e::no, {}
	);
	auto puback = encoders::encode_puback(1, reason_codes::success.value(), {});
	auto publish_2 = encoders::encode_publish(
		2, "t_2", "p_2", qos_e::exactly_once, retain_e::no, dup_e::no, {}
	);
	auto pubrec = encoders::encode_pubrec(2, reason_codes::success.value(), {});
	auto pubrel = encoders::encode_pubrel(2, reason_codes::success.value(), {});
	auto pubcomp = encoders::encode_pubcomp(2, reason_codes::success.value(), {});
	auto subscribe = encoders::encode_subscribe(
		3, std::vector<subscribe_topic> { { "t_0", {} } }, {}
	);
	auto suback = encoders::encode_suback(
		3, std::vector<uint8_t> { reason_codes::granted_qos_2.value() }, {}
	);
	auto unsubscribe = encoders::encode_unsubscribe(
		1, std::vector<std::string> { "t_0" }, {}
	);
	auto unsuback = encoders::encode_unsuback(
		1, std::vector<uint8_t> { reason_codes::success.value() }, {}
	);
	auto disconnect = encoders::encode_disconnect(
		reason_codes::normal_disconnection.value(), {}
	);

	test::msg_exchange broker_side;
	error_code success {};

	broker_side
		.expect(connect)
			.complete_with(success, after(0ms))
			.reply_with(connack, after(0ms))
		.expect(subscribe, publish_0, publish_1, publish_2)
			.complete_with(success, after(0ms))
			.reply_with(puback, pubrec, suback, after(0ms))
		.expect(pubrel)
			.complete_with(success, after(0ms))
			.reply_with(pubcomp, after(0ms))
		.send(publish_0, after(50ms))
		.expect(unsubscribe)
			.complete_with(success, after(0ms))
			.reply_with(unsuback, after(0ms))
		.expect(disconnect)
			.complete_with(success, after(0ms))
		;

	asio::io_context ioc;
	auto executor = ioc.get_executor();
	auto& broker = asio::make_service<test::test_broker>(
		ioc, executor, std::move(broker_side)
	);

	auto strand = asio::make_strand(ioc);

	using client_type = mqtt_client<test::test_stream>;
	client_type c(executor);
	c.brokers("127.0.0.1")
		.async_run(
			asio::bind_executor(
				strand,
				[&](error_code ec) {
					BOOST_TEST(ec == asio::error::operation_aborted);
					BOOST_TEST(strand.running_in_this_thread());
					++handlers_called;
				}
			)
		);

	c.async_publish<qos_e::at_most_once>(
		"t_0", "p_0", retain_e::no, {},
		asio::bind_executor(
			strand,
			[&](error_code ec) {
				BOOST_TEST(!ec);
				BOOST_TEST(strand.running_in_this_thread());
				++handlers_called;
			}
		)
	);

	c.async_publish<qos_e::at_least_once>(
		"t_1", "p_1", retain_e::no, {},
		asio::bind_executor(
			strand,
			[&](error_code ec, reason_code rc, auto) {
				BOOST_TEST(!ec);
				BOOST_TEST(!rc);
				BOOST_TEST(strand.running_in_this_thread());
				++handlers_called;
			}
		)
	);

	c.async_publish<qos_e::exactly_once>(
		"t_2", "p_2", retain_e::no, {},
		asio::bind_executor(
			strand,
			[&](error_code ec, reason_code rc, auto) {
				BOOST_TEST(!ec);
				BOOST_TEST(!rc);
				BOOST_TEST(strand.running_in_this_thread());
				++handlers_called;
			}
		)
	);

	c.async_subscribe(
		subscribe_topic { "t_0", {} }, {},
		asio::bind_executor(
			strand,
			[&](error_code ec, std::vector<reason_code> rcs, auto) {
				BOOST_TEST(!ec);
				BOOST_TEST(!rcs[0]);
				BOOST_TEST(strand.running_in_this_thread());
				++handlers_called;
			}
		)
	);

	c.async_receive(
		asio::bind_executor(
			strand,
			[&](
				error_code ec,
				std::string rec_topic, std::string rec_payload,
				publish_props
			) {
				BOOST_TEST(!ec);
				BOOST_TEST("t_0" == rec_topic);
				BOOST_TEST("p_0" == rec_payload);
				BOOST_TEST(strand.running_in_this_thread());
				++handlers_called;

				c.async_unsubscribe(
					"t_0", {},
					asio::bind_executor(
						strand,
						[&](error_code ec, std::vector<reason_code> rcs, auto) {
							BOOST_TEST(!ec);
							BOOST_TEST(!rcs[0]);
							BOOST_TEST(strand.running_in_this_thread());
							++handlers_called;

							c.async_disconnect(
								asio::bind_executor(
									strand,
									[&](error_code ec) {
										BOOST_TEST(!ec);
										BOOST_TEST(strand.running_in_this_thread());
										++handlers_called;
									}
								)
							);
						}
					)
				);
			}
		)
	);

	ioc.run_for(500ms);
	BOOST_TEST(handlers_called == expected_handlers_called);
	BOOST_TEST(broker.received_all_expected());
}

BOOST_AUTO_TEST_CASE(immediate_executor_async_publish) {
	constexpr int expected_handlers_called = 1;
	int handlers_called = 0;

	asio::io_context ioc;

	using client_type = mqtt_client<asio::ip::tcp::socket>;
	client_type c(ioc.get_executor());

	auto strand = asio::make_strand(ioc);

	auto handler = asio::bind_immediate_executor(
		strand,
		[&handlers_called, &strand](error_code ec) {
			++handlers_called;
			BOOST_TEST(strand.running_in_this_thread());
			BOOST_TEST(ec);
		}
	);
	c.async_publish<qos_e::at_most_once>(
		"invalid/#", "", retain_e::no, publish_props {}, std::move(handler)
	);

	ioc.run();
	BOOST_TEST(handlers_called == expected_handlers_called);
}

BOOST_AUTO_TEST_CASE(immediate_executor_async_subscribe) {
	constexpr int expected_handlers_called = 1;
	int handlers_called = 0;

	asio::io_context ioc;

	using client_type = mqtt_client<asio::ip::tcp::socket>;
	client_type c(ioc.get_executor());

	auto strand = asio::make_strand(ioc);

	auto handler = asio::bind_immediate_executor(
		strand,
		[&handlers_called, &strand](
			error_code ec, std::vector<reason_code>, suback_props
		) {
			++handlers_called;
			BOOST_TEST(strand.running_in_this_thread());
			BOOST_TEST(ec);
		}
	);
	c.async_subscribe(
		{ "+topic", subscribe_options {} }, subscribe_props{}, std::move(handler)
	);

	ioc.run();
	BOOST_TEST(handlers_called == expected_handlers_called);
}

BOOST_AUTO_TEST_CASE(immediate_executor_async_unsubscribe) {
	constexpr int expected_handlers_called = 1;
	int handlers_called = 0;

	asio::io_context ioc;

	using client_type = mqtt_client<asio::ip::tcp::socket>;
	client_type c(ioc.get_executor());

	auto strand = asio::make_strand(ioc);

	auto handler = asio::bind_immediate_executor(
		strand,
		[&handlers_called, &strand](
			error_code ec, std::vector<reason_code>, unsuback_props
		) {
			++handlers_called;
			BOOST_TEST(strand.running_in_this_thread());
			BOOST_TEST(ec);
		}
	);
	c.async_unsubscribe(
		"some/topic#", unsubscribe_props {}, std::move(handler)
	);

	ioc.run();
	BOOST_TEST(handlers_called == expected_handlers_called);
}


BOOST_AUTO_TEST_SUITE_END()