Compare commits

..

4 Commits

32 changed files with 489 additions and 681 deletions

View File

@ -1,36 +1,17 @@
language: bash language: cpp
dist: xenial
compiler:
- gcc
- clang
os:
- linux
- osx
matrix: matrix:
include: exclude:
# macOS # GCC fails on recent Travis OSX images.
- os: osx - compiler: gcc
compiler: clang os: osx
script:
- python test/run.py
- make ws
# Linux script: python test/run.py
- os: linux
dist: xenial
script:
- python test/run.py
- make ws
env:
- CC=gcc
- CXX=g++
# Clang + Linux disabled for now
# - os: linux
# dist: xenial
# script: python test/run.py
# env:
# - CC=clang
# - CXX=clang++
# Windows
- os: windows
env:
- CMAKE_PATH="/c/Program Files/CMake/bin"
script:
- export PATH=$CMAKE_PATH:$PATH
- python test/run.py

View File

@ -41,7 +41,6 @@ set( IXWEBSOCKET_SOURCES
ixwebsocket/IXSelectInterrupt.cpp ixwebsocket/IXSelectInterrupt.cpp
ixwebsocket/IXSelectInterruptFactory.cpp ixwebsocket/IXSelectInterruptFactory.cpp
ixwebsocket/IXConnectionState.cpp ixwebsocket/IXConnectionState.cpp
ixwebsocket/IXWebSocketCloseConstants.cpp
) )
set( IXWEBSOCKET_HEADERS set( IXWEBSOCKET_HEADERS
@ -71,7 +70,6 @@ set( IXWEBSOCKET_HEADERS
ixwebsocket/IXSelectInterrupt.h ixwebsocket/IXSelectInterrupt.h
ixwebsocket/IXSelectInterruptFactory.h ixwebsocket/IXSelectInterruptFactory.h
ixwebsocket/IXConnectionState.h ixwebsocket/IXConnectionState.h
ixwebsocket/IXWebSocketCloseConstants.h
) )
if (UNIX) if (UNIX)
@ -157,6 +155,6 @@ install(TARGETS ixwebsocket
PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/ixwebsocket/ PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/ixwebsocket/
) )
if (USE_WS) if (NOT WIN32)
add_subdirectory(ws) add_subdirectory(ws)
endif() endif()

View File

@ -16,7 +16,6 @@ ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
RUN yum install -y python RUN yum install -y python
RUN yum install -y libtsan RUN yum install -y libtsan
RUN yum install -y zlib-devel
COPY . . COPY . .
# RUN ["make", "test"] # RUN ["make", "test"]

View File

@ -19,7 +19,7 @@
namespace ix namespace ix
{ {
enum class HttpErrorCode : int enum class HttpErrorCode
{ {
Ok = 0, Ok = 0,
CannotConnect = 1, CannotConnect = 1,

View File

@ -129,7 +129,7 @@ namespace ix
} }
// Wake up from poll/select by writing to the pipe which is watched by select // Wake up from poll/select by writing to the pipe which is watched by select
bool Socket::wakeUpFromPoll(uint64_t wakeUpCode) bool Socket::wakeUpFromPoll(uint8_t wakeUpCode)
{ {
return _selectInterrupt->notify(wakeUpCode); return _selectInterrupt->notify(wakeUpCode);
} }

View File

@ -57,7 +57,7 @@ namespace ix
// Functions to check whether there is activity on the socket // Functions to check whether there is activity on the socket
PollResultType poll(int timeoutMs = kDefaultPollTimeout); PollResultType poll(int timeoutMs = kDefaultPollTimeout);
bool wakeUpFromPoll(uint64_t wakeUpCode); bool wakeUpFromPoll(uint8_t wakeUpCode);
PollResultType isReadyToWrite(int timeoutMs); PollResultType isReadyToWrite(int timeoutMs);
PollResultType isReadyToRead(int timeoutMs); PollResultType isReadyToRead(int timeoutMs);

View File

@ -142,10 +142,9 @@ namespace ix
_thread = std::thread(&WebSocket::run, this); _thread = std::thread(&WebSocket::run, this);
} }
void WebSocket::stop(uint16_t code, void WebSocket::stop()
const std::string& reason)
{ {
close(code, reason); close();
if (_thread.joinable()) if (_thread.joinable())
{ {
@ -293,9 +292,6 @@ namespace ix
break; break;
} }
// We cannot enter poll which might block forever if we are stopping
if (_stop) break;
// 2. Poll to see if there's any new data available // 2. Poll to see if there's any new data available
WebSocketTransport::PollResult pollResult = _ws.poll(); WebSocketTransport::PollResult pollResult = _ws.poll();
@ -463,11 +459,6 @@ namespace ix
_automaticReconnection = false; _automaticReconnection = false;
} }
bool WebSocket::isAutomaticReconnectionEnabled() const
{
return _automaticReconnection;
}
size_t WebSocket::bufferedAmount() const size_t WebSocket::bufferedAmount() const
{ {
return _ws.bufferedAmount(); return _ws.bufferedAmount();

View File

@ -19,7 +19,6 @@
#include "IXWebSocketSendInfo.h" #include "IXWebSocketSendInfo.h"
#include "IXWebSocketPerMessageDeflateOptions.h" #include "IXWebSocketPerMessageDeflateOptions.h"
#include "IXWebSocketHttpHeaders.h" #include "IXWebSocketHttpHeaders.h"
#include "IXWebSocketCloseConstants.h"
#include "IXProgressCallback.h" #include "IXProgressCallback.h"
namespace ix namespace ix
@ -100,10 +99,8 @@ namespace ix
// Run asynchronously, by calling start and stop. // Run asynchronously, by calling start and stop.
void start(); void start();
// stop is synchronous // stop is synchronous
void stop(uint16_t code = WebSocketCloseConstants::kNormalClosureCode, void stop();
const std::string& reason = WebSocketCloseConstants::kNormalClosureMessage);
// Run in blocking mode, by connecting first manually, and then calling run. // Run in blocking mode, by connecting first manually, and then calling run.
WebSocketInitResult connect(int timeoutSecs); WebSocketInitResult connect(int timeoutSecs);
@ -116,6 +113,8 @@ namespace ix
const OnProgressCallback& onProgressCallback = nullptr); const OnProgressCallback& onProgressCallback = nullptr);
WebSocketSendInfo ping(const std::string& text); WebSocketSendInfo ping(const std::string& text);
// A close frame can provide a code and a reason
// FIXME: use constants
void close(uint16_t code = 1000, void close(uint16_t code = 1000,
const std::string& reason = "Normal closure"); const std::string& reason = "Normal closure");
@ -135,7 +134,6 @@ namespace ix
void enableAutomaticReconnection(); void enableAutomaticReconnection();
void disableAutomaticReconnection(); void disableAutomaticReconnection();
bool isAutomaticReconnectionEnabled() const;
private: private:

