Files
PowerToys/src/common/UnitTests-CommonUtils/Window.Tests.cpp
Kai Tao 27ba536872 UT: Add ut to protect common utils codes (#45290)
<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request
As title

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [ ] Closes: #xxx
<!-- - [ ] Closes: #yyy (add separate lines for additional resolved
issues) -->
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx

<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments

<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
Tests should be picked up and run and pass
2026-02-03 15:12:45 +08:00

160 lines
5.3 KiB
C++

#include "pch.h"
#include "TestHelpers.h"
#include <window.h>
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
namespace UnitTestsCommonUtils
{
TEST_CLASS(WindowTests)
{
public:
// is_system_window tests
TEST_METHOD(IsSystemWindow_DesktopWindow_ReturnsResult)
{
HWND desktop = GetDesktopWindow();
Assert::IsNotNull(desktop);
// Get class name
char className[256] = {};
GetClassNameA(desktop, className, sizeof(className));
bool result = is_system_window(desktop, className);
// Just verify it doesn't crash and returns a boolean
Assert::IsTrue(result == true || result == false);
}
TEST_METHOD(IsSystemWindow_NullHwnd_ReturnsFalse)
{
auto shell = GetShellWindow();
auto desktop = GetDesktopWindow();
bool result = is_system_window(nullptr, "ClassName");
bool expected = (shell == nullptr) || (desktop == nullptr);
Assert::AreEqual(expected, result);
}
TEST_METHOD(IsSystemWindow_InvalidHwnd_ReturnsFalse)
{
bool result = is_system_window(reinterpret_cast<HWND>(0x12345678), "ClassName");
Assert::IsFalse(result);
}
TEST_METHOD(IsSystemWindow_EmptyClassName_DoesNotCrash)
{
HWND desktop = GetDesktopWindow();
bool result = is_system_window(desktop, "");
// Just verify it doesn't crash
Assert::IsTrue(result == true || result == false);
}
TEST_METHOD(IsSystemWindow_NullClassName_DoesNotCrash)
{
HWND desktop = GetDesktopWindow();
bool result = is_system_window(desktop, nullptr);
// Should handle null className gracefully
Assert::IsTrue(result == true || result == false);
}
// GetWindowCreateParam tests
TEST_METHOD(GetWindowCreateParam_ValidLparam_ReturnsValue)
{
struct TestData
{
int value;
};
TestData data{ 42 };
CREATESTRUCT cs{};
cs.lpCreateParams = &data;
auto result = GetWindowCreateParam<TestData*>(reinterpret_cast<LPARAM>(&cs));
Assert::IsNotNull(result);
Assert::AreEqual(42, result->value);
}
// Window data storage tests
TEST_METHOD(WindowData_StoreAndRetrieve_Works)
{
// Create a simple message-only window for testing
WNDCLASSW wc = {};
wc.lpfnWndProc = DefWindowProcW;
wc.hInstance = GetModuleHandleW(nullptr);
wc.lpszClassName = L"TestWindowClass_DataTest";
RegisterClassW(&wc);
HWND hwnd = CreateWindowExW(0, L"TestWindowClass_DataTest", L"Test",
0, 0, 0, 0, 0, HWND_MESSAGE, nullptr,
GetModuleHandleW(nullptr), nullptr);
if (hwnd)
{
int value = 42;
int* testValue = &value;
StoreWindowParam(hwnd, testValue);
auto retrieved = GetWindowParam<int*>(hwnd);
Assert::AreEqual(testValue, retrieved);
DestroyWindow(hwnd);
}
UnregisterClassW(L"TestWindowClass_DataTest", GetModuleHandleW(nullptr));
Assert::IsTrue(true); // Window creation might fail in test environment
}
// run_message_loop tests
TEST_METHOD(RunMessageLoop_UntilIdle_Completes)
{
// Run message loop until idle with a timeout
// This should complete quickly since there are no messages
auto start = std::chrono::steady_clock::now();
run_message_loop(true, 100);
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
std::chrono::steady_clock::now() - start);
// Should complete within reasonable time
Assert::IsTrue(elapsed.count() < 500);
}
TEST_METHOD(RunMessageLoop_WithTimeout_RespectsTimeout)
{
auto start = std::chrono::steady_clock::now();
run_message_loop(false, 50);
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
std::chrono::steady_clock::now() - start);
// Should take at least the timeout duration
// Allow some tolerance for timing
Assert::IsTrue(elapsed.count() >= 40 && elapsed.count() < 500);
}
TEST_METHOD(RunMessageLoop_ZeroTimeout_CompletesImmediately)
{
auto start = std::chrono::steady_clock::now();
run_message_loop(false, 0);
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
std::chrono::steady_clock::now() - start);
// Should complete very quickly
Assert::IsTrue(elapsed.count() < 100);
}
TEST_METHOD(RunMessageLoop_NoTimeout_ProcessesMessages)
{
// Post a quit message before starting the loop
PostQuitMessage(0);
// Should process the quit message and exit
run_message_loop(false, std::nullopt);
Assert::IsTrue(true);
}
};
}