Configuration history support

.github/actions/spelling/expect.txt

@@ -40,7 +40,7 @@
 bcp
 BEFACEF
 BFirst
 bght
 bigcatalog
 BITMAPINFOHEADER
 bitspace
@@ -74,7 +74,8 @@
 COINIT
 COMGLB
 commandline
-compressapi
+compressapi
+concurrencysal
 contactsupport
 contentfiles
 contoso

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj

@@ -355,6 +355,7 @@
     <ClInclude Include="Commands\COMCommand.h" />
     <ClInclude Include="Commands\CompleteCommand.h" />
     <ClInclude Include="Commands\ConfigureCommand.h" />
+    <ClInclude Include="Commands\ConfigureListCommand.h" />
     <ClInclude Include="Commands\ConfigureShowCommand.h" />
     <ClInclude Include="Commands\ConfigureTestCommand.h" />
     <ClInclude Include="Commands\ConfigureValidateCommand.h" />
@@ -432,6 +433,7 @@
     <ClCompile Include="CheckpointManager.cpp" />
     <ClCompile Include="Commands\COMCommand.cpp" />
     <ClCompile Include="Commands\ConfigureCommand.cpp" />
+    <ClCompile Include="Commands\ConfigureListCommand.cpp" />
     <ClCompile Include="Commands\ConfigureShowCommand.cpp" />
     <ClCompile Include="Commands\ConfigureTestCommand.cpp" />
     <ClCompile Include="Commands\ConfigureValidateCommand.cpp" />
@@ -551,4 +553,4 @@
       </Reference>
     </ItemGroup>
   </Target>
-</Project>
+</Project>

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj.filters

@@ -254,6 +254,9 @@
     <ClInclude Include="ConfigureExportCommand.h">
       <Filter>Commands</Filter>
     </ClInclude>
+    <ClInclude Include="Commands\ConfigureListCommand.h">
+      <Filter>Commands</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="pch.cpp">
@@ -478,6 +481,9 @@
     <ClCompile Include="ConfigureExportCommand.cpp">
       <Filter>Commands</Filter>
     </ClCompile>
+    <ClCompile Include="Commands\ConfigureListCommand.cpp">
+      <Filter>Commands</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="PropertySheet.props" />

src/AppInstallerCLICore/Argument.cpp

@@ -200,7 +200,7 @@ namespace AppInstaller::CLI
 
         // Configuration commands
         case Execution::Args::Type::ConfigurationFile:
-            return { type, "file"_liv, 'f' };
+            return { type, "file"_liv, 'f', ArgTypeCategory::ConfigurationSetChoice, ArgTypeExclusiveSet::ConfigurationSetChoice };
         case Execution::Args::Type::ConfigurationAcceptWarning:
             return { type, "accept-configuration-agreements"_liv };
         case Execution::Args::Type::ConfigurationEnable:
@@ -215,6 +215,10 @@ namespace AppInstaller::CLI
             return { type, "module"_liv };
         case Execution::Args::Type::ConfigurationExportResource:
             return { type, "resource"_liv };
+        case Execution::Args::Type::ConfigurationHistoryItem:
+            return { type, "history"_liv, 'h', ArgTypeCategory::ConfigurationSetChoice, ArgTypeExclusiveSet::ConfigurationSetChoice };
+        case Execution::Args::Type::ConfigurationHistoryRemove:
+            return { type, "remove"_liv };
 
         // Download command
         case Execution::Args::Type::DownloadDirectory:

src/AppInstallerCLICore/Argument.h

@@ -71,6 +71,8 @@ namespace AppInstaller::CLI
         // E.g.: --dependency-source
         // E.g.: --accept-source-agreements
         ExtendedSource = 0x400,
+        // Arguments for selecting a configuration set (file or history).
+        ConfigurationSetChoice = 0x800,
     };
 
     DEFINE_ENUM_FLAG_OPERATORS(ArgTypeCategory);
@@ -87,6 +89,7 @@ namespace AppInstaller::CLI
         StubType = 0x10,
         Proxy = 0x20,
         AllAndTargetVersion = 0x40,
+        ConfigurationSetChoice = 0x80,
 
         // This must always be at the end
         Max

src/AppInstallerCLICore/Commands/ConfigureCommand.cpp

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 #include "pch.h"
 #include "ConfigureCommand.h"
+#include "ConfigureListCommand.h"
 #include "ConfigureShowCommand.h"
 #include "ConfigureTestCommand.h"
 #include "ConfigureValidateCommand.h"
