Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-07 11:46:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

[FancyZones] Split zones-settings: layout templates (#15588)

Browse Source
This commit is contained in:
Seraphima Zykova
2022-01-18 16:13:32 +03:00
committed by GitHub
parent 758a21a22f
commit f6576e01f3
17 changed files with 380 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
src/modules/fancyzones/FancyZonesTests/UnitTests/JsonHelpers.Tests.cpp
View File

@@ -19,46 +19,6 @@ using namespace Microsoft::VisualStudio::CppUnitTestFramework;
namespace FancyZonesUnitTests
{
void compareJsonObjects(const json::JsonObject& expected, const json::JsonObject& actual, bool recursive = true)
{
auto iter = expected.First();
while (iter.HasCurrent())
{
const auto key = iter.Current().Key();
Assert::IsTrue(actual.HasKey(key), key.c_str());
const std::wstring expectedStringified = iter.Current().Value().Stringify().c_str();
const std::wstring actualStringified = actual.GetNamedValue(key).Stringify().c_str();
if (recursive)
{
json::JsonObject expectedJson;
if (json::JsonObject::TryParse(expectedStringified, expectedJson))
{
json::JsonObject actualJson;
if (json::JsonObject::TryParse(actualStringified, actualJson))
{
compareJsonObjects(expectedJson, actualJson, true);
}
else
{
Assert::IsTrue(false, key.c_str());
}
}
else
{
Assert::AreEqual(expectedStringified, actualStringified, key.c_str());
}
}
else
{
Assert::AreEqual(expectedStringified, actualStringified, key.c_str());
}
iter.MoveNext();
}
}
TEST_CLASS (IdValidationUnitTest)
{
TEST_METHOD (GuidValid)
@@ -201,7 +161,8 @@ namespace FancyZonesUnitTests
info.sensitivityRadius = 50;
auto actual = CanvasLayoutInfoJSON::ToJson(info);
compareJsonObjects(m_json, actual);
auto res = CustomAssert::CompareJsonObjects(m_json, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (FromJson)
@@ -465,7 +426,8 @@ namespace FancyZonesUnitTests
GridLayoutInfo info = m_info;
auto actual = GridLayoutInfoJSON::ToJson(info);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
@@ -486,7 +448,8 @@ namespace FancyZonesUnitTests
info.m_spacing = 99;
auto actual = GridLayoutInfoJSON::ToJson(info);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (FromJson)
@@ -605,7 +568,8 @@ namespace FancyZonesUnitTests
expected.SetNamedValue(L"info", GridLayoutInfoJSON::ToJson(std::get<GridLayoutInfo>(zoneSet.data.info)));
auto actual = CustomZoneSetJSON::ToJson(zoneSet);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (ToJsonCanvas)
@@ -616,7 +580,8 @@ namespace FancyZonesUnitTests
expected.SetNamedValue(L"info", CanvasLayoutInfoJSON::ToJson(std::get<CanvasLayoutInfo>(zoneSet.data.info)));
auto actual = CustomZoneSetJSON::ToJson(zoneSet);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (FromJsonGrid)
@@ -718,7 +683,8 @@ namespace FancyZonesUnitTests
json::JsonObject expected = json::JsonObject::Parse(L"{\"uuid\": \"{33A2B101-06E0-437B-A61E-CDBECF502906}\", \"type\": \"rows\"}");
ZoneSetData data{ L"{33A2B101-06E0-437B-A61E-CDBECF502906}", ZoneSetLayoutType::Rows };
const auto actual = ZoneSetDataJSON::ToJson(data);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (FromJsonGeneral)
@@ -782,7 +748,8 @@ namespace FancyZonesUnitTests
json::JsonObject expected = json::JsonObject::Parse(L"{\"app-path\": \"appPath\", \"history\":[{\"zone-index-set\": [54321], \"device-id\": \"device-id_0_0_{00000000-0000-0000-0000-000000000000}\", \"zoneset-uuid\": \"zoneset-uuid\"}]}");
auto actual = AppZoneHistoryJSON::ToJson(appZoneHistory);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (FromJson)
@@ -860,7 +827,8 @@ namespace FancyZonesUnitTests
auto actual = AppZoneHistoryJSON::ToJson(appZoneHistory);
std::wstring s = actual.Stringify().c_str();
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (FromJsonMultipleDesktopAppHistory)
@@ -912,7 +880,8 @@ namespace FancyZonesUnitTests
json::JsonObject expected = m_defaultJson;
auto actual = DeviceInfoJSON::ToJson(deviceInfo);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (FromJson)
@@ -1036,15 +1005,6 @@ namespace FancyZonesUnitTests
HINSTANCE m_hInst{};
FancyZonesData& m_fzData = FancyZonesDataInstance();
void compareJsonArrays(const json::JsonArray& expected, const json::JsonArray& actual)
{
Assert::AreEqual(expected.Size(), actual.Size());
for (uint32_t i = 0; i < expected.Size(); i++)
{
compareJsonObjects(expected.GetObjectAt(i), actual.GetObjectAt(i));
}
}
TEST_METHOD_INITIALIZE(Init)
{
m_hInst = (HINSTANCE)GetModuleHandleW(nullptr);
@@ -1181,7 +1141,8 @@ namespace FancyZonesUnitTests
const auto& deviceInfoMap = ParseDeviceInfos(expected);
auto actual = SerializeDeviceInfos(deviceInfoMap);
compareJsonArrays(expectedDevices, actual);
auto res = CustomAssert::CompareJsonArrays(expectedDevices, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (AppZoneHistoryParseSingle)
@@ -1353,7 +1314,8 @@ namespace FancyZonesUnitTests
auto appZoneHistoryMap = ParseAppZoneHistory(json);
const auto& actual = SerializeAppZoneHistory(appZoneHistoryMap);
compareJsonArrays(expected, actual);
auto res = CustomAssert::CompareJsonArrays(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (AppZoneHistorySerializeMany)
@@ -1393,7 +1355,8 @@ namespace FancyZonesUnitTests
const auto& appZoneHistoryMap = ParseAppZoneHistory(json);
const auto& actual = SerializeAppZoneHistory(appZoneHistoryMap);
compareJsonArrays(expected, actual);
auto res = CustomAssert::CompareJsonArrays(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (AppZoneHistorySerializeEmpty)
@@ -1405,7 +1368,8 @@ namespace FancyZonesUnitTests
const auto& appZoneHistoryMap = ParseAppZoneHistory(json);
const auto& actual = SerializeAppZoneHistory(appZoneHistoryMap);
compareJsonArrays(expected, actual);
auto res = CustomAssert::CompareJsonArrays(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (CustomZoneSetsParseSingle)
@@ -1519,7 +1483,8 @@ namespace FancyZonesUnitTests
const auto& customZoneSetsMap = ParseCustomZoneSets(json);
auto actual = SerializeCustomZoneSets(customZoneSetsMap);
compareJsonArrays(expected, actual);
auto res = CustomAssert::CompareJsonArrays(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (CustomZoneSetsSerializeMany)
@@ -1542,7 +1507,8 @@ namespace FancyZonesUnitTests
const auto& customZoneSetsMap = ParseCustomZoneSets(json);
auto actual = SerializeCustomZoneSets(customZoneSetsMap);
compareJsonArrays(expected, actual);
auto res = CustomAssert::CompareJsonArrays(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (CustomZoneSetsSerializeEmpty)
@@ -1554,7 +1520,8 @@ namespace FancyZonesUnitTests
const auto& customZoneSetsMap = ParseCustomZoneSets(json);
auto actual = SerializeCustomZoneSets(customZoneSetsMap);
compareJsonArrays(expected, actual);
auto res = CustomAssert::CompareJsonArrays(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (SetActiveZoneSet)
@@ -1756,36 +1723,6 @@ namespace FancyZonesUnitTests
Assert::IsTrue(actual);
}
TEST_METHOD (SaveFancyZonesDataWithTemplates)
{
FancyZonesData data;
data.SetSettingsModulePath(m_moduleName);
const auto& jsonPath = data.zonesSettingsFileName;
// json with templates
json::JsonObject expectedJsonObj;
json::JsonObject templateObj = json::JsonObject::Parse(L"{\"type\": \"focus\", \"show-spacing\": false, \"spacing\": 15, \"zone-count\": 7, \"sensitivity-radius\": 25}");
json::JsonArray templatesArray{};
templatesArray.Append(templateObj);
expectedJsonObj.SetNamedValue(L"devices", json::JsonArray{});
expectedJsonObj.SetNamedValue(L"custom-zone-sets", json::JsonArray{});
expectedJsonObj.SetNamedValue(L"templates", templatesArray);
// write json with templates to file
json::to_file(jsonPath, expectedJsonObj);
data.SaveAppZoneHistoryAndZoneSettings();
// verify that file was written successfully
Assert::IsTrue(std::filesystem::exists(jsonPath));
// verify that templates were not changed after calling SaveFancyZonesData()
std::wstring str;
std::wifstream { jsonPath, std::ios::binary } >> str;
json::JsonObject actualJson = json::JsonObject::Parse(str);
compareJsonObjects(expectedJsonObj, actualJson);
}
TEST_METHOD (AppLastZoneIndex)
{
const FancyZonesDataTypes::DeviceIdData deviceId{ L"device-id" };
@@ -2240,7 +2177,8 @@ namespace FancyZonesUnitTests
const auto actual = MonitorInfo::ToJson(monitor);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD(EditorArgsToJson)
@@ -2258,7 +2196,8 @@ namespace FancyZonesUnitTests
const auto expected = json::JsonObject::Parse(expectedStr);
const auto actual = EditorArgs::ToJson(args);
compareJsonObjects(expected, actual);
auto res = CustomAssert::CompareJsonObjects(expected, actual);
Assert::IsTrue(res.first, res.second.c_str());
}
};
}

95
src/modules/fancyzones/FancyZonesTests/UnitTests/LayoutTemplatesTests.Spec.cpp Normal file
View File

@@ -0,0 +1,95 @@
#include "pch.h"
#include <filesystem>
#include <FancyZonesLib/FancyZonesData.h>
#include <FancyZonesLib/FancyZonesData/LayoutTemplates.h>
#include "util.h"
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
namespace FancyZonesUnitTests
{
TEST_CLASS (LayoutTemplatesUnitTests)
{
FancyZonesData& m_fzData = FancyZonesDataInstance();
std::wstring m_testFolder = L"FancyZonesUnitTests";
TEST_METHOD_INITIALIZE(Init)
{
m_fzData.clear_data();
m_fzData.SetSettingsModulePath(L"FancyZonesUnitTests");
}
TEST_METHOD_CLEANUP(CleanUp)
{
std::filesystem::remove_all(LayoutTemplates::LayoutTemplatesFileName());
std::filesystem::remove_all(PTSettingsHelper::get_module_save_folder_location(m_testFolder));
}
TEST_METHOD (MoveLayoutHotkeysFromZonesSettings)
{
// prepare
json::JsonObject root{};
json::JsonArray devicesArray{}, customLayoutsArray{}, templateLayoutsArray{}, quickLayoutKeysArray{};
root.SetNamedValue(L"devices", devicesArray);
root.SetNamedValue(L"custom-zone-sets", customLayoutsArray);
root.SetNamedValue(L"quick-layout-keys", quickLayoutKeysArray);
{
json::JsonObject layout{};
layout.SetNamedValue(L"type", json::value(L"blank"));
layout.SetNamedValue(L"show-spacing", json::value(false));
layout.SetNamedValue(L"spacing", json::value(0));
layout.SetNamedValue(L"zone-count", json::value(0));
layout.SetNamedValue(L"sensitivity-radius", json::value(0));
templateLayoutsArray.Append(layout);
}
{
json::JsonObject layout{};
layout.SetNamedValue(L"type", json::value(L"grid"));
layout.SetNamedValue(L"show-spacing", json::value(true));
layout.SetNamedValue(L"spacing", json::value(-10));
layout.SetNamedValue(L"zone-count", json::value(4));
layout.SetNamedValue(L"sensitivity-radius", json::value(30));
templateLayoutsArray.Append(layout);
}
root.SetNamedValue(L"templates", templateLayoutsArray);
json::to_file(m_fzData.GetZoneSettingsPath(m_testFolder), root);
// test
m_fzData.ReplaceZoneSettingsFileFromOlderVersions();
auto result = json::from_file(LayoutTemplates::LayoutTemplatesFileName());
Assert::IsTrue(result.has_value());
Assert::IsTrue(result.value().HasKey(NonLocalizable::LayoutTemplatesIds::LayoutTemplatesArrayID));
auto res = CustomAssert::CompareJsonArrays(templateLayoutsArray, result.value().GetNamedArray(NonLocalizable::LayoutTemplatesIds::LayoutTemplatesArrayID));
Assert::IsTrue(res.first, res.second.c_str());
}
TEST_METHOD (MoveLayoutHotkeysFromZonesSettingsNoTemplates)
{
// prepare
json::JsonObject root{};
json::JsonArray devicesArray{}, customLayoutsArray{}, quickLayoutKeysArray{};
root.SetNamedValue(L"devices", devicesArray);
root.SetNamedValue(L"custom-zone-sets", customLayoutsArray);
root.SetNamedValue(L"quick-layout-keys", quickLayoutKeysArray);
json::to_file(m_fzData.GetZoneSettingsPath(m_testFolder), root);
// test
m_fzData.ReplaceZoneSettingsFileFromOlderVersions();
auto result = json::from_file(LayoutTemplates::LayoutTemplatesFileName());
Assert::IsFalse(result.has_value());
}
TEST_METHOD (MoveLayoutHotkeysFromZonesSettingsNoFile)
{
// test
m_fzData.ReplaceZoneSettingsFileFromOlderVersions();
auto result = json::from_file(LayoutTemplates::LayoutTemplatesFileName());
Assert::IsFalse(result.has_value());
}
};
}

1
src/modules/fancyzones/FancyZonesTests/UnitTests/UnitTests.vcxproj
View File

@@ -45,6 +45,7 @@
<ClCompile Include="FancyZonesSettings.Spec.cpp" />
<ClCompile Include="JsonHelpers.Tests.cpp" />
<ClCompile Include="LayoutHotkeysTests.Spec.cpp" />
<ClCompile Include="LayoutTemplatesTests.Spec.cpp" />
<ClCompile Include="pch.cpp">
<PrecompiledHeader Condition="'$(CIBuild)'!='true'">Create</PrecompiledHeader>
</ClCompile>

3
src/modules/fancyzones/FancyZonesTests/UnitTests/UnitTests.vcxproj.filters
View File

@@ -45,6 +45,9 @@
<ClCompile Include="LayoutHotkeysTests.Spec.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="LayoutTemplatesTests.Spec.cpp">
<Filter>Source Files</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<ClInclude Include="pch.h">

70
src/modules/fancyzones/FancyZonesTests/UnitTests/Util.h
View File

@@ -28,6 +28,76 @@ namespace CustomAssert
Microsoft::VisualStudio::CppUnitTestFramework::Assert::IsTrue(a1[i].first == a2[i].first);
}
}
static std::pair<bool, std::wstring> CompareJsonObjects(const json::JsonObject& expected, const json::JsonObject& actual, bool recursive = true)
{
auto iter = expected.First();
while (iter.HasCurrent())
{
const auto key = iter.Current().Key();
if (!actual.HasKey(key))
{
return std::make_pair(false, key.c_str());
}
const std::wstring expectedStringified = iter.Current().Value().Stringify().c_str();
const std::wstring actualStringified = actual.GetNamedValue(key).Stringify().c_str();
if (recursive)
{
json::JsonObject expectedJson;
if (json::JsonObject::TryParse(expectedStringified, expectedJson))
{
json::JsonObject actualJson;
if (json::JsonObject::TryParse(actualStringified, actualJson))
{
CompareJsonObjects(expectedJson, actualJson, true);
}
else
{
return std::make_pair(false, key.c_str());
}
}
else
{
if (expectedStringified != actualStringified)
{
return std::make_pair(false, key.c_str());
}
}
}
else
{
if (expectedStringified != actualStringified)
{
return std::make_pair(false, key.c_str());
}
}
iter.MoveNext();
}
return std::make_pair(true, L"");
}
static std::pair<bool, std::wstring> CompareJsonArrays(const json::JsonArray& expected, const json::JsonArray& actual)
{
if (expected.Size() != actual.Size())
{
return std::make_pair(false, L"Array sizes don't match");
}
for (uint32_t i = 0; i < expected.Size(); i++)
{
auto res = CustomAssert::CompareJsonObjects(expected.GetObjectAt(i), actual.GetObjectAt(i));
if (!res.first)
{
return res;
}
}
return std::make_pair(true, L"");
}
}
namespace Mocks