source/network/tests/test_Net.h

   1 /* Copyright (C) 2022 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "lib/self_test.h"
  19
  20 #include "graphics/TerrainTextureManager.h"
  21 #include "lib/external_libraries/enet.h"
  22 #include "lib/external_libraries/libsdl.h"
  23 #include "lib/tex/tex.h"
  24 #include "network/NetServer.h"
  25 #include "network/NetClient.h"
  26 #include "network/NetMessage.h"
  27 #include "network/NetMessages.h"
  28 #include "ps/CLogger.h"
  29 #include "ps/Game.h"
  30 #include "ps/Filesystem.h"
  31 #include "ps/Loader.h"
  32 #include "ps/XML/Xeromyces.h"
  33 #include "scriptinterface/ScriptInterface.h"
  34 #include "simulation2/Simulation2.h"
  35 #include "simulation2/system/TurnManager.h"
  36
  37 class TestNetComms : public CxxTest::TestSuite
  38 {
  39 public:
  40         void setUp()
  41         {
  42                 g_VFS = CreateVfs();
  43                 TS_ASSERT_OK(g_VFS->Mount(L"", DataDir() / "mods" / "public" / "", VFS_MOUNT_MUST_EXIST));
  44                 TS_ASSERT_OK(g_VFS->Mount(L"cache", DataDir() / "_testcache" / "", 0, VFS_MAX_PRIORITY));
  45                 CXeromyces::Startup();
  46
  47                 enet_initialize();
  48         }
  49
  50         void tearDown()
  51         {
  52                 enet_deinitialize();
  53
  54                 CXeromyces::Terminate();
  55                 g_VFS.reset();
  56                 DeleteDirectory(DataDir()/"_testcache");
  57         }
  58
  59         bool clients_are_all(const std::vector<CNetClient*>& clients, uint state)
  60         {
  61                 for (size_t j = 0; j < clients.size(); ++j)
  62                         if (clients[j]->GetCurrState() != state)
  63                                 return false;
  64                 return true;
  65         }
  66
  67         void connect(CNetServer& server, const std::vector<CNetClient*>& clients)
  68         {
  69                 TS_ASSERT(server.SetupConnection(PS_DEFAULT_PORT));
  70                 for (CNetClient* client: clients)
  71                 {
  72                         client->SetupServerData("127.0.0.1", PS_DEFAULT_PORT, false);
  73                         TS_ASSERT(client->SetupConnection(nullptr));
  74                 }
  75
  76                 for (size_t i = 0; ; ++i)
  77                 {
  78 //                      debug_printf(".");
  79                         for (size_t j = 0; j < clients.size(); ++j)
  80                                 clients[j]->Poll();
  81
  82                         if (clients_are_all(clients, NCS_PREGAME))
  83                                 break;
  84
  85                         if (i > 20)
  86                         {
  87                                 TS_FAIL("connection timeout");
  88                                 break;
  89                         }
  90
  91                         SDL_Delay(100);
  92                 }
  93         }
  94
  95 #if 0
  96         void disconnect(CNetServer& server, const std::vector<CNetClient*>& clients)
  97         {
  98                 for (size_t i = 0; ; ++i)
  99                 {
 100 //                      debug_printf(".");
 101                         server.Poll();
 102                         for (size_t j = 0; j < clients.size(); ++j)
 103                                 clients[j]->Poll();
 104
 105                         if (server.GetState() == SERVER_STATE_UNCONNECTED && clients_are_all(clients, NCS_UNCONNECTED))
 106                                 break;
 107
 108                         if (i > 20)
 109                         {
 110                                 TS_FAIL("disconnection timeout");
 111                                 break;
 112                         }
 113
 114                         SDL_Delay(100);
 115                 }
 116         }
 117 #endif
 118
 119         void wait(const std::vector<CNetClient*>& clients, size_t msecs)
 120         {
 121                 for (size_t i = 0; i < msecs/10; ++i)
 122                 {
 123                         for (size_t j = 0; j < clients.size(); ++j)
 124                                 clients[j]->Poll();
 125
 126                         SDL_Delay(10);
 127                 }
 128         }
 129
 130         void test_basic_DISABLED()
 131         {
 132                 // This doesn't actually test much, it just runs a very quick multiplayer game
 133                 // and prints a load of debug output so you can see if anything funny's going on
 134
 135                 ScriptInterface scriptInterface("Engine", "Test", g_ScriptContext);
 136                 ScriptRequest rq(scriptInterface);
 137
 138                 TestStdoutLogger logger;
 139
 140                 std::vector<CNetClient*> clients;
 141
 142                 CGame client1Game(false);
 143                 CGame client2Game(false);
 144                 CGame client3Game(false);
 145
 146                 CNetServer server("no_secret");
 147
 148                 JS::RootedValue attrs(rq.cx);
 149                 Script::CreateObject(
 150                         rq,
 151                         &attrs,
 152                         "mapType", "scenario",
 153                         "map", "maps/scenarios/Saharan Oases",
 154                         "mapPath", "maps/scenarios/",
 155                         "thing", "example");
 156
 157                 server.UpdateInitAttributes(&attrs, scriptInterface);
 158
 159                 CNetClient client1(&client1Game);
 160                 CNetClient client2(&client2Game);
 161                 CNetClient client3(&client3Game);
 162
 163                 clients.push_back(&client1);
 164                 clients.push_back(&client2);
 165                 clients.push_back(&client3);
 166
 167                 connect(server, clients);
 168                 debug_printf("%s", client1.TestReadGuiMessages().c_str());
 169
 170                 server.StartGame();
 171                 SDL_Delay(100);
 172                 for (size_t j = 0; j < clients.size(); ++j)
 173                 {
 174                         clients[j]->Poll();
 175                         TS_ASSERT_OK(LDR_NonprogressiveLoad());
 176                         clients[j]->LoadFinished();
 177                 }
 178
 179                 wait(clients, 100);
 180
 181                 {
 182                         JS::RootedValue cmd(rq.cx);
 183                         Script::CreateObject(
 184                                 rq,
 185                                 &cmd,
 186                                 "type", "debug-print",
 187                                 "message", "[>>> client1 test sim command]\\n");
 188                         client1Game.GetTurnManager()->PostCommand(cmd);
 189                 }
 190
 191                 {
 192                         JS::RootedValue cmd(rq.cx);
 193                         Script::CreateObject(
 194                                 rq,
 195                                 &cmd,
 196                                 "type", "debug-print",
 197                                 "message", "[>>> client2 test sim command]\\n");
 198                         client2Game.GetTurnManager()->PostCommand(cmd);
 199                 }
 200
 201                 wait(clients, 100);
 202                 client1Game.GetTurnManager()->Update(1.0f, 1);
 203                 client2Game.GetTurnManager()->Update(1.0f, 1);
 204                 client3Game.GetTurnManager()->Update(1.0f, 1);
 205                 wait(clients, 100);
 206                 client1Game.GetTurnManager()->Update(1.0f, 1);
 207                 client2Game.GetTurnManager()->Update(1.0f, 1);
 208                 client3Game.GetTurnManager()->Update(1.0f, 1);
 209                 wait(clients, 100);
 210         }
 211
 212         void test_rejoin_DISABLED()
 213         {
 214                 ScriptInterface scriptInterface("Engine", "Test", g_ScriptContext);
 215                 ScriptRequest rq(scriptInterface);
 216
 217                 TestStdoutLogger logger;
 218
 219                 std::vector<CNetClient*> clients;
 220
 221                 CGame client1Game(false);
 222                 CGame client2Game(false);
 223                 CGame client3Game(false);
 224
 225                 CNetServer server("no_secret");
 226
 227                 JS::RootedValue attrs(rq.cx);
 228                 Script::CreateObject(
 229                         rq,
 230                         &attrs,
 231                         "mapType", "scenario",
 232                         "map", "maps/scenarios/Saharan Oases",
 233                         "mapPath", "maps/scenarios/",
 234                         "thing", "example");
 235
 236                 server.UpdateInitAttributes(&attrs, scriptInterface);
 237
 238                 CNetClient client1(&client1Game);
 239                 CNetClient client2(&client2Game);
 240                 CNetClient client3(&client3Game);
 241
 242                 client1.SetUserName(L"alice");
 243                 client2.SetUserName(L"bob");
 244                 client3.SetUserName(L"charlie");
 245
 246                 clients.push_back(&client1);
 247                 clients.push_back(&client2);
 248                 clients.push_back(&client3);
 249
 250                 connect(server, clients);
 251                 debug_printf("%s", client1.TestReadGuiMessages().c_str());
 252
 253                 server.StartGame();
 254                 SDL_Delay(100);
 255                 for (size_t j = 0; j < clients.size(); ++j)
 256                 {
 257                         clients[j]->Poll();
 258                         TS_ASSERT_OK(LDR_NonprogressiveLoad());
 259                         clients[j]->LoadFinished();
 260                 }
 261
 262                 wait(clients, 100);
 263
 264                 {
 265                         JS::RootedValue cmd(rq.cx);
 266                         Script::CreateObject(
 267                                 rq,
 268                                 &cmd,
 269                                 "type", "debug-print",
 270                                 "message", "[>>> client1 test sim command 1]\\n");
 271
 272                         client1Game.GetTurnManager()->PostCommand(cmd);
 273                 }
 274
 275                 wait(clients, 100);
 276                 client1Game.GetTurnManager()->Update(1.0f, 1);
 277                 client2Game.GetTurnManager()->Update(1.0f, 1);
 278                 client3Game.GetTurnManager()->Update(1.0f, 1);
 279                 wait(clients, 100);
 280
 281                 {
 282                         JS::RootedValue cmd(rq.cx);
 283                         Script::CreateObject(
 284                                 rq,
 285                                 &cmd,
 286                                 "type", "debug-print",
 287                                 "message", "[>>> client1 test sim command 2]\\n");
 288                         client1Game.GetTurnManager()->PostCommand(cmd);
 289                 }
 290
 291                 debug_printf("==== Disconnecting client 2\n");
 292
 293                 client2.DestroyConnection();
 294                 clients.erase(clients.begin()+1);
 295
 296                 debug_printf("==== Connecting client 2B\n");
 297
 298                 CGame client2BGame(false);
 299                 CNetClient client2B(&client2BGame);
 300                 client2B.SetUserName(L"bob");
 301                 clients.push_back(&client2B);
 302
 303                 client2B.SetupServerData("127.0.0.1", PS_DEFAULT_PORT, false);
 304                 TS_ASSERT(client2B.SetupConnection(nullptr));
 305
 306                 for (size_t i = 0; ; ++i)
 307                 {
 308                         debug_printf("[%u]\n", client2B.GetCurrState());
 309                         client2B.Poll();
 310                         if (client2B.GetCurrState() == NCS_PREGAME)
 311                                 break;
 312
 313                         if (client2B.GetCurrState() == NCS_UNCONNECTED)
 314                         {
 315                                 TS_FAIL("connection rejected");
 316                                 return;
 317                         }
 318
 319                         if (i > 20)
 320                         {
 321                                 TS_FAIL("connection timeout");
 322                                 return;
 323                         }
 324
 325                         SDL_Delay(100);
 326                 }
 327
 328                 wait(clients, 100);
 329
 330                 client1Game.GetTurnManager()->Update(1.0f, 1);
 331                 client3Game.GetTurnManager()->Update(1.0f, 1);
 332                 wait(clients, 100);
 333                 server.SetTurnLength(100);
 334                 client1Game.GetTurnManager()->Update(1.0f, 1);
 335                 client3Game.GetTurnManager()->Update(1.0f, 1);
 336                 wait(clients, 100);
 337
 338                 // (This SetTurnLength thing doesn't actually detect errors unless you change
 339                 // CTurnManager::TurnNeedsFullHash to always return true)
 340
 341                 {
 342                         JS::RootedValue cmd(rq.cx);
 343                         Script::CreateObject(
 344                                 rq,
 345                                 &cmd,
 346                                 "type", "debug-print",
 347                                 "message", "[>>> client1 test sim command 3]\\n");
 348                         client1Game.GetTurnManager()->PostCommand(cmd);
 349                 }
 350
 351
 352                 clients[2]->Poll();
 353                 TS_ASSERT_OK(LDR_NonprogressiveLoad());
 354                 clients[2]->LoadFinished();
 355
 356                 wait(clients, 100);
 357
 358                 {
 359                         JS::RootedValue cmd(rq.cx);
 360                         Script::CreateObject(
 361                                 rq,
 362                                 &cmd,
 363                                 "type", "debug-print",
 364                                 "message", "[>>> client1 test sim command 4]\\n");
 365
 366                         client1Game.GetTurnManager()->PostCommand(cmd);
 367                 }
 368
 369                 for (size_t i = 0; i < 3; ++i)
 370                 {
 371                         client1Game.GetTurnManager()->Update(1.0f, 1);
 372                         client2BGame.GetTurnManager()->Update(1.0f, 1);
 373                         client3Game.GetTurnManager()->Update(1.0f, 1);
 374                         wait(clients, 100);
 375                 }
 376         }
 377 };