Make the Settings Model tests into proper CI tests

OpenConsole.sln

@@ -270,7 +270,6 @@ EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "TestHostApp", "src\cascadia\LocalTests_TerminalApp\TestHostApp\TestHostApp.vcxproj", "{A021EDFF-45C8-4DC2-BEF7-36E1B3B8CFE8}"
 	ProjectSection(ProjectDependencies) = postProject
 		{CA5CAD1A-082C-4476-9F33-94B339494076} = {CA5CAD1A-082C-4476-9F33-94B339494076}
-		{CA5CAD1A-9B68-456A-B13E-C8218070DC42} = {CA5CAD1A-9B68-456A-B13E-C8218070DC42}
 		{CA5CAD1A-B11C-4DDB-A4FE-C3AFAE9B5506} = {CA5CAD1A-B11C-4DDB-A4FE-C3AFAE9B5506}
 	EndProjectSection
 EndProject
@@ -350,7 +349,7 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "Microsoft.Terminal.Settings
 		{CA5CAD1A-D7EC-4107-B7C6-79CB77AE2907} = {CA5CAD1A-D7EC-4107-B7C6-79CB77AE2907}
 	EndProjectSection
 EndProject
-Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "LocalTests_SettingsModel", "src\cascadia\LocalTests_SettingsModel\SettingsModel.LocalTests.vcxproj", "{CA5CAD1A-9B68-456A-B13E-C8218070DC42}"
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "UnitTests_SettingsModel", "src\cascadia\UnitTests_SettingsModel\SettingsModel.UnitTests.vcxproj", "{CA5CAD1A-9B68-456A-B13E-C8218070DC42}"
 	ProjectSection(ProjectDependencies) = postProject
 		{CA5CAD1A-082C-4476-9F33-94B339494076} = {CA5CAD1A-082C-4476-9F33-94B339494076}
 		{CA5CAD1A-C46D-4588-B1C0-40F31AE9100B} = {CA5CAD1A-C46D-4588-B1C0-40F31AE9100B}

build/pipelines/templates-v2/job-run-pgo-tests.yml

@@ -56,6 +56,7 @@ jobs:
   - task: PowerShell@2
     displayName: 'Run PGO Tests'
     inputs:
+      pwsh: true
       targetType: filePath
       filePath: build\scripts\Run-Tests.ps1
       arguments: >-

build/pipelines/templates-v2/job-test-project.yml

@@ -44,6 +44,7 @@ jobs:
   - task: PowerShell@2
     displayName: 'Run Unit Tests'
     inputs:
+      pwsh: true
       targetType: filePath
       filePath: build\scripts\Run-Tests.ps1
       arguments: -MatchPattern '*unit.test*.dll' -Platform '$(OutputBuildPlatform)' -Configuration '$(BuildConfiguration)' -LogPath '${{ parameters.testLogPath }}' -Root "$(Terminal.BinDir)"
@@ -52,6 +53,7 @@ jobs:
     - task: PowerShell@2
       displayName: 'Run Feature Tests'
       inputs:
+        pwsh: true
         targetType: filePath
         filePath: build\scripts\Run-Tests.ps1
         arguments: -MatchPattern '*feature.test*.dll' -Platform '$(OutputBuildPlatform)' -Configuration '$(BuildConfiguration)' -LogPath '${{ parameters.testLogPath }}' -Root "$(Terminal.BinDir)"

build/scripts/Run-Tests.ps1

