DeploymentManager auto-initializer (microsoft#2835)

* 40724739: DeploymentManagerAutoInitializer. Added auto-initializer, inspired by Bootstrapper's auto-initializer. Split test\Deployment into subdirs. Working through build-isms

Add an auto-initializer for DeploymentManager (very similar to the Bootstrapper's auto-initializer).

If DeploymentManager Initialize fails...
...Write to the eventlog

...Optionally
* DebugBreak
* DebugBreak if a debugger is attached to the process
* FailFast
* MessageBox (modeled after .NET's) asking if you'd like to install the WindowsAppRuntime and if so, ShellExecute(url) to the download page

The optional behavior is triggered by new `DeploymentInitializeOptions` properties or by environment variables
```
SET MICROSOFT_WINDOWSAPPRUNTIME_DEPLOYMENTMANAGER_INITIALIZE_DEBUGBREAK=1
SET MICROSOFT_WINDOWSAPPRUNTIME_DEPLOYMENTMANAGER_INITIALIZE_SHOWUI=1
SET MICROSOFT_WINDOWSAPPRUNTIME_DEPLOYMENTMANAGER_INITIALIZE_FAILFAST=1
```

Testing partial but incomplete as I need a real build (franken-hacking has been too messy to finish E2E testing). The DeploymentManager auto-initializer is inert/unused unless WindowsAppSdkDeploymentManagerInitialize=true and the default to enable that is commented out for now, making this PR functional but inert so I can get a build turned with real packages for further testing.

*.targets updated to provide build-time control.

* **To disable the auto-initializer** the auto-initialize set the property `WindowsAppSDKDeploymentManagerAutoInitialize`=`false`
* **If the auto-initalizer is enabled** you can define properties to control the options passed via `DeploymentInitializeOptions` to `DeploymentManager.Initialize()`
  * **WindowsAppSDKDeploymentManagerAutoInitializeOptions_Default=true** -- use the default options (OnError_ShowUI)
  * **WindowsAppSDKDeploymentManagerAutoInitializeOptions_None=true** -- use no options (None)
  * **WindowsAppSDKDeploymentManagerAutoInitializeOptions_*=true** -- enable the option where * is one or more of the following
    * OnError_DebugBreak
    * OnError_DebugBreak_IfDebuggerAttached
    * OnError_FailFast
    * OnError_ShowUI
    * OnNoPackageIdentity_NoOp

For example, to disable the auto-initializer add to your *proj file:

```xml
<PropertyGroup>
    <WindowsAppSDKDeploymentManagerAutoInitialize>false</WindowsAppSDKDeploymentManagerAutoInitialize>
</PropertyGroup>
```

or to enable the auto-initializer (default) but use the DebugBreak+FailFast options (instead of the default)

```xml
<PropertyGroup>
    <WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_DebugBreak>true</WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_DebugBreak>
    <WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_ShowUI>true</WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_ShowUI>
</PropertyGroup>
```

https://task.ms/40724739

* Added VerifyCopyrightHeaders.cmd and tweaked error message about it

build/CopyFilesToStagingDir.ps1

@@ -170,6 +170,10 @@ PublishFile $FullBuildOutput\WindowsAppRuntime_DLL\StrippedWinMD\Microsoft.Windo
 PublishFile $FullBuildOutput\WindowsAppRuntime_BootstrapDLL\MddBootstrapAutoInitializer.cpp $NugetDir\include
 PublishFile $FullBuildOutput\WindowsAppRuntime_BootstrapDLL\MddBootstrapAutoInitializer.cs $NugetDir\include
 #
+# DeploymentManager Auto-Initializer Files
+PublishFile $FullBuildOutput\WindowsAppRuntime_DLL\DeploymentManagerAutoInitializer.cpp $NugetDir\include
+PublishFile $FullBuildOutput\WindowsAppRuntime_DLL\DeploymentManagerAutoInitializer.cs $NugetDir\include
+#
 # UndockedRegFreeWinRT (URFW) Auto-Initializer Files
 PublishFile $FullBuildOutput\WindowsAppRuntime_DLL\UndockedRegFreeWinRT-AutoInitializer.cpp $NugetDir\include
 PublishFile $FullBuildOutput\WindowsAppRuntime_DLL\UndockedRegFreeWinRT-AutoInitializer.cs $NugetDir\include

build/NuSpecs/Microsoft.WindowsAppSDK.DeploymentManager.CS.targets

@@ -0,0 +1,20 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+    <PropertyGroup>
+        <DefineConstants Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_Default)'=='true'">$(DefineConstants);MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_DEFAULT</DefineConstants>
+        <DefineConstants Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_None)'=='true'">$(DefineConstants);MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_NONE</DefineConstants>
+        <DefineConstants Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_DebugBreak)'=='true'">$(DefineConstants);MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONERROR_DEBUGBREAK</DefineConstants>
+        <DefineConstants Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_DebugBreak_IfDebuggerAttached)'=='true'">$(DefineConstants);MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONERROR_DEBUGBREAK_IFDEBUGGERATTACHED</DefineConstants>
+        <DefineConstants Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_FailFast)'=='true'">$(DefineConstants);MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONERROR_FAILFAST</DefineConstants>
+        <DefineConstants Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnNoMatch_ShowUI)'=='true'">$(DefineConstants);MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONNOMATCH_SHOWUI</DefineConstants>
+        <DefineConstants Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnPackageIdentity_NoOp)'=='true'">$(DefineConstants);MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONPACKAGEIDENTITY_NOOP</DefineConstants>
+    </PropertyGroup>
+
+    <Target Name="GenerateDeploymentManagerCS" BeforeTargets="BeforeCompile">
+        <ItemGroup>
+            <Compile Include="$(MSBuildThisFileDirectory)..\include\DeploymentManagerAutoInitializer.cs" />
+            <Compile Include="$(MSBuildThisFileDirectory)..\include\WindowsAppSDK-VersionInfo.cs" />
+        </ItemGroup>
+    </Target>
+
+</Project>

