Test for OpenEnroth#2116 & some cleanup in EngineController (OpenEnroth#2264)

* Activate characters in tests with key presses

* Added a test for OpenEnroth#2116

Author: captainurist

src/Engine/Components/Control/EngineController.cpp

@@ -26,6 +26,7 @@
 
 #include "Library/FileSystem/Memory/MemoryFileSystem.h"
 #include "Library/Platform/Application/PlatformApplication.h"
+#include "Library/Platform/Interface/PlatformEnumFunctions.h"
 #include "Library/Platform/Interface/PlatformEvents.h"
 
 #include "Utility/Exception.h"
@@ -149,38 +150,23 @@ void EngineController::pressGuiButton(std::string_view buttonId) {
 }
 
 void EngineController::goToGame() {
-    ThrowingTicker ticker(this, "Couldn't return to game");
-
-    // Skip movies.
-    while (current_screen_type == SCREEN_VIDEO) {
-        pressAndReleaseKey(PlatformKey::KEY_ESCAPE);
-        ticker.tick();
-    }
-
-    // Can't always leave key settings menu by pressing ESC, so need custom handling.
-    if (current_screen_type == SCREEN_KEYBOARD_OPTIONS) {
-        pressGuiButton("KeyBinding_Default");
-        ticker.tick();
-    }
-
-    // Leave to game screen if we're in the game, or to main menu if we're in menus.
-    while (current_screen_type != SCREEN_GAME && GetCurrentMenuID() != MENU_MAIN) {
-        pressAndReleaseKey(PlatformKey::KEY_ESCAPE);
-        ticker.tick(2); // Somehow tick(1) is not enough when we're trying to leave the game loading menu.
-    }
-
-    // If game is starting up - wait for main menu to appear.
-    while (GetCurrentMenuID() == MENU_MAIN && lWindowList.empty())
-        ticker.tick();
+    goToGameOrMainMenu();
+    if (GetCurrentMenuID() == MENU_MAIN)
+        throw Exception("Can't go to game from the main menu");
 }
 
 void EngineController::goToInventory(int characterIndex) {
+    assert(characterIndex >= 1 && characterIndex <= 4);
+
     goToGame();
 
-    if (GetCurrentMenuID() != MENU_NONE)
-        throw Exception("Can't go to inventory from the main menu");
+    if (pParty->activeCharacterIndex() != characterIndex) {
+        pressAndReleaseKey(platformKeyForDigit(characterIndex));
+        tick(1);
+        if (pParty->activeCharacterIndex() != characterIndex)
+            throw Exception("Couldn't activate character #{}", characterIndex);
+    }
 
-    pParty->setActiveCharacterIndex(characterIndex);
     pressAndReleaseKey(PlatformKey::KEY_I);
     tick(2); // Need two ticks for inventory to be shown.
 
@@ -189,14 +175,13 @@ void EngineController::goToInventory(int characterIndex) {
 }
 
 void EngineController::goToMainMenu() {
-    ThrowingTicker ticker(this, "Couldn't return to main menu");
-
-    goToGame();
-
+    goToGameOrMainMenu();
     if (GetCurrentMenuID() == MENU_MAIN)
         return;
     assert(GetCurrentMenuID() == MENU_NONE);
 
+    ThrowingTicker ticker(this, "Couldn't return to main menu");
+
     // Go to in-game menu.
     while (current_screen_type != SCREEN_MENU) {
         pressAndReleaseKey(PlatformKey::KEY_ESCAPE);
@@ -343,15 +328,22 @@ void EngineController::teleportTo(MapId map, Vec3f position, int viewYaw) {
 }
 
 void EngineController::castSpell(int characterIndex, SpellId spell) {
-    goToGame();
+    assert(characterIndex >= 1 && characterIndex <= 4);
 
+    goToGame();
     if (GetCurrentMenuID() != MENU_NONE)
         throw Exception("Can't cast a spell from the main menu");
 
+    if (pParty->activeCharacterIndex() != characterIndex) {
+        pressAndReleaseKey(platformKeyForDigit(characterIndex));
+        tick(1);
+        if (pParty->activeCharacterIndex() != characterIndex)
+            throw Exception("Couldn't activate character #{}", characterIndex);
+    }
+
     MagicSchool school = magicSchoolForSpell(spell);
     int index = spellIndexInMagicSchool(spell);
 
-    pParty->setActiveCharacterIndex(characterIndex);
     pressGuiButton("Game_CastSpell");
     tick(1);
     pressGuiButton(fmt::format("SpellBook_School{}", std::to_underlying(school)));
@@ -362,6 +354,32 @@ void EngineController::castSpell(int characterIndex, SpellId spell) {
     tick(1);
 }
 
+void EngineController::goToGameOrMainMenu() {
+    ThrowingTicker ticker(this, "Couldn't return to game");
+
+    // Skip movies.
+    while (current_screen_type == SCREEN_VIDEO) {
+        pressAndReleaseKey(PlatformKey::KEY_ESCAPE);
+        ticker.tick();
+    }
+
+    // Can't always leave key settings menu by pressing ESC, so need custom handling.
+    if (current_screen_type == SCREEN_KEYBOARD_OPTIONS) {
+        pressGuiButton("KeyBinding_Default");
+        ticker.tick();
+    }
+
+    // Leave to game screen if we're in the game, or to main menu if we're in menus.
+    while (current_screen_type != SCREEN_GAME && GetCurrentMenuID() != MENU_MAIN) {
+        pressAndReleaseKey(PlatformKey::KEY_ESCAPE);
+        ticker.tick(2); // Somehow tick(1) is not enough when we're trying to leave the game loading menu.
+    }
+
+    // If game is starting up - wait for main menu to appear.
+    while (GetCurrentMenuID() == MENU_MAIN && lWindowList.empty())
+        ticker.tick();
+}
+
 GUIButton *EngineController::existingButton(std::string_view buttonId) {
     auto findButton = [](std::string_view buttonId) -> GUIButton * {
         for (GUIWindow *window : lWindowList)

src/Engine/Components/Control/EngineController.h

@@ -58,6 +58,9 @@ class EngineController {
      */
     void pressGuiButton(std::string_view buttonId);
 
+    /**
+     * Closes all menus and goes to the game screen. Will fail if main menu is currently open.
+     */
     void goToGame();
 
     void goToInventory(int characterIndex);
@@ -120,6 +123,8 @@ class EngineController {
     void castSpell(int characterIndex, SpellId spell);
 
  private:
+    void goToGameOrMainMenu();
+
     GUIButton *existingButton(std::string_view buttonId);
 
  private:

src/Library/Platform/Interface/CMakeLists.txt

@@ -5,6 +5,7 @@ set(LIBRARY_PLATFORM_INTERFACE_SOURCES
 
 set(LIBRARY_PLATFORM_INTERFACE_HEADERS
         Platform.h
+        PlatformEnumFunctions.h
         PlatformEnums.h
         PlatformEventHandler.h
         PlatformEventLoop.h

src/Library/Platform/Interface/PlatformEnumFunctions.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include <cassert>
+#include <utility>
+
+#include "PlatformEnums.h"
+
+inline PlatformKey platformKeyForDigit(int digit) {
+    assert(digit >= 0 && digit <= 9);
+
+    return static_cast<PlatformKey>(std::to_underlying(PlatformKey::KEY_DIGIT_0) + digit);
+}

test/Bin/GameTest/GameTests_2000.cpp

@@ -318,6 +318,45 @@ GAME_TEST(Issues, Issue2109) {
     EXPECT_LE(damageRange[1], 5);
 }
 
+GAME_TEST(Issues, Issue2116) {
+    // Resuscitating a character in turn based mode does not give them a turn.
+    auto activeCharacterTape = tapes.activeCharacterIndex();
+
+    game.startNewGame();
+    test.startTaping();
+
+    game.pressAndReleaseKey(PlatformKey::KEY_RETURN);
+    game.tick();
+    EXPECT_TRUE(pParty->bTurnBasedModeOn);
+
+    pParty->pCharacters[3].SetCondDeadWithBlockCheck(false);
+    game.tick();
+
+    for (int i = 0; i < 10; i++) {
+        game.pressAndReleaseKey(PlatformKey::KEY_B); // Pass.
+        do {
+            game.tick(2);
+        } while (!pParty->hasActiveCharacter());
+    }
+    EXPECT_CONTAINS(activeCharacterTape, 1);
+    EXPECT_CONTAINS(activeCharacterTape, 2);
+    EXPECT_CONTAINS(activeCharacterTape, 3);
+    EXPECT_MISSES(activeCharacterTape, 4);
+
+    pParty->pCharacters[3].conditions.reset(CONDITION_DEAD);
+    pParty->pCharacters[3].conditions.reset(CONDITION_UNCONSCIOUS);
+    pParty->pCharacters[3].health = 1;
+    game.tick();
+
+    for (int i = 0; i < 10; i++) {
+        game.pressAndReleaseKey(PlatformKey::KEY_B); // Pass.
+        do {
+            game.tick(2);
+        } while (!pParty->hasActiveCharacter());
+    }
+    EXPECT_CONTAINS(activeCharacterTape, 4);
+}
+
 GAME_TEST(Issues, Issue2117) {
     // Jumping down from Celeste crashes the game
     auto mapTape = tapes.map();