Apply required modules

Author: yao-msft

src/AppInstallerCLICore/Workflows/ConfigurationFlow.cpp

@@ -53,7 +53,6 @@ namespace AppInstaller::CLI::Workflow
         constexpr std::wstring_view s_UnitType_WinGetSource_DSCv3 = WINGET_DSCV3_MODULE_NAME_WIDE L"/Source";
         constexpr std::wstring_view s_UnitType_WinGetUserSettingsFile_DSCv3 = WINGET_DSCV3_MODULE_NAME_WIDE L"/UserSettingsFile";
         constexpr std::wstring_view s_UnitType_WinGetAdminSettings_DSCv3 = WINGET_DSCV3_MODULE_NAME_WIDE L"/AdminSettings";
-        constexpr std::wstring_view s_UnitType_PowerShellModuleGet = L"PowerShellGet/PSModule";
 
         constexpr std::wstring_view s_Module_WinGetClient = L"Microsoft.WinGet.DSC";
 
@@ -65,8 +64,6 @@ namespace AppInstaller::CLI::Workflow
         constexpr std::wstring_view s_Setting_WinGetSource_Arg = L"argument";
         constexpr std::wstring_view s_Setting_WinGetSource_Type = L"type";
 
-        constexpr std::wstring_view s_Setting_PowerShellGet_ModuleName = L"name";
-
         struct PredefinedResourceInfo
         {
             std::wstring_view UnitType;
@@ -1246,14 +1243,55 @@ namespace AppInstaller::CLI::Workflow
             return unit;
         }
 
-        ConfigurationUnit CreatePowerShellModuleGetUnit(const std::wstring& moduleName)
+        ConfigurationUnit CreatePowerShellPackageUnit()
+        {
+            ConfigurationUnit unit = CreateConfigurationUnitFromUnitType(s_UnitType_WinGetPackage_DSCv3, "Microsoft.PowerShell");
+
+            ValueSet settings;
+            settings.Insert(s_Setting_WinGetPackage_Id, PropertyValue::CreateString(L"Microsoft.PowerShell"));
+            settings.Insert(s_Setting_WinGetPackage_Source, PropertyValue::CreateString(L"winget"));
+            unit.Settings(settings);
+
+            return unit;
+        }
+
+        ValueSet CreateValueSetFromStringArray(const std::vector<std::wstring>& values)
+        {
+            ValueSet result;
+            size_t index = 0;
+
+            for (const auto& value : values)
+            {
+                std::wostringstream strstr;
+                strstr << index++;
+                result.Insert(strstr.str(), PropertyValue::CreateString(value));
+            }
+
+            result.Insert(L"treatAsArray", PropertyValue::CreateBoolean(true));
+            return result;
+        }
+
+        // TODO: This is a work around unit to ensure v2 dsc resource modules. Move to dsc v3 resource when available.
+        ConfigurationUnit CreateRequiredModuleUnit(std::wstring_view moduleName, const ConfigurationUnit& dependentUnit)
         {
-            ConfigurationUnit unit = CreateConfigurationUnitFromUnitType(s_UnitType_PowerShellModuleGet, Utility::ConvertToUTF8(moduleName));
+            std::wstring moduleNameString{ moduleName };
+
+            ConfigurationUnit unit = CreateConfigurationUnitFromUnitType(L"Microsoft.DSC.Transitional/RunCommandOnSet", Utility::ConvertToUTF8(moduleName));
 
             ValueSet settings;
-            settings.Insert(s_Setting_PowerShellGet_ModuleName, PropertyValue::CreateString(moduleName));
+            settings.Insert(L"executable", PropertyValue::CreateString(L"pwsh"));
+            std::vector<std::wstring> arguments =
+            {
+                L"-NoProfile",
+                L"-NoLogo",
+                L"-Command",
+                L"if (-not (Get-Module -ListAvailable -Name " + moduleNameString + L")) { Install-Module -Name " + moduleNameString + L" -Confirm:$False -Force -AllowPrerelease -AllowClobber }"
+            };
+            settings.Insert(L"arguments", CreateValueSetFromStringArray(arguments));
             unit.Settings(settings);
 
+            unit.Dependencies().Append(dependentUnit.Identifier());
+
             return unit;
         }
 
@@ -1536,15 +1574,37 @@ namespace AppInstaller::CLI::Workflow
         {
             ConfigurationContext& configContext = context.Get<Data::ConfigurationContext>();
 
+            // PowerShell package needs to be present for later certain predefined modules to work.
+            std::optional<ConfigurationUnit> powerShellPackageUnit = CreatePowerShellPackageUnit();
+
+            // Apply the unit to make sure it's on the system.
+            context.Reporter.Info() << Resource::String::ConfigurationExportInstallRequiredModule(Utility::LocIndView{ "Microsoft PowerShell" }) << std::endl;
+            auto applyPowerShellResult = ApplyUnit(context, powerShellPackageUnit.value());
+            if (SUCCEEDED(applyPowerShellResult.ResultInformation().ResultCode()))
+            {
+                configContext.Set().Units().Append(powerShellPackageUnit.value());
+            }
+            else
+            {
+                AICLI_LOG(Config, Warning, << "Failed to ensure module. [Microsoft PowerShell] Related settings will not be exported.");
+                LogFailedGetConfigurationUnitDetails(powerShellPackageUnit.value(), applyPowerShellResult.ResultInformation());
+                context.Reporter.Warn() << Resource::String::ConfigurationExportInstallRequiredModuleFailed << std::endl;
+                powerShellPackageUnit = std::nullopt;
+            }
+
             for (const auto& resources : PredefinedResourcesForExport())
             {
                 std::optional<ConfigurationUnit> requiredModuleUnit;
 
-                /* The PowershellGet/PSModule does not work under dsc v3 adaptor yet.
-                 * Uncomment if still applicable after the issue is fixed.
                 if (!resources.RequiredModule.empty())
                 {
-                    requiredModuleUnit = CreatePowerShellModuleGetUnit(resources.RequiredModule);
+                    if (!powerShellPackageUnit)
+                    {
+                        // PowerShell package not present, skip.
+                        continue;
+                    }
+
+                    requiredModuleUnit = CreateRequiredModuleUnit(resources.RequiredModule, powerShellPackageUnit.value());
 
                     // Apply the unit to make sure it's on the system.
                     context.Reporter.Info() << Resource::String::ConfigurationExportInstallRequiredModule(Utility::LocIndView{ Utility::ConvertToUTF8(resources.RequiredModule) }) << std::endl;
@@ -1561,7 +1621,6 @@ namespace AppInstaller::CLI::Workflow
                         continue;
                     }
                 }
-                */
 
                 for (const auto& resourceInfo : resources.ResourceInfos)
                 {

src/AppInstallerCLIE2ETests/ConfigureExportCommand.cs

@@ -154,7 +154,10 @@ public void ExportAll()
             var showResult = TestCommon.RunAICLICommand(ShowCommand, $"-f {exportFile}", timeOut: 1200000);
             Assert.AreEqual(Constants.ErrorCode.S_OK, showResult.ExitCode);
 
+            Assert.True(showResult.StdOut.Contains("Microsoft.PowerShell"));
+
             Assert.True(showResult.StdOut.Contains("Microsoft.WinGet.Dev/UserSettingsFile"));
+            Assert.True(showResult.StdOut.Contains("Microsoft.WinGet.Dev/AdminSettings"));
             Assert.True(showResult.StdOut.Contains("Microsoft.Windows.Settings/WindowsSettings"));
 
             Assert.True(showResult.StdOut.Contains("Microsoft.WinGet.Dev/Source"));