Adding automatic referencing of targeting packs, adding test coverage…

… on restore
dotnet · Mar 24, 2020 · 714c051 · 714c051
1 parent 48e7133
commit 714c051
Show file tree

Hide file tree

Showing 2 changed files with 143 additions and 0 deletions.
diff --git a/.../Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.FrameworkReferenceResolution.targets b/.../Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Sdk.FrameworkReferenceResolution.targets
@@ -316,6 +316,28 @@ Copyright (c) .NET Foundation. All rights reserved.
 
   <UsingTask TaskName="ResolveRuntimePackAssets" AssemblyFile="$(MicrosoftNETBuildTasksAssembly)" />
 
+  <!--
+    ============================================================
+                                        IncludeTargetingPackReference
+
+    Add package reference for required targeting pack if necessary
+    ============================================================
+    -->
+  <Target Name="IncludeTargetingPackReference" BeforeTargets="_GetRestoreSettingsPerFramework" Condition="'$(TargetFrameworkMoniker)' != '' and '$(TargetFrameworkIdentifier)' == '.NETFramework'">
+    <GetReferenceAssemblyPaths
+        TargetFrameworkMoniker="$(TargetFrameworkMoniker)"
+        RootPath="$(TargetFrameworkRootPath)"
+        TargetFrameworkFallbackSearchPaths="$(TargetFrameworkFallbackSearchPaths)"
+        BypassFrameworkInstallChecks="$(BypassFrameworkInstallChecks)"
+        SuppressNotFoundError="true">
+      <Output TaskParameter="FullFrameworkReferenceAssemblyPaths" PropertyName="_FullFrameworkReferenceAssemblyPaths"/>
+    </GetReferenceAssemblyPaths>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" Condition="'$(_FullFrameworkReferenceAssemblyPaths)' == ''"/>
+    </ItemGroup>
+  </Target>
+
   <!--
     ============================================================
                                         ResolveRuntimePackAssets

diff --git a/src/Tests/Microsoft.NET.Restore.Tests/GivenThatWeWantAutomaticTargetingPackReferences.cs b/src/Tests/Microsoft.NET.Restore.Tests/GivenThatWeWantAutomaticTargetingPackReferences.cs
@@ -0,0 +1,121 @@
+using System.IO;
+using System.Linq;
+using FluentAssertions;
+using Microsoft.Build.Utilities;
+using Microsoft.NET.TestFramework;
+using Microsoft.NET.TestFramework.Assertions;
+using Microsoft.NET.TestFramework.ProjectConstruction;
+using NuGet.Common;
+using NuGet.Frameworks;
+using NuGet.ProjectModel;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Microsoft.NET.Restore.Tests
+{
+    public class GivenThatWeWantAutomaticTargetingPackReferences : SdkTest
+    {
+        public GivenThatWeWantAutomaticTargetingPackReferences(ITestOutputHelper log) : base(log)
+        {
+        }
+
+        [Theory]
+        [InlineData("4.7.1")]
+        [InlineData("4.7.2")]
+        [InlineData("4.5.1")]
+        [InlineData("4.8")]
+        public void It_restores_net_framework_project_successfully(string version)
+        {
+            var targetFrameworkVersion = (TargetDotNetFrameworkVersion)System.Enum.Parse(typeof(TargetDotNetFrameworkVersion), "Version" + string.Join("", version.Split('.')));
+            var targetFramework = "net" + string.Join("", version.Split('.'));
+            var testProject = new TestProject()
+            {
+                Name = "ProjectWithoutTargetingPackRef",
+                TargetFrameworks = targetFramework,
+                IsSdkProject = true,
+            };
+
+            var testAsset = _testAssetsManager.CreateTestProject(testProject);
+
+            string projectAssetsJsonPath = Path.Combine(
+                testAsset.Path,
+                testProject.Name,
+                "obj",
+                "project.assets.json");
+
+            var restoreCommand =
+                testAsset.GetRestoreCommand(Log, relativePath: testProject.Name);
+            restoreCommand.Execute().Should().Pass();
+
+            LockFile lockFile = LockFileUtilities.GetLockFile(projectAssetsJsonPath, NullLogger.Instance);
+            var netFrameworkLibrary = lockFile.GetTarget(NuGetFramework.Parse(".NETFramework,Version=v" + version), null).Libraries.FirstOrDefault((file) => file.Name.Contains(targetFramework));
+
+            if (ReferenceAssembliesAreInstalled(targetFrameworkVersion))
+            {
+                netFrameworkLibrary.Should().BeNull();
+            }
+            else
+            {
+                netFrameworkLibrary.Name.Should().Be("Microsoft.NETFramework.ReferenceAssemblies." + targetFramework);
+                netFrameworkLibrary.Type.Should().Be("package");
+            }
+        }
+
+        [Fact]
+        public void It_restores_multitargeted_net_framework_project_successfully()
+        {
+            var testProject = new TestProject()
+            {
+                Name = "ProjectWithoutTargetingPackRef",
+                TargetFrameworks = "net471;net472;netcoreapp3.0",
+                IsSdkProject = true,
+            };
+
+            var testAsset = _testAssetsManager.CreateTestProject(testProject);
+
+            string projectAssetsJsonPath = Path.Combine(
+                testAsset.Path,
+                testProject.Name,
+                "obj",
+                "project.assets.json");
+
+            var restoreCommand =
+                testAsset.GetRestoreCommand(Log, relativePath: testProject.Name);
+            restoreCommand.Execute().Should().Pass();
+
+            LockFile lockFile = LockFileUtilities.GetLockFile(
+                projectAssetsJsonPath,
+                NullLogger.Instance);
+
+            var net471FrameworkLibrary = lockFile.GetTarget(NuGetFramework.Parse(".NETFramework,Version=v4.7.1"), null).Libraries.FirstOrDefault((file) => file.Name.Contains("net471"));
+            if (ReferenceAssembliesAreInstalled(TargetDotNetFrameworkVersion.Version471))
+            {
+                net471FrameworkLibrary.Should().BeNull();
+            }
+            else
+            { 
+                net471FrameworkLibrary.Name.Should().Be("Microsoft.NETFramework.ReferenceAssemblies.net471");
+                net471FrameworkLibrary.Type.Should().Be("package");
+            }
+
+            var net472FrameworkLibrary = lockFile.GetTarget(NuGetFramework.Parse(".NETFramework,Version=v4.7.2"), null).Libraries.FirstOrDefault((file) => file.Name.Contains("net472"));
+
+            if (ReferenceAssembliesAreInstalled(TargetDotNetFrameworkVersion.Version472))
+            {
+                net472FrameworkLibrary.Should().BeNull();
+            }
+            else
+            {
+                net472FrameworkLibrary.Name.Should().Be("Microsoft.NETFramework.ReferenceAssemblies.net472");
+                net472FrameworkLibrary.Type.Should().Be("package");
+            }
+
+        }
+
+        public static bool ReferenceAssembliesAreInstalled(TargetDotNetFrameworkVersion targetFrameworkVersion)
+        {
+            var referenceAssemblies = ToolLocationHelper.GetPathToDotNetFrameworkReferenceAssemblies(targetFrameworkVersion);
+            return referenceAssemblies != null;
+        }
+    }
+}