Isolate received savegame path test

Author: DevOpsOfChaos

tests/s25Main/network/testGameClient.cpp

@@ -79,6 +79,27 @@ class CustomUserMapFolderFixture
     }
 };
 
+void AdvanceClientToMapInfoRequest(GameClient& client, GameMessageInterface& clientMsgInterface,
+                                   MockClientInterface& callbacks, const std::string& password,
+                                   ServerType serverType, int serverPort)
+{
+    mock::sequence s;
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::Initiated).once();
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::VerifyServer).once();
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::QueryPw).once();
+    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::QueryMapInfo).once();
+
+    BOOST_TEST_REQUIRE(client.Connect("localhost", password, serverType, serverPort, false, false));
+    clientMsgInterface.OnGameMessage(GameMessage_Player_Id(1));
+    client.GetMainPlayer().sendQueue.clear();
+
+    clientMsgInterface.OnGameMessage(GameMessage_Server_TypeOK(GameMessage_Server_TypeOK::StatusCode::Ok, ""));
+    client.GetMainPlayer().sendQueue.clear();
+
+    clientMsgInterface.OnGameMessage(GameMessage_Server_Password("true"));
+    client.GetMainPlayer().sendQueue.clear();
+}
+
 } // namespace
 
 BOOST_FIXTURE_TEST_SUITE(GameClientTests, CustomUserMapFolderFixture)
@@ -246,6 +267,9 @@ BOOST_DATA_TEST_CASE(ClientFollowsConnectProtocol, usesLuaScriptValues, usesLuaS
 
 BOOST_AUTO_TEST_CASE(ClientStoresReceivedSavegamesInSaveFolder)
 {
+    rttr::test::TmpFolder testUserData;
+    rttr::test::ConfigOverride userDataOverride("USERDATA", testUserData);
+
     GameClient client;
     GameMessageInterface& clientMsgInterface = client;
     MockClientInterface callbacks;
@@ -256,26 +280,8 @@ BOOST_AUTO_TEST_CASE(ClientStoresReceivedSavegamesInSaveFolder)
     const auto pw = rttr::test::randString(10);
     const auto serverType = rttr::test::randomEnum<ServerType>();
 
-    mock::sequence s;
-    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::Initiated).once();
-    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::VerifyServer).once();
-    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::QueryPw).once();
-    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::QueryMapInfo).once();
-    MOCK_EXPECT(callbacks.CI_NextConnectState).in(s).with(ConnectState::ReceiveMap).once();
-
-    BOOST_TEST_REQUIRE(client.Connect("localhost", pw, serverType, serverPort, false, false));
-    clientMsgInterface.OnGameMessage(GameMessage_Player_Id(1));
-    BOOST_TEST_REQUIRE(boost::dynamic_pointer_cast<GameMessage_Server_Type>(client.GetMainPlayer().sendQueue.pop()));
-
-    clientMsgInterface.OnGameMessage(GameMessage_Server_TypeOK(GameMessage_Server_TypeOK::StatusCode::Ok, ""));
-    BOOST_TEST_REQUIRE(boost::dynamic_pointer_cast<GameMessage_Server_Password>(client.GetMainPlayer().sendQueue.pop()));
-
-    clientMsgInterface.OnGameMessage(GameMessage_Server_Password("true"));
-    BOOST_TEST_REQUIRE(dynamic_cast<GameMessage_Player_Name*>(client.GetMainPlayer().sendQueue.pop().get()));
-    BOOST_TEST_REQUIRE(dynamic_cast<GameMessage_Player_Portrait*>(client.GetMainPlayer().sendQueue.pop().get()));
-    const auto infoRequest = boost::dynamic_pointer_cast<GameMessage_MapRequest>(client.GetMainPlayer().sendQueue.pop());
-    BOOST_TEST_REQUIRE(infoRequest);
-    BOOST_TEST(infoRequest->requestInfo);
+    MOCK_EXPECT(callbacks.CI_NextConnectState).with(ConnectState::ReceiveMap).once();
+    AdvanceClientToMapInfoRequest(client, clientMsgInterface, callbacks, pw, serverType, serverPort);
 
     const boost::filesystem::path testMapPath =
       rttr::test::rttrBaseDir / "tests" / "testData" / "maps" / "LuaFunctions.SWD";
@@ -288,11 +294,14 @@ BOOST_AUTO_TEST_CASE(ClientStoresReceivedSavegamesInSaveFolder)
 
     const auto expectedSavePath = RTTRCONFIG.ExpandPath(s25::folders::save) / "received.sav";
     const auto unexpectedMapsPath = RTTRCONFIG.ExpandPath(s25::folders::mapsPlayed) / "received.sav";
+    BOOST_TEST(expectedSavePath.parent_path() == testUserData / "SAVE");
+    BOOST_TEST(unexpectedMapsPath.parent_path() == testUserData / "MAPS");
     BOOST_TEST(client.GetMapType() == MapType::Savegame);
     BOOST_TEST(client.GetMapPath() == expectedSavePath);
     BOOST_TEST(client.GetMapPath() != unexpectedMapsPath);
 
-    const auto transferRequest = boost::dynamic_pointer_cast<GameMessage_MapRequest>(client.GetMainPlayer().sendQueue.pop());
+    const auto transferRequest =
+      boost::dynamic_pointer_cast<GameMessage_MapRequest>(client.GetMainPlayer().sendQueue.pop());
     BOOST_TEST_REQUIRE(transferRequest);
     BOOST_TEST(!transferRequest->requestInfo);