build/NuSpecs/Microsoft.WindowsAppSDK.DeploymentManagerCommon.targets

@@ -0,0 +1,21 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+    <!-- Targets file common to both managed and native projects -->
+
+    <PropertyGroup Condition="'$(WindowsAppSdkDeploymentManagerInitialize)'=='' and '$(WindowsAppSDKSelfContained)'!='true' and '$(WindowsPackageType)'=='None' and ('$(OutputType)'=='Exe' or '$(OutputType)'=='Winexe')">
+        <!--Allows GenerateDeploymentManagerCS/GenerateDeploymentManagerCpp to run-->
+<!--
+    TODO Uncomment when ready to enable default
+    Franken-builds giving weird results after way too much manual hackery
+    so can't get a reliable read on if it's good or what's wrong. Enable
+    it all but inert unless explicitly requested (which no one does today)
+    to have viable packages for testing.
+        <WindowsAppSdkDeploymentManagerInitialize>true</WindowsAppSdkDeploymentManagerInitialize>
+-->
+    </PropertyGroup>
+
+    <PropertyGroup Condition="'$(WindowsAppSdkDeploymentManagerInitialize)'== 'true'">
+        <PublishAppxPackage>false</PublishAppxPackage>
+    </PropertyGroup>
+
+</Project>

build/NuSpecs/Microsoft.WindowsAppSDK.Foundation.targets

@@ -10,4 +10,7 @@
   <Import Project="$(MSBuildThisFileDirectory)Microsoft.WindowsAppSDK.UndockedRegFreeWinRTCommon.targets" />
   <Import Project="$(MSBuildThisFileDirectory)Microsoft.WindowsAppSDK.UndockedRegFreeWinRT.CS.targets" Condition="'$(WindowsAppSdkUndockedRegFreeWinRTInitialize)' == 'true'"/>
 
+  <Import Project="$(MSBuildThisFileDirectory)Microsoft.WindowsAppSDK.DeploymentManagerCommon.targets" />
+  <Import Project="$(MSBuildThisFileDirectory)Microsoft.WindowsAppSDK.DeploymentManager.CS.targets" Condition="'$(WindowsAppSdkDeploymentManagerInitialize)' == 'true'"/>
+
 </Project>

