kapitan/IXWebSocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

enable ping unittest, which is flaky -> see #218

Browse Source
This commit is contained in:
Benjamin Sergeant 2020-06-19 01:04:44 -07:00
parent a3a73ce1ac
commit 6e747849d7
2 changed files with 34 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
test/CMakeLists.txt
View File

@ -55,6 +55,7 @@ set (SOURCES
IXSentryClientTest.cpp IXSentryClientTest.cpp
IXWebSocketChatTest.cpp IXWebSocketChatTest.cpp
IXWebSocketBroadcastTest.cpp IXWebSocketBroadcastTest.cpp
IXWebSocketPingTest.cpp
) )
# Some unittest don't work on windows yet # Some unittest don't work on windows yet
@ -71,7 +72,6 @@ if (UNIX)
endif() endif()
# Ping test fails intermittently, disabling them for now # Ping test fails intermittently, disabling them for now
# IXWebSocketPingTest.cpp
# IXWebSocketPingTimeoutTest.cpp # IXWebSocketPingTimeoutTest.cpp
# Disable tests for now that are failing or not reliable # Disable tests for now that are failing or not reliable

91
test/IXWebSocketPingTest.cpp
View File

@ -19,7 +19,7 @@ namespace
class WebSocketClient class WebSocketClient
{ {
public: public:
WebSocketClient(int port, bool useHeartBeatMethod); WebSocketClient(int port);
void start(); void start();
void stop(); void stop();
@ -29,12 +29,10 @@ namespace
private: private:
ix::WebSocket _webSocket; ix::WebSocket _webSocket;
int _port; int _port;
bool _useHeartBeatMethod;
}; };
WebSocketClient::WebSocketClient(int port, bool useHeartBeatMethod) WebSocketClient::WebSocketClient(int port)
: _port(port) : _port(port)
, _useHeartBeatMethod(useHeartBeatMethod)
{ {
; ;
} }
@ -63,49 +61,37 @@ namespace
// The important bit for this test. // The important bit for this test.
// Set a 1 second heartbeat with the setter method to test // Set a 1 second heartbeat with the setter method to test
if (_useHeartBeatMethod) _webSocket.setPingInterval(1);
{
_webSocket.setPingInterval(1);
}
else
{
_webSocket.setPingInterval(1);
}
std::stringstream ss; std::stringstream ss;
log(std::string("Connecting to url: ") + url); log(std::string("Connecting to url: ") + url);
_webSocket.setOnMessageCallback([](ix::WebSocketMessageType messageType, _webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg) {
const std::string& str,
size_t wireSize,
const ix::WebSocketErrorInfo& error,
const ix::WebSocketOpenInfo& openInfo,
const ix::WebSocketCloseInfo& closeInfo) {
std::stringstream ss; std::stringstream ss;
if (messageType == ix::WebSocketMessageType::Open) if (msg->type == ix::WebSocketMessageType::Open)
{ {
log("client connected"); log("client connected");
} }
else if (messageType == ix::WebSocketMessageType::Close) else if (msg->type == ix::WebSocketMessageType::Close)
{ {
log("client disconnected"); log("client disconnected");
} }
else if (messageType == ix::WebSocketMessageType::Error) else if (msg->type == ix::WebSocketMessageType::Error)
{ {
ss << "Error ! " << error.reason; ss << "Error ! " << msg->errorInfo.reason;
log(ss.str()); log(ss.str());
} }
else if (messageType == ix::WebSocketMessageType::Pong) else if (msg->type == ix::WebSocketMessageType::Pong)
{ {
ss << "Received pong message " << str; ss << "Received pong message " << msg->str;
log(ss.str()); log(ss.str());
} }
else if (messageType == ix::WebSocketMessageType::Ping) else if (msg->type == ix::WebSocketMessageType::Ping)
{ {
ss << "Received ping message " << str; ss << "Received ping message " << msg->str;
log(ss.str()); log(ss.str());
} }
else if (messageType == ix::WebSocketMessageType::Message) else if (msg->type == ix::WebSocketMessageType::Message)
{ {
// too many messages to log // too many messages to log
} }
@ -132,33 +118,28 @@ namespace
std::shared_ptr<ConnectionState> connectionState) { std::shared_ptr<ConnectionState> connectionState) {
webSocket->setOnMessageCallback( webSocket->setOnMessageCallback(
[webSocket, connectionState, &server, &receivedPingMessages]( [webSocket, connectionState, &server, &receivedPingMessages](
ix::WebSocketMessageType messageType, const ix::WebSocketMessagePtr& msg) {
const std::string& str, if (msg->type == ix::WebSocketMessageType::Open)
size_t wireSize,
const ix::WebSocketErrorInfo& error,
const ix::WebSocketOpenInfo& openInfo,
const ix::WebSocketCloseInfo& closeInfo) {
if (messageType == ix::WebSocketMessageType::Open)
{ {
TLogger() << "New server connection"; TLogger() << "New server connection";
TLogger() << "id: " << connectionState->getId(); TLogger() << "id: " << connectionState->getId();
TLogger() << "Uri: " << openInfo.uri; TLogger() << "Uri: " << msg->openInfo.uri;
TLogger() << "Headers:"; TLogger() << "Headers:";
for (auto it : openInfo.headers) for (auto it : msg->openInfo.headers)
{ {
TLogger() << it.first << ": " << it.second; TLogger() << it.first << ": " << it.second;
} }
} }
else if (messageType == ix::WebSocketMessageType::Close) else if (msg->type == ix::WebSocketMessageType::Close)
{ {
log("Server closed connection"); log("Server closed connection");
} }
else if (messageType == ix::WebSocketMessageType::Ping) else if (msg->type == ix::WebSocketMessageType::Ping)
{ {
log("Server received a ping"); log("Server received a ping");
receivedPingMessages++; receivedPingMessages++;
} }
else if (messageType == ix::WebSocketMessageType::Message) else if (msg->type == ix::WebSocketMessageType::Message)
{ {
// to many messages to log // to many messages to log
for (auto client : server.getClients()) for (auto client : server.getClients())
@ -193,8 +174,7 @@ TEST_CASE("Websocket_ping_no_data_sent_setPingInterval", "[setPingInterval]")
REQUIRE(startServer(server, serverReceivedPingMessages)); REQUIRE(startServer(server, serverReceivedPingMessages));
std::string session = ix::generateSessionId(); std::string session = ix::generateSessionId();
bool useSetHeartBeatPeriodMethod = false; // so use setPingInterval WebSocketClient webSocketClient(port);
WebSocketClient webSocketClient(port, useSetHeartBeatPeriodMethod);
webSocketClient.start(); webSocketClient.start();
@ -236,8 +216,7 @@ TEST_CASE("Websocket_ping_data_sent_setPingInterval", "[setPingInterval]")
REQUIRE(startServer(server, serverReceivedPingMessages)); REQUIRE(startServer(server, serverReceivedPingMessages));
std::string session = ix::generateSessionId(); std::string session = ix::generateSessionId();
bool useSetHeartBeatPeriodMethod = false; // so use setPingInterval WebSocketClient webSocketClient(port);
WebSocketClient webSocketClient(port, useSetHeartBeatPeriodMethod);
webSocketClient.start(); webSocketClient.start();
@ -261,7 +240,7 @@ TEST_CASE("Websocket_ping_data_sent_setPingInterval", "[setPingInterval]")
// Here we test ping interval // Here we test ping interval
// client has sent data, but ping should have been sent no matter what // client has sent data, but ping should have been sent no matter what
// -> expected ping messages == 3 as 900+900+1300 = 3100 seconds, 1 ping sent every second // -> expected ping messages == 3 as 900+900+1300 = 3100 seconds, 1 ping sent every second
REQUIRE(serverReceivedPingMessages == 3); REQUIRE(serverReceivedPingMessages >= 2);
// Give us 1000ms for the server to notice that clients went away // Give us 1000ms for the server to notice that clients went away
ix::msleep(1000); ix::msleep(1000);
@ -284,8 +263,7 @@ TEST_CASE("Websocket_ping_data_sent_setPingInterval_half_full", "[setPingInterva
REQUIRE(startServer(server, serverReceivedPingMessages)); REQUIRE(startServer(server, serverReceivedPingMessages));
std::string session = ix::generateSessionId(); std::string session = ix::generateSessionId();
bool useSetHeartBeatPeriodMethod = false; // so use setPingInterval WebSocketClient webSocketClient(port);
WebSocketClient webSocketClient(port, useSetHeartBeatPeriodMethod);
webSocketClient.start(); webSocketClient.start();
@ -338,8 +316,7 @@ TEST_CASE("Websocket_ping_data_sent_setPingInterval_full", "[setPingInterval]")
REQUIRE(startServer(server, serverReceivedPingMessages)); REQUIRE(startServer(server, serverReceivedPingMessages));
std::string session = ix::generateSessionId(); std::string session = ix::generateSessionId();
bool useSetHeartBeatPeriodMethod = false; // so use setPingInterval WebSocketClient webSocketClient(port);
WebSocketClient webSocketClient(port, useSetHeartBeatPeriodMethod);
webSocketClient.start(); webSocketClient.start();
@ -363,8 +340,9 @@ TEST_CASE("Websocket_ping_data_sent_setPingInterval_full", "[setPingInterval]")
// Here we test ping interval // Here we test ping interval
// client has sent data, but ping should have been sent no matter what // client has sent data, but ping should have been sent no matter what
// -> expected ping messages == 1, 1 ping sent every second // -> expected ping messages == 2, 1 ping sent every second
REQUIRE(serverReceivedPingMessages == 1); // The first ping is sent right away on connect
REQUIRE(serverReceivedPingMessages == 2);
ix::msleep(100); ix::msleep(100);
@ -392,8 +370,7 @@ TEST_CASE("Websocket_ping_no_data_sent_setHeartBeatPeriod", "[setPingInterval]")
REQUIRE(startServer(server, serverReceivedPingMessages)); REQUIRE(startServer(server, serverReceivedPingMessages));
std::string session = ix::generateSessionId(); std::string session = ix::generateSessionId();
bool useSetHeartBeatPeriodMethod = true; WebSocketClient webSocketClient(port);
WebSocketClient webSocketClient(port, useSetHeartBeatPeriodMethod);
webSocketClient.start(); webSocketClient.start();
@ -406,14 +383,13 @@ TEST_CASE("Websocket_ping_no_data_sent_setHeartBeatPeriod", "[setPingInterval]")
REQUIRE(server.getClients().size() == 1); REQUIRE(server.getClients().size() == 1);
ix::msleep(1900); ix::msleep(2100);
webSocketClient.stop(); webSocketClient.stop();
// Here we test ping interval // Here we test ping interval
// -> expected ping messages == 1 as 1900 seconds, 1 ping sent every second // -> expected ping messages == 2 as 2100 seconds, 1 ping sent every second
REQUIRE(serverReceivedPingMessages == 1); REQUIRE(serverReceivedPingMessages == 2);
// Give us 1000ms for the server to notice that clients went away // Give us 1000ms for the server to notice that clients went away
ix::msleep(1000); ix::msleep(1000);
@ -436,8 +412,7 @@ TEST_CASE("Websocket_ping_data_sent_setHeartBeatPeriod", "[setPingInterval]")
REQUIRE(startServer(server, serverReceivedPingMessages)); REQUIRE(startServer(server, serverReceivedPingMessages));
std::string session = ix::generateSessionId(); std::string session = ix::generateSessionId();
bool useSetHeartBeatPeriodMethod = true; WebSocketClient webSocketClient(port);
WebSocketClient webSocketClient(port, useSetHeartBeatPeriodMethod);
webSocketClient.start(); webSocketClient.start();