From 5bc4fd52e938a391460895404a7b65943492988e Mon Sep 17 00:00:00 2001
From: Ankit Jain <radical@gmail.com>
Date: Fri, 8 Mar 2024 20:26:31 -0500
Subject: [PATCH] [workload-testing] Remove the hacks, and use the update task

1. remove package source mapping from `nuget.config` as it gets added at
   build time now
2. Manifest packages are installed with a `PackageDownload` instead of a
   `PackageReference`, thus it can work with
   `PackageType='dotnetplatform'` packages.
3. Generating a patched nuget.config for building test projects can be
   done using a new `PatchNuGetConfig` task, and thus we can remove the
   inline task.
---
 NuGet.config                                  |  4 --
 .../Microsoft.NET.Sdk.Aspire.csproj           | 10 ---
 tests/Shared/Aspire.Workload.Testing.targets  | 72 +++----------------
 3 files changed, 11 insertions(+), 75 deletions(-)

diff --git a/NuGet.config b/NuGet.config
index 35a7f2a6bc..d611b31697 100644
--- a/NuGet.config
+++ b/NuGet.config
@@ -22,10 +22,6 @@
     <add key="azure-sdk-for-net-dev" value="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" />
   </packageSources>
   <packageSourceMapping>
-    <!-- used for installing test workloads for resolving aspire workload manifest -->
-    <packageSource key="nuget-local">
-      <package pattern="*Aspire*" />
-    </packageSource>
     <packageSource key="dotnet9-transport">
       <package pattern="*WorkloadBuildTasks*" />
     </packageSource>
diff --git a/src/Microsoft.NET.Sdk.Aspire/Microsoft.NET.Sdk.Aspire.csproj b/src/Microsoft.NET.Sdk.Aspire/Microsoft.NET.Sdk.Aspire.csproj
index 02522b1603..d73e9507f2 100644
--- a/src/Microsoft.NET.Sdk.Aspire/Microsoft.NET.Sdk.Aspire.csproj
+++ b/src/Microsoft.NET.Sdk.Aspire/Microsoft.NET.Sdk.Aspire.csproj
@@ -5,16 +5,6 @@
   <PropertyGroup>
     <PackageId>$(PackageId).Manifest-$(DotNetAspireManifestVersionBand)</PackageId>
     <Description>.NET Aspire workload manifest</Description>
-
-    <!--
-      the workload testing targets from dotnet/runtime install the manifest nuget with nuget-restore, which fails
-      for this manifest package because PackageType='dotnetplatform'.
-
-      As a temporary workaround, set `PackageType=''` but only for Linux/CI or local runs
-      Because the official workload packages are generated on windows, they will not be
-      affected by this workaround
-    -->
-    <PackageType Condition="'$(ContinuousIntegrationBuild)' != 'true' or ('$(OS)' != 'Windows_NT' and '$(ArchiveTests)' == 'true')" />
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/tests/Shared/Aspire.Workload.Testing.targets b/tests/Shared/Aspire.Workload.Testing.targets
index 54045ac654..519daa6561 100644
--- a/tests/Shared/Aspire.Workload.Testing.targets
+++ b/tests/Shared/Aspire.Workload.Testing.targets
@@ -3,6 +3,11 @@
     <GetWorkloadInputsDependsOn>_GetWorkloadsToInstall;$(GetWorkloadInputsDependsOn)</GetWorkloadInputsDependsOn>
     <GetNuGetsToBuildForWorkloadTestingDependsOn>_GetNuGetsToBuild;$(GetNuGetsToBuildForWorkloadTestingDependsOn)</GetNuGetsToBuildForWorkloadTestingDependsOn>
 
+    <!-- this will cause the output for `dotnet workload install` to be visible to the user -->
+    <WorkloadInstallCommandOutputImportance>High</WorkloadInstallCommandOutputImportance>
+
+    <NuGetConfigPackageSourceMappingsForWorkloadTesting>*Aspire*</NuGetConfigPackageSourceMappingsForWorkloadTesting>
+
     <_ShippingPackagesDir>$([MSBuild]::NormalizeDirectory($(ArtifactsDir), 'packages', $(Configuration), 'Shipping'))</_ShippingPackagesDir>
 
     <_GlobalJsonContent>$([System.IO.File]::ReadAllText('$(RepoRoot)global.json'))</_GlobalJsonContent>
