Add resume command and support saving the argument state.

.github/actions/spelling/allow.txt

@@ -3,6 +3,7 @@ ACCESSDENIED
 ACTIONDATA
 ACTIONSTART
 activatable
+addcontext
 addfile
 addmanifest
 addpin
@@ -60,6 +61,7 @@ cdn
 cer
 certutil
 cguid
+checkpointindex
 chrono
 cin
 cla
@@ -115,6 +117,7 @@ debugbreak
 declspec
 decltype
 declval
+deconstructor
 defaultlocale
 delstore
 Demitrius
@@ -231,6 +234,7 @@ https
 HWND
 Hyperlink
 IAppx
+ICheckpoint
 IConfiguration
 icu
 IDX
@@ -491,6 +495,8 @@ seinfo
 selectany
 SERVICEPACKMAJOR
 SERVICEPACKMINOR
+setclientversion
+setcommandname
 setfill
 setschemaversion
 setupexitcodes
@@ -635,10 +641,13 @@ Unmarshal
 Unregister
 Unregisters
 untimes
+updateboolargument
 updatefile
+updatelastcheckpointflag
 updatemanifest
 updatepin
 updateportablefile
+updatestringargument
 UPLEVEL
 upvote
 uregex

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj

@@ -350,6 +350,7 @@
   <ItemGroup>
     <ClInclude Include="Argument.h" />
     <ClInclude Include="ChannelStreams.h" />
+    <ClInclude Include="CheckpointManager.h" />
     <ClInclude Include="Command.h" />
     <ClInclude Include="Commands\COMCommand.h" />
     <ClInclude Include="Commands\CompleteCommand.h" />
@@ -370,6 +371,7 @@
     <ClInclude Include="Commands\ShowCommand.h" />
     <ClInclude Include="Commands\InstallCommand.h" />
     <ClInclude Include="Commands\RootCommand.h" />
+    <ClInclude Include="Commands\ResumeCommand.h" />
     <ClInclude Include="Commands\SourceCommand.h" />
     <ClInclude Include="Commands\TestCommand.h" />
     <ClInclude Include="Commands\UninstallCommand.h" />
@@ -412,6 +414,7 @@
     <ClInclude Include="Workflows\ShellExecuteInstallerHandler.h" />
     <ClInclude Include="Workflows\InstallFlow.h" />
     <ClInclude Include="Workflows\ManifestComparator.h" />
+    <ClInclude Include="Workflows\ResumeFlow.h" />
     <ClInclude Include="Workflows\ShowFlow.h" />
     <ClInclude Include="Workflows\SourceFlow.h" />
     <ClInclude Include="Workflows\UninstallFlow.h" />
@@ -420,6 +423,7 @@
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="COMContext.cpp" />
+    <ClCompile Include="CheckpointManager.cpp" />
     <ClCompile Include="Commands\COMCommand.cpp" />
     <ClCompile Include="Commands\ConfigureCommand.cpp" />
     <ClCompile Include="Commands\ConfigureShowCommand.cpp" />
@@ -449,6 +453,7 @@
     <ClCompile Include="Commands\ShowCommand.cpp" />
     <ClCompile Include="Commands\InstallCommand.cpp" />
     <ClCompile Include="Commands\RootCommand.cpp" />
+    <ClCompile Include="Commands\ResumeCommand.cpp" />
     <ClCompile Include="Commands\SourceCommand.cpp" />
     <ClCompile Include="Commands\UninstallCommand.cpp" />
     <ClCompile Include="Commands\UpgradeCommand.cpp" />
@@ -480,6 +485,7 @@
     <ClCompile Include="Workflows\ShellExecuteInstallerHandler.cpp" />
     <ClCompile Include="Workflows\InstallFlow.cpp" />
     <ClCompile Include="Workflows\ManifestComparator.cpp" />
+    <ClCompile Include="Workflows\ResumeFlow.cpp" />
     <ClCompile Include="Workflows\ShowFlow.cpp" />
     <ClCompile Include="Workflows\SourceFlow.cpp" />
     <ClCompile Include="Workflows\UninstallFlow.cpp" />

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj.filters

@@ -227,6 +227,15 @@
     <ClInclude Include="Commands\DownloadCommand.h">
       <Filter>Commands</Filter>
     </ClInclude>
+    <ClInclude Include="Commands\ResumeCommand.h">
+      <Filter>Commands</Filter>
+    </ClInclude>
+    <ClInclude Include="Workflows\ResumeFlow.h">
+      <Filter>Workflows</Filter>
+    </ClInclude>
+    <ClInclude Include="CheckpointManager.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="pch.cpp">
@@ -421,6 +430,15 @@
     <ClInclude Include="Commands\DownloadCommand.cpp">
       <Filter>Commands</Filter>
     </ClInclude>
