Add test for the multi-package tool creation

Author: baronfel

Directory.Build.props

@@ -67,6 +67,8 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
     <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
 
+    <SkipBuildingInstallers Condition="'$(SkipBuildingInstallers)' == ''">true</SkipBuildingInstallers>
+
     <!-- https://github.com/dotnet/source-build/issues/4115. -->
     <PublishWindowsPdb>false</PublishWindowsPdb>
   </PropertyGroup>

src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.PackTool.targets

@@ -62,7 +62,7 @@ Copyright (c) .NET Foundation. All rights reserved.
     <_PackToolPublishDependency Condition=" '$(_ToolPackageShouldIncludeImplementation)' != '' and '$(GeneratePackageOnBuild)' == 'true' and $(IsPublishable) == 'true' ">$(_PublishNoBuildAlternativeDependsOn)</_PackToolPublishDependency>
 
     <!-- Trigger RID-specific inner builds if RID-specific mode is enabled-->
-    <GenerateNuspecDependsOn Condition=" '$(_HasRIDSpecificTools)' == 'true' and '$(PublishAot)' != 'true' ">$(GenerateNuspecDependsOn);_CreateRIDSpecificToolPackages</GenerateNuspecDependsOn>
+    <GenerateNuspecDependsOn>$(GenerateNuspecDependsOn);_CreateRIDSpecificToolPackages</GenerateNuspecDependsOn>
 
     <!-- finally set up the entrypoint for all tool-content regardless of tool type-->
     <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);PackTool</TargetsForTfmSpecificContentInPackage>
@@ -322,7 +322,7 @@ Copyright (c) .NET Foundation. All rights reserved.
   </Target>
 
   <!-- orchestrator for making the N RID-specific tool packages -->
-  <Target Name="_CreateRIDSpecificToolPackages">
+  <Target Name="_CreateRIDSpecificToolPackages" Condition="'$(RuntimeIdentifier)' == '' and $(_HasRIDSpecificTools) and '$(PublishAot)' != 'true'">
     <PropertyGroup>
         <_PackageRids>$(ToolPackageRuntimeIdentifiers)</_PackageRids>
         <_PackageRids Condition="'$(_PackageRids)' == ''">$(RuntimeIdentifiers)</_PackageRids>

test/Microsoft.DotNet.PackageInstall.Tests/EndToEndToolTests.cs

@@ -1,10 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System;
-using System.Collections.Generic;
-using System.Text;
-using Microsoft.Extensions.EnvironmentAbstractions;
+using System.IO.Compression;
 
 namespace Microsoft.DotNet.PackageInstall.Tests
 {
@@ -136,6 +133,43 @@ public void InstallAndRunNativeAotLocalTool()
                 .Should().Pass()
                 .And.HaveStdOutContaining("Hello Tool!");
         }
+
+
+        [Fact]
+        public void PackagesMultipleToolsWithASingleInvocation()
+        {
+
+            var toolSettings = new TestToolBuilder.TestToolSettings()
+            {
+                SelfContained = true
+            };
+            string toolPackagesPath = ToolBuilder.CreateTestTool(Log, toolSettings);
+
+            var packages = Directory.GetFiles(toolPackagesPath, "*.nupkg");
+            var packageIdentifier = toolSettings.ToolPackageId;
+            var expectedRids = ToolsetInfo.LatestRuntimeIdentifiers.Split(';');
+
+            packages.Length.Should().Be(expectedRids.Length + 1, "There should be one package for the tool-wrapper and one for each RID");
+            foreach (string rid in expectedRids)
+            {
+                var packageName = $"{toolSettings.ToolPackageId}.{rid}.{toolSettings.ToolPackageVersion}";
+                var package = packages.FirstOrDefault(p => p.EndsWith(packageName + ".nupkg"));
+                packages.Should().NotBeNull($"Package {packageName} should be present in the tool packages directory");
+            }
+
+            // top-level package should declare all of the rids
+            var topLevelPackage = packages.First(p => p.EndsWith($"{packageIdentifier}.{toolSettings.ToolPackageVersion}.nupkg"));
+            using var zipArchive = ZipFile.OpenRead(topLevelPackage);
+            var nuspecEntry = zipArchive.GetEntry($"tools/{ToolsetInfo.CurrentTargetFramework}/any/DotnetToolSettings.xml")!;
+            var stream = nuspecEntry.Open();
+            var xml = XDocument.Load(stream, LoadOptions.None);
+            var packageNodes =
+                (xml.Root!.Nodes()
+                    .First(n => n is XElement e && e.Name == "RuntimeIdentifierPackages") as XElement)!.Nodes()
+                    .Where(n => (n as XElement)!.Name == "RuntimeIdentifierPackage")
+                    .Select(e => (e as XElement)!.Attributes().First(a => a.Name == "RuntimeIdentifier").Value);
+            packageNodes.Should().BeEquivalentTo(expectedRids, "The top-level package should declare all of the RIDs for the tools it contains");
+        }
     }
 
     static class EndToEndToolTestExtensions

