Enabling app notification tests (#5781)

* Adding basic stuff

* adding try catch on method uninit

* Removing toast verification from unpackaged

* Revert "Removing toast verification from unpackaged"

This reverts commit 0368799.

* Removing unpackaged self contained

* Revert "Removing unpackaged self contained"

This reverts commit e97e184.

* Revert "adding try catch on method uninit"

This reverts commit 413ca91.

* Disabling unpackaged tests

* Nit changes

* Testing on Win10 rs5

* Revert "Testing on Win10 rs5"

This reverts commit 345d65c.

* Fixing message

* Increasing timeout

* Revert "Increasing timeout"

This reverts commit 2a5ec5b.

* Enabling only x64

* Revert "Enabling only x64"

This reverts commit 7d8c0b6.

* Testing with error expected

* Refactoring test method

* Trying with error not found

* Revert "Trying with error not found"

This reverts commit 417686d.

* Reenabling unpackaged

* Keeping manager reference

* Trying log instead of throwing

* Revert "Trying log instead of throwing"

This reverts commit daa049e.

* Trying try catch

* Testing supported thing

* Revert "Testing supported thing"

This reverts commit c2eda3a.

* Trying removing static variable

* Revert "Trying removing static variable"

This reverts commit e03a455.

* Forcing is supported

* Revert "Trying try catch"

This reverts commit 63ba13e.

* Revert "Keeping manager reference"

This reverts commit 5beb012.

* Forcing run as restricted user in commandline

* Revert "Forcing is supported"

This reverts commit a90be93.

* Reapply "Forcing is supported"

This reverts commit 3933960.

* Revert "Forcing run as restricted user in commandline"

This reverts commit 7fb3f7a.

* Running as LowIL

* Revert "Reapply "Forcing is supported""

This reverts commit 38f06ed.

* Removing static

* debugging il level

* Using custom runas

* Using medium IL and method level runas

* Reorganizing code

* Adding static

* Trying normal restricted user

* Removing debug logging

* Disabling all tests for old windows 10 versions

* Removing unused include

* Removing arm64 to not be misleading

Author: guimafelipe

test/AppNotificationTests/AppNotification-Test-Constants.h

@@ -11,3 +11,4 @@ inline const std::wstring c_appUserModelId{ L"TaefTestAppId" };
 inline const std::chrono::milliseconds c_sleepTimeout{ 5000 };
 inline const std::chrono::milliseconds c_delay{ 25 };
 constexpr PCWSTR c_nonExistentPackage{ L"NonExistentPackage" };
+constexpr PCWSTR c_fakePackageFamilyName{ L"AppNotificationTest.PackageFamilyName.DoesNotExist_1234567890abc" };

test/AppNotificationTests/AppNotificationTests.testdef

@@ -0,0 +1,18 @@
+{
+    "Tests": [
+        {
+            "Description": "App Notification Tests Packaged",
+            "Filename": "AppNotificationTests.dll",
+            "Parameters": "/name:PackagedTests*",
+            "Architectures": ["x64", "x86"],
+            "Status": "Enabled"
+        },
+        {
+            "Description": "App Notification Tests Unpackaged",
+            "Filename": "AppNotificationTests.dll",
+            "Parameters": "/name:UnpackagedTests*",
+            "Architectures": ["x64", "x86"],
+            "Status": "Enabled"
+        }
+    ]
+}

test/AppNotificationTests/AppNotificationTests.vcxproj

@@ -169,6 +169,7 @@
   <Target Name="CopyFiles" AfterTargets="AfterBuild">
     <Copy SkipUnchangedFiles="true" SourceFiles="$(OutDir)\..\WindowsAppRuntime_BootstrapDLL\Microsoft.WindowsAppRuntime.Bootstrap.dll" DestinationFolder="$(OutDir)" />
     <Copy SkipUnchangedFiles="true" SourceFiles="$(OutDir)\..\WindowsAppRuntime_DLL\Microsoft.Internal.FrameworkUdk.dll" DestinationFolder="$(OutDir)" />
+    <Copy SkipUnchangedFiles="true" SourceFiles="AppNotificationTests.testdef" DestinationFolder="$(OutDir)" />
   </Target>
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
     <PropertyGroup>

test/AppNotificationTests/BaseTestSuite.cpp

@@ -6,6 +6,7 @@
 #include "AppNotification-Test-Constants.h"
 #include "AppNotifications.Test.h"
 #include "BaseTestSuite.h"
+#include "MddWin11.h"
 
 using namespace WEX::Common;
 using namespace WEX::Logging;
@@ -23,6 +24,13 @@ using namespace AppNotifications::Test;
 
 void BaseTestSuite::ClassSetup()
 {
+    // Skip tests on Win10 RS5 and earlier due to COM registration issues
+    if (!WindowsVersion::IsWindows10_19H1OrGreater())
+    {
+        WEX::Logging::Log::Result(WEX::Logging::TestResults::Skipped, L"AppNotification require Win10 19H1 or greater due to COM registration compatibility. Skipping tests on this OS version.");
+        return;
+    }
+
     ::Test::Bootstrap::Setup();
 }
 
@@ -36,17 +44,24 @@ void BaseTestSuite::MethodSetup()
     bool isSelfContained{};
     VERIFY_SUCCEEDED(TestData::TryGetValue(L"SelfContained", isSelfContained));
 
-    if (!isSelfContained)
+    PCWSTR testFrameworkPackageFamilyName{ ::Test::Bootstrap::TP::WindowsAppRuntimeFramework::c_PackageFamilyName };
+    PCWSTR testMainPackageFamilyName{ ::Test::Bootstrap::TP::WindowsAppRuntimeMain::c_PackageFamilyName };
+
+    if (isSelfContained)
     {
-        ::WindowsAppRuntime::VersionInfo::TestInitialize(::Test::Bootstrap::TP::WindowsAppRuntimeFramework::c_PackageFamilyName,
-                                                        ::Test::Bootstrap::TP::WindowsAppRuntimeMain::c_PackageFamilyName);
-        VERIFY_IS_FALSE(::WindowsAppRuntime::SelfContained::IsSelfContained());
+        testFrameworkPackageFamilyName = testMainPackageFamilyName = c_fakePackageFamilyName;
     }
-    else
+
+    // For Windows 11 newer versions, the TestInitialize will fail fast if we pass a non null package family name.
+    // https://github.com/microsoft/WindowsAppSDK/blob/main/dev/Common/WindowsAppRuntime.VersionInfo.cpp#L123-L133
+    if (MddCore::Win11::IsSupported())
     {
-        ::WindowsAppRuntime::VersionInfo::TestInitialize(L"I_don't_exist_package!", L"I_don't_exist_package!");
-        VERIFY_IS_TRUE(::WindowsAppRuntime::SelfContained::IsSelfContained());
+        testMainPackageFamilyName = nullptr;
     }
+
+    ::WindowsAppRuntime::VersionInfo::TestInitialize(testFrameworkPackageFamilyName, testMainPackageFamilyName);
+
+    VERIFY_ARE_EQUAL(isSelfContained, ::WindowsAppRuntime::SelfContained::IsSelfContained());
 }
 
 void BaseTestSuite::MethodCleanup()