@@ -24,6 +25,7 @@ namespace AppInstaller::CLI
     {
         return InitializeFromMoveOnly<std::vector<std::unique_ptr<Command>>>({
             std::make_unique<ConfigureShowCommand>(FullName()),
+            std::make_unique<ConfigureListCommand>(FullName()),
             std::make_unique<ConfigureTestCommand>(FullName()),
             std::make_unique<ConfigureValidateCommand>(FullName()),
             std::make_unique<ConfigureExportCommand>(FullName()),
@@ -35,6 +37,7 @@ namespace AppInstaller::CLI
         return {
             Argument{ Execution::Args::Type::ConfigurationFile, Resource::String::ConfigurationFileArgumentDescription, ArgumentType::Positional },
             Argument{ Execution::Args::Type::ConfigurationModulePath, Resource::String::ConfigurationModulePath, ArgumentType::Positional },
+            Argument{ Execution::Args::Type::ConfigurationHistoryItem, Resource::String::ConfigurationHistoryItemArgumentDescription, ArgumentType::Standard, Argument::Visibility::Help },
             Argument{ Execution::Args::Type::ConfigurationAcceptWarning, Resource::String::ConfigurationAcceptWarningArgumentDescription, ArgumentType::Flag },
             Argument{ Execution::Args::Type::ConfigurationEnable, Resource::String::ConfigurationEnableMessage, ArgumentType::Flag, Argument::Visibility::Help },
             Argument{ Execution::Args::Type::ConfigurationDisable, Resource::String::ConfigurationDisableMessage, ArgumentType::Flag, Argument::Visibility::Help },
@@ -94,12 +97,15 @@ namespace AppInstaller::CLI
         }
         else
         {
-            if (!execArgs.Contains(Execution::Args::Type::ConfigurationFile))
-            {
-                throw CommandException(Resource::String::RequiredArgError("file"_liv));
-            }
+            Configuration::ValidateCommonArguments(execArgs, true);
+        }
+    }
 
-            Configuration::ValidateCommonArguments(execArgs);
+    void ConfigureCommand::Complete(Execution::Context& context, Execution::Args::Type argType) const
+    {
+        if (argType == Execution::Args::Type::ConfigurationHistoryItem)
+        {
+            context << CompleteConfigurationHistoryItem;
         }
     }
 }

src/AppInstallerCLICore/Commands/ConfigureCommand.h

@@ -21,5 +21,6 @@ namespace AppInstaller::CLI
     protected:
         void ExecuteInternal(Execution::Context& context) const override;
         void ValidateArgumentsInternal(Execution::Args& execArgs) const override;
+        void Complete(Execution::Context& context, Execution::Args::Type argType) const override;
     };
 }

src/AppInstallerCLICore/Commands/ConfigureListCommand.cpp

@@ -0,0 +1,84 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#include "pch.h"
+#include "ConfigureListCommand.h"
+#include "Workflows/ConfigurationFlow.h"
+#include "ConfigurationCommon.h"
+
+using namespace AppInstaller::CLI::Workflow;
+
+namespace AppInstaller::CLI
+{
+    std::vector<Argument> ConfigureListCommand::GetArguments() const
+    {
+        return {
+            Argument{ Execution::Args::Type::ConfigurationHistoryItem, Resource::String::ConfigurationHistoryItemArgumentDescription, ArgumentType::Standard },
+            Argument{ Execution::Args::Type::OutputFile, Resource::String::OutputFileArgumentDescription, ArgumentType::Standard, Argument::Visibility::Help },
+            Argument{ Execution::Args::Type::ConfigurationHistoryRemove, Resource::String::ConfigurationHistoryRemoveArgumentDescription, ArgumentType::Flag, Argument::Visibility::Help },
+        };
+    }
+
+    Resource::LocString ConfigureListCommand::ShortDescription() const
+    {
+        return { Resource::String::ConfigureListCommandShortDescription };
+    }
+
+    Resource::LocString ConfigureListCommand::LongDescription() const
+    {
+        return { Resource::String::ConfigureListCommandLongDescription };
+    }
+
+    Utility::LocIndView ConfigureListCommand::HelpLink() const
+    {
+        return "https://aka.ms/winget-command-configure#list"_liv;
+    }
+
+    void ConfigureListCommand::ExecuteInternal(Execution::Context& context) const
+    {
+        context <<
+            VerifyIsFullPackage <<
+            CreateConfigurationProcessorWithoutFactory <<
+            GetConfigurationSetHistory;
+
+        if (context.Args.Contains(Execution::Args::Type::ConfigurationHistoryItem))
+        {
+            context << SelectSetFromHistory;
+
+            if (context.Args.Contains(Execution::Args::Type::OutputFile))
+            {
+                context << SerializeConfigurationSetHistory;
+            }
+
+            if (context.Args.Contains(Execution::Args::Type::ConfigurationHistoryRemove))
+            {
+                context << RemoveConfigurationSetHistory;
+            }
+            else
+            {
+                context << ShowSingleConfigurationSetHistory;
+            }
+        }
+        else
+        {
+            context << ShowConfigurationSetHistory;
+        }
+    }
+
+    void ConfigureListCommand::ValidateArgumentsInternal(Execution::Args& execArgs) const
+    {
+        if ((execArgs.Contains(Execution::Args::Type::ConfigurationHistoryRemove) ||
+             execArgs.Contains(Execution::Args::Type::OutputFile)) &&
+            !execArgs.Contains(Execution::Args::Type::ConfigurationHistoryItem))
+        {
+            throw CommandException(Resource::String::RequiredArgError(ArgumentCommon::ForType(Execution::Args::Type::ConfigurationHistoryItem).Name));
+        }
+    }
+
+    void ConfigureListCommand::Complete(Execution::Context& context, Execution::Args::Type argType) const
+    {
+        if (argType == Execution::Args::Type::ConfigurationHistoryItem)
+        {
+            context << CompleteConfigurationHistoryItem;
+        }
+    }
+}