@@ -16,22 +16,48 @@ Param(
 # Find test DLLs based on the provided root, match pattern, and recursion
 $testDlls = Get-ChildItem -Path $Root -Recurse -Filter $MatchPattern
 
-$args = @()
+$teArgs = @()
 
 # Check if the LogPath parameter is provided and enable WTT logging
 if ($LogPath) {
-    $args += '/enablewttlogging'
-    $args += '/appendwttlogging'
-    $args += "/logFile:$LogPath"
+    $teArgs += '/enablewttlogging'
+    $teArgs += '/appendwttlogging'
+    $teArgs += "/logFile:$LogPath"
     Write-Host "WTT Logging Enabled"
 }
 
-# Invoke the te.exe executable with arguments and test DLLs
-& "$Root\te.exe" $args $testDlls.FullName $AdditionalTaefArguments
+$rootTe = "$Root\te.exe"
 
-# Check the exit code of the te.exe process and exit accordingly
-if ($LASTEXITCODE -ne 0) {
-    Exit $LASTEXITCODE
+# Some of our test fixtures depend on resources.pri in the same folder as the .exe hosting them.
+# Unfortunately, that means that we need to run the te.exe *next to* each test DLL we discover.
+# This code establishes a mapping from te.exe to test DLL (or DLLs)
+$testDllTaefGroups = $testDlls | % {
+	$localTe = Get-Item (Join-Path (Split-Path $_ -Parent) "te.exe") -EA:Ignore
+	If ($null -eq $localTe) {
+		$finalTePath = $rootTe
+	} Else {
+		$finalTePath = $localTe.FullName
+	}
+	[PSCustomObject]@{
+		TePath = $finalTePath;
+		TestDll = $_;
+	}
+}
+
+# Invoke the te.exe executables with arguments and test DLLs
+$anyFailed = $false
+$testDllTaefGroups | Group-Object TePath | % {
+	$te = $_.Group[0].TePath
+	$dlls = $_.Group.TestDll
+	Write-Verbose "Running $te (for $($dlls.Name))"
+	& $te $teArgs $dlls.FullName $AdditionalTaefArguments
+	if ($LASTEXITCODE -ne 0) {
+		$anyFailed = $true
+	}
+}
+
+if ($anyFailed) {
+    Exit 1
 }
 
 Exit 0

src/cascadia/LocalTests_TerminalApp/SettingsTests.cpp

@@ -4,7 +4,7 @@
 #include "pch.h"
 
 #include "../TerminalApp/TerminalPage.h"
-#include "../LocalTests_SettingsModel/TestUtils.h"
+#include "../UnitTests_SettingsModel/TestUtils.h"
 
 using namespace Microsoft::Console;
 using namespace WEX::Logging;

src/cascadia/LocalTests_TerminalApp/TestHostApp/TestHostApp.vcxproj

@@ -133,7 +133,6 @@
 
   <ItemGroup>
     <TestDll Include="$(OpenConsoleCommonOutDir)\LocalTests_TerminalApp\TerminalApp.LocalTests.dll" />
-    <TestDll Include="$(OpenConsoleCommonOutDir)\LocalTests_SettingsModel\SettingsModel.LocalTests.dll" />
   </ItemGroup>
 
   <Target Name="AfterBuild" Inputs="@(TestDll)" Outputs="@(TestDll->'$(TargetDir)'\%(Filename)%(Extension)')">

src/cascadia/TerminalSettingsModel/ActionMap.h

@@ -20,7 +20,7 @@ Author(s):
 #include "Command.h"
 
 // fwdecl unittest classes
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
     class KeyBindingsTests;
     class DeserializationTests;
@@ -123,8 +123,8 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         //   than is necessary to be serialized.
         std::unordered_map<InternalActionID, Model::Command> _MaskingActions;
 
-        friend class SettingsModelLocalTests::KeyBindingsTests;
-        friend class SettingsModelLocalTests::DeserializationTests;
-        friend class SettingsModelLocalTests::TerminalSettingsTests;
+        friend class SettingsModelUnitTests::KeyBindingsTests;
+        friend class SettingsModelUnitTests::DeserializationTests;
+        friend class SettingsModelUnitTests::TerminalSettingsTests;
     };
 }

src/cascadia/TerminalSettingsModel/Command.h

@@ -25,7 +25,7 @@ Author(s):
 #include "SettingsTypes.h"
 
 // fwdecl unittest classes
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
     class DeserializationTests;
     class CommandTests;
@@ -87,8 +87,8 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
         static std::vector<Model::Command> _expandCommand(Command* const expandable,
                                                           Windows::Foundation::Collections::IVectorView<Model::Profile> profiles,
                                                           Windows::Foundation::Collections::IVectorView<Model::ColorScheme> schemes);
-        friend class SettingsModelLocalTests::DeserializationTests;
-        friend class SettingsModelLocalTests::CommandTests;
+        friend class SettingsModelUnitTests::DeserializationTests;
+        friend class SettingsModelUnitTests::CommandTests;
     };
 }
 

src/cascadia/TerminalSettingsModel/GlobalAppSettings.h

@@ -27,7 +27,7 @@ Author(s):
 #include "RemainingProfilesEntry.h"
 
 // fwdecl unittest classes
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
     class DeserializationTests;
     class ColorSchemeTests;

src/cascadia/TerminalSettingsModel/Profile.cpp

@@ -317,7 +317,11 @@ Json::Value Profile::ToJson() const
     JsonUtils::SetValueForKey(json, GuidKey, writeBasicSettings ? Guid() : _Guid);
     JsonUtils::SetValueForKey(json, HiddenKey, writeBasicSettings ? Hidden() : _Hidden);
     JsonUtils::SetValueForKey(json, SourceKey, writeBasicSettings ? Source() : _Source);
-    JsonUtils::SetValueForKey(json, IconKey, writeBasicSettings ? Icon() : _Icon);
+
+    // Recall: Icon isn't actually a setting in the MTSM_PROFILE_SETTINGS. We
+    // defined it manually in Profile, so make sure we only serialize the Icon
+    // if the user actually changed it here.
+    JsonUtils::SetValueForKey(json, IconKey, (writeBasicSettings && HasIcon()) ? Icon() : _Icon);
 
     // PermissiveStringConverter is unnecessary for serialization
     JsonUtils::SetValueForKey(json, PaddingKey, _Padding);