+    <ClCompile Include="Commands\ResumeCommand.cpp">
+      <Filter>Commands</Filter>
+    </ClCompile>
+    <ClCompile Include="Workflows\ResumeFlow.cpp">
+      <Filter>Workflows</Filter>
+    </ClCompile>
+    <ClCompile Include="CheckpointManager.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="PropertySheet.props" />

src/AppInstallerCLICore/Argument.cpp

@@ -174,6 +174,10 @@ namespace AppInstaller::CLI
         case Execution::Args::Type::PinInstalled:
             return { type, "installed"_liv, ArgTypeCategory::None };
 
+        // Resume command
+        case Execution::Args::Type::ResumeGuid:
+            return { type, "resume-guid"_liv, 'g', ArgTypeCategory::None };
+
         // Configuration commands
         case Execution::Args::Type::ConfigurationFile:
             return { type, "file"_liv, 'f' };
@@ -345,6 +349,8 @@ namespace AppInstaller::CLI
             return Argument{ type, Resource::String::DownloadDirectoryArgumentDescription, ArgumentType::Standard, Argument::Visibility::Help, false };
         case Args::Type::InstallerType:
             return Argument{ type, Resource::String::InstallerTypeArgumentDescription, ArgumentType::Standard, Argument::Visibility::Help, false };
+        case Args::Type::ResumeGuid:
+            return Argument{ type, Resource::String::ResumeGuidArgumentDescription, ArgumentType::Standard, true };
         default:
             THROW_HR(E_UNEXPECTED);
         }

src/AppInstallerCLICore/CheckpointManager.cpp