View File

@ -1,23 +0,0 @@
/*
* IXWebSocketCloseConstants.cpp
* Author: Benjamin Sergeant
* Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
*/
#include "IXWebSocketCloseConstants.h"
namespace ix
{
const uint16_t WebSocketCloseConstants::kNormalClosureCode(1000);
const uint16_t WebSocketCloseConstants::kInternalErrorCode(1011);
const uint16_t WebSocketCloseConstants::kAbnormalCloseCode(1006);
const uint16_t WebSocketCloseConstants::kProtocolErrorCode(1002);
const uint16_t WebSocketCloseConstants::kNoStatusCodeErrorCode(1005);
const std::string WebSocketCloseConstants::kNormalClosureMessage("Normal closure");
const std::string WebSocketCloseConstants::kInternalErrorMessage("Internal error");
const std::string WebSocketCloseConstants::kAbnormalCloseMessage("Abnormal closure");
const std::string WebSocketCloseConstants::kPingTimeoutMessage("Ping timeout");
const std::string WebSocketCloseConstants::kProtocolErrorMessage("Protocol error");
const std::string WebSocketCloseConstants::kNoStatusCodeErrorMessage("No status code");
}

View File

@ -1,29 +0,0 @@
/*
* IXWebSocketCloseConstants.h
* Author: Benjamin Sergeant
* Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
*/
#pragma once
#include <cstdint>
#include <string>
namespace ix
{
struct WebSocketCloseConstants
{
static const uint16_t kNormalClosureCode;
static const uint16_t kInternalErrorCode;
static const uint16_t kAbnormalCloseCode;
static const uint16_t kProtocolErrorCode;
static const uint16_t kNoStatusCodeErrorCode;
static const std::string kNormalClosureMessage;
static const std::string kInternalErrorMessage;
static const std::string kAbnormalCloseMessage;
static const std::string kPingTimeoutMessage;
static const std::string kProtocolErrorMessage;
static const std::string kNoStatusCodeErrorMessage;
};
}

View File

