Add Qt tests

Author: JanSimek

CMakeLists.txt

@@ -88,6 +88,9 @@ find_package(PkgConfig QUIET)
 
 # Qt6 for dialogs and future UI migration
 find_package(Qt6 REQUIRED COMPONENTS Core Widgets Svg)
+if(GECK_BUILD_TESTS)
+    find_package(Qt6 REQUIRED COMPONENTS Test)
+endif()
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTORCC ON)
 set(CMAKE_AUTOUIC ON)

TODO.md

@@ -52,9 +52,6 @@ Detailed progress dialog with task descriptions and completion estimates for lon
 - [ ] Refactor hex rendering into dedicated HexRenderer class
 - [ ] Improve separation of concerns between HexagonGrid and EditorWidget
 
-### Review Follow-ups
-- [ ] Add Qt/UI tests around `Pro*Widget`, inventory UI flows, and panel toggles before larger refactors
-
 ### Presets
 - [ ] TBD: paint a pattern of tiles
 - [ ] TBD: paste a preset into the map, e.g. hut from Arroyo. Presets should be stored in a JSON/YAML/...

src/CMakeLists.txt

@@ -4,9 +4,7 @@
 ###################################
 
 # Define source files
-set(GECK_SOURCES
-    main.cpp
-
+set(GECK_APP_SOURCES
     Application.h
     Application.cpp
 
@@ -188,17 +186,21 @@ set(GECK_SOURCES
     ${CMAKE_SOURCE_DIR}/resources/icons.qrc
 )
 
+# Reusable application library for the executable and UI tests
+add_library(gecko_app STATIC ${GECK_APP_SOURCES})
+add_library(gecko::app ALIAS gecko_app)
+
 # Platform-specific executable settings
 if(WIN32)
-    add_executable(${PROJECT_NAME} WIN32 ${GECK_SOURCES})
+    add_executable(${PROJECT_NAME} WIN32 main.cpp)
     # Add Windows resource file for icon
     target_sources(${PROJECT_NAME} PRIVATE ${CMAKE_SOURCE_DIR}/resources/gecko.rc)
 elseif(APPLE)
     # Add icon to bundle
     set(MACOSX_BUNDLE_ICON_FILE gecko.icns)
     set(APP_ICON_MACOSX ${CMAKE_SOURCE_DIR}/resources/gecko.icns)
     set_source_files_properties(${APP_ICON_MACOSX} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
-    add_executable(${PROJECT_NAME} MACOSX_BUNDLE ${GECK_SOURCES} ${APP_ICON_MACOSX})
+    add_executable(${PROJECT_NAME} MACOSX_BUNDLE main.cpp ${APP_ICON_MACOSX})
 
     # Set bundle properties
     set_target_properties(${PROJECT_NAME} PROPERTIES
@@ -209,7 +211,7 @@ elseif(APPLE)
         MACOSX_BUNDLE_BUNDLE_VERSION "1"
     )
 else()
-    add_executable(${PROJECT_NAME} ${GECK_SOURCES})
+    add_executable(${PROJECT_NAME} main.cpp)
 endif()
 
 ###################################
@@ -333,7 +335,7 @@ PRIVATE
     gecko::spdlog
 )
 
-target_link_libraries(${PROJECT_NAME} PRIVATE
+target_link_libraries(gecko_app PUBLIC
     SFML::System SFML::Graphics SFML::Window
     Qt6::Core
     Qt6::Widgets
@@ -343,9 +345,12 @@ target_link_libraries(${PROJECT_NAME} PRIVATE
     vault
 )
 
-target_include_directories(${PROJECT_NAME} PRIVATE
-        "${CMAKE_SOURCE_DIR}/vendor/vfspp/include"
-        "${CMAKE_BINARY_DIR}/generated")
+target_include_directories(gecko_app PUBLIC
+    ${CMAKE_CURRENT_SOURCE_DIR}
+    "${CMAKE_BINARY_DIR}/generated"
+)
+
+target_link_libraries(${PROJECT_NAME} PRIVATE gecko_app)
 
 # copy shared external libraries to the build directory for Windows builds
 if(WIN32)

src/ui/dialogs/InventoryViewerDialog.cpp

@@ -14,6 +14,10 @@
 namespace geck {
 
 InventoryViewerDialog::InventoryViewerDialog(std::shared_ptr<Object> object, QWidget* parent)
+    : InventoryViewerDialog(object ? object->getMapObjectPtr() : nullptr, parent) {
+}
+
+InventoryViewerDialog::InventoryViewerDialog(std::shared_ptr<MapObject> mapObject, QWidget* parent)
     : QDialog(parent)
     , _mainLayout(nullptr)
     , _splitter(nullptr)
@@ -38,21 +42,12 @@ InventoryViewerDialog::InventoryViewerDialog(std::shared_ptr<Object> object, QWi
     , _removeButton(nullptr)
     , _editButton(nullptr)
     , _closeButton(nullptr)
-    , _object(object)
-    , _mapObject(nullptr) {
+    , _mapObject(std::move(mapObject)) {
 
     spdlog::debug("InventoryViewerDialog: Constructor called");
 
-    if (!_object) {
-        spdlog::error("InventoryViewerDialog: Invalid object provided");
-        reject();
-        return;
-    }
-
-    _mapObject = _object->getMapObjectPtr();
     if (!_mapObject) {
-        spdlog::error("InventoryViewerDialog: Object has no MapObject");
-        QMessageBox::warning(this, "Error", "Selected object has no map data.");
+        spdlog::error("InventoryViewerDialog: Invalid map object provided");
         reject();
         return;
     }

src/ui/dialogs/InventoryViewerDialog.h

@@ -32,6 +32,7 @@ class InventoryViewerDialog : public QDialog {
 
 public:
     explicit InventoryViewerDialog(std::shared_ptr<Object> object, QWidget* parent = nullptr);
+    explicit InventoryViewerDialog(std::shared_ptr<MapObject> mapObject, QWidget* parent = nullptr);
     ~InventoryViewerDialog() = default;
 
 private slots:
@@ -80,7 +81,6 @@ private slots:
     QPushButton* _closeButton;
 
     // Data
-    std::shared_ptr<Object> _object;
     std::shared_ptr<MapObject> _mapObject;
 
     // Tree widget columns

src/util/Settings.cpp

@@ -25,15 +25,18 @@ Settings& Settings::getInstance() {
 
 QString Settings::getSettingsFilePath() const {
     QString configPath = QStandardPaths::writableLocation(QStandardPaths::ConfigLocation);
-    QDir configDir(configPath);
+    QDir configDir;
 
-    // Create organization directory if it doesn't exist
-    if (!configDir.exists(ORGANIZATION_NAME)) {
-        configDir.mkpath(ORGANIZATION_NAME);
+    if (!configDir.mkpath(configPath)) {
+        return QDir(configPath).filePath(SETTINGS_FILENAME);
     }
 
-    configDir.cd(ORGANIZATION_NAME);
-    return configDir.absoluteFilePath(SETTINGS_FILENAME);
+    const QString organizationPath = QDir(configPath).filePath(ORGANIZATION_NAME);
+    if (!configDir.mkpath(organizationPath)) {
+        return QDir(configPath).filePath(SETTINGS_FILENAME);
+    }
+
+    return QDir(organizationPath).filePath(SETTINGS_FILENAME);
 }
 
 bool Settings::exists() const {

tests/CMakeLists.txt

@@ -19,6 +19,11 @@ add_executable(performance_tests
     performance/test_reader_performance.cpp
 )
 
+add_executable(qt_tests
+    qt/qt_test_main.cpp
+    qt/test_ui_regressions.cpp
+)
+
 target_link_libraries(general_tests PRIVATE
     Catch2::Catch2WithMain
     gecko::spdlog
@@ -37,6 +42,15 @@ target_link_libraries(performance_tests PRIVATE
     SFML::System SFML::Graphics
 )
 
+target_link_libraries(qt_tests PRIVATE
+    Catch2::Catch2
+    Qt6::Test
+    gecko::app
+)
+
+target_include_directories(qt_tests PRIVATE
+    ${CMAKE_SOURCE_DIR}/src
+)
 
 # Enable testing
 include(CTest)
@@ -55,6 +69,8 @@ else()
     catch_discover_tests(performance_tests)
 endif()
 
+add_test(NAME qt_tests COMMAND qt_tests)
+
 
 # copy shared external libraries to the build directory for Windows builds
 if(WIN32)
@@ -68,6 +84,11 @@ if(WIN32)
         COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_RUNTIME_DLLS:performance_tests> $<TARGET_FILE_DIR:performance_tests>
         COMMAND_EXPAND_LISTS
     )
+    add_custom_command(
+        TARGET qt_tests POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_RUNTIME_DLLS:qt_tests> $<TARGET_FILE_DIR:qt_tests>
+        COMMAND_EXPAND_LISTS
+    )
 endif()
 
 # Copy test data to both the executable directory and the test working directory
@@ -82,3 +103,8 @@ add_custom_command(
     COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/tests/data $<TARGET_FILE_DIR:performance_tests>/data
     COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/tests/data ${CMAKE_CURRENT_BINARY_DIR}/data
 )
+
+add_custom_command(
+    TARGET qt_tests POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/resources $<TARGET_FILE_DIR:qt_tests>/resources
+)

tests/qt/qt_test_main.cpp

@@ -0,0 +1,43 @@
+#include <QByteArray>
+#include <QApplication>
+#include <QStandardPaths>
+#include <QTemporaryDir>
+
+#include <catch2/catch_session.hpp>
+
+#include "util/ResourceManager.h"
+
+int main(int argc, char** argv) {
+    QTemporaryDir testHome;
+    if (!testHome.isValid()) {
+        return 1;
+    }
+
+    qputenv("HOME", testHome.path().toUtf8());
+    QStandardPaths::setTestModeEnabled(true);
+
+#if defined(Q_OS_MACOS)
+    if (qEnvironmentVariableIsEmpty("QT_QPA_PLATFORM")) {
+        qputenv("QT_QPA_PLATFORM", QByteArray("offscreen"));
+    }
+#elif defined(Q_OS_LINUX)
+    if (qEnvironmentVariableIsEmpty("QT_QPA_PLATFORM")
+        && qEnvironmentVariableIsEmpty("DISPLAY")
+        && qEnvironmentVariableIsEmpty("WAYLAND_DISPLAY")) {
+        qputenv("QT_QPA_PLATFORM", QByteArray("offscreen"));
+    }
+#endif
+
+    QApplication app(argc, argv);
+    app.setApplicationName("gecko-qt-tests");
+    app.setOrganizationName("gecko");
+    Q_INIT_RESOURCE(icons);
+
+    Catch::Session session;
+    const int result = session.run(argc, argv);
+
+    geck::ResourceManager::getInstance().clearAllDataPaths();
+    geck::ResourceManager::getInstance().cleanup();
+
+    return result;
+}