Files
PowerToys/src/common/UnitTests-CommonUtils/WinApiError.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

131 lines
4.5 KiB
C++

#include "pch.h"
#include "TestHelpers.h"
#include <winapi_error.h>
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
namespace UnitTestsCommonUtils
{
TEST_CLASS(WinApiErrorTests)
{
public:
// get_last_error_message tests
TEST_METHOD(GetLastErrorMessage_Success_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_SUCCESS);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
TEST_METHOD(GetLastErrorMessage_FileNotFound_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_FILE_NOT_FOUND);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
TEST_METHOD(GetLastErrorMessage_AccessDenied_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_ACCESS_DENIED);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
TEST_METHOD(GetLastErrorMessage_PathNotFound_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_PATH_NOT_FOUND);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
TEST_METHOD(GetLastErrorMessage_InvalidHandle_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_INVALID_HANDLE);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
TEST_METHOD(GetLastErrorMessage_NotEnoughMemory_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_NOT_ENOUGH_MEMORY);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
TEST_METHOD(GetLastErrorMessage_InvalidParameter_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_INVALID_PARAMETER);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
// get_last_error_or_default tests
TEST_METHOD(GetLastErrorOrDefault_Success_ReturnsMessage)
{
auto result = get_last_error_or_default(ERROR_SUCCESS);
Assert::IsFalse(result.empty());
}
TEST_METHOD(GetLastErrorOrDefault_FileNotFound_ReturnsMessage)
{
auto result = get_last_error_or_default(ERROR_FILE_NOT_FOUND);
Assert::IsFalse(result.empty());
}
TEST_METHOD(GetLastErrorOrDefault_AccessDenied_ReturnsMessage)
{
auto result = get_last_error_or_default(ERROR_ACCESS_DENIED);
Assert::IsFalse(result.empty());
}
TEST_METHOD(GetLastErrorOrDefault_UnknownError_ReturnsEmptyOrMessage)
{
// For an unknown error code, should return empty string or a default message
auto result = get_last_error_or_default(0xFFFFFFFF);
// Either empty or has content, both are valid
Assert::IsTrue(result.empty() || !result.empty());
}
// Comparison tests
TEST_METHOD(BothFunctions_SameError_ProduceSameContent)
{
auto message = get_last_error_message(ERROR_FILE_NOT_FOUND);
auto defaultMessage = get_last_error_or_default(ERROR_FILE_NOT_FOUND);
Assert::IsTrue(message.has_value());
Assert::AreEqual(*message, defaultMessage);
}
TEST_METHOD(BothFunctions_SuccessError_ProduceSameContent)
{
auto message = get_last_error_message(ERROR_SUCCESS);
auto defaultMessage = get_last_error_or_default(ERROR_SUCCESS);
Assert::IsTrue(message.has_value());
Assert::AreEqual(*message, defaultMessage);
}
// Error code specific tests
TEST_METHOD(GetLastErrorMessage_SharingViolation_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_SHARING_VIOLATION);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
TEST_METHOD(GetLastErrorMessage_FileExists_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_FILE_EXISTS);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
TEST_METHOD(GetLastErrorMessage_DirNotEmpty_ReturnsMessage)
{
auto result = get_last_error_message(ERROR_DIR_NOT_EMPTY);
Assert::IsTrue(result.has_value());
Assert::IsFalse(result->empty());
}
};
}