Add Windows toast cleanup to test utils

Implement Windows-specific notification cleanup for tests: add WinRT/UIAutomation helpers (clearToastNotificationHistory, closeVisibleToastNotifications, releaseCom, isCloseButtonInToastArea, invokeButton) and update dismissNativeNotifications to use them. Add required Windows headers/includes and link additional Windows libs (ole32, oleaut32, runtimeobject, uiautomationcore) in tests/CMakeLists.txt. Also simplify the README icon support line and replace an explicit sleep in waitForNativeNotificationTimeout with a call to dismissNativeNotifications.

Author: ReenigneArcher

CMakeLists.txt

@@ -134,6 +134,8 @@ if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
     endif()
 
     if(BUILD_TESTS)
+        target_compile_definitions(${PROJECT_NAME} PRIVATE TRAY_ENABLE_TEST_HOOKS=1)
+
         #
         # Additional setup for coverage
         # https://gcovr.com/en/stable/guide/compiling.html#compiler-options

README.md

@@ -133,10 +133,7 @@ The `icon` and `notification_icon` fields can be a path to an image file or an i
 are resolved from the process working directory, so applications should copy or install icon files where the running
 process can find them.
 
-| Component                               | Backend                                                      | Supported inputs                   | Notes                                                                                                                                      |
-|-----------------------------------------|--------------------------------------------------------------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
-| Tray icon (`icon`)                      | Qt `QSystemTrayIcon` / `QIcon` on all platforms              | SVG, ICO, PNG, Qt theme icon names | Loaded through Qt's `QIcon` path; SVG, ICO, and PNG are tested. Theme icon names are resolved by Qt when the platform/theme supports them. |
-| Notification icon (`notification_icon`) | Qt `QSystemTrayIcon::showMessage` / `QIcon` on all platforms | SVG, ICO, PNG, Qt theme icon names | Loaded through Qt's `QIcon` path; SVG, ICO, and PNG are tested. Theme icon names are resolved by Qt when the platform/theme supports them. |
+SVG, ICO, PNG, and Qt theme icon names are supported.
 
 For the most predictable cross-platform behavior, use SVG or PNG files for both tray and notification icons. ICO is
 supported by the Qt-backed paths tested by this project.

src/QtTrayMenu.cpp

@@ -7,6 +7,7 @@
 
 // qt includes
 #include <QApplication>
+#include <QByteArray>
 #include <QCursor>
 #include <QDebug>
 #include <QMouseEvent>
@@ -19,6 +20,12 @@ namespace {
   int defaultArgc = 1;  // NOSONAR(cpp:S5421): This is required for QApplication's argc/argv constructor
   char defaultArgv0[] = "TrayMenuApp";  // NOSONAR(cpp:S5421): This is required for QApplication's argc/argv constructor
   char *defaultArgv[] = {defaultArgv0, nullptr};  // NOSONAR(cpp:S5421,cpp:S5954): This is required for QApplication's argc/argv constructor
+
+#ifdef TRAY_ENABLE_TEST_HOOKS
+  bool nativeNotificationsSuppressed() {
+    return qgetenv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS") == QByteArrayLiteral("1");
+  }
+#endif
 }  // namespace
 
 QtTrayMenu::QtTrayMenu(QObject *parent, const bool debug):
