Support for PowerShell cmdlets in admin mode

.gitignore

@@ -329,3 +329,8 @@ ASALocalRun/
 
 # MFractors (Xamarin productivity tool) working folder 
 .mfractor/
+
+# Generated files from WinGetServer.idl
+**/WinGetServer/WinGetServer.h
+**/WinGetServer/WinGetServer_c.c
+**/WinGetServer/WinGetServer_s.c

azure-pipelines.yml

@@ -213,12 +213,6 @@ jobs:
       CleanTargetFolder: false
       OverWrite: true
 
-  - template: templates/e2e-test.template.yml
-    parameters:
-      title: "E2E Tests Packaged"
-      isPackaged: true
-      filter: "TestCategory!=InProcess&TestCategory!=OutOfProcess"
-
   - task: PowerShell@2
     displayName: 'Set program files directory'
     inputs:
@@ -238,12 +232,6 @@ jobs:
       TargetFolder:  '$(platformProgramFiles)\dotnet'
       Contents: resources.pri
 
-  - template: templates/e2e-test.template.yml
-    parameters:
-      title: "COM API E2E Tests (In-process)"
-      isPackaged: false
-      filter: "TestCategory=InProcess"
-
   # Winmd accessed by test runner process (dotnet.exe)
   - task: CopyFiles@2
     displayName: 'Copy winmd to dotnet directory'
@@ -260,6 +248,18 @@ jobs:
       TargetFolder:  'src\AppInstallerCLIPackage\bin\$(buildPlatform)\$(buildConfiguration)'
       Contents: Microsoft.Management.Deployment.winmd
 
+  - template: templates/e2e-test.template.yml
+    parameters:
+      title: "E2E Tests Packaged"
+      isPackaged: true
+      filter: "TestCategory!=InProcess&TestCategory!=OutOfProcess"
+
+  - template: templates/e2e-test.template.yml
+    parameters:
+      title: "COM API E2E Tests (In-process)"
+      isPackaged: false
+      filter: "TestCategory=InProcess"
+
   - template: templates/e2e-test.template.yml
     parameters:
       title: "COM API E2E Tests (Out-of-process)"
@@ -305,6 +305,7 @@ jobs:
     inputs:
       filePath: 'src\PowerShell\Microsoft.WinGet.Client\Copy-PlatformBinaries.ps1'
       arguments: '-Platform $(buildPlatform) -Configuration $(buildConfiguration) -OutDir $(artifactsDir)\PowerShell'
+    condition: always()
 
   - task: PublishPipelineArtifact@1
     displayName: Publish Pipeline Artifacts

src/AppInstallerCLI.sln

@@ -990,8 +990,8 @@ Global
 		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.Release|ARM64.ActiveCfg = Debug|Win32
 		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.Release|x64.ActiveCfg = Release|x64
 		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.Release|x64.Build.0 = Release|x64
-		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.Release|x86.ActiveCfg = Debug|Win32
-		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.Release|x86.Build.0 = Debug|Win32
+		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.Release|x86.ActiveCfg = Release|Win32
+		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.Release|x86.Build.0 = Release|Win32
 		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.TestRelease|Any CPU.ActiveCfg = Debug|Win32
 		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.TestRelease|Any CPU.Build.0 = Debug|Win32
 		{31ED69A8-5310-45A9-953F-56C351D2C3E1}.TestRelease|ARM.ActiveCfg = Debug|Win32

src/AppInstallerCLIE2ETests/Constants.cs

@@ -17,6 +17,7 @@ public class Constants
         public const string MsiInstallerPathParameter = "MsiTestInstallerPath";
         public const string MsixInstallerPathParameter = "MsixTestInstallerPath";
         public const string PackageCertificatePathParameter = "PackageCertificatePath";
+        public const string PowerShellModulePathParameter = "PowerShellModulePath";
         public const string AppInstallerTestCert = "AppInstallerTest.cer";
         public const string AppInstallerTestCertThumbprint = "d03e7a688b388b1edde8476a627531c49db88017";
 
@@ -74,6 +75,16 @@ public class Constants
         public const string TestExeUninstallerFileName = "UninstallTestExe.bat";
         public const string TestExeUninstalledFileName = "TestExeUninstalled.txt";
 
