From 2a7933898601e63793eac3c33eb8407aaa52f96d Mon Sep 17 00:00:00 2001 From: Pablo Andres Fuente Date: Fri, 20 Sep 2024 23:00:41 -0300 Subject: [PATCH] Add unit tests for TCPServer This PR aims to help "fix" #43440 --- tests/core/io/test_tcp_server.h | 209 ++++++++++++++++++++++++++++++++ tests/test_main.cpp | 1 + 2 files changed, 210 insertions(+) create mode 100644 tests/core/io/test_tcp_server.h diff --git a/tests/core/io/test_tcp_server.h b/tests/core/io/test_tcp_server.h new file mode 100644 index 00000000000..631599f370a --- /dev/null +++ b/tests/core/io/test_tcp_server.h @@ -0,0 +1,209 @@ +/**************************************************************************/ +/* test_tcp_server.h */ +/**************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/**************************************************************************/ +/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ +/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ +/* */ +/* Permission is hereby granted, free of charge, to any person obtaining */ +/* a copy of this software and associated documentation files (the */ +/* "Software"), to deal in the Software without restriction, including */ +/* without limitation the rights to use, copy, modify, merge, publish, */ +/* distribute, sublicense, and/or sell copies of the Software, and to */ +/* permit persons to whom the Software is furnished to do so, subject to */ +/* the following conditions: */ +/* */ +/* The above copyright notice and this permission notice shall be */ +/* included in all copies or substantial portions of the Software. */ +/* */ +/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ +/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ +/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ +/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ +/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ +/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ +/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/**************************************************************************/ + +#ifndef TEST_TCP_SERVER_H +#define TEST_TCP_SERVER_H + +#include "core/io/stream_peer_tcp.h" +#include "core/io/tcp_server.h" +#include "tests/test_macros.h" + +namespace TestTCPServer { + +const int port = 12345; +const IPAddress localhost("127.0.0.1"); + +Ref create_server(const IPAddress &p_address, int p_port) { + Ref server; + server.instantiate(); + + REQUIRE_EQ(server->listen(port, localhost), Error::OK); + REQUIRE(server->is_listening()); + CHECK_FALSE(server->is_connection_available()); + + return server; +} + +Ref create_client(const IPAddress &p_address, int p_port) { + Ref client; + client.instantiate(); + + REQUIRE_EQ(client->connect_to_host(localhost, port), Error::OK); + CHECK_EQ(client->get_connected_host(), localhost); + CHECK_EQ(client->get_connected_port(), port); + CHECK_EQ(client->get_status(), StreamPeerTCP::STATUS_CONNECTING); + + return client; +} + +Ref accept_connection(Ref &server) { + REQUIRE(server->is_connection_available()); + Ref client_from_server = server->take_connection(); + REQUIRE_MESSAGE(client_from_server.is_valid(), "A Stream Peer TCP from the TCP Server should not be a null pointer."); + CHECK_EQ(client_from_server->get_connected_host(), localhost); + CHECK_EQ(client_from_server->get_status(), StreamPeerTCP::STATUS_CONNECTED); + + return client_from_server; +} + +TEST_CASE("[TCPServer] Instantiation") { + Ref server; + server.instantiate(); + + REQUIRE_MESSAGE(server.is_valid(), "A TCP Server created should not be a null pointer."); + CHECK_EQ(false, server->is_listening()); +} + +TEST_CASE("[TCPServer] Accept a connection and receive/send data") { + Ref server = create_server(localhost, port); + Ref client = create_client(localhost, port); + + // Required to get the connection properly established. + OS::get_singleton()->delay_usec(500000); + + Ref client_from_server = accept_connection(server); + + REQUIRE_EQ(client->poll(), Error::OK); + CHECK_EQ(client->get_status(), StreamPeerTCP::STATUS_CONNECTED); + + // Sending data from client to server. + String hello_world = "Hello World!"; + client->put_string(hello_world); + CHECK_EQ(client_from_server->get_string(), hello_world); + + // Sending data from server to client. + float pi = 3.1415; + client_from_server->put_float(pi); + CHECK_EQ(client->get_float(), pi); + + client->disconnect_from_host(); + server->stop(); + CHECK_FALSE(server->is_listening()); +} + +TEST_CASE("[TCPServer] Handle multiple clients at the same time") { + Ref server = create_server(localhost, port); + + Vector> clients; + for (int i = 0; i < 5; i++) { + clients.push_back(create_client(localhost, port)); + } + + // Required to get the connection properly established. + OS::get_singleton()->delay_usec(500000); + + Vector> clients_from_server; + for (int i = 0; i < clients.size(); i++) { + clients_from_server.push_back(accept_connection(server)); + } + + // Calling poll() to update client status. + for (Ref &c : clients) { + REQUIRE_EQ(c->poll(), Error::OK); + } + + // Sending data from each client to server. + for (int i = 0; i < clients.size(); i++) { + String hello_client = "Hello " + itos(i); + clients[i]->put_string(hello_client); + CHECK_EQ(clients_from_server[i]->get_string(), hello_client); + } + + for (Ref &c : clients) { + c->disconnect_from_host(); + } + server->stop(); +} + +TEST_CASE("[TCPServer] When stopped shouldn't accept new connections") { + Ref server = create_server(localhost, port); + Ref client = create_client(localhost, port); + + // Required to get the connection properly established. + OS::get_singleton()->delay_usec(500000); + + Ref client_from_server = accept_connection(server); + + REQUIRE_EQ(client->poll(), Error::OK); + CHECK_EQ(client->get_status(), StreamPeerTCP::STATUS_CONNECTED); + + // Sending data from client to server. + String hello_world = "Hello World!"; + client->put_string(hello_world); + CHECK_EQ(client_from_server->get_string(), hello_world); + + client->disconnect_from_host(); + server->stop(); + CHECK_FALSE(server->is_listening()); + + Ref new_client = create_client(localhost, port); + + // Required to get the connection properly established. + OS::get_singleton()->delay_usec(500000); + + CHECK_FALSE(server->is_connection_available()); + + Error err = new_client->poll(); + REQUIRE_MESSAGE((err == Error::OK || err == Error::ERR_CONNECTION_ERROR), "Poll should return OK or ERR_CONNECTION_ERROR."); + StreamPeerTCP::Status status = new_client->get_status(); + CHECK_MESSAGE((status == StreamPeerTCP::STATUS_CONNECTING || status == StreamPeerTCP::STATUS_ERROR), "Status should be STATUS_CONNECTING or STATUS_ERROR."); + + new_client->disconnect_from_host(); +} + +TEST_CASE("[TCPServer] Should disconnect client") { + Ref server = create_server(localhost, port); + Ref client = create_client(localhost, port); + + // Required to get the connection properly established. + OS::get_singleton()->delay_usec(500000); + + Ref client_from_server = accept_connection(server); + + REQUIRE_EQ(client->poll(), Error::OK); + CHECK_EQ(client->get_status(), StreamPeerTCP::STATUS_CONNECTED); + + // Sending data from client to server. + String hello_world = "Hello World!"; + client->put_string(hello_world); + CHECK_EQ(client_from_server->get_string(), hello_world); + + client_from_server->disconnect_from_host(); + server->stop(); + CHECK_FALSE(server->is_listening()); + + client->put_string(hello_world); + REQUIRE_EQ(client->poll(), Error::OK); + CHECK_EQ(client->get_status(), StreamPeerTCP::STATUS_NONE); +} + +} // namespace TestTCPServer + +#endif // TEST_TCP_SERVER_H diff --git a/tests/test_main.cpp b/tests/test_main.cpp index 12ff3ad4bc9..a8865207b1d 100644 --- a/tests/test_main.cpp +++ b/tests/test_main.cpp @@ -52,6 +52,7 @@ #include "tests/core/io/test_marshalls.h" #include "tests/core/io/test_pck_packer.h" #include "tests/core/io/test_resource.h" +#include "tests/core/io/test_tcp_server.h" #include "tests/core/io/test_xml_parser.h" #include "tests/core/math/test_aabb.h" #include "tests/core/math/test_astar.h"