Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-03 17:56:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

[CmdPal][UnitTest] Refactor system command unit test (#40874)

Browse Source 
<!-- 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
Ok... The AI generated and migrated ut's quality is very poor. We need
to refactor it.

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

- [x] Closes: #40875
- [x] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [x] **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

---------

Co-authored-by: Yu Leng (from Dev Box) <yuleng@microsoft.com>
This commit is contained in:
Yu Leng
2025-07-30 17:19:40 +08:00
committed by GitHub
parent decb947283
commit 46d380c2b6
13 changed files with 262 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/modules/cmdpal/Tests/Microsoft.CmdPal.Ext.System.UnitTests/BasicTests.cs
View File

@@ -11,17 +11,6 @@ namespace Microsoft.CmdPal.Ext.System.UnitTests;
[TestClass]
public class BasicTests
{
[TestMethod]
public void CommandsHelperTest()
{
// Setup & Act
var commands = Commands.GetSystemCommands(false, false, false, false);
// Assert
Assert.IsNotNull(commands);
Assert.IsTrue(commands.Count > 0);
}
[TestMethod]
public void IconsHelperTest()
{

57
src/modules/cmdpal/Tests/Microsoft.CmdPal.Ext.System.UnitTests/ImageTests.cs
View File

@@ -16,56 +16,25 @@ namespace Microsoft.CmdPal.Ext.System.UnitTests;
[TestClass]
public class ImageTests
{
[DataTestMethod]
[DataRow("shutdown", "ShutdownIcon")]
[DataRow("restart", "RestartIcon")]
[DataRow("sign out", "LogoffIcon")]
[DataRow("lock", "LockIcon")]
[DataRow("sleep", "SleepIcon")]
[DataRow("hibernate", "SleepIcon")]
[DataRow("recycle bin", "RecycleBinIcon")]
[DataRow("uefi firmware settings", "FirmwareSettingsIcon")]
[DataRow("IPv4 addr", "NetworkAdapterIcon")]
[DataRow("IPV6 addr", "NetworkAdapterIcon")]
[DataRow("MAC addr", "NetworkAdapterIcon")]
public void IconThemeDarkTest(string typedString, string expectedIconPropertyName)
[DataRow(true)]
[DataRow(false)]
[TestMethod]
public void IconThemeTest(bool isDarkIcon)
{
var systemPage = new SystemCommandPage(new SettingsManager());
var systemPage = new SystemCommandPage(new Settings());
var commands = systemPage.GetItems();
foreach (var item in systemPage.GetItems())
foreach (var item in commands)
{
if (item.Title.Contains(typedString, StringComparison.OrdinalIgnoreCase) || item.Subtitle.Contains(typedString, StringComparison.OrdinalIgnoreCase))
var icon = item.Icon;
Assert.IsNotNull(icon, $"Icon for '{item.Title}' should not be null.");
if (isDarkIcon)
{
var icon = item.Icon;
Assert.IsNotNull(icon, $"Icon for '{typedString}' should not be null.");
Assert.IsNotEmpty(icon.Dark.Icon, $"Icon for '{typedString}' should not be empty.");
Assert.IsNotEmpty(icon.Dark.Icon, $"Icon for '{item.Title}' should not be empty.");
}
}
}
[DataTestMethod]
[DataRow("shutdown", "ShutdownIcon")]
[DataRow("restart", "RestartIcon")]
[DataRow("sign out", "LogoffIcon")]
[DataRow("lock", "LockIcon")]
[DataRow("sleep", "SleepIcon")]
[DataRow("hibernate", "SleepIcon")]
[DataRow("recycle bin", "RecycleBinIcon")]
[DataRow("uefi firmware settings", "FirmwareSettingsIcon")]
[DataRow("IPv4 addr", "NetworkAdapterIcon")]
[DataRow("IPV6 addr", "NetworkAdapterIcon")]
[DataRow("MAC addr", "NetworkAdapterIcon")]
public void IconThemeLightTest(string typedString, string expectedIconPropertyName)
{
var systemPage = new SystemCommandPage(new SettingsManager());
foreach (var item in systemPage.GetItems())
{
if (item.Title.Contains(typedString, StringComparison.OrdinalIgnoreCase) || item.Subtitle.Contains(typedString, StringComparison.OrdinalIgnoreCase))
else
{
var icon = item.Icon;
Assert.IsNotNull(icon, $"Icon for '{typedString}' should not be null.");
Assert.IsNotEmpty(icon.Light.Icon, $"Icon for '{typedString}' should not be empty.");
Assert.IsNotEmpty(icon.Light.Icon, $"Icon for '{item.Title}' should not be empty.");
}
}
}

1
src/modules/cmdpal/Tests/Microsoft.CmdPal.Ext.System.UnitTests/Microsoft.CmdPal.Ext.System.UnitTests.csproj
View File

@@ -20,5 +20,6 @@
<ProjectReference Include="..\..\..\..\common\ManagedCommon\ManagedCommon.csproj" />
<ProjectReference Include="..\..\ext\Microsoft.CmdPal.Ext.System\Microsoft.CmdPal.Ext.System.csproj" />
<ProjectReference Include="..\..\extensionsdk\Microsoft.CommandPalette.Extensions.Toolkit\Microsoft.CommandPalette.Extensions.Toolkit.csproj" />
<ProjectReference Include="..\Microsoft.CmdPal.Ext.UnitTestsBase\Microsoft.CmdPal.Ext.UnitTestBase.csproj" />
</ItemGroup>
</Project>

147
src/modules/cmdpal/Tests/Microsoft.CmdPal.Ext.System.UnitTests/QueryTests.cs
View File

@@ -5,12 +5,16 @@
using System;
using System.Linq;
using Microsoft.CmdPal.Ext.System.Helpers;
using Microsoft.CmdPal.Ext.System.Pages;
using Microsoft.CmdPal.Ext.UnitTestBase;
using Microsoft.CommandPalette.Extensions;
using Microsoft.CommandPalette.Extensions.Toolkit;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace Microsoft.CmdPal.Ext.System.UnitTests;
[TestClass]
public class QueryTests
public class QueryTests : CommandPaletteUnitTestBase
{
[DataTestMethod]
[DataRow("shutdown", "Shutdown")]
@@ -19,87 +23,130 @@ public class QueryTests
[DataRow("lock", "Lock")]
[DataRow("sleep", "Sleep")]
[DataRow("hibernate", "Hibernate")]
public void SystemCommandsTest(string typedString, string expectedCommand)
[DataRow("open recycle", "Open Recycle Bin")]
[DataRow("empty recycle", "Empty Recycle Bin")]
[DataRow("uefi", "UEFI Firmware Settings")]
public void TopLevelPageQueryTest(string input, string matchedTitle)
{
// Setup
var commands = Commands.GetSystemCommands(false, false, false, false);
var settings = new Settings();
var pages = new SystemCommandPage(settings);
var allCommands = pages.GetItems();
// Act
var result = commands.Where(c => c.Title.Contains(expectedCommand, StringComparison.OrdinalIgnoreCase)).FirstOrDefault();
var result = Query(input, allCommands);
// Assert
// Empty recycle bin command should exist
Assert.IsNotNull(result);
Assert.IsTrue(result.Title.Contains(expectedCommand, StringComparison.OrdinalIgnoreCase));
var firstItem = result.FirstOrDefault();
Assert.IsNotNull(firstItem, "No items matched the query.");
Assert.AreEqual(matchedTitle, firstItem.Title, $"Expected to match '{input}' but got '{firstItem.Title}'");
}
[TestMethod]
public void RecycleBinCommandTest()
{
// Setup
var commands = Commands.GetSystemCommands(false, false, false, false);
var settings = new Settings(hideEmptyRecycleBin: true);
var pages = new SystemCommandPage(settings);
var allCommands = pages.GetItems();
// Act
var result = commands.Where(c => c.Title.Contains("Recycle", StringComparison.OrdinalIgnoreCase)).FirstOrDefault();
var result = Query("recycle", allCommands);
// Assert
// Empty recycle bin command should exist
Assert.IsNotNull(result);
foreach (var item in result)
{
if (item.Title.Contains("Open Recycle Bin") || item.Title.Contains("Empty Recycle Bin"))
{
Assert.Fail("Recycle Bin commands should not be available when hideEmptyRecycleBin is true.");
}
}
var firstItem = result.FirstOrDefault();
Assert.IsNotNull(firstItem, "No items matched the query.");
Assert.IsTrue(
firstItem.Title.Contains("Recycle Bin", StringComparison.OrdinalIgnoreCase),
$"Expected to match 'Recycle Bin' but got '{firstItem.Title}'");
}
[TestMethod]
public void NetworkCommandsTest()
{
// Test that network commands can be retrieved
try
var settings = new Settings();
var pages = new SystemCommandPage(settings);
var allCommands = pages.GetItems();
var ipv4Result = Query("IPv4", allCommands);
Assert.IsNotNull(ipv4Result);
Assert.IsTrue(ipv4Result.Length > 0, "No IPv4 commands matched the query.");
var ipv6Result = Query("IPv6", allCommands);
Assert.IsNotNull(ipv6Result);
Assert.IsTrue(ipv6Result.Length > 0, "No IPv6 commands matched the query.");
var macResult = Query("MAC", allCommands);
Assert.IsNotNull(macResult);
Assert.IsTrue(macResult.Length > 0, "No MAC commands matched the query.");
var findDisconnectedMACResult = false;
foreach (var item in macResult)
{
var networkPropertiesList = NetworkConnectionProperties.GetList();
Assert.IsTrue(networkPropertiesList.Count >= 0); // Should not throw exceptions
}
catch (Exception ex)
{
Assert.Fail($"Network commands should not throw exceptions: {ex.Message}");
if (item.Details.Body.Contains("Disconnected"))
{
findDisconnectedMACResult = true;
break;
}
}
Assert.IsTrue(findDisconnectedMACResult, "No disconnected MAC address found in the results.");
}
[TestMethod]
public void UefiCommandIsAvailableTest()
public void HideDisconnectedNetworkInfoTest()
{
// Setup
var firmwareType = Win32Helpers.GetSystemFirmwareType();
var isUefiMode = firmwareType == FirmwareType.Uefi;
var settings = new Settings(hideDisconnectedNetworkInfo: true);
var pages = new SystemCommandPage(settings);
var allCommands = pages.GetItems();
// Act
var commands = Commands.GetSystemCommands(isUefiMode, false, false, false);
var uefiCommand = commands.Where(c => c.Title.Contains("UEFI", StringComparison.OrdinalIgnoreCase)).FirstOrDefault();
var macResult = Query("MAC", allCommands);
Assert.IsNotNull(macResult);
Assert.IsTrue(macResult.Length > 0, "No MAC commands matched the query.");
// Assert
if (isUefiMode)
var findDisconnectedMACResult = false;
foreach (var item in macResult)
{
Assert.IsNotNull(uefiCommand);
}
else
{
// UEFI command may still exist but be disabled on non-UEFI systems
Assert.IsTrue(true); // Test environment independent
if (item.Details.Body.Contains("Disconnected"))
{
findDisconnectedMACResult = true;
break;
}
}
Assert.IsTrue(!findDisconnectedMACResult, "Disconnected MAC address found in the results.");
}
[TestMethod]
public void FirmwareTypeTest()
[DataRow(FirmwareType.Uefi, true)]
[DataRow(FirmwareType.Bios, false)]
[DataRow(FirmwareType.Max, false)]
[DataRow(FirmwareType.Unknown, false)]
public void FirmwareSettingsTest(FirmwareType firmwareType, bool hasCommand)
{
// Test that GetSystemFirmwareType returns a valid enum value
var firmwareType = Win32Helpers.GetSystemFirmwareType();
Assert.IsTrue(Enum.IsDefined(typeof(FirmwareType), firmwareType));
}
var settings = new Settings(firmwareType: firmwareType);
var pages = new SystemCommandPage(settings);
var allCommands = pages.GetItems();
var result = Query("UEFI", allCommands);
[TestMethod]
public void EmptyRecycleBinCommandTest()
{
// Test that empty recycle bin command exists
var commands = Commands.GetSystemCommands(false, false, false, false);
var result = commands.Where(c => c.Title.Contains("Empty", StringComparison.OrdinalIgnoreCase) &&
c.Title.Contains("Recycle", StringComparison.OrdinalIgnoreCase)).FirstOrDefault();
// Empty recycle bin command should exist
// UEFI Firmware Settings command should exist
Assert.IsNotNull(result);
var firstItem = result.FirstOrDefault();
Assert.IsNotNull(firstItem, "No items matched the query.");
var containsFirmwareSettings = firstItem.Title.Contains("UEFI Firmware Settings", StringComparison.OrdinalIgnoreCase);
Assert.IsTrue(
containsFirmwareSettings == hasCommand,
$"Expected to match 'UEFI Firmware Settings' but got '{firstItem.Title}'");
}
}

40
src/modules/cmdpal/Tests/Microsoft.CmdPal.Ext.System.UnitTests/Settings.cs Normal file
View File

@@ -0,0 +1,40 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Microsoft.CmdPal.Ext.System.Helpers;
namespace Microsoft.CmdPal.Ext.System.UnitTests;
public class Settings : ISettingsInterface
{
private bool hideDisconnectedNetworkInfo;
private bool hideEmptyRecycleBin;
private bool showDialogToConfirmCommand;
private bool showSuccessMessageAfterEmptyingRecycleBin;
private FirmwareType firmwareType;
public Settings(bool hideDisconnectedNetworkInfo = false, bool hideEmptyRecycleBin = false, bool showDialogToConfirmCommand = false, bool showSuccessMessageAfterEmptyingRecycleBin = false, FirmwareType firmwareType = FirmwareType.Uefi)
{
this.hideDisconnectedNetworkInfo = hideDisconnectedNetworkInfo;
this.hideEmptyRecycleBin = hideEmptyRecycleBin;
this.showDialogToConfirmCommand = showDialogToConfirmCommand;
this.showSuccessMessageAfterEmptyingRecycleBin = showSuccessMessageAfterEmptyingRecycleBin;
this.firmwareType = firmwareType;
}
public bool HideDisconnectedNetworkInfo() => hideDisconnectedNetworkInfo;
public bool HideEmptyRecycleBin() => hideEmptyRecycleBin;
public bool ShowDialogToConfirmCommand() => showDialogToConfirmCommand;
public bool ShowSuccessMessageAfterEmptyingRecycleBin() => showSuccessMessageAfterEmptyingRecycleBin;
public FirmwareType GetSystemFirmwareType() => firmwareType;
}

27
src/modules/cmdpal/Tests/Microsoft.CmdPal.Ext.UnitTestsBase/CommandPaletteUnitTestBase.cs Normal file
View File

@@ -0,0 +1,27 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Microsoft.CommandPalette.Extensions;
using Microsoft.CommandPalette.Extensions.Toolkit;
namespace Microsoft.CmdPal.Ext.UnitTestBase;
public class CommandPaletteUnitTestBase
{
private bool MatchesFilter(string filter, IListItem item) => StringMatcher.FuzzySearch(filter, item.Title).Success || StringMatcher.FuzzySearch(filter, item.Subtitle).Success;
public IListItem[] Query(string query, IListItem[] candidates)
{
IListItem[] listItems = candidates
.Where(item => MatchesFilter(query, item))
.ToArray();
return listItems;
}
}

19
src/modules/cmdpal/Tests/Microsoft.CmdPal.Ext.UnitTestsBase/Microsoft.CmdPal.Ext.UnitTestBase.csproj Normal file
View File

@@ -0,0 +1,19 @@
<Project Sdk="Microsoft.NET.Sdk">
<!-- Look at Directory.Build.props in root for common stuff as well -->
<Import Project="..\..\..\..\Common.Dotnet.CsWinRT.props" />
<PropertyGroup>
<IsPackable>false</IsPackable>
<RootNamespace>Microsoft.CmdPal.Ext.UnitTestsBase</RootNamespace>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Moq" />
<PackageReference Include="MSTest" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\extensionsdk\Microsoft.CommandPalette.Extensions.Toolkit\Microsoft.CommandPalette.Extensions.Toolkit.csproj" />
</ItemGroup>
</Project>