@@ -209,11 +216,20 @@ void QtTrayMenu::createNotification() {
 
 QIcon QtTrayMenu::lookupIcon(QString icon) const {
   // Find icon for tray
-  if (std::filesystem::exists(icon.toStdString())) {
+  const auto icon_path = std::filesystem::path(icon.toStdString());
+  if (std::filesystem::exists(icon_path)) {
     if (auto result = QIcon(icon); !result.isNull()) {
       return result;
     }
   }
+  if (icon_path.is_relative()) {
+    const auto app_icon_path = std::filesystem::path(QApplication::applicationDirPath().toStdString()) / icon_path;
+    if (std::filesystem::exists(app_icon_path)) {
+      if (auto result = QIcon(QString::fromStdString(app_icon_path.string())); !result.isNull()) {
+        return result;
+      }
+    }
+  }
   if (auto result = QIcon::fromTheme(icon); !result.isNull()) {
     return result;
   }
@@ -310,6 +326,11 @@ void QtTrayMenu::showMessage(const QString &title, const QString &msg, std::func
   }
   if (QSystemTrayIcon::supportsMessages()) {
     notificationCallback = std::move(callback);
+#ifdef TRAY_ENABLE_TEST_HOOKS
+    if (nativeNotificationsSuppressed()) {
+      return;
+    }
+#endif
     emit trayIcon->showMessage(title, msg, icon, msecs);
   }
 }
@@ -320,6 +341,11 @@ void QtTrayMenu::showMessage(const QString &title, const QString &msg, const QSt
   }
   if (QSystemTrayIcon::supportsMessages()) {
     notificationCallback = std::move(callback);
+#ifdef TRAY_ENABLE_TEST_HOOKS
+    if (nativeNotificationsSuppressed()) {
+      return;
+    }
+#endif
     emit trayIcon->showMessage(title, msg, lookupIcon(iconPath), msecs);
   }
 }

tests/CMakeLists.txt

@@ -20,7 +20,7 @@ include_directories("${GTEST_SOURCE_DIR}/googletest/include" "${GTEST_SOURCE_DIR
 if (APPLE)
     set(TEST_LIBS "-framework Cocoa")
 elseif (WIN32)
-    set(TEST_LIBS gdi32 gdiplus)
+    set(TEST_LIBS gdi32 gdiplus ole32 oleaut32 runtimeobject uiautomationcore)
 endif()
 
 file(GLOB_RECURSE TEST_SOURCES

tests/unit/test_tray.cpp

@@ -46,6 +46,28 @@ namespace {
     return info.param.name;
   }
 
+  class NativeNotificationSuppression {
+  public:
+    NativeNotificationSuppression() {
+      setEnv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS", "1");
+    }
+
+    ~NativeNotificationSuppression() {
+      setEnv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS", "1");
+    }
+  };
+
+  class NativeNotificationDisplay {
+  public:
+    NativeNotificationDisplay() {
+      setEnv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS", "0");
+    }
+
+    ~NativeNotificationDisplay() {
+      setEnv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS", "1");
+    }
+  };
+
   void PrintTo(const TrayIconParam &param, std::ostream *os) {
     *os << param.name;
   }
@@ -169,6 +191,8 @@ class TrayTest: public BaseTest {  // NOSONAR(cpp:S3656) - fixture members must
   void SetUp() override {
     BaseTest::SetUp();
 
+    setEnv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS", "1");
+
     // Wire up callbacks (file-scope arrays can't use addresses of class statics at init time)
     g_submenu[0].cb = hello_cb;
     g_submenu[1].cb = toggle_cb;
@@ -235,6 +259,7 @@ class TrayTest: public BaseTest {  // NOSONAR(cpp:S3656) - fixture members must
 
   void TearDown() override {
     ShutdownTray();
+    setEnv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS", "1");
     BaseTest::TearDown();
   }
 
@@ -272,6 +297,7 @@ TEST_P(TrayIconTest, TestTrayIconDisplay) {
   trayRunning = (result == 0);
   EXPECT_EQ(result, 0);
   WaitForTrayReady();
+  dismissNativeNotifications();
   EXPECT_TRUE(captureScreenshot(std::string("tray_icon_") + iconParam.name));
 }
 
@@ -372,6 +398,7 @@ TEST_P(TrayNotificationIconTest, TestNotificationDisplay) {
   if (const std::string skipReason = nativeNotificationSkipReason(); !skipReason.empty()) {
     GTEST_SKIP() << skipReason;
   }
+  NativeNotificationDisplay displayNativeNotifications;
 
   const auto &iconParam = GetParam();
   testTray.icon = iconParam.icon;
@@ -382,7 +409,8 @@ TEST_P(TrayNotificationIconTest, TestNotificationDisplay) {
   dismissNativeNotifications();
 
   // Set notification properties
-  testTray.notification_title = "Test Notification";
+  const std::string notificationTitle = std::string("Test Notification ") + iconParam.name;
+  testTray.notification_title = notificationTitle.c_str();
   testTray.notification_text = "This is a test notification message";
   testTray.notification_icon = iconParam.icon;
 
@@ -404,6 +432,8 @@ TEST_P(TrayNotificationIconTest, TestNotificationCallback) {
     GTEST_SKIP() << skipReason;
   }
 
+  NativeNotificationSuppression suppressNativeNotifications;
+
   const auto &iconParam = GetParam();
   testTray.icon = iconParam.icon;
 
@@ -605,6 +635,8 @@ TEST_F(TrayTest, TestMenuAppearsOnLeftClick) {
 TEST_P(TrayNotificationIconTest, TestNotificationCallbackFiredOnClick) {
   // Regression test for: clicking a notification did not invoke the callback.
   // The test hook exercises the same stored callback used by Qt's messageClicked signal.
+  NativeNotificationSuppression suppressNativeNotifications;
+
   const auto &iconParam = GetParam();
   testTray.icon = iconParam.icon;
   static bool callbackInvoked = false;
@@ -639,6 +671,8 @@ TEST_P(TrayNotificationIconTest, TestNotificationCallbackFiredOnClick) {
 }
 
 TEST_F(TrayTest, TestMenuCallbackAfterNotificationUpdate) {
+  NativeNotificationSuppression suppressNativeNotifications;
+
   static int callbackCount = 0;
   callbackCount = 0;
 

tests/unit/test_tray_qt.cpp

@@ -44,6 +44,8 @@ class TrayQtCoverageTest: public BaseTest {  // NOSONAR(cpp:S3656) - fixture mem
   void SetUp() override {
     BaseTest::SetUp();
 
+    setEnv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS", "1");
+
     tray_set_log_callback(nullptr);
     tray_set_app_info(nullptr, nullptr, nullptr);
 
@@ -76,6 +78,8 @@ class TrayQtCoverageTest: public BaseTest {  // NOSONAR(cpp:S3656) - fixture mem
       trayRunning = false;
     }
 
+    setEnv("TRAY_TEST_SUPPRESS_NATIVE_NOTIFICATIONS", "0");
+
     tray_set_log_callback(nullptr);
     BaseTest::TearDown();
   }