build/NuSpecs/WindowsAppSDK-Nuget-Native.DeploymentManager.targets

@@ -0,0 +1,18 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+    <Target Name="GenerateDeploymentManagerCpp" BeforeTargets="ClCompile">
+        <ItemGroup>
+            <ClCompile Include="$(MSBuildThisFileDirectory)..\..\include\DeploymentManagerAutoInitializer.cpp">
+                <PrecompiledHeader>NotUsing</PrecompiledHeader>
+                <PreprocessorDefinitions Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_Default)'=='true'">MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_DEFAULT;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+                <PreprocessorDefinitions Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_None)'=='true'">MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_NONE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+                <PreprocessorDefinitions Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_DebugBreak)'=='true'">MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONERROR_DEBUGBREAK;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+                <PreprocessorDefinitions Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_DebugBreak_IfDebuggerAttached)'=='true'">MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONERROR_DEBUGBREAK_IFDEBUGGERATTACHED;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+                <PreprocessorDefinitions Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnError_FailFast)'=='true'">MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONERROR_FAILFAST;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+                <PreprocessorDefinitions Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnNoMatch_ShowUI)'=='true'">MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONNOMATCH_SHOWUI;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+                <PreprocessorDefinitions Condition="'$(WindowsAppSDKDeploymentManagerAutoInitializeOptions_OnPackageIdentity_NoOp)'=='true'">MICROSOFT_WINDOWSAPPSDK_DEPLOYMENTMANAGER_AUTO_INITIALIZE_OPTIONS_ONPACKAGEIDENTITY_NOOP;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+            </ClCompile>
+        </ItemGroup>
+    </Target>
+
+</Project>

build/NuSpecs/WindowsAppSDK-Nuget-Native.targets

@@ -74,4 +74,7 @@
   <Import Project="$(MSBuildThisFileDirectory)..\Microsoft.WindowsAppSDK.UndockedRegFreeWinRTCommon.targets" />
   <Import Project="$(MSBuildThisFileDirectory)WindowsAppSDK-Nuget-Native.UndockedRegFreeWinRT.targets" Condition="'$(WindowsAppSdkUndockedRegFreeWinRTInitialize)' == 'true'"/>
 
+  <Import Project="$(MSBuildThisFileDirectory)..\Microsoft.WindowsAppSDK.DeploymentManagerCommon.targets" />
+  <Import Project="$(MSBuildThisFileDirectory)WindowsAppSDK-Nuget-Native.DeploymentManager.targets" Condition="'$(WindowsAppSdkDeploymentManagerInitialize)' == 'true'"/>
+
 </Project>

dev/Common/AppModel.Identity.h

@@ -164,6 +164,92 @@ inline std::wstring GetVersionShortTagFromVersionTag(
     }
     return versionShortTag;
 }
