feedc0de/boost_mqtt5
1
0
Fork 0
forked from boostorg/mqtt5
Code Pull Requests Activity

[mqtt-test] cancellation tests from long time ago

Browse Source 
Summary:
related to T12015
  - added some cancellation tests (testing ioc.stop() & client.cancel()
  - some tests fail and some hang (on windows specifically)

Reviewers: ivica

Reviewed By: ivica

Subscribers: miljen, iljazovic

Differential Revision: https://repo.mireo.local/D26317
This commit is contained in:
Korina Šimičević
2023-10-05 10:19:37 +02:00
parent 9e0e57530c
commit 15a3d62727
5 changed files with 257 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
SConscript
View File

@ -23,6 +23,7 @@ test_sources = [
'test/unit/test/publish_send_op.cpp',
'test/unit/test/client_broker.cpp',
'test/unit/test/coroutine.cpp',
'test/unit/test/cancellation.cpp',
'test/unit/src/run_tests.cpp'
]

6
include/async_mqtt5/impl/client_service.hpp
View File

@ -198,6 +198,12 @@ public:
_cancel_ping.emit(asio::cancellation_type::terminal);
_cancel_sentry.emit(asio::cancellation_type::terminal);
// cancelling the receive channel invokes all pending handlers with
// ec = asio::experimental::error::channel_cancelled
// adding another ec to the list of the possible client ecs
// TODO: close() the channel instead, and open() it on the next run()
_rec_channel.cancel();
_replies.cancel_unanswered();
_async_sender.cancel();
_stream.close();

246
test/unit/test/cancellation.cpp Normal file
View File

@ -0,0 +1,246 @@
#include <boost/test/unit_test.hpp>
#include <boost/asio/io_context.hpp>
#include <boost/asio/steady_timer.hpp>
#include <boost/asio/post.hpp>
#include <async_mqtt5.hpp>
using namespace async_mqtt5;
namespace async_mqtt5::test {
enum cancellation_type {
ioc_stop = 1,
client_cancel
};
} // end namespace async_mqtt5::test
template <test::cancellation_type type>
void cancel_async_receive() {
using enum test::cancellation_type;
constexpr int num_handlers = 3;
constexpr int expected_handlers_called = type == ioc_stop ? 0 : num_handlers;
int handlers_called = 0;
asio::io_context ioc;
using stream_type = asio::ip::tcp::socket;
using client_type = mqtt_client<stream_type>;
client_type c(ioc, "");
c.brokers("mqtt.mireo.local", 1883)
.run();
for (auto i = 0; i < num_handlers; ++i)
c.async_receive([&handlers_called](
error_code ec, std::string, std::string, publish_props
) {
BOOST_CHECK_EQUAL(ec, asio::experimental::error::channel_cancelled);
handlers_called++;
});
asio::steady_timer timer(c.get_executor());
timer.expires_after(std::chrono::seconds(1));
timer.async_wait([&](auto) {
if constexpr (type == ioc_stop)
ioc.stop();
else
c.cancel();
});
ioc.run();
BOOST_CHECK_EQUAL(
handlers_called, expected_handlers_called
);
}
template <test::cancellation_type type>
void cancel_async_publish() {
using enum test::cancellation_type;
constexpr int expected_handlers_called = type == ioc_stop ? 0 : 3;
int handlers_called = 0;
asio::io_context ioc;
using stream_type = asio::ip::tcp::socket;
using client_type = mqtt_client<stream_type>;
client_type c(ioc, "");
c.brokers("mqtt.mireo.local", 1883)
.run();
c.async_publish<qos_e::at_most_once>(
"topic", "payload", retain_e::yes, {},
[&handlers_called](error_code ec) {
BOOST_CHECK_EQUAL(ec, asio::error::operation_aborted);
handlers_called++;
}
);
c.async_publish<qos_e::at_least_once>(
"topic", "payload", retain_e::yes, {},
[&handlers_called](error_code ec, reason_code rc, puback_props) {
BOOST_CHECK_EQUAL(ec, asio::error::operation_aborted);
handlers_called++;
}
);
c.async_publish<qos_e::exactly_once>(
"topic", "payload", retain_e::yes, {},
[&handlers_called](error_code ec, reason_code rc, pubcomp_props) {
BOOST_CHECK_EQUAL(ec, asio::error::operation_aborted);
handlers_called++;
}
);
asio::steady_timer timer(c.get_executor());
timer.expires_after(std::chrono::seconds(1));
timer.async_wait([&](auto) {
if constexpr (type == ioc_stop)
ioc.stop();
else
c.cancel();
});
ioc.run();
BOOST_CHECK_EQUAL(
handlers_called, expected_handlers_called
);
}
template <test::cancellation_type type>
void cancel_during_connecting() {
using enum test::cancellation_type;
constexpr int expected_handlers_called = type == ioc_stop ? 0 : 1;
int handlers_called = 0;
asio::io_context ioc;
using stream_type = asio::ip::tcp::socket;
using client_type = mqtt_client<stream_type>;
client_type c(ioc, "");
c.brokers("127.0.0.1", 1883)
.run();
c.async_publish<qos_e::at_most_once>(
"topic", "payload", retain_e::yes, {},
[&handlers_called](error_code ec) {
BOOST_CHECK_EQUAL(ec, asio::error::operation_aborted);
handlers_called++;
}
);
asio::steady_timer timer(c.get_executor());
timer.expires_after(std::chrono::seconds(2));
timer.async_wait([&](auto) {
if constexpr (type == ioc_stop)
ioc.stop();
else
c.cancel();
});
ioc.run();
BOOST_CHECK_EQUAL(
handlers_called, expected_handlers_called
);
}
BOOST_AUTO_TEST_SUITE(cancellation)
BOOST_AUTO_TEST_CASE(ioc_stop_async_receive) {
cancel_async_receive<test::ioc_stop>();
}
BOOST_AUTO_TEST_CASE(client_cancel_async_receive) {
cancel_async_receive<test::client_cancel>();
}
// passes on debian, hangs on windows in io_context destructor
BOOST_AUTO_TEST_CASE(ioc_stop_async_publish) {
cancel_async_publish<test::ioc_stop>();
}
BOOST_AUTO_TEST_CASE(client_cancel_async_publish) {
cancel_async_publish<test::client_cancel>();
}
// passes on debian, hangs on windows
BOOST_AUTO_TEST_CASE(ioc_stop_cancel_during_connecting) {
cancel_during_connecting<test::ioc_stop>();
}
BOOST_AUTO_TEST_CASE(client_cancel_during_connecting) {
cancel_during_connecting<test::client_cancel>();
}
// last two ec checks fail, they finish with no_recovery when
// you don't call c.cancel()
BOOST_AUTO_TEST_CASE(rerunning_the_client) {
constexpr int expected_handlers_called = 3;
int handlers_called = 0;
asio::io_context ioc;
using stream_type = asio::ip::tcp::socket;
using client_type = mqtt_client<stream_type>;
client_type c(ioc, "");
c.brokers("mqtt.mireo.local", 1883)
.run();
c.async_publish<qos_e::exactly_once>(
"cancelled_topic", "cancelled_payload", retain_e::yes, {},
[&handlers_called](error_code ec, reason_code rc, pubcomp_props) {
BOOST_CHECK_EQUAL(ec, asio::error::operation_aborted);
BOOST_CHECK_EQUAL(rc, reason_codes::empty);
handlers_called++;
}
);
asio::post(ioc, [&c] { c.cancel(); });
asio::steady_timer cancel_timer(c.get_executor());
cancel_timer.expires_after(std::chrono::seconds(1));
cancel_timer.async_wait(
[&](auto) {
c.run();
c.async_publish<qos_e::at_most_once>(
"test/mqtt-test", "payload", retain_e::yes, {},
[&handlers_called](error_code ec) {
BOOST_CHECK(!ec);
handlers_called++;
}
);
c.async_receive([&handlers_called](
error_code ec, std::string, std::string, publish_props
) {
BOOST_CHECK(!ec);
handlers_called++;
});
}
);
asio::steady_timer timer(c.get_executor());
timer.expires_after(std::chrono::seconds(2));
timer.async_wait([&](auto) { c.cancel(); });
ioc.run();
BOOST_CHECK_EQUAL(
handlers_called, expected_handlers_called
);
}
BOOST_AUTO_TEST_SUITE_END();

1
win/test/mqtt-test.vcxproj
View File

@ -29,6 +29,7 @@
</ItemGroup>
<ItemGroup>
<ClCompile Include="..\..\test\unit\src\run_tests.cpp" />
<ClCompile Include="..\..\test\unit\test\cancellation.cpp" />
<ClCompile Include="..\..\test\unit\test\client_broker.cpp" />
<ClCompile Include="..\..\test\unit\test\coroutine.cpp" />
<ClCompile Include="..\..\test\unit\test\publish_send_op.cpp" />

3
win/test/mqtt-test.vcxproj.filters
View File

@ -59,5 +59,8 @@
<ClCompile Include="..\..\test\unit\src\run_tests.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="..\..\test\unit\test\cancellation.cpp">
<Filter>Source Files\test</Filter>
</ClCompile>
</ItemGroup>
</Project>