Handle name conflict between project name and referenced package in GenerateDepsFile

Author: dsplaisted

src/Tasks/Microsoft.NET.Build.Tasks/DependencyContextBuilder.cs

@@ -262,11 +262,6 @@ public DependencyContext Build(string[] userRuntimeAssemblies = null)
 
             List<ModifiableRuntimeLibrary> runtimeLibraries = new();
 
-            if (_includeMainProjectInDepsFile)
-            {
-                runtimeLibraries.Add(GetProjectRuntimeLibrary());
-            }
-
             runtimeLibraries.AddRange(GetRuntimePackLibraries());
 
             foreach (var library in _dependencyLibraries.Values
@@ -304,6 +299,11 @@ public DependencyContext Build(string[] userRuntimeAssemblies = null)
                 runtimeLibraries.Add(runtimeLibrary);
             }
 
+            if (_includeMainProjectInDepsFile)
+            {
+                runtimeLibraries.Add(GetProjectRuntimeLibrary());
+            }
+
             /*
              * We now need to modify runtimeLibraries to eliminate those that don't have any runtime assets. We follow the following steps:
              * 0. Construct a reverse dependencies list: all runtimeLibraries that depend on this one
@@ -518,7 +518,7 @@ private ModifiableRuntimeLibrary GetProjectRuntimeLibrary()
 
             return new ModifiableRuntimeLibrary(new RuntimeLibrary(
                 type: "project",
-                name: _mainProjectInfo.Name,
+                name: GetUniqueLibraryName(_mainProjectInfo.Name, "Project"),
                 version: _mainProjectInfo.Version,
                 hash: string.Empty,
                 runtimeAssemblyGroups: runtimeAssemblyGroups,
@@ -918,7 +918,7 @@ private string GetReferenceLibraryName(ReferenceInfo reference)
             {
                 // Reference names can conflict with PackageReference names, so
                 // ensure that the Reference names are unique when creating libraries
-                name = GetUniqueReferenceName(reference.Name);
+                name = GetUniqueLibraryName(reference.Name);
 
                 ReferenceLibraryNames.Add(reference, name);
                 _usedLibraryNames.Add(name);
@@ -927,11 +927,11 @@ private string GetReferenceLibraryName(ReferenceInfo reference)
             return name;
         }
 
-        private string GetUniqueReferenceName(string name)
+        private string GetUniqueLibraryName(string name, string qualifier = "Reference")
         {
             if (_usedLibraryNames.Contains(name))
             {
-                string startingName = $"{name}.Reference";
+                string startingName = $"{name}.{qualifier}";
                 name = startingName;
 
                 int suffix = 1;

test/Microsoft.NET.Build.Tests/GivenThatWeWantToBuildADesktopLibrary.cs

@@ -3,6 +3,7 @@
 
 #nullable disable
 
+using System.Security.Cryptography;
 using Microsoft.Build.Utilities;
 using Microsoft.Extensions.DependencyModel;
 
@@ -156,6 +157,24 @@ public void PackageWithoutAssets_ShouldNotShowUpInDepsJson()
             }
         }
 
+        [Fact]
+        public void ProjectNameCanMatchPackageReferenceName()
+        {
+            var testProject = new TestProject()
+            {
+                Name = "Newtonsoft.Json",
+                TargetFrameworks = ToolsetInfo.CurrentTargetFramework,
+            };
+
+            testProject.PackageReferences.Add(new TestPackageReference("Newtonsoft.Json", ToolsetInfo.GetNewtonsoftJsonPackageVersion()));
+            testProject.AdditionalProperties["PackageId"] = "Newtonsoft.Json*";
+
+            var testAsset = _testAssetsManager.CreateTestProject(testProject);
+
+            var buildCommand = new BuildCommand(testAsset);
+            buildCommand.Execute().Should().Pass();
+        }
+
         [WindowsOnlyFact]
         public void It_can_reference_a_netstandard2_library_and_exchange_types()
         {