test/Microsoft.DotNet.PackageInstall.Tests/TestToolBuilder.cs

@@ -33,8 +33,9 @@ public class TestToolSettings
             public string ToolCommandName { get; set; } = "TestTool";
 
             public bool NativeAOT { get; set; } = false;
+            public bool SelfContained { get; set; } = false;
 
-            public string GetIdentifier() => $"{ToolPackageId}-{ToolPackageVersion}-{ToolCommandName}-{(NativeAOT ? "nativeaot" : "managed")}";
+            public string GetIdentifier() => $"{ToolPackageId}-{ToolPackageVersion}-{ToolCommandName}-{(NativeAOT ? "nativeaot" : SelfContained ? "selfcontained" : "managed")}";
         }
 
 
@@ -59,6 +60,12 @@ public string CreateTestTool(ITestOutputHelper log, TestToolSettings toolSetting
                 testProject.AdditionalProperties["RuntimeIdentifiers"] = RuntimeInformation.RuntimeIdentifier;
             }
 
+            if (toolSettings.SelfContained)
+            {
+                testProject.AdditionalProperties["SelfContained"] = "true";
+                testProject.AdditionalProperties["RuntimeIdentifiers"] = ToolsetInfo.LatestRuntimeIdentifiers;
+            }
+
             testProject.SourceFiles.Add("Program.cs", "Console.WriteLine(\"Hello Tool!\");");
 
             var testAssetManager = new TestAssetsManager(log);

test/Microsoft.NET.TestFramework/ToolsetInfo.cs

@@ -16,7 +16,7 @@ public class ToolsetInfo
         public const string LatestWinRuntimeIdentifier = "win";
         public const string LatestLinuxRuntimeIdentifier = "linux";
         public const string LatestMacRuntimeIdentifier = "osx";
-        public const string LatestRuntimeIdentifiers = $"{LatestWinRuntimeIdentifier}-x64;{LatestWinRuntimeIdentifier}-x86;osx-x64;{LatestMacRuntimeIdentifier}-x64;{LatestLinuxRuntimeIdentifier}-x64;linux-musl-x64";
+        public const string LatestRuntimeIdentifiers = $"{LatestWinRuntimeIdentifier}-x64;{LatestWinRuntimeIdentifier}-x86;{LatestMacRuntimeIdentifier}-x64;{LatestLinuxRuntimeIdentifier}-x64;linux-musl-x64";
 
         public string DotNetRoot { get; }
         public string DotNetHostPath { get; }
@@ -138,7 +138,7 @@ private void InitMSBuildVersion()
                 {
                     string? msbuildRoot = null;
                     var msbuildBinPath = Path.GetDirectoryName(FullFrameworkMSBuildPath);
-                    if(msbuildBinPath is not null)
+                    if (msbuildBinPath is not null)
                     {
                         msbuildRoot = Directory.GetParent(msbuildBinPath)?.Parent?.FullName;
                     }
@@ -158,7 +158,7 @@ public void AddTestEnvironmentVariables(IDictionary<string, string> environment)
                 string sdksPath = Path.Combine(DotNetRoot, "sdk", SdkVersion, "Sdks");
 
                 //  Use stage 2 MSBuild SDK resolver
-                if(SdkResolverPath is not null)
+                if (SdkResolverPath is not null)
                 {
                     environment["MSBUILDADDITIONALSDKRESOLVERSFOLDER"] = SdkResolverPath;
                 }