@@ -369,7 +384,16 @@ void BaseTestSuite::VerifyRemoveWithIdentifierAsyncUsingNonActiveToastIdentifier
         removeNotificationAsync.Cancel();
     });
 
-    VERIFY_ARE_EQUAL(removeNotificationAsync.wait_for(c_timeout), winrt::Windows::Foundation::AsyncStatus::Completed);
+    // On x86, the wait_for may return Error instead of Completed.
+    // We check if the HR is E_INVALIDARG in that case.
+    auto status = removeNotificationAsync.wait_for(c_timeout);
+    VERIFY_IS_TRUE(status == winrt::Windows::Foundation::AsyncStatus::Completed || status == winrt::Windows::Foundation::AsyncStatus::Error);
+
+    if (status == winrt::Windows::Foundation::AsyncStatus::Error)
+    {
+        VERIFY_THROWS_HR(removeNotificationAsync.GetResults(), E_INVALIDARG);
+    }
+
     scope_exit.release();
 }
 

test/AppNotificationTests/UnpackagedTests.h

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 #include "pch.h"
@@ -13,7 +13,7 @@ class UnpackagedTests : BaseTestSuite
     BEGIN_TEST_CLASS(UnpackagedTests)
         TEST_CLASS_PROPERTY(L"Description", L"Windows App SDK App Notifications test")
         TEST_CLASS_PROPERTY(L"ThreadingModel", L"MTA")
-        TEST_CLASS_PROPERTY(L"RunAs:Class", L"RestrictedUser")
+        TEST_CLASS_PROPERTY(L"RunAs", L"RestrictedUser")
         TEST_CLASS_PROPERTY(L"IsolationLevel", L"Class")
         TEST_CLASS_PROPERTY(L"Data:SelfContained", L"{true, false}")
     END_TEST_CLASS()