Dscv3 package resource (#5395)

## Change
Add a new DSC v3 resource: `package`. This largely follows the design of
the v2 resource, but uses the v3 paradigm for existence.

Other minor changes:
- Adds a `StdErrLogger` and attaches it during resource execution. This
currently writes all logs at `Error` or higher to `std::cerr`, allowing
`dsc.exe` to receive (and pass on) failure information.
- Uses the type of the standard input handle to determine if it should
be read from (will not read JSON input from the interactive console,
only piped input).
- Adds support for localized schema generation for resources.
- Moves `ManifestComparator` to common for re-use.

## Validation
Added E2E tests to invoke the package resource in a variety of
situations.

Author: JohnMcPMS

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj

@@ -305,6 +305,7 @@
     <ClInclude Include="Commands\DscCommand.h" />
     <ClInclude Include="Commands\DscCommandBase.h" />
     <ClInclude Include="Commands\DscComposableObject.h" />
+    <ClInclude Include="Commands\DscPackageResource.h" />
     <ClInclude Include="Commands\DscTestFileResource.h" />
     <ClInclude Include="Commands\DscTestJsonResource.h" />
     <ClInclude Include="Commands\ErrorCommand.h" />
@@ -369,7 +370,6 @@
     <ClInclude Include="Workflows\SettingsFlow.h" />
     <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" />
@@ -391,6 +391,7 @@
     <ClCompile Include="Commands\DscCommand.cpp" />
     <ClCompile Include="Commands\DscCommandBase.cpp" />
     <ClCompile Include="Commands\DscComposableObject.cpp" />
+    <ClCompile Include="Commands\DscPackageResource.cpp" />
     <ClCompile Include="Commands\DscTestFileResource.cpp" />
     <ClCompile Include="Commands\DscTestJsonResource.cpp" />
     <ClCompile Include="Commands\ErrorCommand.cpp" />
@@ -456,7 +457,6 @@
     <ClCompile Include="Workflows\SettingsFlow.cpp" />
     <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" />

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj.filters

@@ -47,9 +47,6 @@
     <ClInclude Include="Workflows\InstallFlow.h">
       <Filter>Workflows</Filter>
     </ClInclude>
-    <ClInclude Include="Workflows\ManifestComparator.h">
-      <Filter>Workflows</Filter>
-    </ClInclude>
     <ClInclude Include="Workflows\ShellExecuteInstallerHandler.h">
       <Filter>Workflows</Filter>
     </ClInclude>
@@ -284,6 +281,9 @@
     <ClInclude Include="Commands\DscTestJsonResource.h">
       <Filter>Commands\Configuration</Filter>
     </ClInclude>
+    <ClInclude Include="Commands\DscPackageResource.h">
+      <Filter>Commands\Configuration</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="pch.cpp">
@@ -301,9 +301,6 @@
     <ClCompile Include="Core.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="Workflows\ManifestComparator.cpp">
-      <Filter>Workflows</Filter>
-    </ClCompile>
     <ClCompile Include="Workflows\ShellExecuteInstallerHandler.cpp">
       <Filter>Workflows</Filter>
     </ClCompile>
@@ -535,6 +532,9 @@
     <ClCompile Include="Commands\DscTestJsonResource.cpp">
       <Filter>Commands\Configuration</Filter>
     </ClCompile>
+    <ClCompile Include="Commands\DscPackageResource.cpp">
+      <Filter>Commands\Configuration</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="PropertySheet.props" />

src/AppInstallerCLICore/Argument.cpp

@@ -289,6 +289,8 @@ namespace AppInstaller::CLI
             return { type, "force"_liv, ArgTypeCategory::CopyFlagToSubContext };
         case Execution::Args::Type::OutputFile:
             return { type, "output"_liv, 'o' };
+        case Execution::Args::Type::Correlation:
+            return { type, "correlation"_liv };
 
         case Execution::Args::Type::DependencySource:
             return { type, "dependency-source"_liv, ArgTypeCategory::ExtendedSource };
@@ -468,6 +470,8 @@ namespace AppInstaller::CLI
             return Argument{ type, Resource::String::NoProxyArgumentDescription, ArgumentType::Flag, TogglePolicy::Policy::ProxyCommandLineOptions, BoolAdminSetting::ProxyCommandLineOptions };
         case Args::Type::Family:
             return Argument{ type, Resource::String::FontFamilyNameArgumentDescription, ArgumentType::Positional, false };
+        case Args::Type::Correlation:
+            return Argument{ type, Resource::String::CorrelationArgumentDescription, ArgumentType::Standard, Argument::Visibility::Hidden };
         default:
             THROW_HR(E_UNEXPECTED);
         }