+
+/// Package Identity
+class PackageIdentity
+{
+public:
+    static PackageIdentity FromPackageFullName(PCWSTR packageFullName)
+    {
+        PackageIdentity packageIdentity;
+        UINT32 bufferLength{ sizeof(packageIdentity.m_buffer) };
+        THROW_IF_WIN32_ERROR(PackageIdFromFullName(packageFullName, PACKAGE_INFORMATION_BASIC, &bufferLength, packageIdentity.m_buffer));
+        packageIdentity.m_packageId = reinterpret_cast<PACKAGE_ID*>(packageIdentity.m_buffer);
+        packageIdentity.m_packageFullName = packageFullName;
+        return packageIdentity;
+    }
+
+public:
+    PackageIdentity() = default;
+
+    PackageIdentity(PackageIdentity&& other) :
+        m_packageFullName(std::move(other.m_packageFullName))
+    {
+        memcpy(m_buffer, other.m_buffer, sizeof(m_buffer));
+        m_packageId = reinterpret_cast<PACKAGE_ID*>(m_buffer);
+
+        other.m_packageId = nullptr;
+        memset(other.m_buffer, 0, sizeof(other.m_buffer));
+    }
+
+    ~PackageIdentity() = default;
+
+    PackageIdentity& operator=(PackageIdentity&& other)
+    {
+        if (this != &other)
+        {
+            m_packageFullName = std::move(other.m_packageFullName);
+            memcpy(m_buffer, other.m_buffer, sizeof(m_buffer));
+            m_packageId = reinterpret_cast<PACKAGE_ID*>(m_buffer);
+
+            other.m_packageId = nullptr;
+            memset(other.m_buffer, 0, sizeof(other.m_buffer));
+        }
+        return *this;
+    }
+
+    const std::wstring& PackageFullName() const
+    {
+        return m_packageFullName;
+    }
+
+    PCWSTR Name() const
+    {
+        return m_packageId->name;
+    }
+
+    PACKAGE_VERSION Version() const
+    {
+        return m_packageId->version;
+    }
+
+    winrt::Windows::System::ProcessorArchitecture Architecture() const
+    {
+        return static_cast<winrt::Windows::System::ProcessorArchitecture>(m_packageId->processorArchitecture);
+    }
+
+    PCWSTR ResourceId() const
+    {
+        return m_packageId->resourceId;
+    }
+
+    PCWSTR PublisherId() const
+    {
+        return m_packageId->publisherId;
+    }
+
+    explicit operator bool() const
+    {
+        return m_packageId != nullptr;
+    }
+
+private:
+    std::wstring m_packageFullName;
+    const PACKAGE_ID * m_packageId{};
+    BYTE m_buffer[sizeof(PACKAGE_ID) + (PACKAGE_NAME_MAX_LENGTH + 1 +
+                                        PACKAGE_RESOURCEID_MAX_LENGTH + 1 +
+                                        PACKAGE_PUBLISHERID_MAX_LENGTH + 1) * sizeof(WCHAR)]{};
+};
 }
 
 #endif // __APPMODEL_IDENTITY_H

dev/Common/Microsoft.Configuration.h

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+#ifndef __MICROSOFT_CONFIGURATION_H
+#define __MICROSOFT_CONFIGURATION_H
+
+namespace Microsoft::Configuration
+{
+inline bool IsOptionEnabled(PCWSTR name)
+{
+    WCHAR value[1 + 1]{};
+    if (::GetEnvironmentVariableW(name, value, ARRAYSIZE(value)) == 1)
+    {
+        if (*value == L'0')
+        {
+            return false;
+        }
+        else if (*value == L'1')
+        {
+            return true;
+        }
+    }
+    return false;
+}
+}
+
+#endif // __MICROSOFT_CONFIGURATION_H

dev/Deployment/Deployment.idl

@@ -3,7 +3,7 @@
 
 namespace Microsoft.Windows.ApplicationModel.WindowsAppRuntime
 {
-    [contractversion(2)]
+    [contractversion(3)]
     apicontract DeploymentContract{};
 
     /// Represents the current Deployment status of the WindowsAppRuntime
@@ -40,6 +40,26 @@ namespace Microsoft.Windows.ApplicationModel.WindowsAppRuntime
         /// WindowsAppSDK main and singleton packages will be shut down forcibly if they are
         /// currently in use, when registering the WinAppSDK packages.
         Boolean ForceDeployment;
+
+        /// If not successful call DebugBreak()
+        [contract(DeploymentContract, 3)]
+        Boolean OnError_DebugBreak;
+
+        /// If not successful call DebugBreak() if a debugger is attached to the process
+        [contract(DeploymentContract, 3)]
+        Boolean OnError_DebugBreak_IfDebuggerAttached;
+
+        /// If not successful perform a fail-fast
+        [contract(DeploymentContract, 3)]
+        Boolean OnError_FailFast;
+
+        /// If not successful show UI
+        [contract(DeploymentContract, 3)]
+        Boolean OnError_ShowUI;
+
+        /// Do nothing (do not error) if the process lacks package identity
+        [contract(DeploymentContract, 3)]
+        Boolean OnNoPackageIdentity_NOOP;
     };
 
     /// Used to query deployment information for WindowsAppRuntime