@ -74,11 +74,21 @@ namespace ix
const int WebSocketTransport::kClosingMaximumWaitingDelayInMs(200); const int WebSocketTransport::kClosingMaximumWaitingDelayInMs(200);
constexpr size_t WebSocketTransport::kChunkSize; constexpr size_t WebSocketTransport::kChunkSize;
const uint16_t WebSocketTransport::kInternalErrorCode(1011);
const uint16_t WebSocketTransport::kAbnormalCloseCode(1006);
const uint16_t WebSocketTransport::kProtocolErrorCode(1002);
const uint16_t WebSocketTransport::kNoStatusCodeErrorCode(1005);
const std::string WebSocketTransport::kInternalErrorMessage("Internal error");
const std::string WebSocketTransport::kAbnormalCloseMessage("Abnormal closure");
const std::string WebSocketTransport::kPingTimeoutMessage("Ping timeout");
const std::string WebSocketTransport::kProtocolErrorMessage("Protocol error");
const std::string WebSocketTransport::kNoStatusCodeErrorMessage("No status code");
WebSocketTransport::WebSocketTransport() : WebSocketTransport::WebSocketTransport() :
_useMask(true), _useMask(true),
_readyState(ReadyState::CLOSED), _readyState(ReadyState::CLOSED),
_closeCode(WebSocketCloseConstants::kInternalErrorCode), _closeCode(kInternalErrorCode),
_closeReason(WebSocketCloseConstants::kInternalErrorMessage), _closeReason(kInternalErrorMessage),
_closeWireSize(0), _closeWireSize(0),
_closeRemote(false), _closeRemote(false),
_enablePerMessageDeflate(false), _enablePerMessageDeflate(false),
@ -130,8 +140,6 @@ namespace ix
WebSocketInitResult WebSocketTransport::connectToUrl(const std::string& url, WebSocketInitResult WebSocketTransport::connectToUrl(const std::string& url,
int timeoutSecs) int timeoutSecs)
{ {
std::lock_guard<std::mutex> lock(_socketMutex);
std::string protocol, host, path, query; std::string protocol, host, path, query;
int port; int port;
@ -141,8 +149,8 @@ namespace ix
std::string("Could not parse URL ") + url); std::string("Could not parse URL ") + url);
} }
std::string errorMsg;
bool tls = protocol == "wss"; bool tls = protocol == "wss";
std::string errorMsg;
_socket = createSocket(tls, errorMsg); _socket = createSocket(tls, errorMsg);
if (!_socket) if (!_socket)
@ -168,8 +176,6 @@ namespace ix
// Server // Server
WebSocketInitResult WebSocketTransport::connectToSocket(int fd, int timeoutSecs) WebSocketInitResult WebSocketTransport::connectToSocket(int fd, int timeoutSecs)
{ {
std::lock_guard<std::mutex> lock(_socketMutex);
// Server should not mask the data it sends to the client // Server should not mask the data it sends to the client
_useMask = false; _useMask = false;
@ -209,8 +215,8 @@ namespace ix
{ {
std::lock_guard<std::mutex> lock(_closeDataMutex); std::lock_guard<std::mutex> lock(_closeDataMutex);
_onCloseCallback(_closeCode, _closeReason, _closeWireSize, _closeRemote); _onCloseCallback(_closeCode, _closeReason, _closeWireSize, _closeRemote);
_closeCode = WebSocketCloseConstants::kInternalErrorCode; _closeCode = kInternalErrorCode;
_closeReason = WebSocketCloseConstants::kInternalErrorMessage; _closeReason = kInternalErrorMessage;
_closeWireSize = 0; _closeWireSize = 0;
_closeRemote = false; _closeRemote = false;
} }
@ -280,8 +286,7 @@ namespace ix
// ping response (PONG) exceeds the maximum delay, then close the connection // ping response (PONG) exceeds the maximum delay, then close the connection
if (pingTimeoutExceeded()) if (pingTimeoutExceeded())
{ {
close(WebSocketCloseConstants::kInternalErrorCode, close(kInternalErrorCode, kPingTimeoutMessage);
WebSocketCloseConstants::kPingTimeoutMessage);
} }
// If ping is enabled and no ping has been sent for a duration // If ping is enabled and no ping has been sent for a duration
// exceeding our ping interval, send a ping to the server. // exceeding our ping interval, send a ping to the server.
@ -315,20 +320,9 @@ namespace ix
} }
#ifdef _WIN32 #ifdef _WIN32
// Windows does not have select interrupt capabilities, so wait with a small timeout if (lastingTimeoutDelayInMs <= 0) lastingTimeoutDelayInMs = 20;
if (lastingTimeoutDelayInMs <= 0)
{
lastingTimeoutDelayInMs = 20;
}
#endif #endif
// If we are requesting a cancellation, pass in a positive and small timeout
// to never poll forever without a timeout.
if (_requestInitCancellation)
{
lastingTimeoutDelayInMs = 100;
}
// poll the socket // poll the socket
PollResultType pollResult = _socket->poll(lastingTimeoutDelayInMs); PollResultType pollResult = _socket->poll(lastingTimeoutDelayInMs);
@ -344,7 +338,7 @@ namespace ix
if (result == PollResultType::Error) if (result == PollResultType::Error)
{ {
closeSocket(); _socket->close();
setReadyState(ReadyState::CLOSED); setReadyState(ReadyState::CLOSED);
break; break;
} }
@ -369,7 +363,7 @@ namespace ix
// if there are received data pending to be processed, then delay the abnormal closure // if there are received data pending to be processed, then delay the abnormal closure
// to after dispatch (other close code/reason could be read from the buffer) // to after dispatch (other close code/reason could be read from the buffer)
closeSocket(); _socket->close();
return PollResult::AbnormalClose; return PollResult::AbnormalClose;
} }
@ -383,18 +377,18 @@ namespace ix
} }
else if (pollResult == PollResultType::Error) else if (pollResult == PollResultType::Error)
{ {
closeSocket(); _socket->close();
} }
else if (pollResult == PollResultType::CloseRequest) else if (pollResult == PollResultType::CloseRequest)
{ {
closeSocket(); _socket->close();
} }
if (_readyState == ReadyState::CLOSING && closingDelayExceeded()) if (_readyState == ReadyState::CLOSING && closingDelayExceeded())
{ {
_rxbuf.clear(); _rxbuf.clear();
// close code and reason were set when calling close() // close code and reason were set when calling close()
closeSocket(); _socket->close();
setReadyState(ReadyState::CLOSED); setReadyState(ReadyState::CLOSED);
} }
@ -626,8 +620,8 @@ namespace ix
else else
{ {
// no close code received // no close code received
code = WebSocketCloseConstants::kNoStatusCodeErrorCode; code = kNoStatusCodeErrorCode;
reason = WebSocketCloseConstants::kNoStatusCodeErrorMessage; reason = kNoStatusCodeErrorMessage;
} }
// We receive a CLOSE frame from remote and are NOT the ones who triggered the close // We receive a CLOSE frame from remote and are NOT the ones who triggered the close
@ -661,9 +655,8 @@ namespace ix
else else
{ {
// Unexpected frame type // Unexpected frame type
close(WebSocketCloseConstants::kProtocolErrorCode,
WebSocketCloseConstants::kProtocolErrorMessage, close(kProtocolErrorCode, kProtocolErrorMessage, _rxbuf.size());
_rxbuf.size());
} }
// Erase the message that has been processed from the input/read buffer // Erase the message that has been processed from the input/read buffer
@ -680,15 +673,13 @@ namespace ix
// if we previously closed the connection (CLOSING state), then set state to CLOSED (code/reason were set before) // if we previously closed the connection (CLOSING state), then set state to CLOSED (code/reason were set before)
if (_readyState == ReadyState::CLOSING) if (_readyState == ReadyState::CLOSING)
{ {
closeSocket(); _socket->close();
setReadyState(ReadyState::CLOSED); setReadyState(ReadyState::CLOSED);
} }
// if we weren't closing, then close using abnormal close code and message // if we weren't closing, then close using abnormal close code and message
else if (_readyState != ReadyState::CLOSED) else if (_readyState != ReadyState::CLOSED)
{ {
closeSocketAndSwitchToClosedState(WebSocketCloseConstants::kAbnormalCloseCode, closeSocketAndSwitchToClosedState(kAbnormalCloseCode, kAbnormalCloseMessage, 0, false);
WebSocketCloseConstants::kAbnormalCloseMessage,
0, false);
} }
} }
} }
@ -958,19 +949,13 @@ namespace ix
_enablePerMessageDeflate, onProgressCallback); _enablePerMessageDeflate, onProgressCallback);
} }
ssize_t WebSocketTransport::send()
{
std::lock_guard<std::mutex> lock(_socketMutex);
return _socket->send((char*)&_txbuf[0], _txbuf.size());
}
void WebSocketTransport::sendOnSocket() void WebSocketTransport::sendOnSocket()
{ {
std::lock_guard<std::mutex> lock(_txbufMutex); std::lock_guard<std::mutex> lock(_txbufMutex);
while (_txbuf.size()) while (_txbuf.size())
{ {
ssize_t ret = send(); ssize_t ret = _socket->send((char*)&_txbuf[0], _txbuf.size());
if (ret < 0 && Socket::isWaitNeeded()) if (ret < 0 && Socket::isWaitNeeded())
{ {
@ -978,7 +963,8 @@ namespace ix
} }
else if (ret <= 0) else if (ret <= 0)
{ {
closeSocket(); _socket->close();
setReadyState(ReadyState::CLOSED); setReadyState(ReadyState::CLOSED);
break; break;
} }
@ -994,7 +980,7 @@ namespace ix
bool compress = false; bool compress = false;
// if a status is set/was read // if a status is set/was read
if (code != WebSocketCloseConstants::kNoStatusCodeErrorCode) if (code != kNoStatusCodeErrorCode)
{ {
// See list of close events here: // See list of close events here:
// https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent // https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
@ -1012,17 +998,9 @@ namespace ix
} }
} }
void WebSocketTransport::closeSocket() void WebSocketTransport::closeSocketAndSwitchToClosedState(uint16_t code, const std::string& reason, size_t closeWireSize, bool remote)
{ {
std::lock_guard<std::mutex> lock(_socketMutex);
_socket->close(); _socket->close();
}
void WebSocketTransport::closeSocketAndSwitchToClosedState(
uint16_t code, const std::string& reason, size_t closeWireSize, bool remote)
{
closeSocket();
{ {
std::lock_guard<std::mutex> lock(_closeDataMutex); std::lock_guard<std::mutex> lock(_closeDataMutex);
_closeCode = code; _closeCode = code;
@ -1030,13 +1008,10 @@ namespace ix
_closeWireSize = closeWireSize; _closeWireSize = closeWireSize;
_closeRemote = remote; _closeRemote = remote;
} }
setReadyState(ReadyState::CLOSED); setReadyState(ReadyState::CLOSED);
_requestInitCancellation = false;
} }
void WebSocketTransport::close( void WebSocketTransport::close(uint16_t code, const std::string& reason, size_t closeWireSize, bool remote)
uint16_t code, const std::string& reason, size_t closeWireSize, bool remote)
{ {
_requestInitCancellation = true; _requestInitCancellation = true;

View File

@ -25,7 +25,6 @@
#include "IXCancellationRequest.h" #include "IXCancellationRequest.h"
#include "IXWebSocketHandshake.h" #include "IXWebSocketHandshake.h"
#include "IXProgressCallback.h" #include "IXProgressCallback.h"
#include "IXWebSocketCloseConstants.h"
namespace ix namespace ix
{ {
@ -92,14 +91,11 @@ namespace ix
const OnProgressCallback& onProgressCallback); const OnProgressCallback& onProgressCallback);
WebSocketSendInfo sendPing(const std::string& message); WebSocketSendInfo sendPing(const std::string& message);
void close(uint16_t code = WebSocketCloseConstants::kNormalClosureCode, void close(uint16_t code = 1000,
const std::string& reason = WebSocketCloseConstants::kNormalClosureMessage, const std::string& reason = "Normal closure",
size_t closeWireSize = 0, size_t closeWireSize = 0,
bool remote = false); bool remote = false);
void closeSocket();
ssize_t send();
ReadyState getReadyState() const; ReadyState getReadyState() const;
void setReadyState(ReadyState readyState); void setReadyState(ReadyState readyState);
void setOnCloseCallback(const OnCloseCallback& onCloseCallback); void setOnCloseCallback(const OnCloseCallback& onCloseCallback);
@ -155,7 +151,6 @@ namespace ix
// Underlying TCP socket // Underlying TCP socket
std::shared_ptr<Socket> _socket; std::shared_ptr<Socket> _socket;
std::mutex _socketMutex;
// Hold the state of the connection (OPEN, CLOSED, etc...) // Hold the state of the connection (OPEN, CLOSED, etc...)
std::atomic<ReadyState> _readyState; std::atomic<ReadyState> _readyState;
@ -179,6 +174,17 @@ namespace ix
std::chrono::time_point<std::chrono::steady_clock>_closingTimePoint; std::chrono::time_point<std::chrono::steady_clock>_closingTimePoint;
static const int kClosingMaximumWaitingDelayInMs; static const int kClosingMaximumWaitingDelayInMs;
// Constants for dealing with closing conneections
static const uint16_t kInternalErrorCode;
static const uint16_t kAbnormalCloseCode;
static const uint16_t kProtocolErrorCode;
static const uint16_t kNoStatusCodeErrorCode;
static const std::string kInternalErrorMessage;
static const std::string kAbnormalCloseMessage;
static const std::string kPingTimeoutMessage;
static const std::string kProtocolErrorMessage;
static const std::string kNoStatusCodeErrorMessage;
// enable auto response to ping // enable auto response to ping
std::atomic<bool> _enablePong; std::atomic<bool> _enablePong;
static const bool kDefaultEnablePong; static const bool kDefaultEnablePong;

View File

@ -9,10 +9,7 @@ install: brew
# on osx it is good practice to make /usr/local user writable # on osx it is good practice to make /usr/local user writable
# sudo chown -R `whoami`/staff /usr/local # sudo chown -R `whoami`/staff /usr/local
brew: brew:
mkdir -p build && (cd build ; cmake -DUSE_TLS=1 -DUSE_WS=1 .. ; make -j install) mkdir -p build && (cd build ; cmake -DUSE_TLS=1 .. ; make -j install)
ws:
mkdir -p build && (cd build ; cmake -DUSE_TLS=1 -DUSE_WS=1 .. ; make -j)
uninstall: uninstall:
xargs rm -fv < build/install_manifest.txt xargs rm -fv < build/install_manifest.txt
@ -51,8 +48,8 @@ test_server:
test: test:
python2.7 test/run.py python2.7 test/run.py
ws_test: ws ws_test: all
(cd ws ; env DEBUG=1 PATH=../ws/build:$$PATH bash test_ws.sh) (cd ws ; bash test_ws.sh)
# For the fork that is configured with appveyor # For the fork that is configured with appveyor
rebase_upstream: rebase_upstream:
@ -67,4 +64,3 @@ install_cmake_for_linux:
.PHONY: test .PHONY: test
.PHONY: build .PHONY: build
.PHONY: ws

View File

@ -7,7 +7,7 @@ project (ixwebsocket_unittest)
set (CMAKE_CXX_STANDARD 14) set (CMAKE_CXX_STANDARD 14)
if (NOT WIN32) if (UNIX)
set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/../third_party/sanitizers-cmake/cmake" ${CMAKE_MODULE_PATH}) set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/../third_party/sanitizers-cmake/cmake" ${CMAKE_MODULE_PATH})
find_package(Sanitizers) find_package(Sanitizers)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=thread") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=thread")
@ -31,30 +31,29 @@ set (SOURCES
../third_party/msgpack11/msgpack11.cpp ../third_party/msgpack11/msgpack11.cpp
../ws/ixcore/utils/IXCoreLogger.cpp ../ws/ixcore/utils/IXCoreLogger.cpp
IXDNSLookupTest.cpp
IXSocketTest.cpp IXSocketTest.cpp
IXSocketConnectTest.cpp IXSocketConnectTest.cpp
IXWebSocketServerTest.cpp IXWebSocketServerTest.cpp
IXWebSocketPingTest.cpp
IXWebSocketTestConnectionDisconnection.cpp IXWebSocketTestConnectionDisconnection.cpp
IXUrlParserTest.cpp IXUrlParserTest.cpp
IXWebSocketServerTest.cpp IXWebSocketServerTest.cpp
IXWebSocketPingTest.cpp
) )
# Some unittest don't work on windows yet # Some unittest don't work on windows yet
if (UNIX) if (UNIX)
list(APPEND SOURCES list(APPEND SOURCES
IXDNSLookupTest.cpp # IXWebSocketPingTimeoutTest.cpp # This test isn't reliable # (multiple platforms), disabling in master
# IXWebSocketCloseTest.cpp #
cmd_websocket_chat.cpp cmd_websocket_chat.cpp
) )
endif() endif()
# Disable tests for now that are failing or not reliable
# IXWebSocketPingTest.cpp
# IXWebSocketPingTimeoutTest.cpp
# IXWebSocketCloseTest.cpp
add_executable(ixwebsocket_unittest ${SOURCES}) add_executable(ixwebsocket_unittest ${SOURCES})
if (NOT WIN32) if (UNIX)
add_sanitizers(ixwebsocket_unittest) add_sanitizers(ixwebsocket_unittest)
endif() endif()

View File

@ -17,12 +17,8 @@ TEST_CASE("socket_connect", "[net]")
{ {
SECTION("Test connecting to a known hostname") SECTION("Test connecting to a known hostname")
{ {
int port = getFreePort();
ix::WebSocketServer server(port);
REQUIRE(startWebSocketEchoServer(server));
std::string errMsg; std::string errMsg;
int fd = SocketConnect::connect("127.0.0.1", port, errMsg, [] { return false; }); int fd = SocketConnect::connect("www.google.com", 80, errMsg, [] { return false; });
std::cerr << "Error message: " << errMsg << std::endl; std::cerr << "Error message: " << errMsg << std::endl;
REQUIRE(fd != -1); REQUIRE(fd != -1);
} }
@ -38,13 +34,9 @@ TEST_CASE("socket_connect", "[net]")
SECTION("Test connecting to a good hostname, with cancellation") SECTION("Test connecting to a good hostname, with cancellation")
{ {
int port = getFreePort();
ix::WebSocketServer server(port);
REQUIRE(startWebSocketEchoServer(server));
std::string errMsg; std::string errMsg;
// The callback returning true means we are requesting cancellation // The callback returning true means we are requesting cancellation
int fd = SocketConnect::connect("127.0.0.1", port, errMsg, [] { return true; }); int fd = SocketConnect::connect("www.google.com", 80, errMsg, [] { return true; });
std::cerr << "Error message: " << errMsg << std::endl; std::cerr << "Error message: " << errMsg << std::endl;
REQUIRE(fd == -1); REQUIRE(fd == -1);
} }

View File

@ -53,17 +53,13 @@ namespace ix
TEST_CASE("socket", "[socket]") TEST_CASE("socket", "[socket]")
{ {
SECTION("Connect to a local websocket server over a free port. Send GET request without header. Should return 400") SECTION("Connect to google HTTP server. Send GET request without header. Should return 200")
{ {
// Start a server first which we'll hit with our socket code
int port = getFreePort();
ix::WebSocketServer server(port);
REQUIRE(startWebSocketEchoServer(server));
std::string errMsg; std::string errMsg;
bool tls = false; bool tls = false;
std::shared_ptr<Socket> socket = createSocket(tls, errMsg); std::shared_ptr<Socket> socket = createSocket(tls, errMsg);
std::string host("127.0.0.1"); std::string host("www.google.com");
int port = 80;
std::stringstream ss; std::stringstream ss;
ss << "GET / HTTP/1.1\r\n"; ss << "GET / HTTP/1.1\r\n";
@ -71,14 +67,14 @@ TEST_CASE("socket", "[socket]")
ss << "\r\n"; ss << "\r\n";
std::string request(ss.str()); std::string request(ss.str());
int expectedStatus = 400; int expectedStatus = 200;
int timeoutSecs = 3; int timeoutSecs = 3;
testSocket(host, port, request, socket, expectedStatus, timeoutSecs); testSocket(host, port, request, socket, expectedStatus, timeoutSecs);
} }
#if defined(__APPLE__) || defined(__linux__) #if defined(__APPLE__) || defined(__linux__)
SECTION("Connect to google HTTPS server over port 443. Send GET request without header. Should return 200") SECTION("Connect to google HTTPS server. Send GET request without header. Should return 200")
{ {
std::string errMsg; std::string errMsg;
bool tls = true; bool tls = true;

View File

@ -170,58 +170,4 @@ namespace ix
std::cout << prefix << ": " << s << " => " << ss.str() << std::endl; std::cout << prefix << ": " << s << " => " << ss.str() << std::endl;
} }
bool startWebSocketEchoServer(ix::WebSocketServer& server)
{
server.setOnConnectionCallback(
[&server](std::shared_ptr<ix::WebSocket> webSocket,
std::shared_ptr<ConnectionState> connectionState)
{
webSocket->setOnMessageCallback(
[webSocket, connectionState, &server](ix::WebSocketMessageType messageType,
const std::string& str,
size_t wireSize,
const ix::WebSocketErrorInfo& error,
const ix::WebSocketOpenInfo& openInfo,
const ix::WebSocketCloseInfo& closeInfo)
{
if (messageType == ix::WebSocketMessageType::Open)
{
Logger() << "New connection";
Logger() << "Uri: " << openInfo.uri;
Logger() << "Headers:";
for (auto it : openInfo.headers)
{
Logger() << it.first << ": " << it.second;
}
}
else if (messageType == ix::WebSocketMessageType::Close)
{
Logger() << "Closed connection";
}
else if (messageType == ix::WebSocketMessageType::Message)
{
for (auto&& client : server.getClients())
{
if (client != webSocket)
{
client->send(str);
}
}
}
}
);
}
);
auto res = server.listen();
if (!res.first)
{
Logger() << res.second;
return false;
}
server.start();
return true;
}
} }

View File

@ -11,8 +11,6 @@
#include <sstream> #include <sstream>
#include <iostream> #include <iostream>
#include <mutex> #include <mutex>
#include <spdlog/spdlog.h>
#include <ixwebsocket/IXWebSocketServer.h>
namespace ix namespace ix
{ {
@ -34,9 +32,8 @@ namespace ix
{ {
std::lock_guard<std::mutex> lock(_mutex); std::lock_guard<std::mutex> lock(_mutex);
std::stringstream ss; std::cerr << obj;
ss << obj; std::cerr << std::endl;
spdlog::info(ss.str());
return *this; return *this;
} }
@ -47,6 +44,4 @@ namespace ix
void log(const std::string& msg); void log(const std::string& msg);
int getFreePort(); int getFreePort();
bool startWebSocketEchoServer(ix::WebSocketServer& server);
} }

View File

@ -86,7 +86,8 @@ namespace
void WebSocketClient::stop(uint16_t code, const std::string& reason) void WebSocketClient::stop(uint16_t code, const std::string& reason)
{ {
_webSocket.stop(code, reason); _webSocket.close(code, reason);
_webSocket.stop();
} }
void WebSocketClient::start() void WebSocketClient::start()

View File

@ -359,13 +359,12 @@ TEST_CASE("Websocket_no_ping_but_timeout", "[setPingTimeout]")
REQUIRE(webSocketClient.isClosed() == false); REQUIRE(webSocketClient.isClosed() == false);
REQUIRE(webSocketClient.closedDueToPingTimeout() == false); REQUIRE(webSocketClient.closedDueToPingTimeout() == false);
ix::msleep(300); ix::msleep(200);
// Here we test ping timeout, timeout // Here we test ping timeout, timeout
REQUIRE(serverReceivedPingMessages == 0); REQUIRE(serverReceivedPingMessages == 0);
REQUIRE(webSocketClient.getReceivedPongMessages() == 0); REQUIRE(webSocketClient.getReceivedPongMessages() == 0);
// Ensure client close was by ping timeout // Ensure client close was not by ping timeout
ix::msleep(300);
REQUIRE(webSocketClient.isClosed() == true); REQUIRE(webSocketClient.isClosed() == true);
REQUIRE(webSocketClient.closedDueToPingTimeout() == true); REQUIRE(webSocketClient.closedDueToPingTimeout() == true);
@ -416,8 +415,7 @@ TEST_CASE("Websocket_ping_timeout", "[setPingTimeout]")
// Here we test ping timeout, timeout // Here we test ping timeout, timeout
REQUIRE(serverReceivedPingMessages == 1); REQUIRE(serverReceivedPingMessages == 1);
REQUIRE(webSocketClient.getReceivedPongMessages() == 0); REQUIRE(webSocketClient.getReceivedPongMessages() == 0);
// Ensure client close was by ping timeout // Ensure client close was not by ping timeout
ix::msleep(300);
REQUIRE(webSocketClient.isClosed() == true); REQUIRE(webSocketClient.isClosed() == true);
REQUIRE(webSocketClient.closedDueToPingTimeout() == true); REQUIRE(webSocketClient.closedDueToPingTimeout() == true);

View File

@ -62,33 +62,33 @@ namespace
std::stringstream ss; std::stringstream ss;
if (messageType == ix::WebSocketMessageType::Open) if (messageType == ix::WebSocketMessageType::Open)
{ {
log("TestConnectionDisconnection: connected !"); log("cmd_websocket_satori_chat: connected !");
} }
else if (messageType == ix::WebSocketMessageType::Close) else if (messageType == ix::WebSocketMessageType::Close)
{ {
log("TestConnectionDisconnection: disconnected !"); log("cmd_websocket_satori_chat: disconnected !");
} }
else if (messageType == ix::WebSocketMessageType::Error) else if (messageType == ix::WebSocketMessageType::Error)
{ {
ss << "TestConnectionDisconnection: Error! "; ss << "cmd_websocket_satori_chat: Error! ";
ss << error.reason; ss << error.reason;
log(ss.str()); log(ss.str());
} }
else if (messageType == ix::WebSocketMessageType::Message) else if (messageType == ix::WebSocketMessageType::Message)
{ {
log("TestConnectionDisconnection: received message.!"); log("cmd_websocket_satori_chat: received message.!");
} }
else if (messageType == ix::WebSocketMessageType::Ping) else if (messageType == ix::WebSocketMessageType::Ping)
{ {
log("TestConnectionDisconnection: received ping message.!"); log("cmd_websocket_satori_chat: received ping message.!");
} }
else if (messageType == ix::WebSocketMessageType::Pong) else if (messageType == ix::WebSocketMessageType::Pong)
{ {
log("TestConnectionDisconnection: received pong message.!"); log("cmd_websocket_satori_chat: received pong message.!");
} }
else if (messageType == ix::WebSocketMessageType::Fragment) else if (messageType == ix::WebSocketMessageType::Fragment)
{ {
log("TestConnectionDisconnection: received fragment.!"); log("cmd_websocket_satori_chat: received fragment.!");
} }
else else
{ {
@ -96,12 +96,6 @@ namespace
} }
}); });
_webSocket.enableAutomaticReconnection();
REQUIRE(_webSocket.isAutomaticReconnectionEnabled() == true);
_webSocket.disableAutomaticReconnection();
REQUIRE(_webSocket.isAutomaticReconnectionEnabled() == false);
// Start the connection // Start the connection
_webSocket.start(); _webSocket.start();
} }
@ -129,38 +123,26 @@ TEST_CASE("websocket_connections", "[websocket]")
SECTION("Try to connect and disconnect with different timing, not enough time to succesfully connect") SECTION("Try to connect and disconnect with different timing, not enough time to succesfully connect")
{ {
IXWebSocketTestConnectionDisconnection test; IXWebSocketTestConnectionDisconnection test;
log(std::string("50 Runs"));
for (int i = 0; i < 50; ++i) for (int i = 0; i < 50; ++i)
{ {
log(std::string("Run: ") + std::to_string(i)); log(std::string("Run: ") + std::to_string(i));
test.start(WEBSOCKET_DOT_ORG_URL); test.start(WEBSOCKET_DOT_ORG_URL);
log(std::string("Sleeping"));
ix::msleep(i); ix::msleep(i);
log(std::string("Stopping"));
test.stop(); test.stop();
} }
} }
// This test breaks on travis CI - Ubuntu Xenial + gcc + tsan // This test breaks on travis CI - Ubuntu Xenial + gcc + tsan
// We should fix this. // We should fix this.
SECTION("Try to connect and disconnect with different timing, from not enough time to successfull connect") /*SECTION("Try to connect and disconnect with different timing, from not enough time to successfull connect")
{ {
IXWebSocketTestConnectionDisconnection test; IXWebSocketTestConnectionDisconnection test;
log(std::string("20 Runs"));
for (int i = 0; i < 20; ++i) for (int i = 0; i < 20; ++i)
{ {
log(std::string("Run: ") + std::to_string(i)); log(std::string("Run: ") + std::to_string(i));
test.start(WEBSOCKET_DOT_ORG_URL); test.start(WEBSOCKET_DOT_ORG_URL);
log(std::string("Sleeping"));
ix::msleep(i*50); ix::msleep(i*50);
log(std::string("Stopping"));
test.stop(); test.stop();
} }
} }*/
} }