src/cascadia/TerminalSettingsModel/Profile.h

@@ -54,7 +54,7 @@ Author(s):
 #include "FontConfig.h"
 
 // fwdecl unittest classes
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
     class DeserializationTests;
     class ProfileTests;
@@ -147,10 +147,10 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
 
         winrt::hstring _evaluateIcon() const;
 
-        friend class SettingsModelLocalTests::DeserializationTests;
-        friend class SettingsModelLocalTests::ProfileTests;
-        friend class SettingsModelLocalTests::ColorSchemeTests;
-        friend class SettingsModelLocalTests::KeyBindingsTests;
+        friend class SettingsModelUnitTests::DeserializationTests;
+        friend class SettingsModelUnitTests::ProfileTests;
+        friend class SettingsModelUnitTests::ColorSchemeTests;
+        friend class SettingsModelUnitTests::KeyBindingsTests;
         friend class TerminalAppUnitTests::DynamicProfileTests;
         friend class TerminalAppUnitTests::JsonTests;
     };

src/cascadia/TerminalSettingsModel/TerminalSettings.h

@@ -25,7 +25,7 @@ using IFontFeatureMap = winrt::Windows::Foundation::Collections::IMap<winrt::hst
 using IEnvironmentVariableMap = winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring>;
 
 // fwdecl unittest classes
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
     class TerminalSettingsTests;
 }
@@ -182,7 +182,7 @@ namespace winrt::Microsoft::Terminal::Settings::Model::implementation
                                       const Windows::Foundation::Collections::IMapView<hstring, Microsoft::Terminal::Settings::Model::ColorScheme>& schemes,
                                       const winrt::Microsoft::Terminal::Settings::Model::Theme currentTheme);
 
-        friend class SettingsModelLocalTests::TerminalSettingsTests;
+        friend class SettingsModelUnitTests::TerminalSettingsTests;
     };
 }
 

src/cascadia/LocalTests_SettingsModel/ColorSchemeTests.cpp → src/cascadia/UnitTests_SettingsModel/ColorSchemeTests.cpp