+        // PowerShell Cmdlets
+        public const string FindCmdlet = "Find-WinGetPackage";
+        public const string GetCmdlet = "Get-WinGetPackage";
+        public const string GetSourceCmdlet = "Get-WinGetSource";
+        public const string InstallCmdlet = "Install-WinGetPackage";
+        public const string UninstallCmdlet = "Uninstall-WinGetPackage";
+        public const string UpdateCmdlet = "Update-WinGetPackage";
+
+        public const string WinGetServerExeName = "WindowsPackageManagerServer";
+
         // Locations
         public const string LocalAppData = "LocalAppData";
 

src/AppInstallerCLIE2ETests/PowerShell/PowerShellModule.cs

@@ -0,0 +1,177 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace AppInstallerCLIE2ETests.PowerShell
+{
+    using NUnit.Framework;
+    using System;
+    using System.Diagnostics;
+    using System.Linq;
+    using System.Threading;
+
+    /// <summary>
+    /// Basic E2E smoke tests for verifying the behavior of the PowerShell module cmdlets.
+    /// </summary>
+    [Category("PowerShell")]
+    public class PowerShellModule
+    {
+        // TODO: Consider using Pester framework for conducting more extensive PowerShell module tests.
+
+        [OneTimeSetUp]
+        public void Setup()
+        {
+            TestCommon.RunAICLICommand("source add", $"-n {Constants.TestSourceName} {Constants.TestSourceUrl}");
+        }
+
+        [OneTimeTearDown]
+        public void TearDown()
+        {
+            // TODO: This is a workaround to an issue where the server takes longer than expected to terminate when
+            // running from the E2E tests. This can cause other E2E tests to fail when attempting to reset the test source.
+            if (IsRunning(Constants.WinGetServerExeName))
+            {
+                // There should only be one WinGetServer process running at a time.
+                Process serverProcess = Process.GetProcessesByName(Constants.WinGetServerExeName).First();
+                serverProcess.Kill();
+            }
+
+            TestCommon.RunAICLICommand("source remove", $"{Constants.TestSourceName}");
+        }
+
+        [Test]
+        public void AssertServerShutdownAfterExecution()
+        {
+            if (!Environment.Is64BitProcess)
+            {
+                return;
+            }
+
+            TestCommon.RunPowerShellCommandWithResult(Constants.GetSourceCmdlet, $"-Name {Constants.TestSourceName}");
+
+            Assert.IsTrue(IsRunning(Constants.WinGetServerExeName), $"{Constants.WinGetServerExeName} is not running.");
+            Process serverProcess = Process.GetProcessesByName(Constants.WinGetServerExeName).First();
+
+            // Wait a maximum of 30 seconds for the server process to exit.
+            bool serverProcessExit = serverProcess.WaitForExit(30000);
+            Assert.IsTrue(serverProcessExit, $"{Constants.WinGetServerExeName} failed to terminate after creating COM object.");
+        }
+
+        [Test]
+        public void GetWinGetSource()
+        {
+            // Running the x86 PowerShell Module requires PowerShell Core (x86). The tests currently only target PowerShell Core (x64)
+            if (!Environment.Is64BitProcess)
+            {
+                return;
+            }
+
+            var getSourceResult = TestCommon.RunPowerShellCommandWithResult(Constants.GetSourceCmdlet, $"-Name {Constants.TestSourceName}");
+            Assert.IsTrue(getSourceResult.ExitCode == 0, $"ExitCode: {getSourceResult.ExitCode} Failed with the following output: {getSourceResult.StdOut}, {getSourceResult.StdErr}");
+            Assert.IsTrue(getSourceResult.StdOut.Contains($"{Constants.TestSourceName}"));
+        }
+
+        [Test]
+        public void FindWinGetPackage()
+        {
+            if (!Environment.Is64BitProcess)
+            {
+                return;
+            }
+
+            var result = TestCommon.RunPowerShellCommandWithResult(Constants.FindCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+            Assert.IsTrue(result.ExitCode == 0, $"ExitCode: {result.ExitCode} Failed with the following output: {result.StdOut}; {result.StdErr}");
+            Assert.IsTrue(result.StdOut.Contains("TestExeInstaller"));
+        }
+
+        [Test]
+        public void GetWinGetPackage()
+        {
+            if (!Environment.Is64BitProcess)
+            {
+                return;
+            }
+
+            var installResult = TestCommon.RunPowerShellCommandWithResult(Constants.InstallCmdlet, $"-Id {Constants.MsiInstallerPackageId}");
+            var getResult = TestCommon.RunPowerShellCommandWithResult(Constants.GetCmdlet, $"-Id {Constants.MsiInstallerPackageId}");
+            var uninstallResult = TestCommon.RunPowerShellCommandWithResult(Constants.UninstallCmdlet, $"-Id {Constants.MsiInstallerPackageId}");
+
+            Assert.IsTrue(installResult.ExitCode == 0, $"ExitCode: {installResult.ExitCode}; Failed with the following output: {installResult.StdOut}; {installResult.StdErr}");
+            Assert.IsTrue(getResult.ExitCode == 0, $"Failed with the following output: {getResult.StdOut}");
+            Assert.IsTrue(uninstallResult.ExitCode == 0, $"Failed with the following output: {uninstallResult.StdOut}");
+
+            Assert.IsTrue(!string.IsNullOrEmpty(installResult.StdOut));
+            Assert.IsTrue(getResult.StdOut.Contains("TestMsiInstaller"));
+            Assert.IsTrue(!string.IsNullOrEmpty(uninstallResult.StdOut));
+        }
+
+        [Test]
+        public void InstallWinGetPackage()
+        {
+            if (!Environment.Is64BitProcess)
+            {
+                return;
+            }
+
+            var installResult = TestCommon.RunPowerShellCommandWithResult(Constants.InstallCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+            var uninstallResult = TestCommon.RunPowerShellCommandWithResult(Constants.UninstallCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+
+            Assert.IsTrue(installResult.ExitCode == 0, $"ExitCode: {installResult.ExitCode}; Failed with the following output: {installResult.StdOut}; {installResult.StdErr}");
+            Assert.IsTrue(uninstallResult.ExitCode == 0, $"Failed with the following output: {uninstallResult.StdOut}");
+
+            Assert.IsTrue(!string.IsNullOrEmpty(installResult.StdOut));
+            Assert.IsTrue(!string.IsNullOrEmpty(uninstallResult.StdOut));
+        }
+
+        [Test]
+        public void UpdateWinGetPackage()
+        {
+            if (!Environment.Is64BitProcess)
+            {
+                return;
+            }
+
+            var installResult = TestCommon.RunPowerShellCommandWithResult(Constants.InstallCmdlet, $"-Id {Constants.ExeInstallerPackageId} -Version 1.0.0.0");
+            var updateResult = TestCommon.RunPowerShellCommandWithResult(Constants.UpdateCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+            var getResult = TestCommon.RunPowerShellCommandWithResult(Constants.GetCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+            var uninstallResult = TestCommon.RunPowerShellCommandWithResult(Constants.UninstallCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+
+            Assert.IsTrue(installResult.ExitCode == 0, $"Failed with the following output: {installResult.StdOut}");
+            Assert.IsTrue(updateResult.ExitCode == 0, $"Failed with the following output: {updateResult.StdOut}");
+            Assert.IsTrue(getResult.ExitCode == 0, $"Failed with the following output: {getResult.StdOut}");
+            Assert.IsTrue(uninstallResult.ExitCode == 0, $"Failed with the following output: {uninstallResult.StdOut}");
+
+            Assert.IsTrue(!string.IsNullOrEmpty(installResult.StdOut));
+            Assert.IsTrue(!string.IsNullOrEmpty(updateResult.StdOut));
+            Assert.IsTrue(getResult.StdOut.Contains("2.0.0.0"));
+            Assert.IsTrue(!string.IsNullOrEmpty(uninstallResult.StdOut));
+        }
+
+        /// <summary>
+        /// There is a known issue where the server takes an abnormally long time to terminate after the E2E test pwsh processes finish execution.
+        /// This test verifies that the server does indeed terminate within 5 minutes after running all of the cmdlets.
+        /// Commented out to reduce the overall duration of the build pipeline.
+        /// </summary>
+        // [Test]
+        public void VerifyServerTermination()
+        {
+            TestCommon.RunPowerShellCommandWithResult(Constants.GetSourceCmdlet, $"-Name {Constants.TestSourceName}");
+            TestCommon.RunPowerShellCommandWithResult(Constants.FindCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+            TestCommon.RunPowerShellCommandWithResult(Constants.InstallCmdlet, $"-Id {Constants.ExeInstallerPackageId} -Version 1.0.0.0");
+            TestCommon.RunPowerShellCommandWithResult(Constants.UpdateCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+            TestCommon.RunPowerShellCommandWithResult(Constants.GetCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+            TestCommon.RunPowerShellCommandWithResult(Constants.UninstallCmdlet, $"-Id {Constants.ExeInstallerPackageId}");
+
+            Assert.IsTrue(IsRunning(Constants.WinGetServerExeName), $"{Constants.WinGetServerExeName} is not running.");
+            Process serverProcess = Process.GetProcessesByName(Constants.WinGetServerExeName).First();
+
+            // Wait a maximum of 5 minutes for the server process to exit.
+            bool serverProcessExit = serverProcess.WaitForExit(300000);
+            Assert.IsTrue(serverProcessExit, $"{Constants.WinGetServerExeName} failed to terminate after creating COM object.");
+        }
+
+        private bool IsRunning(string processName)
+        {
+            return Process.GetProcessesByName(processName).Length > 0;
+        }
+    }
+}

src/AppInstallerCLIE2ETests/README.md

@@ -56,7 +56,8 @@ Therefore to run the executable in the command line, simply change into the dire
 | StaticFileRootPath | Path to the set of static test files that will be served as the source for testing purposes. This path should be identical to the one provided to the LocalHostWebServer|
 | MsixTestInstallerPath | The MSIX (or APPX) Installer executable under test. |
 | ExeTestInstallerPath |The Exe Installer executable under test. |
-| PackageCertificatePath |Signing Certificate Path used to certify test index source package|
+| PackageCertificatePath | Signing Certificate Path used to certify test index source package |
+| PowerShellModulePath | Path to the PowerShell module manifest file under test |
 
 #### Example of Test.runsettings format:
 
@@ -72,6 +73,7 @@ Therefore to run the executable in the command line, simply change into the dire
 			<Parameter name="MsixTestInstallerPath" value="MsixTestInstaller.msix" />
 			<Parameter name="ExeTestInstallerPath" value="ExeTestInstaller.exe" />
 			<Parameter name="PackageCertificatePath" value="certificate.pfx"/>
+			<Parameter name="PowerShellModulePath" value="TestPowerShellModule.psd1" />
 		</TestRunParameters>
 	</RunSettings>
 
@@ -90,6 +92,7 @@ Make sure to replace **MSFT** with your own user name. Modifying this example wi
 			<Parameter name="MsixTestInstallerPath" value="C:\Users\MSFT\Temp\MsixTestInstaller.msix" />
 			<Parameter name="ExeTestInstallerPath" value="C:\Users\MSFT\source\repos\winget-cli\src\x64\Debug\AppInstallerTestExeInstaller\AppInstallerTestExeInstaller.exe" />
 			<Parameter name="PackageCertificatePath" value="C:\Users\MSFT\Temp\packageCertificate.pfx"/>
+			<Parameter name="PowerShellModulePath" value="C:\Users\MSFT\source\repos\winget-cli\src\x64\Debug\PowerShell\Microsoft.WinGet.Client.psd1" />
 		</TestRunParameters>
 	</RunSettings>
 

src/AppInstallerCLIE2ETests/SetUpFixture.cs

@@ -5,7 +5,6 @@ namespace AppInstallerCLIE2ETests
 {
     using Microsoft.Win32;
     using Newtonsoft.Json;
-    using Newtonsoft.Json.Linq;
     using NUnit.Framework;
     using System;
     using System.IO;
@@ -96,6 +95,11 @@ public void Setup()
                 TestCommon.PackageCertificatePath = TestContext.Parameters.Get(Constants.PackageCertificatePathParameter);
             }
 
+            if (TestContext.Parameters.Exists(Constants.PowerShellModulePathParameter))
+            {
+                TestCommon.PowerShellModulePath = TestContext.Parameters.Get(Constants.PowerShellModulePathParameter);
+            }
+
             ReadTestInstallerPaths();
 
             TestIndexSetup.GenerateTestDirectory();

src/AppInstallerCLIE2ETests/Test.runsettings

@@ -19,6 +19,7 @@
 	   MsixTestInstallerPath: The MSIX (or APPX) Installer executable under test.
 	   ExeTestInstallerPath: The Exe Installer executable under test.
 	   PackageCertificatePath: Signing Certificate Path used to certify Index Source Package
+	   PowerShellModulePath: Path to the PowerShell module manifest file under test
   -->
   <TestRunParameters>
 	  <Parameter name="PackagedContext" value="true" />
@@ -32,5 +33,6 @@
 	  <Parameter name="MsixTestInstallerPath" value="MsixTestInstaller.msix" />
 	  <Parameter name="ExeTestInstallerPath" value="ExeTestInstaller.exe" />
 	  <Parameter name="PackageCertificatePath" value="certificate.pfx"/>
+      <Parameter name="PowerShellModulePath" value="TestPowerShellModule.psd1" />
   </TestRunParameters>
 </RunSettings>

src/AppInstallerCLIE2ETests/TestCommon.cs

@@ -36,6 +36,8 @@ public class TestCommon
 
         public static string PackageCertificatePath { get; set; }
 
+        public static string PowerShellModulePath { get; set; }
+
         public static string SettingsJsonFilePath {
             get
             {
@@ -252,6 +254,11 @@ public static RunCommandResult RunCommandWithResult(string fileName, string args
             return result;
         }
 
+        public static RunCommandResult RunPowerShellCommandWithResult(string cmdlet, string args, int timeOut = 60000)
+        {
+            return RunCommandWithResult("pwsh.exe", $"-Command ipmo {PowerShellModulePath}; {cmdlet} {args}", timeOut);
+        }
+
         public static string GetTestFile(string fileName)
         {
             return Path.Combine(TestContext.CurrentContext.TestDirectory, fileName);

src/AppInstallerCLIPackage/Package.appxmanifest

@@ -37,6 +37,16 @@
             <uap5:ExecutionAlias Alias="WinGetDev.exe" />
           </uap5:AppExecutionAlias>
         </uap5:Extension>
+      </Extensions>
+    </Application>
+    <Application Id="WinGetComServer" Executable="WinGetServer\WindowsPackageManagerServer.exe" EntryPoint="Windows.FullTrustApplication">
+      <uap:VisualElements DisplayName="WinGet Dev COM Server" Square150x150Logo="Images\Square150x150Logo.png" Square44x44Logo="Images\Square44x44Logo.png" Description="The WinGet COM server." BackgroundColor="#0078d7" AppListEntry="none" />
+      <Extensions>
+        <uap5:Extension Category="windows.appExecutionAlias">
+          <uap5:AppExecutionAlias>
+            <uap5:ExecutionAlias Alias="WindowsPackageManagerServerDev.exe" />
+          </uap5:AppExecutionAlias>
+        </uap5:Extension>          
         <com:Extension Category="windows.comServer">
           <com:ComServer>
             <com:ExeServer Executable="WinGetServer\WindowsPackageManagerServer.exe" DisplayName="Windows Package Manager Server" LaunchAndActivationPermission="O:SYG:SYD:(A;;11;;;WD)(A;;11;;;RC)(A;;11;;;AC)(A;;11;;;AN)S:P(ML;;NX;;;S-1-16-0)">

src/PowerShell/Microsoft.WinGet.Client/Commands/GetSourceCommand.cs

@@ -6,7 +6,6 @@
 
 namespace Microsoft.WinGet.Client.Commands
 {
-    using System;
     using System.Management.Automation;
     using Microsoft.Management.Deployment;
     using Microsoft.WinGet.Client.Common;