src/AppInstallerCLICore/Commands/ConfigureListCommand.h

@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#pragma once
+#include "Command.h"
+
+namespace AppInstaller::CLI
+{
+    struct ConfigureListCommand final : public Command
+    {
+        ConfigureListCommand(std::string_view parent) : Command("list", { "ls" }, parent) {}
+
+        std::vector<Argument> GetArguments() const override;
+
+        Resource::LocString ShortDescription() const override;
+        Resource::LocString LongDescription() const override;
+
+        Utility::LocIndView HelpLink() const override;
+
+    protected:
+        void ExecuteInternal(Execution::Context& context) const override;
+        void ValidateArgumentsInternal(Execution::Args& execArgs) const override;
+        void Complete(Execution::Context& context, Execution::Args::Type argType) const override;
+    };
+}

src/AppInstallerCLICore/Commands/ConfigureShowCommand.cpp

@@ -13,8 +13,9 @@ namespace AppInstaller::CLI
     {
         return {
             // Required for now, make exclusive when history implemented
-            Argument{ Execution::Args::Type::ConfigurationFile, Resource::String::ConfigurationFileArgumentDescription, ArgumentType::Positional, true },
+            Argument{ Execution::Args::Type::ConfigurationFile, Resource::String::ConfigurationFileArgumentDescription, ArgumentType::Positional },
             Argument{ Execution::Args::Type::ConfigurationModulePath, Resource::String::ConfigurationModulePath, ArgumentType::Positional },
+            Argument{ Execution::Args::Type::ConfigurationHistoryItem, Resource::String::ConfigurationHistoryItemArgumentDescription, ArgumentType::Standard, Argument::Visibility::Help },
         };
     }
 
@@ -45,6 +46,14 @@ namespace AppInstaller::CLI
 
     void ConfigureShowCommand::ValidateArgumentsInternal(Execution::Args& execArgs) const
     {
-        Configuration::ValidateCommonArguments(execArgs);
+        Configuration::ValidateCommonArguments(execArgs, true);
+    }
+
+    void ConfigureShowCommand::Complete(Execution::Context& context, Execution::Args::Type argType) const
+    {
+        if (argType == Execution::Args::Type::ConfigurationHistoryItem)
+        {
+            context << CompleteConfigurationHistoryItem;
+        }
     }
 }

src/AppInstallerCLICore/Commands/ConfigureShowCommand.h

@@ -19,5 +19,6 @@ namespace AppInstaller::CLI
     protected:
         void ExecuteInternal(Execution::Context& context) const override;
         void ValidateArgumentsInternal(Execution::Args& execArgs) const override;
+        void Complete(Execution::Context& context, Execution::Args::Type argType) const override;
     };
 }

src/AppInstallerCLICore/Commands/ConfigureTestCommand.cpp

