WinGet COM API for Repair

.github/actions/spelling/expect.txt

@@ -185,6 +185,7 @@
 fuzzer
 fzanollo
 gcpi
+GDK
 GES
 GESMBH
 getwinget
@@ -476,7 +477,7 @@
 Roronoa
 rosoft
 rowid
 rowids
 roy
 rpwgpm
 RRF
@@ -556,7 +557,7 @@
 tcs
 TEMPDIRECTORY
 templating
 Templating
 temppath
 testexampleinstaller
 thiscouldbeapc
@@ -613,7 +614,7 @@
 webpages
 Webserver
 website
 websites
 wesome
 wfsopen
 wgetenv

src/AppInstallerCLICore/Commands/COMCommand.cpp

@@ -7,7 +7,8 @@
 #include "Workflows/PromptFlow.h"
 #include "Workflows/UninstallFlow.h"
 #include "Workflows/WorkflowBase.h"
-#include "Workflows/DependenciesFlow.h"
+#include "Workflows/DependenciesFlow.h"
+#include "Workflows/RepairFlow.h"
 
 namespace AppInstaller::CLI
 {
@@ -45,4 +46,12 @@ namespace AppInstaller::CLI
         context <<
             Workflow::UninstallSinglePackage;
     }
+
+    // IMPORTANT: To use this command, the caller should have already retrieved the InstalledPackageVersion and added it to the Context Data
+    void COMRepairCommand::ExecuteInternal(Execution::Context& context) const
+    {
+        context <<
+            Workflow::SelectApplicableInstallerIfNecessary <<
+            Workflow::RepairSinglePackage;
+    }
 }

src/AppInstallerCLICore/Commands/COMCommand.h

@@ -33,5 +33,15 @@ namespace AppInstaller::CLI
 
     protected:
         void ExecuteInternal(Execution::Context& context) const override;
+    };
+
+    // IMPORTANT: To use this command, the caller should have already retrieved the InstalledPackageVersion and added it to the Context Data
+    struct COMRepairCommand final : public Command
+    {
+        constexpr static std::string_view CommandName = "repair"sv;
+        COMRepairCommand(std::string_view parent) : Command(CommandName, parent) {}
+
+    protected:
+        void ExecuteInternal(Execution::Context& context) const override;
     };
 }

src/AppInstallerCLICore/ContextOrchestrator.cpp

@@ -12,7 +12,7 @@ namespace AppInstaller::CLI::Execution
 {
     namespace
     {
-        // Operation command queue used by install and uninstall commands.
+        // Operation command queue used by install, uninstall and repair commands.
         constexpr static std::string_view OperationCommandQueueName = "operation"sv;
 
         // Callback function used by worker threads in the queue.
@@ -30,7 +30,7 @@ namespace AppInstaller::CLI::Execution
         // Get command queue name based on command name.
         std::string_view GetCommandQueueName(std::string_view commandName)
         {
-            if (commandName == COMInstallCommand::CommandName || commandName == COMUninstallCommand::CommandName)
+            if (commandName == COMInstallCommand::CommandName || commandName == COMUninstallCommand::CommandName || commandName == COMRepairCommand::CommandName)
             {
                 return OperationCommandQueueName;
             }
@@ -363,6 +363,7 @@ namespace AppInstaller::CLI::Execution
         case PackageOperationType::Upgrade: return "root:upgrade"sv;
         case PackageOperationType::Uninstall: return "root:uninstall"sv;
         case PackageOperationType::Download: return "root:download"sv;
+        case PackageOperationType::Repair: return "root:repair"sv;
         default: return "unknown";
         }
     }
@@ -394,4 +395,11 @@ namespace AppInstaller::CLI::Execution
         item->AddCommand(std::make_unique<::AppInstaller::CLI::COMDownloadCommand>(RootCommand::CommandName));
         return item;
     }
+
+    std::unique_ptr<OrchestratorQueueItem> OrchestratorQueueItemFactory::CreateItemForRepair(std::wstring packageId, std::wstring sourceId, std::unique_ptr<COMContext> context)
+    {
+        std::unique_ptr<OrchestratorQueueItem> item = std::make_unique<OrchestratorQueueItem>(OrchestratorQueueItemId(std::move(packageId), std::move(sourceId)), std::move(context), PackageOperationType::Repair);
+        item->AddCommand(std::make_unique<::AppInstaller::CLI::COMRepairCommand>(RootCommand::CommandName));
+        return item;
+    }
 }

src/AppInstallerCLICore/ContextOrchestrator.h

@@ -47,6 +47,7 @@ namespace AppInstaller::CLI::Execution
         Upgrade,
         Uninstall,
         Download,
+        Repair,
     };
 
     struct OrchestratorQueueItem
@@ -101,6 +102,8 @@ namespace AppInstaller::CLI::Execution
         static std::unique_ptr<OrchestratorQueueItem> CreateItemForSearch(std::wstring packageId, std::wstring sourceId, std::unique_ptr<COMContext> context);
         // Create queue item for download
         static std::unique_ptr<OrchestratorQueueItem> CreateItemForDownload(std::wstring packageId, std::wstring sourceId, std::unique_ptr<COMContext> context);
+        // Create queue item for repair
+        static std::unique_ptr<OrchestratorQueueItem> CreateItemForRepair(std::wstring packageId, std::wstring sourceId, std::unique_ptr<COMContext> context);
     };
 
     struct ContextOrchestrator

src/AppInstallerCLIE2ETests/Constants.cs

