Add ability to write all manifests to a directory with one command

Author: JohnMcPMS

src/AppInstallerCLICore/Commands/DscCommand.cpp

@@ -12,8 +12,22 @@
 
 namespace AppInstaller::CLI
 {
+    namespace
+    {
+        Argument GetOutputFileArgument()
+        {
+            return { Execution::Args::Type::OutputFile, Resource::String::OutputFileArgumentDescription, ArgumentType::Standard };
+        }
+    }
+
+    DscCommand::DscCommand(std::string_view parent) :
+        Command(StaticName(), parent, Settings::ExperimentalFeature::Feature::ConfigurationDSCv3)
+    {
+    }
+
     std::vector<std::unique_ptr<Command>> DscCommand::GetCommands() const
     {
+        // These should all derive from DscCommandBase
         return InitializeFromMoveOnly<std::vector<std::unique_ptr<Command>>>({
             std::make_unique<DscPackageResource>(FullName()),
             std::make_unique<DscSourceResource>(FullName()),
@@ -24,6 +38,16 @@ namespace AppInstaller::CLI
         });
     }
 
+    std::vector<Argument> DscCommand::GetArguments() const
+    {
+        std::vector<Argument> result;
+
+        result.emplace_back(Execution::Args::Type::DscResourceFunctionManifest, Resource::String::DscResourceFunctionDescriptionManifest, ArgumentType::Flag);
+        result.emplace_back(GetOutputFileArgument());
+
+        return result;
+    }
+
     Resource::LocString DscCommand::ShortDescription() const
     {
         return { Resource::String::DscCommandShortDescription };
@@ -41,6 +65,34 @@ namespace AppInstaller::CLI
 
     void DscCommand::ExecuteInternal(Execution::Context& context) const
     {
-        OutputHelp(context.Reporter);
+        if (context.Args.Contains(Execution::Args::Type::DscResourceFunctionManifest))
+        {
+            std::filesystem::path outputDirectory{ Utility::ConvertToUTF16(context.Args.GetArg(Execution::Args::Type::OutputFile)) };
+            std::filesystem::create_directories(outputDirectory);
+
+            std::string filePrefix = Utility::ToLower(DscCommandBase::ModuleName());
+
+            for (const auto& command : GetCommands())
+            {
+                DscCommandBase* commandBase = static_cast<DscCommandBase*>(command.get());
+
+                std::filesystem::path outputPath = outputDirectory;
+                outputPath /= std::string{ filePrefix }.append(".").append(commandBase->Name()).append(".dsc.resource.json");
+                commandBase->WriteManifest(context, outputPath);
+            }
+        }
+        else
+        {
+            OutputHelp(context.Reporter);
+        }
+    }
+
+    void DscCommand::ValidateArgumentsInternal(Execution::Args& args) const
+    {
+        if (args.Contains(Execution::Args::Type::DscResourceFunctionManifest) &&
+            !args.Contains(Execution::Args::Type::OutputFile))
+        {
+            throw CommandException(Resource::String::RequiredArgError(GetOutputFileArgument().Name()));
+        }
     }
 }

src/AppInstallerCLICore/Commands/DscCommand.h

@@ -8,11 +8,12 @@ namespace AppInstaller::CLI
 {
     struct DscCommand final : public Command
     {
-        DscCommand(std::string_view parent) : Command(StaticName(), parent, Settings::ExperimentalFeature::Feature::ConfigurationDSCv3) {}
+        DscCommand(std::string_view parent);
 
         static constexpr std::string_view StaticName() { return "dscv3"sv; };
 
         std::vector<std::unique_ptr<Command>> GetCommands() const override;
+        std::vector<Argument> GetArguments() const override;
 
         Resource::LocString ShortDescription() const override;
         Resource::LocString LongDescription() const override;
@@ -21,5 +22,6 @@ namespace AppInstaller::CLI
 
     protected:
         void ExecuteInternal(Execution::Context& context) const override;
+        void ValidateArgumentsInternal(Execution::Args& args) const override;
     };
 }

src/AppInstallerCLICore/Commands/DscCommandBase.cpp

@@ -22,8 +22,6 @@ namespace AppInstaller::CLI
 {
     namespace
     {
-        constexpr std::string_view s_WingetModuleName = "Microsoft.WinGet"sv;
-
         std::string GetFunctionManifestString(DscFunctions function)
         {
             THROW_HR_IF(E_INVALIDARG, !WI_IsSingleFlagSet(function));
@@ -224,14 +222,23 @@ namespace AppInstaller::CLI
 
     WINGET_DSC_FUNCTION_FOREACH(WINGET_DSC_FUNCTION_METHOD);
 
-    void DscCommandBase::ResourceFunctionManifest(Execution::Context& context) const
+    std::string_view DscCommandBase::ModuleName()
+    {
+#ifndef AICLI_DISABLE_TEST_HOOKS
+        return "Microsoft.WinGet.Dev"sv;
+#else
+        return "Microsoft.WinGet"sv;
+#endif
+    }
+
+    void DscCommandBase::WriteManifest(Execution::Context& context, const std::filesystem::path& filePath) const
     {
         Json::Value json{ Json::ValueType::objectValue };
 
         // TODO: Move to release schema when released (there should be an aka.ms link as well, but it wasn't active yet)
         //json["$schema"] = "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/resource/manifest.json";
         json["$schema"] = "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/bundled/resource/manifest.json";
-        json["type"] = std::string{ s_WingetModuleName } + '/' + ResourceType();
+        json["type"] = std::string{ ModuleName() } + '/' + ResourceType();
         json["description"] = LongDescription().get();
         json["version"] = Runtime::GetClientVersion().get();
 
@@ -253,9 +260,9 @@ namespace AppInstaller::CLI
         writerBuilder.settings_["indentation"] = "  ";
         std::string jsonString = Json::writeString(writerBuilder, json);
 
-        if (context.Args.Contains(Execution::Args::Type::OutputFile))
+        if (!filePath.empty())
         {
-            std::ofstream stream{ Utility::ConvertToUTF16(context.Args.GetArg(Execution::Args::Type::OutputFile)), std::ios::binary };
+            std::ofstream stream{ filePath, std::ios::binary };
             stream.write(jsonString.c_str(), jsonString.length());
         }
         else
@@ -264,6 +271,16 @@ namespace AppInstaller::CLI
         }
     }
 
+    void DscCommandBase::ResourceFunctionManifest(Execution::Context& context) const
+    {
+        std::filesystem::path path;
+        if (context.Args.Contains(Execution::Args::Type::OutputFile))
+        {
+            path = std::filesystem::path{ Utility::ConvertToUTF16(context.Args.GetArg(Execution::Args::Type::OutputFile)) };
+        }
+        WriteManifest(context, path);
+    }
+
 #undef WINGET_DSC_FUNCTION_METHOD
 
     std::optional<Json::Value> DscCommandBase::GetJsonFromInput(Execution::Context& context, bool terminateContextOnError) const

src/AppInstallerCLICore/Commands/DscCommandBase.h

@@ -75,6 +75,12 @@ namespace AppInstaller::CLI
 
         Utility::LocIndView HelpLink() const override;
 
+        static std::string_view ModuleName();
+
+        // Writes the manifest for the command to the file path.
+        // If the path is empty, writes the manifest to the output stream.
+        void WriteManifest(Execution::Context& context, const std::filesystem::path& filePath) const;
+
     protected:
         void ExecuteInternal(Execution::Context& context) const override;