@@ -12,8 +12,9 @@ namespace AppInstaller::CLI
     std::vector<Argument> ConfigureTestCommand::GetArguments() const
     {
         return {
-            Argument{ Execution::Args::Type::ConfigurationFile, Resource::String::ConfigurationFileArgumentDescription, ArgumentType::Positional, true },
+            Argument{ Execution::Args::Type::ConfigurationFile, Resource::String::ConfigurationFileArgumentDescription, ArgumentType::Positional },
             Argument{ Execution::Args::Type::ConfigurationModulePath, Resource::String::ConfigurationModulePath, ArgumentType::Positional },
+            Argument{ Execution::Args::Type::ConfigurationHistoryItem, Resource::String::ConfigurationHistoryItemArgumentDescription, ArgumentType::Standard, Argument::Visibility::Help },
             Argument{ Execution::Args::Type::ConfigurationAcceptWarning, Resource::String::ConfigurationAcceptWarningArgumentDescription, ArgumentType::Flag },
         };
     }
@@ -48,6 +49,14 @@ namespace AppInstaller::CLI
 
     void ConfigureTestCommand::ValidateArgumentsInternal(Execution::Args& execArgs) const
     {
-        Configuration::ValidateCommonArguments(execArgs);
+        Configuration::ValidateCommonArguments(execArgs, true);
+    }
+
+    void ConfigureTestCommand::Complete(Execution::Context& context, Execution::Args::Type argType) const
+    {
+        if (argType == Execution::Args::Type::ConfigurationHistoryItem)
+        {
+            context << CompleteConfigurationHistoryItem;
+        }
     }
 }

src/AppInstallerCLICore/Commands/ConfigureTestCommand.h

@@ -19,5 +19,6 @@ namespace AppInstaller::CLI
     protected:
         void ExecuteInternal(Execution::Context& context) const override;
         void ValidateArgumentsInternal(Execution::Args& execArgs) const override;
+        void Complete(Execution::Context& context, Execution::Args::Type argType) const override;
     };
 }

src/AppInstallerCLICore/ConfigurationCommon.cpp

@@ -54,7 +54,7 @@ namespace AppInstaller::CLI
 
     namespace Configuration
     {
-        void ValidateCommonArguments(Execution::Args& execArgs)
+        void ValidateCommonArguments(Execution::Args& execArgs, bool requireConfigurationSetChoice)
         {
             auto modulePath = GetModulePathInfo(execArgs);
 
@@ -71,6 +71,12 @@ namespace AppInstaller::CLI
                     throw CommandException(Resource::String::ConfigurationModulePathArgError);
                 }
             }
+
+            if (requireConfigurationSetChoice &&
+                !WI_IsFlagSet(Argument::GetCategoriesPresent(execArgs), ArgTypeCategory::ConfigurationSetChoice))
+            {
+                throw CommandException(Resource::String::RequiredArgError("file"_liv));
+            }
         }
 
         void SetModulePath(Execution::Context& context, IConfigurationSetProcessorFactory const& factory)

src/AppInstallerCLICore/ConfigurationCommon.h

@@ -9,7 +9,7 @@ namespace AppInstaller::CLI
     namespace Configuration
     {
         // Validates common arguments between configuration commands.
-        void ValidateCommonArguments(Execution::Args& execArgs);
+        void ValidateCommonArguments(Execution::Args& execArgs, bool requireConfigurationSetChoice = false);
 
         // Sets the module path to install modules in the set processor.
         void SetModulePath(Execution::Context& context, winrt::Microsoft::Management::Configuration::IConfigurationSetProcessorFactory const& factory);

src/AppInstallerCLICore/ConfigurationContext.cpp

@@ -14,6 +14,7 @@ namespace AppInstaller::CLI::Execution
         {
             ConfigurationProcessor Processor = nullptr;
             ConfigurationSet Set = nullptr;
+            std::vector<ConfigurationSet> History;
         };
     }
 
@@ -65,4 +66,21 @@ namespace AppInstaller::CLI::Execution
     {
         m_data->Set = std::move(value);
     }
+
+    std::vector<ConfigurationSet>& ConfigurationContext::History()
+    {
+        return m_data->History;
+    }
+
+    const std::vector<ConfigurationSet>& ConfigurationContext::History() const
+    {
+        return m_data->History;
+    }
+
+    void ConfigurationContext::History(const winrt::Windows::Foundation::Collections::IVector<ConfigurationSet>& value)
+    {
+        std::vector<ConfigurationSet> history{ value.Size() };
+        value.GetMany(0, history);
+        m_data->History = std::move(history);
+    }
 }