@@ -60,6 +60,7 @@ public class Constants
         public const string MsiInstallerV2FileName = "AppInstallerTestMsiInstallerV2.msi";
         public const string MsixInstallerFileName = "AppInstallerTestMsixInstaller.msix";
         public const string ZipInstallerFileName = "AppInstallerTestZipInstaller.zip";
+        public const string ModifyRepairInstaller = "AppInstallerTest.TestModifyRepair";
         public const string IndexPackage = "source.msix";
         public const string MakeAppx = "makeappx.exe";
         public const string SignTool = "signtool.exe";

src/AppInstallerCLIE2ETests/Interop/GroupPolicyForInterop.cs

@@ -8,6 +8,7 @@ namespace AppInstallerCLIE2ETests.Interop
 {
     using System;
     using System.IO;
+    using System.Text;
     using System.Threading.Tasks;
     using AppInstallerCLIE2ETests.Helpers;
     using Microsoft.Management.Deployment;
@@ -86,6 +87,10 @@ public void DisableWinGetPolicy()
             Assert.AreEqual(Constants.BlockByWinGetPolicyErrorMessage, groupPolicyException.Message);
             Assert.AreEqual(Constants.ErrorCode.ERROR_BLOCKED_BY_POLICY, groupPolicyException.HResult);
 
+            groupPolicyException = Assert.Catch<GroupPolicyException>(() => { RepairOptions repairOptions = this.TestFactory.CreateRepairOptions(); });
+            Assert.AreEqual(Constants.BlockByWinGetPolicyErrorMessage, groupPolicyException.Message);
+            Assert.AreEqual(Constants.ErrorCode.ERROR_BLOCKED_BY_POLICY, groupPolicyException.HResult);
+
             // PackageManagerSettings is not implemented in context OutOfProcDev
             if (this.TestFactory.Context == ClsidContext.InProc)
             {
@@ -116,33 +121,44 @@ public async Task DisableWinGetCommandLineInterfacesPolicy()
             PackageCatalogReference compositeSource = packageManager.CreateCompositePackageCatalog(options);
 
             // Find package
-            var searchResult = this.FindOnePackage(compositeSource, PackageMatchField.Id, PackageFieldMatchOption.Equals, Constants.ExeInstallerPackageId);
+            var searchResult = this.FindOnePackage(compositeSource, PackageMatchField.Id, PackageFieldMatchOption.Equals, Constants.ModifyRepairInstaller);
 
             // Configure installation
             var installOptions = this.TestFactory.CreateInstallOptions();
-            installOptions.PackageInstallMode = PackageInstallMode.Silent;
-            installOptions.PreferredInstallLocation = installDir;
             installOptions.AcceptPackageAgreements = true;
+            installOptions.ReplacementInstallerArguments = $"/InstallDir {installDir} /Version 2.0.0.0 /DisplayName TestModifyRepair /UseHKLM";
 
             // Install
             var installResult = await packageManager.InstallPackageAsync(searchResult.CatalogPackage, installOptions);
             Assert.AreEqual(InstallResultStatus.Ok, installResult.Status);
 
             // Find package again, but this time it should detect the installed version
-            searchResult = this.FindOnePackage(compositeSource, PackageMatchField.Id, PackageFieldMatchOption.Equals, Constants.ExeInstallerPackageId);
+            searchResult = this.FindOnePackage(compositeSource, PackageMatchField.Id, PackageFieldMatchOption.Equals, Constants.ModifyRepairInstaller);
             Assert.NotNull(searchResult.CatalogPackage.InstalledVersion);
 
+            // Repair
+            var repairOptions = this.TestFactory.CreateRepairOptions();
+            repairOptions.PackageRepairMode = PackageRepairMode.Silent;
+            var repairResult = await packageManager.RepairPackageAsync(searchResult.CatalogPackage, repairOptions);
+            Assert.AreEqual(RepairResultStatus.Ok, repairResult.Status);
+
             // Uninstall
             var uninstallResult = await packageManager.UninstallPackageAsync(searchResult.CatalogPackage, this.TestFactory.CreateUninstallOptions());
             Assert.AreEqual(UninstallResultStatus.Ok, uninstallResult.Status);
             Assert.True(TestCommon.VerifyTestExeUninstalled(installDir));
 
+            // Clean up.
+            if (Directory.Exists(installDir))
+            {
+                Directory.Delete(installDir, true);
+            }
+
             // Download
             var downloadResult = await packageManager.DownloadPackageAsync(searchResult.CatalogPackage, this.TestFactory.CreateDownloadOptions());
             Assert.AreEqual(DownloadResultStatus.Ok, downloadResult.Status);
             var packageVersion = "2.0.0.0";
-            string downloadDir = Path.Combine(TestCommon.GetDefaultDownloadDirectory(), $"{Constants.ExeInstallerPackageId}_{packageVersion}");
-            Assert.True(TestCommon.VerifyInstallerDownload(downloadDir, "TestExeInstaller", packageVersion, ProcessorArchitecture.X86, TestCommon.Scope.Unknown, PackageInstallerType.Exe));
+            string downloadDir = Path.Combine(TestCommon.GetDefaultDownloadDirectory(), $"{Constants.ModifyRepairInstaller}_{packageVersion}");
+            Assert.True(TestCommon.VerifyInstallerDownload(downloadDir, "TestModifyRepair", packageVersion, ProcessorArchitecture.X86, TestCommon.Scope.Unknown, PackageInstallerType.Burn, "en-US"));
         }
     }
 }