@@ -0,0 +1,221 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#include "pch.h"
+#include "AppInstallerRuntime.h"
+#include "CheckpointManager.h"
+#include "Microsoft/CheckpointIndex.h"
+#include "Microsoft/SQLiteStorageBase.h"
+#include <Argument.h>
+#include <Command.h>
+
+namespace AppInstaller::CLI::Checkpoint
+{
+    void CheckpointManager::Initialize(GUID checkpointId)
+    {
+        // Initialize should only be called once.
+        THROW_HR_IF(E_UNEXPECTED, m_checkpointId != GUID_NULL);
+
+        bool createCheckpointIndex = (checkpointId == GUID_NULL);
+        if (createCheckpointIndex)
+        {
+            std::ignore = CoCreateGuid(&m_checkpointId);
+            AICLI_LOG(CLI, Info, << "Creating checkpoint index with guid: " << m_checkpointId);
+        }
+        else
+        {
+            m_checkpointId = checkpointId;
+            AICLI_LOG(CLI, Info, << "Opening checkpoint index with guid: " << m_checkpointId);
+        }
+
+        auto openDisposition = AppInstaller::Repository::Microsoft::SQLiteStorageBase::OpenDisposition::ReadWrite;
+        auto checkpointIndex = AppInstaller::Repository::Microsoft::CheckpointIndex::OpenOrCreateDefault(m_checkpointId, openDisposition);
+        if (!checkpointIndex)
+        {
+            AICLI_LOG(CLI, Error, << "Unable to open checkpoint index.");
+            THROW_HR_MSG(HRESULT_FROM_WIN32(ERROR_NOT_FOUND), "The checkpoint state could not be found.");
+        }
+
+        m_checkpointIndex = std::move(checkpointIndex);
+
+        if (createCheckpointIndex)
+        {
+            m_checkpointIndex->SetClientVersion(AppInstaller::Runtime::GetClientVersion());
+        }
+    }
+
+    void CheckpointManager::Checkpoint(Execution::Context& context, Execution::CheckpointFlag checkpointFlag)
+    {
+        Execution::CheckpointFlag contextCheckpointFlag = context.GetTargetCheckpoint();
+
+        // If the context target checkpoint is ahead or equal to the current checkpoint, we have previously executed this state, load checkpoint state from index.
+        // If the context target checkpoint is behind the current checkpoint, we have not yet processed this state, save checkpoint state to index.
+        if (contextCheckpointFlag > checkpointFlag || contextCheckpointFlag == checkpointFlag)
+        {
+            LoadCheckpoint(context, checkpointFlag);
+        }
+        else if (contextCheckpointFlag < checkpointFlag)
+        {
+            SaveCheckpoint(context, checkpointFlag);
+        }
+    }
+
+    bool CheckpointManager::HasContext()
+    {
+        return !m_checkpointIndex->IsEmpty();
+    }
+
+    void CheckpointManager::AddContext(int contextId)
+    {
+        m_checkpointIndex->AddContext(contextId);
+    }
+
+    void CheckpointManager::RemoveContext(int contextId)
+    {
+        m_checkpointIndex->RemoveContext(contextId);
+    }
+
+    std::string CheckpointManager::GetClientVersion()
+    {
+        return m_checkpointIndex->GetClientVersion();
+    }
+
+    std::string CheckpointManager::GetCommandName(int contextId)
+    {
+        return m_checkpointIndex->GetCommandName(contextId);
+    }
+
+    int CheckpointManager::GetFirstContextId()
+    {
+        return m_checkpointIndex->GetFirstContextId();
+    }
+
+    Execution::CheckpointFlag CheckpointManager::GetLastCheckpoint(int contextId)
+    {
+        return static_cast<Execution::CheckpointFlag>(m_checkpointIndex->GetLastCheckpoint(contextId));
+    }
+
+#ifndef AICLI_DISABLE_TEST_HOOKS
+    static bool s_MockCheckpointManagerCleanUp_Override = false;
+
+    void TestHook_MockCheckpointManagerCleanUp_Override(bool status)
+    {
+        s_MockCheckpointManagerCleanUp_Override = status;
+    }
+#endif
+
+    void CheckpointManager::CleanUpIndex()
+    {
+#ifndef AICLI_DISABLE_TEST_HOOKS
+        // Unit tests will handle clean up so this hook is needed to avoid attempting to reset and clean up again.
+        if (s_MockCheckpointManagerCleanUp_Override)
+        {
+            return;
+        }
+#endif
+
+        bool isIndexEmpty = m_checkpointIndex->IsEmpty();
+
+        m_checkpointIndex.reset();
+
+        if (isIndexEmpty)
+        {
+            const auto& checkpointIndexPath = AppInstaller::Repository::Microsoft::CheckpointIndex::GetCheckpointIndexPath(m_checkpointId);
+            if (std::filesystem::remove(checkpointIndexPath))
+            {
+                AICLI_LOG(CLI, Info, << "Checkpoint index deleted: " << checkpointIndexPath);
+            }
+        }
+    }
+
+    CheckpointManager::~CheckpointManager()
+    {
+        CleanUpIndex();
+    }
+
+    void CheckpointManager::SaveCheckpoint(Execution::Context& context, Execution::CheckpointFlag flag)
+    {
+        switch (flag)
+        {
+        case Execution::CheckpointFlag::CommandArguments:
+            RecordContextArgsToIndex(context);
+            break;
+        default:
+            THROW_HR(E_UNEXPECTED);
+        }
+
+        m_checkpointIndex->SetLastCheckpoint(context.GetContextId(), static_cast<int>(flag));
+        context.SetCurrentCheckpoint(flag);
+    }
+
+    void CheckpointManager::LoadCheckpoint(Execution::Context& context, Execution::CheckpointFlag flag)
+    {
+        switch (flag)
+        {
+        case Execution::CheckpointFlag::CommandArguments:
+            PopulateContextArgsFromIndex(context);
+            break;
+        default:
+            THROW_HR(E_UNEXPECTED);
+        }
+
+        context.SetCurrentCheckpoint(flag);
+    }
+
+    void CheckpointManager::PopulateContextArgsFromIndex(Execution::Context& context)
+    {
+        int contextId = context.GetContextId();
+
+        const auto& executingCommand = context.GetExecutingCommand();
+        if (executingCommand != nullptr)
+        {
+            const auto& commandArguments = executingCommand->GetArguments();
+            for (const auto& argument : commandArguments)
+            {
+                if (m_checkpointIndex->ContainsArgument(contextId, argument.Name()))
+                {
+                    Execution::Args::Type executionArgsType = argument.ExecArgType();
+                    if (argument.Type() == ArgumentType::Flag)
+                    {
+                        if (m_checkpointIndex->GetBoolArgument(contextId, argument.Name()))
+                        {
+                            context.Args.AddArg(executionArgsType);
+                        }
+                    }
+                    else
+                    {
+                        context.Args.AddArg(executionArgsType, m_checkpointIndex->GetStringArgument(contextId, argument.Name()));
+                    }
+                }
+            }
+        }
+    }
+
+    void CheckpointManager::RecordContextArgsToIndex(Execution::Context& context)
+    {
+        int contextId = context.GetContextId();
+
+        const auto& executingCommand = context.GetExecutingCommand();
+        if (executingCommand != nullptr)
+        {
+            m_checkpointIndex->SetCommandName(contextId, executingCommand->Name());
+
+            const auto& commandArguments = executingCommand->GetArguments();
+            for (const auto& argument : commandArguments)
+            {
+                Execution::Args::Type type = argument.ExecArgType();
+                if (context.Args.Contains(type))
+                {
+                    if (argument.Type() == ArgumentType::Flag)
+                    {
+                        m_checkpointIndex->UpdateArgument(contextId, argument.Name(), true);
+                    }
+                    else
+                    {
+                        const auto& argumentValue = context.Args.GetArg(type);
+                        m_checkpointIndex->UpdateArgument(contextId, argument.Name(), argumentValue);
+                    }
+                }
+            }
+        }
+    }
+}