dev/Deployment/Deployment.vcxitems

@@ -36,6 +36,8 @@
     <ClCompile Include="$(MSBuildThisFileDirectory)DeploymentActivityContext.cpp" />
   </ItemGroup>
   <ItemGroup>
+    <PublicHeaders Include="$(MSBuildThisFileDirectory)DeploymentManagerAutoInitializer.cs" />
+    <PublicHeaders Include="$(MSBuildThisFileDirectory)DeploymentManagerAutoInitializer.cpp" />
     <PublicHeaders Include="$(MSBuildThisFileDirectory)..\common\TerminalVelocityFeatures-DeploymentAPI.h" />
   </ItemGroup>
 </Project>

dev/Deployment/DeploymentInitializeOptions.cpp

@@ -10,9 +10,48 @@ namespace winrt::Microsoft::Windows::ApplicationModel::WindowsAppRuntime::implem
     {
         return m_ForceDeployment;
     }
-
     void DeploymentInitializeOptions::ForceDeployment(bool value)
     {
         m_ForceDeployment = value;
     }
+    bool DeploymentInitializeOptions::OnError_DebugBreak()
+    {
+        return m_OnError_DebugBreak;
+    }
+    void DeploymentInitializeOptions::OnError_DebugBreak(bool value)
+    {
+        m_OnError_DebugBreak = value;
+    }
+    bool DeploymentInitializeOptions::OnError_DebugBreak_IfDebuggerAttached()
+    {
+        return m_OnError_DebugBreak_IfDebuggerAttached;
+    }
+    void DeploymentInitializeOptions::OnError_DebugBreak_IfDebuggerAttached(bool value)
+    {
+        m_OnError_DebugBreak_IfDebuggerAttached = value;
+    }
+    bool DeploymentInitializeOptions::OnError_FailFast()
+    {
+        return m_OnError_FailFast;
+    }
+    void DeploymentInitializeOptions::OnError_FailFast(bool value)
+    {
+        m_OnError_FailFast = value;
+    }
+    bool DeploymentInitializeOptions::OnError_ShowUI()
+    {
+        return m_OnError_ShowUI;
+    }
+    void DeploymentInitializeOptions::OnError_ShowUI(bool value)
+    {
+        m_OnError_ShowUI = value;
+    }
+    bool DeploymentInitializeOptions::OnNoPackageIdentity_NOOP()
+    {
+        return m_OnNoPackageIdentity_NOOP;
+    }
+    void DeploymentInitializeOptions::OnNoPackageIdentity_NOOP(bool value)
+    {
+        m_OnNoPackageIdentity_NOOP = value;
+    }
 }

dev/Deployment/DeploymentInitializeOptions.h

@@ -1,7 +1,4 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-
-// Copyright(c) Microsoft Corporation.All rights reserved.
+// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
 #pragma once
@@ -16,9 +13,24 @@ namespace winrt::Microsoft::Windows::ApplicationModel::WindowsAppRuntime::implem
 
         bool ForceDeployment();
         void ForceDeployment(bool value);
+        bool OnError_DebugBreak();
+        void OnError_DebugBreak(bool value);
+        bool OnError_DebugBreak_IfDebuggerAttached();
+        void OnError_DebugBreak_IfDebuggerAttached(bool value);
+        bool OnError_FailFast();
+        void OnError_FailFast(bool value);
+        bool OnError_ShowUI();
+        void OnError_ShowUI(bool value);
+        bool OnNoPackageIdentity_NOOP();
+        void OnNoPackageIdentity_NOOP(bool value);
 
     private:
         bool m_ForceDeployment{};
+        bool m_OnError_DebugBreak{};
+        bool m_OnError_DebugBreak_IfDebuggerAttached{};
+        bool m_OnError_FailFast{};
+        bool m_OnError_ShowUI{};
+        bool m_OnNoPackageIdentity_NOOP{};
     };
 }
 namespace winrt::Microsoft::Windows::ApplicationModel::WindowsAppRuntime::factory_implementation