@@ -72,69 +77,14 @@
     </ItemGroup>
   </Target>
 
-  <UsingTask TaskName="PrepareNuGetConfigForWorkloadTesting"
-      TaskFactory="RoslynCodeTaskFactory"
-      AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll">
-    <ParameterGroup>
-      <TemplateNuGetConfigPath ParameterType="System.String" Required="true" />
-      <OutputFile ParameterType="System.String" Required="true" />
-      <AddBuiltNuGetSource ParameterType="System.Boolean" Required="false" />
-      <AddPackageSourceMapping ParameterType="System.Boolean" Required="false" />
-    </ParameterGroup>
-    <Task>
-      <Using Namespace="System.IO" />
-      <Using Namespace="System.Xml.Linq" />
-      <Using Namespace="System.Xml.XPath" />
-      <Code Type="Fragment" Language="cs">
-        <![CDATA[
-          if (!File.Exists(TemplateNuGetConfigPath))
-          {
-            Log.LogError($"Could not find nuget config template at '{TemplateNuGetConfigPath}' .");
-            return false;
-          }
-
-          XDocument doc = XDocument.Load(TemplateNuGetConfigPath);
-          if (AddBuiltNuGetSource)
-          {
-            string xpath = "/configuration/packageSources";
-            XElement packageSources = doc.XPathSelectElement(xpath);
-            if (packageSources is null)
-            {
-              Log.LogError($"Could not find {xpath} in {TemplateNuGetConfigPath}");
-              return false;
-            }
-            packageSources.LastNode.AddAfterSelf(
-              new XElement("add",
-                new XAttribute("key", "nuget-local"),
-                new XAttribute("value", "%BUILT_NUGETS_PATH%")));
-          }
-
-          if (AddPackageSourceMapping)
-          {
-            string mappingXpath = "/configuration/packageSourceMapping";
-            XElement packageSourceMapping = doc.XPathSelectElement(mappingXpath);
-            if (packageSourceMapping is null)
-            {
-              // if mapping has been removed completely then the task needs an update!
-              throw new InvalidOperationException($"Expected to find {mappingXpath} in {TemplateNuGetConfigPath}");
-            }
-
-            packageSourceMapping.FirstNode.AddBeforeSelf(
-              new XElement("packageSource",
-                new XAttribute("key", "nuget-local"),
-                new XElement("package", new XAttribute("pattern", "*Aspire*"))));
-          }
-          doc.Save(OutputFile);
-          Log.LogMessage(MessageImportance.Low, $"Generated patched nuget.config at {OutputFile}");
-        ]]>
-      </Code>
-    </Task>
-  </UsingTask>
-
   <!-- For test projects -->
 
-  <Target Name="_PatchNuGetConfig" AfterTargets="GetCopyToOutputDirectoryItems" Inputs="$(TemplateNuGetConfigPath)" Outputs="$(PatchedNuGetConfigPath)">
-    <PrepareNuGetConfigForWorkloadTesting TemplateNuGetConfigPath="$(RepoRoot)NuGet.config" OutputFile="$(PatchedNuGetConfigPath)" AddBuiltNuGetSource="true" />
+  <Target Name="_PatchNuGetConfigForBuildingTestProject" AfterTargets="GetCopyToOutputDirectoryItems" Inputs="$(TemplateNuGetConfigPath)" Outputs="$(PatchedNuGetConfigPath)">
+    <!-- %BUILT_NUGETS_PATH% is set when building the testproject -->
+    <PatchNuGetConfig TemplateNuGetConfigPath="$(RepoRoot)NuGet.config"
+                      LocalNuGetsPath="%BUILT_NUGETS_PATH%"
+                      NuGetConfigPackageSourceMappings="$(NuGetConfigPackageSourceMappingsForWorkloadTesting)"
+                      OutputPath="$(PatchedNuGetConfigPath)" />
   </Target>
 
   <Target Name="_AddPackageVersionsForUseWithHelix" BeforeTargets="ZipTestArchive">