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

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):
@@ -310,6 +317,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 +332,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_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();
   }

tests/utils.cpp

@@ -8,10 +8,175 @@
 // standard includes
 #include <chrono>
 #include <cstdlib>
+#include <cwchar>
 #include <thread>
 
-#ifdef __linux__
+#ifdef _WIN32
+  #ifndef NOMINMAX
+    #define NOMINMAX
+  #endif
+  #include <roapi.h>
+  #include <uiautomationclient.h>
+  #include <Windows.h>
+  #include <windows.ui.notifications.h>
+  #include <winstring.h>
+#endif
+
+#if defined(_WIN32) || defined(__linux__)
 namespace {
+  #ifdef _WIN32
+  namespace notifications = ABI::Windows::UI::Notifications;
+
+  template<typename T>
+  void releaseCom(T *&value) {
+    if (value != nullptr) {
+      value->Release();
+      value = nullptr;
+    }
+  }
+
+  void clearToastNotificationHistory() {
+    const HRESULT init_result = RoInitialize(RO_INIT_MULTITHREADED);
+    const bool should_uninitialize = SUCCEEDED(init_result);
+
+    HSTRING class_id = nullptr;
+    HRESULT result = WindowsCreateString(
+      RuntimeClass_Windows_UI_Notifications_ToastNotificationManager,
+      static_cast<UINT32>(std::wcslen(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager)),
+      &class_id
+    );
+    if (FAILED(result)) {
+      if (should_uninitialize) {
+        RoUninitialize();
+      }
+      return;
+    }
+
+    notifications::IToastNotificationManagerStatics2 *manager = nullptr;
+    result = RoGetActivationFactory(
+      class_id,
+      __uuidof(notifications::IToastNotificationManagerStatics2),
+      reinterpret_cast<void **>(&manager)
+    );
+    WindowsDeleteString(class_id);
+    if (FAILED(result) || manager == nullptr) {
+      if (should_uninitialize) {
+        RoUninitialize();
+      }
+      return;
+    }
+
+    notifications::IToastNotificationHistory *history = nullptr;
+    result = manager->get_History(&history);
+    manager->Release();
+    if (SUCCEEDED(result) && history != nullptr) {
+      (void) history->Clear();
+      history->Release();
+    }
+
+    if (should_uninitialize) {
+      RoUninitialize();
+    }
+  }
+
+  bool isCloseButtonInToastArea(IUIAutomationElement *button) {
+    BSTR name = nullptr;
+    if (FAILED(button->get_CurrentName(&name))) {
+      if (name != nullptr) {
+        SysFreeString(name);
+      }
+      return false;
+    }
+    if (name == nullptr) {
+      return false;
+    }
+
+    const bool is_close_button = std::wcscmp(name, L"Close") == 0;
+    SysFreeString(name);
+    if (!is_close_button) {
+      return false;
+    }
+
+    RECT rect {};
+    if (FAILED(button->get_CurrentBoundingRectangle(&rect))) {
+      return false;
+    }
+
+    const int screen_width = GetSystemMetrics(SM_CXSCREEN);
+    const int screen_height = GetSystemMetrics(SM_CYSCREEN);
+    return rect.left > screen_width / 2 && rect.top > screen_height / 2 && rect.right <= screen_width && rect.bottom <= screen_height;
+  }
+
+  void invokeButton(IUIAutomationElement *button) {
+    IUnknown *pattern = nullptr;
+    if (FAILED(button->GetCurrentPattern(UIA_InvokePatternId, &pattern)) || pattern == nullptr) {
+      return;
+    }
+
+    IUIAutomationInvokePattern *invoke_pattern = nullptr;
+    if (SUCCEEDED(pattern->QueryInterface(IID_PPV_ARGS(&invoke_pattern))) && invoke_pattern != nullptr) {
+      (void) invoke_pattern->Invoke();
+    }
+    releaseCom(invoke_pattern);
+    releaseCom(pattern);
+  }
+
+  void closeVisibleToastNotifications() {
+    const HRESULT init_result = CoInitializeEx(nullptr, COINIT_MULTITHREADED);
+    if (FAILED(init_result) && init_result != RPC_E_CHANGED_MODE) {
+      return;
+    }
+    const bool should_uninitialize = SUCCEEDED(init_result);
+
+    IUIAutomation *automation = nullptr;
+    HRESULT result = CoCreateInstance(CLSID_CUIAutomation, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&automation));
+    if (FAILED(result) || automation == nullptr) {
+      if (should_uninitialize) {
+        CoUninitialize();
+      }
+      return;
+    }
+
+    IUIAutomationElement *root = nullptr;
+    IUIAutomationCondition *button_condition = nullptr;
+    IUIAutomationElementArray *buttons = nullptr;
+    VARIANT button_type {};
+    button_type.vt = VT_I4;
+    button_type.lVal = UIA_ButtonControlTypeId;
+
+    result = automation->GetRootElement(&root);
+    if (SUCCEEDED(result) && root != nullptr) {
+      result = automation->CreatePropertyCondition(UIA_ControlTypePropertyId, button_type, &button_condition);
+    }
+    if (SUCCEEDED(result) && button_condition != nullptr) {
+      result = root->FindAll(TreeScope_Descendants, button_condition, &buttons);
+    }
+
+    int button_count = 0;
+    if (SUCCEEDED(result) && buttons != nullptr && SUCCEEDED(buttons->get_Length(&button_count))) {
+      for (int i = 0; i < button_count; ++i) {
+        IUIAutomationElement *button = nullptr;
+        if (SUCCEEDED(buttons->GetElement(i, &button)) && button != nullptr) {
+          if (isCloseButtonInToastArea(button)) {
+            invokeButton(button);
+          }
+          releaseCom(button);
+        }
+      }
+    }
+
+    releaseCom(buttons);
+    releaseCom(button_condition);
+    releaseCom(root);
+    releaseCom(automation);
+
+    if (should_uninitialize) {
+      CoUninitialize();
+    }
+  }
+  #endif
+
+  #ifdef __linux__
   void closeFreedesktopNotifications() {
     constexpr const char *close_notifications =
       "if command -v dbus-send >/dev/null 2>&1; then "
@@ -24,6 +189,7 @@ namespace {
       "fi";
     (void) std::system(close_notifications);  // NOSONAR(cpp:S4721) - test-only cleanup of desktop notifications
   }
+  #endif
 }  // namespace
 #endif
 
@@ -42,7 +208,12 @@ int setEnv(const std::string &name, const std::string &value) {
 }
 
 void dismissNativeNotifications() {
-#ifdef __linux__
+#ifdef _WIN32
+  clearToastNotificationHistory();
+  closeVisibleToastNotifications();
+  constexpr auto wait_timeout = std::chrono::milliseconds(500);
+  std::this_thread::sleep_for(wait_timeout);
+#elif defined(__linux__)
   closeFreedesktopNotifications();
   constexpr auto wait_timeout = std::chrono::milliseconds(500);
   std::this_thread::sleep_for(wait_timeout);
@@ -51,8 +222,7 @@ void dismissNativeNotifications() {
 
 void waitForNativeNotificationTimeout() {
 #ifdef _WIN32
-  constexpr auto wait_timeout = std::chrono::milliseconds(6000);
-  std::this_thread::sleep_for(wait_timeout);
+  dismissNativeNotifications();
 #elif defined(__linux__)
   dismissNativeNotifications();
 #endif