From 2e0a718cd73ee38bfc0ddcb3ee439092e172cf2c Mon Sep 17 00:00:00 2001
From: BruebachL <44814898+BruebachL@users.noreply.github.com>
Date: Wed, 4 Nov 2026 06:23:43 +0100
Subject: [PATCH] [Tests] Vendor QtTesting behind an opt-in WITH_GUI_TEST flag
 (#7693)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
---
 .gitmodules                               |  3 ++
 CMakeLists.txt                            | 38 +++++++++++++++++++++++
 cockatrice/CMakeLists.txt                 |  5 +++
 cockatrice/resources/config/qtlogging.ini |  1 +
 external/qttesting                        |  1 +
 5 files changed, 48 insertions(+)
 create mode 160000 external/qttesting

diff --git a/.gitmodules b/.gitmodules
index 732fec7ca..e69c8e686 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -4,3 +4,6 @@
 [submodule "doxygen-awesome-css"]
 	path = doc/doxygen/theme
 	url = https://github.com/jothepro/doxygen-awesome-css.git
+[submodule "external/qttesting"]
+	path = external/qttesting
+	url = https://github.com/Kitware/QtTesting.git
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 677ef0c12..563f174e8 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -20,6 +20,8 @@ option(WITH_CLIENT "Build Cockatrice client" ON)
 option(WITH_ORACLE "Build Cockatrice card database tool (Oracle)" ON)
 # Compile Servatrice
 option(WITH_SERVER "Build Cockatrice server (Servatrice)" OFF)
+# Compile GUI tests (QtTesting widget-level playback)
+option(WITH_GUI_TEST "Build the QtTesting-based GUI test harness" OFF)
 # Compile tests
 option(TEST "Build tests" OFF)
 # Build with AddressSanitizer and UndefinedBehaviorSanitizer
@@ -29,6 +31,14 @@ option(ENABLE_COVERAGE "Build instrumented for GCC line coverage" OFF)
 # Use vcpkg regardless of OS
 option(USE_VCPKG "Use vcpkg regardless of OS" OFF)
 
+# The GUI test harness lives in a submodule; a checkout without it must still configure.
+if(WITH_GUI_TEST AND NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/external/qttesting/CMakeLists.txt")
+  message(WARNING "WITH_GUI_TEST is ON but external/qttesting is missing, so GUI tests are disabled.\n"
+                  "Run 'git submodule update --init external/qttesting' to enable them."
+  )
+  set(WITH_GUI_TEST OFF)
+endif()
+
 # Default to "Release" build type
 # User-provided value for CMAKE_BUILD_TYPE must be checked before the PROJECT() call
 if(DEFINED CMAKE_BUILD_TYPE)
@@ -463,6 +473,34 @@ if(WITH_ORACLE)
   set(CPACK_INSTALL_CMAKE_PROJECTS "Oracle;Oracle;ALL;/" ${CPACK_INSTALL_CMAKE_PROJECTS})
 endif()
 
+if(WITH_GUI_TEST)
+  set(QtTesting_QT_VERSION "6")
+  # QtTesting registers its own unit tests when BUILD_TESTING is on. They target the
+  # Qt version the harness was written for and fail on Qt 6.11 (toolbutton
+  # long-press recording), and they are not Cockatrice's tests, so suppress them
+  # for the duration of the subdirectory instead of painting ctest red.
+  if(DEFINED BUILD_TESTING)
+    set(_cockatrice_saved_build_testing ${BUILD_TESTING})
+  endif()
+  set(BUILD_TESTING
+      OFF
+      CACHE BOOL "Build the testing tree." FORCE
+  )
+  add_subdirectory(external/qttesting)
+  if(DEFINED _cockatrice_saved_build_testing)
+    set(BUILD_TESTING
+        ${_cockatrice_saved_build_testing}
+        CACHE BOOL "Build the testing tree." FORCE
+    )
+  else()
+    unset(BUILD_TESTING CACHE)
+  endif()
+  # cl.exe has no warnings-as-errors here, and it rejects -Wno-error with D8021.
+  if(NOT MSVC)
+    target_compile_options(qttesting PRIVATE -Wno-error)
+  endif()
+endif()
+
 if(TEST)
   include(CTest)
   add_subdirectory(tests)
diff --git a/cockatrice/CMakeLists.txt b/cockatrice/CMakeLists.txt
index ccf2dfcea..79c26916f 100644
--- a/cockatrice/CMakeLists.txt
+++ b/cockatrice/CMakeLists.txt
@@ -566,6 +566,11 @@ target_link_libraries(
 
 cockatrice_target_enable_crash_reporting(cockatrice)
 
+if(WITH_GUI_TEST)
+  target_link_libraries(cockatrice PRIVATE QtTesting)
+  target_compile_definitions(cockatrice PRIVATE WITH_GUI_TEST)
+endif()
+
 if(UNIX)
   if(APPLE)
     set(MACOSX_BUNDLE_INFO_STRING "${PROJECT_NAME}")
diff --git a/cockatrice/resources/config/qtlogging.ini b/cockatrice/resources/config/qtlogging.ini
index 7ac0d9ca4..e4b845af9 100644
--- a/cockatrice/resources/config/qtlogging.ini
+++ b/cockatrice/resources/config/qtlogging.ini
@@ -10,6 +10,7 @@
 # or set <category> = false to disable logging
 
 #main = true
+#recording = true
 #qt_translator = true
 #window_main.* = true
 #release_channel = true
diff --git a/external/qttesting b/external/qttesting
new file mode 160000
index 000000000..c7bb5d372
--- /dev/null
+++ b/external/qttesting
@@ -0,0 +1 @@
+Subproject commit c7bb5d372133e94c75cbdc70b04e039b864ea379