@@ -16,24 +16,11 @@ using namespace WEX::Logging;
 using namespace WEX::TestExecution;
 using namespace WEX::Common;
 
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
-    // TODO:microsoft/terminal#3838:
-    // Unfortunately, these tests _WILL NOT_ work in our CI. We're waiting for
-    // an updated TAEF that will let us install framework packages when the test
-    // package is deployed. Until then, these tests won't deploy in CI.
-
     class ColorSchemeTests : public JsonTestClass
     {
-        // Use a custom AppxManifest to ensure that we can activate winrt types
-        // from our test. This property will tell taef to manually use this as
-        // the AppxManifest for this test class.
-        // This does not yet work for anything XAML-y. See TabTests.cpp for more
-        // details on that.
-        BEGIN_TEST_CLASS(ColorSchemeTests)
-            TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
-            TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
-        END_TEST_CLASS()
+        TEST_CLASS(ColorSchemeTests);
 
         TEST_METHOD(ParseSimpleColorScheme);
         TEST_METHOD(LayerColorSchemesOnArray);

src/cascadia/LocalTests_SettingsModel/CommandTests.cpp → src/cascadia/UnitTests_SettingsModel/CommandTests.cpp

@@ -15,24 +15,11 @@ using namespace WEX::Logging;
 using namespace WEX::TestExecution;
 using namespace WEX::Common;
 
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
-    // TODO:microsoft/terminal#3838:
-    // Unfortunately, these tests _WILL NOT_ work in our CI. We're waiting for
-    // an updated TAEF that will let us install framework packages when the test
-    // package is deployed. Until then, these tests won't deploy in CI.
-
     class CommandTests : public JsonTestClass
     {
-        // Use a custom AppxManifest to ensure that we can activate winrt types
-        // from our test. This property will tell taef to manually use this as
-        // the AppxManifest for this test class.
-        // This does not yet work for anything XAML-y. See TabTests.cpp for more
-        // details on that.
-        BEGIN_TEST_CLASS(CommandTests)
-            TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
-            TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
-        END_TEST_CLASS()
+        TEST_CLASS(CommandTests);
 
         TEST_METHOD(ManyCommandsSameAction);
         TEST_METHOD(LayerCommand);

src/cascadia/LocalTests_SettingsModel/DeserializationTests.cpp → src/cascadia/UnitTests_SettingsModel/DeserializationTests.cpp

@@ -19,24 +19,11 @@ using namespace winrt::Microsoft::Terminal::Settings::Model;
 using namespace winrt::Microsoft::Terminal::Control;
 using VirtualKeyModifiers = winrt::Windows::System::VirtualKeyModifiers;
 
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
-    // TODO:microsoft/terminal#3838:
-    // Unfortunately, these tests _WILL NOT_ work in our CI. We're waiting for
-    // an updated TAEF that will let us install framework packages when the test
-    // package is deployed. Until then, these tests won't deploy in CI.
-
     class DeserializationTests : public JsonTestClass
     {
-        // Use a custom AppxManifest to ensure that we can activate winrt types
-        // from our test. This property will tell taef to manually use this as
-        // the AppxManifest for this test class.
-        // This does not yet work for anything XAML-y. See TabTests.cpp for more
-        // details on that.
-        BEGIN_TEST_CLASS(DeserializationTests)
-            TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
-            TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
-        END_TEST_CLASS()
+        TEST_CLASS(DeserializationTests);
 
         TEST_METHOD(ValidateProfilesExist);
         TEST_METHOD(ValidateDefaultProfileExists);

src/cascadia/LocalTests_SettingsModel/KeyBindingsTests.cpp → src/cascadia/UnitTests_SettingsModel/KeyBindingsTests.cpp

@@ -17,24 +17,11 @@ using namespace WEX::TestExecution;
 using namespace WEX::Common;
 using VirtualKeyModifiers = winrt::Windows::System::VirtualKeyModifiers;
 
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
-    // TODO:microsoft/terminal#3838:
-    // Unfortunately, these tests _WILL NOT_ work in our CI. We're waiting for
-    // an updated TAEF that will let us install framework packages when the test
-    // package is deployed. Until then, these tests won't deploy in CI.
-
     class KeyBindingsTests : public JsonTestClass
     {
-        // Use a custom AppxManifest to ensure that we can activate winrt types
-        // from our test. This property will tell taef to manually use this as
-        // the AppxManifest for this test class.
-        // This does not yet work for anything XAML-y. See TabTests.cpp for more
-        // details on that.
-        BEGIN_TEST_CLASS(KeyBindingsTests)
-            TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
-            TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
-        END_TEST_CLASS()
+        TEST_CLASS(KeyBindingsTests);
 
         TEST_METHOD(KeyChords);
         TEST_METHOD(ManyKeysSameAction);

src/cascadia/LocalTests_SettingsModel/NewTabMenuTests.cpp → src/cascadia/UnitTests_SettingsModel/NewTabMenuTests.cpp

@@ -18,24 +18,11 @@ using namespace WEX::Logging;
 using namespace WEX::TestExecution;
 using namespace WEX::Common;
 
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
-    // TODO:microsoft/terminal#3838:
-    // Unfortunately, these tests _WILL NOT_ work in our CI. We're waiting for
-    // an updated TAEF that will let us install framework packages when the test
-    // package is deployed. Until then, these tests won't deploy in CI.
-
     class NewTabMenuTests : public JsonTestClass
     {
-        // Use a custom AppxManifest to ensure that we can activate winrt types
-        // from our test. This property will tell taef to manually use this as
-        // the AppxManifest for this test class.
-        // This does not yet work for anything XAML-y. See TabTests.cpp for more
-        // details on that.
-        BEGIN_TEST_CLASS(NewTabMenuTests)
-            TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
-            TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
-        END_TEST_CLASS()
+        TEST_CLASS(NewTabMenuTests);
 
         TEST_METHOD(DefaultsToRemainingProfiles);
         TEST_METHOD(ParseEmptyFolder);

src/cascadia/LocalTests_SettingsModel/ProfileTests.cpp → src/cascadia/UnitTests_SettingsModel/ProfileTests.cpp

@@ -15,24 +15,11 @@ using namespace WEX::Logging;
 using namespace WEX::TestExecution;
 using namespace WEX::Common;
 
-namespace SettingsModelLocalTests
+namespace SettingsModelUnitTests
 {
-    // TODO:microsoft/terminal#3838:
-    // Unfortunately, these tests _WILL NOT_ work in our CI. We're waiting for
-    // an updated TAEF that will let us install framework packages when the test
-    // package is deployed. Until then, these tests won't deploy in CI.
-
     class ProfileTests : public JsonTestClass
     {
-        // Use a custom AppxManifest to ensure that we can activate winrt types
-        // from our test. This property will tell taef to manually use this as
-        // the AppxManifest for this test class.
-        // This does not yet work for anything XAML-y. See TabTests.cpp for more
-        // details on that.
-        BEGIN_TEST_CLASS(ProfileTests)
-            TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
-            TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
-        END_TEST_CLASS()
+        TEST_CLASS(ProfileTests);
 
         TEST_METHOD(ProfileGeneratesGuid);
         TEST_METHOD(LayerProfileProperties);