@@ -486,6 +490,7 @@ namespace AppInstaller::CLI
         args.emplace_back(Args::Type::DisableInteractivity, Resource::String::DisableInteractivityArgumentDescription, ArgumentType::Flag, false);
         args.push_back(ForType(Args::Type::Proxy));
         args.push_back(ForType(Args::Type::NoProxy));
+        args.push_back(ForType(Args::Type::Correlation));
     }
 
     std::string Argument::GetUsageString() const

src/AppInstallerCLICore/Commands/DscCommand.cpp

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 #include "pch.h"
 #include "DscCommand.h"
+#include "DscPackageResource.h"
 
 #ifndef AICLI_DISABLE_TEST_HOOKS
 #include "DscTestFileResource.h"
@@ -13,6 +14,7 @@ namespace AppInstaller::CLI
     std::vector<std::unique_ptr<Command>> DscCommand::GetCommands() const
     {
         return InitializeFromMoveOnly<std::vector<std::unique_ptr<Command>>>({
+            std::make_unique<DscPackageResource>(FullName()),
 #ifndef AICLI_DISABLE_TEST_HOOKS
             std::make_unique<DscTestFileResource>(FullName()),
             std::make_unique<DscTestJsonResource>(FullName()),

src/AppInstallerCLICore/Commands/DscCommandBase.cpp

@@ -4,6 +4,7 @@
 #include "DscCommandBase.h"
 #include "DscCommand.h"
 #include <winget/Runtime.h>
+#include <winget/StdErrLogger.h>
 
 #define WINGET_DSC_FUNCTION_FOREACH(_macro_) \
     _macro_(Get); \
@@ -201,8 +202,7 @@ namespace AppInstaller::CLI
     void DscCommandBase::ExecuteInternal(Execution::Context& context) const
     {
         context.Reporter.SetChannel(Execution::Reporter::Channel::Json);
-
-        // TODO: Consider adding a stderr logger
+        Logging::StdErrLogger::Add();
 
 #define WINGET_DSC_FUNCTION_ARGUMENT(_function_) \
         if (context.Args.Contains(Execution::Args::Type::DscResourceFunction ## _function_)) \
@@ -266,18 +266,33 @@ namespace AppInstaller::CLI
 
 #undef WINGET_DSC_FUNCTION_METHOD
 
-    std::optional<Json::Value> DscCommandBase::GetJsonFromInput(Execution::Context& context) const
+    std::optional<Json::Value> DscCommandBase::GetJsonFromInput(Execution::Context& context, bool terminateContextOnError) const
     {
-        Json::Value result;
-        Json::CharReaderBuilder builder;
-        Json::String errors;
-        if (!Json::parseFromStream(builder, context.Reporter.RawInputStream(), &result, &errors))
+        // Don't attempt to read from an interactive stream as this will just block
+        if (!context.Reporter.InputStreamIsInteractive())
         {
+            AICLI_LOG(CLI, Verbose, << "Reading Json from input stream...");
+
+            Json::Value result;
+            Json::CharReaderBuilder builder;
+            Json::String errors;
+            if (Json::parseFromStream(builder, context.Reporter.RawInputStream(), &result, &errors))
+            {
+                AICLI_LOG(CLI, Info, << "Json from input stream:\n" << Json::writeString(Json::StreamWriterBuilder{}, result));
+                return result;
+            }
+
             AICLI_LOG(CLI, Error, << "Failed to read input JSON: " << errors);
-            AICLI_TERMINATE_CONTEXT_RETURN(APPINSTALLER_CLI_ERROR_JSON_INVALID_FILE, std::nullopt);
         }
 
-        return result;
+        if (terminateContextOnError)
+        {
+            AICLI_TERMINATE_CONTEXT_RETURN(APPINSTALLER_CLI_ERROR_JSON_INVALID_FILE, std::nullopt);
+        }
+        else
+        {
+            return std::nullopt;
+        }
     }
 
     void DscCommandBase::WriteJsonOutputLine(Execution::Context& context, const Json::Value& value) const

src/AppInstallerCLICore/Commands/DscCommandBase.h

@@ -94,7 +94,7 @@ namespace AppInstaller::CLI
         virtual void ResourceFunctionManifest(Execution::Context& context) const;
 
         // Parses a JSON object from stdin.
-        std::optional<Json::Value> GetJsonFromInput(Execution::Context& context) const;
+        std::optional<Json::Value> GetJsonFromInput(Execution::Context& context, bool terminateContextOnError = true) const;
 
         // Writes the value to the context output.
         void WriteJsonOutputLine(Execution::Context& context, const Json::Value& value) const;

src/AppInstallerCLICore/Commands/DscComposableObject.cpp

@@ -5,6 +5,32 @@
 
 namespace AppInstaller::CLI
 {
+    namespace
+    {
+        std::string GetTypeString(Json::ValueType type)
+        {
+            switch (type)
+            {
+            case Json::nullValue:
+                return "null";
+            case Json::intValue:
+            case Json::uintValue:
+            case Json::realValue:
+                return "number";
+            case Json::stringValue:
+                return "string";
+            case Json::booleanValue:
+                return "boolean";
+            case Json::arrayValue:
+                return "array";
+            case Json::objectValue:
+                return "object";
+            default:
+                THROW_HR(E_UNEXPECTED);
+            }
+        }
+    }
+
     namespace details
     {
         const Json::Value* GetProperty(const Json::Value& object, std::string_view name)
@@ -32,7 +58,14 @@ namespace AppInstaller::CLI
             return result;
         }
 
-        void AddPropertySchema(Json::Value& object, std::string_view name, DscComposablePropertyFlag flags, std::string_view type, std::string_view description)
+        void AddPropertySchema(
+            Json::Value& object,
+            std::string_view name,
+            DscComposablePropertyFlag flags,
+            Json::ValueType type,
+            std::string_view description,
+            const std::vector<std::string>& enumValues,
+            const std::optional<std::string>& defaultValue)
         {
             Json::Value& propertiesObject = object["properties"];
 
@@ -45,13 +78,30 @@ namespace AppInstaller::CLI
 
             Json::Value property{ Json::ValueType::objectValue };
 
-            if (!type.empty())
+            if (type != Json::ValueType::objectValue)
             {
-                property["type"] = std::string{ type };
+                property["type"] = GetTypeString(type);
             }
 
             property["description"] = std::string{ description };
 
+            if (!enumValues.empty())
+            {
+                Json::Value enumArray{ Json::ValueType::arrayValue };
+
+                for (const std::string& enumValue : enumValues)
+                {
+                    enumArray.append(enumValue);
+                }
+
+                property["enum"] = std::move(enumArray);
+            }
+
+            if (defaultValue)
+            {
+                property["default"] = defaultValue.value();
+            }
+
             propertiesObject[nameString] = std::move(property);
 
             if (WI_IsFlagSet(flags, DscComposablePropertyFlag::Required))