From 762b0131e83447e6f8a633d550784fb8ce12c35a Mon Sep 17 00:00:00 2001 From: Simon Giesecke Date: Fri, 11 May 2018 11:43:41 +0200 Subject: [PATCH] Problem: no tests for poller_t Solution: add tests --- tests/CMakeLists.txt | 1 + tests/active_poller.cpp | 49 +------ tests/poller.cpp | 294 ++++++++++++++++++++++++++++++++++++++++ tests/testutil.hpp | 49 +++++++ 4 files changed, 351 insertions(+), 42 deletions(-) create mode 100644 tests/poller.cpp create mode 100644 tests/testutil.hpp diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 30b86b0..1ed035e 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -25,6 +25,7 @@ add_executable( message.cpp context.cpp socket.cpp + poller.cpp active_poller.cpp multipart.cpp ) diff --git a/tests/active_poller.cpp b/tests/active_poller.cpp index 65b23cc..8cf9de1 100644 --- a/tests/active_poller.cpp +++ b/tests/active_poller.cpp @@ -1,6 +1,7 @@ -#include #include +#include "testutil.hpp" + #if defined(ZMQ_CPP11) && defined(ZMQ_BUILD_DRAFT_API) #include @@ -82,6 +83,9 @@ TEST(active_poller, add_handler) TEST(active_poller, add_handler_invalid_events_type) { + /// \todo is it good that this is accepted? should probably already be + /// checked by zmq_poller_add/modify in libzmq: + /// https://github.com/zeromq/libzmq/issues/3088 zmq::context_t context; zmq::socket_t socket{context, zmq::socket_type::router}; zmq::active_poller_t active_poller; @@ -138,54 +142,15 @@ TEST(active_poller, remove_registered_non_empty) } namespace { - -class loopback_ip4_binder +struct server_client_setup : common_server_client_setup { -public: - loopback_ip4_binder(zmq::socket_t &socket) { bind(socket); } - std::string endpoint() { return endpoint_; } -private: - // Helper function used in constructor - // as Gtest allows ASSERT_* only in void returning functions - // and constructor/destructor are not. - void bind(zmq::socket_t &socket) - { - ASSERT_NO_THROW(socket.bind("tcp://127.0.0.1:*")); - std::array endpoint{}; - size_t endpoint_size = endpoint.size(); - ASSERT_NO_THROW(socket.getsockopt(ZMQ_LAST_ENDPOINT, endpoint.data(), - &endpoint_size)); - ASSERT_TRUE(endpoint_size < endpoint.size()); - endpoint_ = std::string{endpoint.data()}; - } - std::string endpoint_; -}; - -struct server_client_setup -{ - server_client_setup () - { - init (); - } - - void init() - { - endpoint = loopback_ip4_binder {server}.endpoint (); - ASSERT_NO_THROW (client.connect (endpoint)); - } - zmq::active_poller_t::handler_t handler = [&](short e) { events = e; }; - zmq::context_t context; - zmq::socket_t server {context, zmq::socket_type::server}; - zmq::socket_t client {context, zmq::socket_type::client}; - std::string endpoint; short events = 0; }; - -} //namespace +} TEST(active_poller, poll_basic) { diff --git a/tests/poller.cpp b/tests/poller.cpp new file mode 100644 index 0000000..a777be3 --- /dev/null +++ b/tests/poller.cpp @@ -0,0 +1,294 @@ +#include "testutil.hpp" + +#if defined(ZMQ_CPP11) && defined(ZMQ_BUILD_DRAFT_API) + +#include +#include + +TEST(poller, create_destroy) +{ + zmq::poller_t<> poller; +} + +static_assert(!std::is_copy_constructible>::value, "poller_t should not be copy-constructible"); +static_assert(!std::is_copy_assignable>::value, "poller_t should not be copy-assignable"); + +TEST(poller, move_construct_empty) +{ + zmq::poller_t<> a; + zmq::poller_t<> b = std::move (a); +} + +TEST(poller, move_assign_empty) +{ + zmq::poller_t<> a; + zmq::poller_t<> b; + b = std::move(a); +} + +TEST(poller, move_construct_non_empty) +{ + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + + zmq::poller_t<> a; + a.add(socket, ZMQ_POLLIN, nullptr); + zmq::poller_t<> b = std::move (a); +} + +TEST(poller, move_assign_non_empty) +{ + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + + zmq::poller_t<> a; + a.add(socket, ZMQ_POLLIN, nullptr); + zmq::poller_t<> b; + b = std::move(a); +} + +TEST(poller, add_nullptr) +{ + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + zmq::poller_t<> poller; + ASSERT_NO_THROW(poller.add(socket, ZMQ_POLLIN, nullptr)); +} + +TEST(poller, add_non_nullptr) +{ + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + zmq::poller_t<> poller; + int i; + ASSERT_NO_THROW(poller.add(socket, ZMQ_POLLIN, &i)); +} + +TEST(poller, add_handler_invalid_events_type) +{ + /// \todo is it good that this is accepted? should probably already be + /// checked by zmq_poller_add/modify in libzmq: + /// https://github.com/zeromq/libzmq/issues/3088 + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + zmq::poller_t<> poller; + short invalid_events_type = 2 << 10; + ASSERT_NO_THROW(poller.add(socket, invalid_events_type, nullptr)); +} + +TEST(poller, add_handler_twice_throws) +{ + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + zmq::poller_t<> poller; + poller.add(socket, ZMQ_POLLIN, nullptr); + /// \todo the actual error code should be checked + ASSERT_THROW(poller.add(socket, ZMQ_POLLIN, nullptr), zmq::error_t); +} + +TEST(poller, wait_with_no_handlers_throws) +{ + zmq::poller_t<> poller; + std::vector events; + /// \todo the actual error code should be checked + ASSERT_THROW(poller.wait_all(events, std::chrono::milliseconds{10}), zmq::error_t); +} + +TEST(poller, remove_unregistered_throws) +{ + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + zmq::poller_t<> poller; + /// \todo the actual error code should be checked + ASSERT_THROW(poller.remove(socket), zmq::error_t); +} + +TEST(poller, remove_registered_empty) +{ + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + zmq::poller_t<> poller; + poller.add(socket, ZMQ_POLLIN, nullptr); + ASSERT_NO_THROW(poller.remove(socket)); +} + +TEST(poller, remove_registered_non_empty) +{ + zmq::context_t context; + zmq::socket_t socket{context, zmq::socket_type::router}; + zmq::poller_t<> poller; + poller.add(socket, ZMQ_POLLIN, nullptr); + ASSERT_NO_THROW(poller.remove(socket)); +} + +TEST(poller, poll_basic) +{ + common_server_client_setup s; + + ASSERT_NO_THROW(s.client.send("Hi")); + + zmq::poller_t poller; + std::vector events{1}; + int i = 0; + ASSERT_NO_THROW(poller.add(s.server, ZMQ_POLLIN, &i)); + ASSERT_EQ(1, poller.wait_all(events, std::chrono::milliseconds{-1})); + ASSERT_EQ(s.server, events[0].socket); + ASSERT_EQ(&i, events[0].user_data); +} + +TEST(poller, add_invalid_socket_throws) +{ + zmq::context_t context; + zmq::poller_t<> poller; + zmq::socket_t a {context, zmq::socket_type::router}; + zmq::socket_t b {std::move (a)}; + ASSERT_THROW (poller.add (a, ZMQ_POLLIN, nullptr), + zmq::error_t); +} + +TEST(poller, remove_invalid_socket_throws) +{ + zmq::context_t context; + zmq::socket_t socket {context, zmq::socket_type::router}; + zmq::poller_t<> poller; + ASSERT_NO_THROW (poller.add (socket, ZMQ_POLLIN, nullptr)); + std::vector sockets; + sockets.emplace_back (std::move (socket)); + ASSERT_THROW (poller.remove (socket), zmq::error_t); + ASSERT_NO_THROW (poller.remove (sockets[0])); +} + +TEST(poller, modify_empty_throws) +{ + zmq::context_t context; + zmq::socket_t socket {context, zmq::socket_type::push}; + zmq::poller_t<> poller; + ASSERT_THROW (poller.modify (socket, ZMQ_POLLIN), zmq::error_t); +} + +TEST(poller, modify_invalid_socket_throws) +{ + zmq::context_t context; + zmq::socket_t a {context, zmq::socket_type::push}; + zmq::socket_t b {std::move (a)}; + zmq::poller_t<> poller; + ASSERT_THROW (poller.modify (a, ZMQ_POLLIN), zmq::error_t); +} + +TEST(poller, modify_not_added_throws) +{ + zmq::context_t context; + zmq::socket_t a {context, zmq::socket_type::push}; + zmq::socket_t b {context, zmq::socket_type::push}; + zmq::poller_t<> poller; + ASSERT_NO_THROW (poller.add (a, ZMQ_POLLIN, nullptr)); + ASSERT_THROW (poller.modify (b, ZMQ_POLLIN), zmq::error_t); +} + +TEST(poller, modify_simple) +{ + zmq::context_t context; + zmq::socket_t a {context, zmq::socket_type::push}; + zmq::poller_t<> poller; + ASSERT_NO_THROW (poller.add (a, ZMQ_POLLIN, nullptr)); + ASSERT_NO_THROW (poller.modify (a, ZMQ_POLLIN|ZMQ_POLLOUT)); +} + +TEST(poller, poll_client_server) +{ + // Setup server and client + common_server_client_setup s; + + // Setup poller + zmq::poller_t<> poller; + ASSERT_NO_THROW(poller.add(s.server, ZMQ_POLLIN, s.server)); + + // client sends message + ASSERT_NO_THROW(s.client.send("Hi")); + + // wait for message and verify events + std::vector events(1); + ASSERT_EQ(1, poller.wait_all(events, std::chrono::milliseconds{500})); + ASSERT_EQ(ZMQ_POLLIN, events[0].events); + + // Modify server socket with pollout flag + ASSERT_NO_THROW(poller.modify(s.server, ZMQ_POLLIN | ZMQ_POLLOUT)); + ASSERT_EQ(1, poller.wait_all(events, std::chrono::milliseconds{500})); + ASSERT_EQ(ZMQ_POLLIN | ZMQ_POLLOUT, events[0].events); +} + +TEST(poller, wait_one_return) +{ + // Setup server and client + common_server_client_setup s; + + // Setup poller + zmq::poller_t<> poller; + ASSERT_NO_THROW(poller.add(s.server, ZMQ_POLLIN, nullptr)); + + // client sends message + ASSERT_NO_THROW(s.client.send("Hi")); + + // wait for message and verify events + std::vector events(1); + ASSERT_EQ(1, poller.wait_all(events, std::chrono::milliseconds{500})); +} + +TEST(poller, wait_on_move_constructed_poller) +{ + common_server_client_setup s; + ASSERT_NO_THROW (s.client.send ("Hi")); + zmq::poller_t<> a; + ASSERT_NO_THROW (a.add (s.server, ZMQ_POLLIN, nullptr)); + zmq::poller_t<> b {std::move (a)}; + std::vector events(1); + /// \todo the actual error code should be checked + ASSERT_THROW(a.wait_all (events, std::chrono::milliseconds{10}), zmq::error_t); + ASSERT_EQ (1, b.wait_all (events, std::chrono::milliseconds {-1})); +} + +TEST(poller, wait_on_move_assigned_poller) +{ + common_server_client_setup s; + ASSERT_NO_THROW (s.client.send ("Hi")); + zmq::poller_t<> a; + ASSERT_NO_THROW (a.add (s.server, ZMQ_POLLIN, nullptr)); + zmq::poller_t<> b; + b = {std::move (a)}; + /// \todo the actual error code should be checked + std::vector events(1); + ASSERT_THROW(a.wait_all (events, std::chrono::milliseconds{10}), zmq::error_t); + ASSERT_EQ (1, b.wait_all (events, std::chrono::milliseconds {-1})); +} + +TEST(poller, remove_from_handler) +{ + constexpr auto ITER_NO = 10; + + // Setup servers and clients + std::vector setup_list; + for (auto i = 0; i < ITER_NO; ++i) + setup_list.emplace_back (common_server_client_setup{}); + + // Setup poller + zmq::poller_t<> poller; + for (auto i = 0; i < ITER_NO; ++i) { + ASSERT_NO_THROW(poller.add(setup_list[i].server, ZMQ_POLLIN, nullptr)); + } + // Clients send messages + for (auto & s : setup_list) { + ASSERT_NO_THROW(s.client.send("Hi")); + } + + // Wait for all servers to receive a message + for (auto & s : setup_list) { + zmq::pollitem_t items [] = { { s.server, 0, ZMQ_POLLIN, 0 } }; + zmq::poll (&items [0], 1); + } + + // Fire all handlers in one wait + std::vector events(ITER_NO); + ASSERT_EQ(ITER_NO, poller.wait_all (events, std::chrono::milliseconds{-1})); +} + +#endif diff --git a/tests/testutil.hpp b/tests/testutil.hpp new file mode 100644 index 0000000..1ed5432 --- /dev/null +++ b/tests/testutil.hpp @@ -0,0 +1,49 @@ +#pragma once + +#include +#include + +#if defined(ZMQ_CPP11) +#include + +class loopback_ip4_binder +{ +public: + loopback_ip4_binder(zmq::socket_t &socket) { bind(socket); } + std::string endpoint() { return endpoint_; } +private: + // Helper function used in constructor + // as Gtest allows ASSERT_* only in void returning functions + // and constructor/destructor are not. + void bind(zmq::socket_t &socket) + { + ASSERT_NO_THROW(socket.bind("tcp://127.0.0.1:*")); + std::array endpoint{}; + size_t endpoint_size = endpoint.size(); + ASSERT_NO_THROW(socket.getsockopt(ZMQ_LAST_ENDPOINT, endpoint.data(), + &endpoint_size)); + ASSERT_TRUE(endpoint_size < endpoint.size()); + endpoint_ = std::string{endpoint.data()}; + } + std::string endpoint_; +}; + +struct common_server_client_setup +{ + common_server_client_setup () + { + init (); + } + + void init() + { + endpoint = loopback_ip4_binder {server}.endpoint (); + ASSERT_NO_THROW (client.connect (endpoint)); + } + + zmq::context_t context; + zmq::socket_t server {context, zmq::socket_type::server}; + zmq::socket_t client {context, zmq::socket_type::client}; + std::string endpoint; +}; +#endif