View File

@ -1,4 +1,10 @@
#!/usr/bin/env python2.7 #!/usr/bin/env python2.7
'''
Windows notes:
generator = '-G"NMake Makefiles"'
make = 'nmake'
testBinary ='ixwebsocket_unittest.exe'
'''
from __future__ import print_function from __future__ import print_function
@ -97,8 +103,7 @@ def runCMake(sanitizer, buildDir):
if platform.system() == 'Windows': if platform.system() == 'Windows':
#generator = '"NMake Makefiles"' #generator = '"NMake Makefiles"'
#generator = '"Visual Studio 16 2019"' generator = '"Visual Studio 16 2019"'
generator = '"Visual Studio 15 2017"'
else: else:
generator = '"Unix Makefiles"' generator = '"Unix Makefiles"'
@ -269,12 +274,12 @@ def executeJob(job):
return job return job
def executeJobs(jobs, cpuCount): def executeJobs(jobs):
'''Execute a list of job concurrently on multiple CPU/cores''' '''Execute a list of job concurrently on multiple CPU/cores'''
print('Using {} cores to execute the unittest'.format(cpuCount)) poolSize = multiprocessing.cpu_count()
pool = multiprocessing.Pool(cpuCount) pool = multiprocessing.Pool(poolSize)
results = pool.map(executeJob, jobs) results = pool.map(executeJob, jobs)
pool.close() pool.close()
pool.join() pool.join()
@ -346,22 +351,26 @@ def generateXmlOutput(results, xmlOutput, testRunName, runTime):
f.write(content.encode('utf-8')) f.write(content.encode('utf-8'))
def run(testName, buildDir, sanitizer, xmlOutput, def run(testName, buildDir, sanitizer, xmlOutput, testRunName, buildOnly, useLLDB):
testRunName, buildOnly, useLLDB, cpuCount):
'''Main driver. Run cmake, compiles, execute and validate the testsuite.''' '''Main driver. Run cmake, compiles, execute and validate the testsuite.'''
# gen build files with CMake # gen build files with CMake
runCMake(sanitizer, buildDir) runCMake(sanitizer, buildDir)
if platform.system() == 'Linux':
# build with make -j
runCommand('make -C {} -j 2'.format(buildDir))
elif platform.system() == 'Darwin':
# build with make # build with make
runCommand('make -C {} -j 8'.format(buildDir)) #makeCmd = 'cmake --build '
else: #jobs = '-j8'
# build with cmake on recent
runCommand('cmake --build --parallel {}'.format(buildDir)) #if platform.system() == 'Windows':
# makeCmd = 'nmake'
# nmake does not have a -j option
# jobs = ''
#runCommand('{} -C {} {}'.format(makeCmd, buildDir, jobs))
# build with cmake
runCommand('cmake --build ' + buildDir)
if buildOnly: if buildOnly:
return return
@ -406,7 +415,7 @@ def run(testName, buildDir, sanitizer, xmlOutput,
}) })
start = time.time() start = time.time()
results = executeJobs(jobs, cpuCount) results = executeJobs(jobs)
runTime = time.time() - start runTime = time.time() - start
generateXmlOutput(results, xmlOutput, testRunName, runTime) generateXmlOutput(results, xmlOutput, testRunName, runTime)
@ -456,8 +465,6 @@ def main():
help='Run the test through lldb.') help='Run the test through lldb.')
parser.add_argument('--run_name', '-n', parser.add_argument('--run_name', '-n',
help='Name of the test run.') help='Name of the test run.')
parser.add_argument('--cpu_count', '-j', type=int, default=multiprocessing.cpu_count(),
help='Number of cpus to use for running the tests.')
args = parser.parse_args() args = parser.parse_args()
@ -503,7 +510,7 @@ def main():
args.lldb = False args.lldb = False
return run(args.test, buildDir, sanitizer, xmlOutput, return run(args.test, buildDir, sanitizer, xmlOutput,
testRunName, args.build_only, args.lldb, args.cpu_count) testRunName, args.build_only, args.lldb)
if __name__ == '__main__': if __name__ == '__main__':

View File

@ -61,4 +61,4 @@ sleep 2
kill `cat /tmp/ws_test/pidfile.transfer` kill `cat /tmp/ws_test/pidfile.transfer`
kill `cat /tmp/ws_test/pidfile.receive` kill `cat /tmp/ws_test/pidfile.receive`
kill `cat /tmp/ws_test/pidfile.send` kill `cat /tmp/ws_test/pidfile.send`
exit 0