From 51827185f6bedd5781af8a0d87cd83eb5460eb4c Mon Sep 17 00:00:00 2001
From: Jose Perez Rodriguez <joperezr@microsoft.com>
Date: Tue, 16 Jun 2020 15:00:46 -0700
Subject: [PATCH] Adding linker correctness tests to test library annotations
 for the linker (#37618)

---
 .../libraries/execute-trimming-tests-steps.yml     |  7 ++
 eng/pipelines/runtime-linker-tests.yml             | 39 +++++++++
 .../linker/SupportFiles/Directory.Build.props      | 10 +++
 .../linker/SupportFiles/Directory.Build.targets    | 24 ++++++
 eng/testing/linker/project.csproj.template         | 11 +++
 eng/testing/linker/trimmingTests.targets           | 97 ++++++++++++++++++++++
 src/libraries/Directory.Build.props                |  2 +
 src/libraries/Directory.Build.targets              |  1 +
 .../TrimmingTests/GenericArraySortHelperTest.cs    | 16 ++++
 .../System.Runtime.TrimmingTests.proj              |  5 ++
 src/libraries/restore/runtime/runtime.depproj      |  2 +-
 src/libraries/tests.proj                           | 10 ++-
 12 files changed, 222 insertions(+), 2 deletions(-)
 create mode 100644 eng/pipelines/libraries/execute-trimming-tests-steps.yml
 create mode 100644 eng/pipelines/runtime-linker-tests.yml
 create mode 100644 eng/testing/linker/SupportFiles/Directory.Build.props
 create mode 100644 eng/testing/linker/SupportFiles/Directory.Build.targets
 create mode 100644 eng/testing/linker/project.csproj.template
 create mode 100644 eng/testing/linker/trimmingTests.targets
 create mode 100644 src/libraries/System.Runtime/tests/TrimmingTests/GenericArraySortHelperTest.cs
 create mode 100644 src/libraries/System.Runtime/tests/TrimmingTests/System.Runtime.TrimmingTests.proj

diff --git a/eng/pipelines/libraries/execute-trimming-tests-steps.yml b/eng/pipelines/libraries/execute-trimming-tests-steps.yml
new file mode 100644
index 0000000..183cebb
--- /dev/null
+++ b/eng/pipelines/libraries/execute-trimming-tests-steps.yml
@@ -0,0 +1,7 @@
+parameters:
+  archType: ''
+
+steps:
+  # Execute tests
+  - script: $(Build.SourcesDirectory)$(dir)build$(scriptExt) -ci -arch ${{ parameters.archType }} $(_osParameter) -s libs.tests -c $(_BuildConfig) /p:TestAssemblies=false /p:TestTrimming=true $(_officialBuildParameter) $(_crossBuildPropertyArg) /bl:$(Build.SourcesDirectory)/artifacts/log/$(buildConfigUpper)/TrimmingTests.binlog
+    displayName: Run Trimming Tests
diff --git a/eng/pipelines/runtime-linker-tests.yml b/eng/pipelines/runtime-linker-tests.yml
new file mode 100644
index 0000000..ab65e1d
--- /dev/null
+++ b/eng/pipelines/runtime-linker-tests.yml
@@ -0,0 +1,39 @@
+# The purpose of this pipeline is to exercise local developer workflow in the consolidated
+# runtime repo. In particular, it is supposed to run the root "build" script just like any
+# normal developer normally would and monitor regressions w.r.t. this fundamental scenario.
+
+trigger:
+  batch: true
+  branches:
+    include:
+    - master
+    - release/*.*
+
+pr:
+  branches:
+    include:
+    - master
+    - release/*.*
+
+jobs:
+#
+# Checkout repository
+#
+- template: /eng/pipelines/common/checkout-job.yml
+
+#
+# Build Release config vertical for Windows, Linux, Linux musl and OSX
+#
+- template: /eng/pipelines/common/platform-matrix.yml
+  parameters:
+    jobTemplate: /eng/pipelines/common/global-build-job.yml
+    buildConfig: release
+    platforms:
+    - Windows_NT_x64
+    - OSX_x64
+    - Linux_x64
+    jobParameters:
+      testGroup: innerloop
+      nameSuffix: Runtime_Release
+      buildArgs: -s clr+libs -c $(_BuildConfig)
+      extraStepsTemplate: /eng/pipelines/libraries/execute-trimming-tests-steps.yml
diff --git a/eng/testing/linker/SupportFiles/Directory.Build.props b/eng/testing/linker/SupportFiles/Directory.Build.props
new file mode 100644
index 0000000..f64aabf
--- /dev/null
+++ b/eng/testing/linker/SupportFiles/Directory.Build.props
@@ -0,0 +1,10 @@
+<Project>
+  <PropertyGroup>
+    <PublishTrimmed>true</PublishTrimmed>
+    <_TrimmerDefaultAction>link</_TrimmerDefaultAction>
+    <SelfContained>true</SelfContained>
+    <EnableTargetingPackDownload>false</EnableTargetingPackDownload>
+    <PlatformManifestFile />
+    <DisableImplicitFrameworkReferences>true</DisableImplicitFrameworkReferences>
+  </PropertyGroup>
+</Project>
\ No newline at end of file
diff --git a/eng/testing/linker/SupportFiles/Directory.Build.targets b/eng/testing/linker/SupportFiles/Directory.Build.targets
new file mode 100644
index 0000000..90ce573
--- /dev/null
+++ b/eng/testing/linker/SupportFiles/Directory.Build.targets
@@ -0,0 +1,24 @@
+<Project>
+  <Target Name="RestoreProject">
+    <MSBuild Projects="$(MSBuildProjectFullPath)"
+             Properties="Configuration=$(Configuration)"
+             Targets="Restore" />
+  </Target>
+
+  <Target Name="AddFrameworkReference">
+    <ItemGroup>
+      <FrameworkReference Include="Microsoft.NETCore.App" />
+    </ItemGroup>
+  </Target>
+
+  <Target Name="UpdateRuntimePack"
+          DependsOnTargets="AddFrameworkReference;ResolveFrameworkReferences">
+    <ItemGroup>
+      <ResolvedRuntimePack Update="@(ResolvedRuntimePack)" PackageDirectory="$(RuntimePackDir)" />
+      <ResolvedTargetingPack Update="@(ResolvedTargetingPack)" Path="$(TargetingPackDir)" />
+    </ItemGroup>
+  </Target>
+
+  <Target Name="PublishTrimmed" DependsOnTargets="RestoreProject;UpdateRuntimePack;Publish" />
+
+</Project>
\ No newline at end of file
diff --git a/eng/testing/linker/project.csproj.template b/eng/testing/linker/project.csproj.template
new file mode 100644
index 0000000..b762f74
--- /dev/null
+++ b/eng/testing/linker/project.csproj.template
@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>{NetCoreAppCurrent}</TargetFramework>
+    <RuntimeIdentifier>{RuntimeIdentifier}</RuntimeIdentifier>
+    <RuntimePackDir>{RuntimePackDir}</RuntimePackDir>
+    <TargetingPackDir>{TargetingPackDir}</TargetingPackDir>
+  </PropertyGroup>
+
+</Project>
\ No newline at end of file
diff --git a/eng/testing/linker/trimmingTests.targets b/eng/testing/linker/trimmingTests.targets
new file mode 100644
index 0000000..7e4f91b
--- /dev/null
+++ b/eng/testing/linker/trimmingTests.targets
@@ -0,0 +1,97 @@
+<Project>
+  <PropertyGroup>
+    <TrimmingTestDir>$([MSBuild]::NormalizeDirectory('$(ArtifactsBinDir)', 'trimmingTests'))</TrimmingTestDir>
+    <TrimmingTestProjectsDir>$([MSBuild]::NormalizeDirectory('$(TrimmingTestDir)', 'projects'))</TrimmingTestProjectsDir>
+    <TestDotNetPath>$([MSBuild]::NormalizePath('$(DotNetRoot)', 'dotnet'))</TestDotNetPath>
+    <ProjectTemplate>$(MSBuildThisFileDirectory)project.csproj.template</ProjectTemplate>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <TestConsoleAppSourceFiles Include="$(MSBuildProjectDirectory)\*.cs" />
+
+    <TestSupportFiles Include="$(MSBuildThisFileDirectory)SupportFiles\Directory.Build.*">
+      <DestinationFolder>$(TrimmingTestDir)</DestinationFolder>
+    </TestSupportFiles>
+  </ItemGroup>
+
+  <Target Name="CreateTestDir"
+          Inputs="@(TestSupportFiles)"
+          Outputs="@(TestSupportFiles->'%(DestinationFolder)\%(FileName)%(Extension)')">
+    <MakeDir Directories="%(TestSupportFiles.DestinationFolder)" />
+    <Copy SourceFiles="@(TestSupportFiles)" DestinationFolder="%(TestSupportFiles.DestinationFolder)" />
+  </Target>
+
+  <Target Name="GetTestConsoleApps">
+    <ItemGroup>
+      <TestConsoleAppSourceFiles>
+        <ProjectDir>$([MSBuild]::NormalizeDirectory('$(TrimmingTestProjectsDir)', '$(MSBuildProjectName)', '%(Filename)', '$(PackageRID)'))</ProjectDir>
+        <TestRuntimeIdentifier>$(PackageRID)</TestRuntimeIdentifier>
+      </TestConsoleAppSourceFiles>
+      <!-- We need to separate Item metadata declaration in two in order to be able to use ProjectDir and TestRuntimeIdentifier bellow -->
+      <TestConsoleAppSourceFiles>
+        <ProjectFile>%(ProjectDir)project.csproj</ProjectFile>
+        <TestCommand>$([MSBuild]::NormalizePath('%(ProjectDir)', 'bin', '$(Configuration)', '$(NetCoreAppCurrent)', '%(TestRuntimeIdentifier)', 'publish', 'project'))</TestCommand>
+        <TestExecutionDirectory>$([MSBuild]::NormalizeDirectory('%(ProjectDir)', 'bin', '$(Configuration)', '$(NetCoreAppCurrent)', '%(TestRuntimeIdentifier)', 'publish'))</TestExecutionDirectory>
+        <RuntimePackDirectory>$([MSBuild]::NormalizeDirectory('$(ArtifactsBinDir)', 'microsoft.netcore.app.runtime.%(TestRuntimeIdentifier)', '$(Configuration)'))</RuntimePackDirectory>
+      </TestConsoleAppSourceFiles>
+    </ItemGroup>
+
+    <ItemGroup>
+      <TestConsoleApps Include="@(TestConsoleAppSourceFiles->'%(ProjectFile)')">
+        <ProjectCompileItems>%(Identity)</ProjectCompileItems>
+      </TestConsoleApps>
+    </ItemGroup>
+  </Target>
+
+  <Target Name="GenerateProjects"
+          DependsOnTargets="GetTestConsoleApps;CreateTestDir"
+          Inputs="@(TestConsoleAppSourceFiles);$(ProjectTemplate);@(TestSupportFiles)"
+          Outputs="%(TestConsoleApps.Identity)">
+    <PropertyGroup>
+      <_projectDir>%(TestConsoleApps.ProjectDir)\</_projectDir>
+      <_projectFile>%(TestConsoleApps.ProjectFile)</_projectFile>
+      <_projectSourceFile>%(TestConsoleApps.ProjectCompileItems)</_projectSourceFile>
+    </PropertyGroup>
+
+    <MakeDir Directories="$(_projectDir)" />
+    <WriteLinesToFile File="$(_projectFile)"
+                      Lines="$([System.IO.File]::ReadAllText('$(ProjectTemplate)').Replace('{NetCoreAppCurrent}', '$(NetCoreAppCurrent)').Replace('{RuntimePackDir}', '%(TestConsoleApps.RuntimePackDirectory)').Replace('{TargetingPackDir}','$(MicrosoftNetCoreAppRefPackDir)').Replace('{RuntimeIdentifier}','%(TestConsoleApps.TestRuntimeIdentifier)'))"
+                      Overwrite="true" />
+    <Copy SourceFiles="$(_projectSourceFile)"
+          DestinationFolder="$(_projectDir)" />
+    <Message Text="Generated $(_projectFile)" />
+  </Target>
+
+  <Target Name="PublishTrimmedProjects"
+          DependsOnTargets="GenerateProjects">
+    <PropertyGroup>
+      <TestRestoreCommand>"$(TestDotNetPath)"</TestRestoreCommand>
+      <TestRestoreCommand>$(TestRestoreCommand) msbuild /t:PublishTrimmed</TestRestoreCommand>
+      <TestRestoreCommand>$(TestRestoreCommand) /nr:false</TestRestoreCommand>
+      <TestRestoreCommand>$(TestRestoreCommand) /warnaserror</TestRestoreCommand>
+      <TestRestoreCommand>$(TestRestoreCommand) -p:configuration=Release</TestRestoreCommand>
+    </PropertyGroup>
+
+    <Exec Command="$(TestRestoreCommand)" StandardOutputImportance="Low" WorkingDirectory="%(TestConsoleApps.ProjectDir)" />
+  </Target>
+
+  <Target Name="ExecuteApplications"
+          DependsOnTargets="PublishTrimmedProjects"
+          Inputs="%(TestConsoleApps.Identity)"
+          Outputs="_unused"
+          Condition="'$(ArchiveTests)' != 'true'">
+
+    <Message Importance="High" Text="[Trimming Tests] Running test: %(TestConsoleApps.ProjectCompileItems)..." />
+    <Exec IgnoreExitCode="true" Command="%(TestConsoleApps.TestCommand)" StandardOutputImportance="Low" WorkingDirectory="%(TestConsoleApps.TestExecutionDirectory)">
+      <Output TaskParameter="ExitCode" PropertyName="ExecutionExitCode" />
+    </Exec>
+
+    <Error Condition="'$(ExecutionExitCode)' != '100'" Text="Error: [Failed Test]: %(TestConsoleApps.ProjectCompileItems) The Command %(TestConsoleApps.TestCommand) return a non-success exit code." />
+  </Target>
+
+  <Target Name="Build" DependsOnTargets="ExecuteApplications" />
+
+  <!-- define test to do nothing, for this project Build does all the testing -->
+  <Target Name="Test" DependsOnTargets="Build" />
+  <Target Name="VSTest" DependsOnTargets="Build" />
+</Project>
diff --git a/src/libraries/Directory.Build.props b/src/libraries/Directory.Build.props
index df200fa..fd05586 100644
--- a/src/libraries/Directory.Build.props
+++ b/src/libraries/Directory.Build.props
@@ -57,6 +57,8 @@
     <IsTestSupportProject>false</IsTestSupportProject>
     <IsTestSupportProject Condition="($(MSBuildProjectFullPath.Contains('\tests\')) or $(MSBuildProjectFullPath.Contains('/tests/'))) and '$(IsTestProject)' != 'true'">true</IsTestSupportProject>
 
+    <IsTrimmingTestProject Condition="$(MSBuildProjectName.EndsWith('.TrimmingTests'))">true</IsTrimmingTestProject>
+
     <!-- Treat test assemblies as non-shipping (do not publish or sign them). -->
     <IsShipping Condition="'$(IsTestProject)' == 'true' or '$(IsTestSupportProject)' == 'true'">false</IsShipping>
   </PropertyGroup>
diff --git a/src/libraries/Directory.Build.targets b/src/libraries/Directory.Build.targets
index 995f353..520de08 100644
--- a/src/libraries/Directory.Build.targets
+++ b/src/libraries/Directory.Build.targets
@@ -136,6 +136,7 @@
   <Import Project="$(RepositoryEngineeringDir)references.targets" />
   <Import Project="$(RepositoryEngineeringDir)resolveContract.targets" />
   <Import Project="$(RepositoryEngineeringDir)testing\tests.targets" Condition="'$(EnableTestSupport)' == 'true'" />
+  <Import Project="$(RepositoryEngineeringDir)testing\linker\trimmingTests.targets" Condition="'$(IsTrimmingTestProject)' == 'true'" />
   <Import Project="$(RepositoryEngineeringDir)testing\runtimeConfiguration.targets" />
   <Import Project="$(RepositoryEngineeringDir)testing\runsettings.targets" Condition="'$(EnableRunSettingsSupport)' == 'true'" />
   <Import Project="$(RepositoryEngineeringDir)testing\coverage.targets" Condition="'$(EnableRunSettingsSupport)' == 'true' or '$(EnableCoverageSupport)' == 'true'" />
diff --git a/src/libraries/System.Runtime/tests/TrimmingTests/GenericArraySortHelperTest.cs b/src/libraries/System.Runtime/tests/TrimmingTests/GenericArraySortHelperTest.cs
new file mode 100644
index 0000000..d863967
--- /dev/null
+++ b/src/libraries/System.Runtime/tests/TrimmingTests/GenericArraySortHelperTest.cs
@@ -0,0 +1,16 @@
+using System;
+using System.Collections;
+
+class Program
+{
+    static int Main(string[] args)
+    {
+        var x = new[] { 5, 4, 3, 100, 2, 1 };
+        var y = new[] { "a", "b", "c", "h", "d", "e" };
+        // This will test that GenericArraySortHelper'2 called by reflection will be kept.
+        Array.Sort(x, y);
+        // This will test that GenericArraySortHelper'1 called by reflection will be kept.
+        Array.Sort(y);
+        return 100;
+    }
+}
diff --git a/src/libraries/System.Runtime/tests/TrimmingTests/System.Runtime.TrimmingTests.proj b/src/libraries/System.Runtime/tests/TrimmingTests/System.Runtime.TrimmingTests.proj
new file mode 100644
index 0000000..da4a46f
--- /dev/null
+++ b/src/libraries/System.Runtime/tests/TrimmingTests/System.Runtime.TrimmingTests.proj
@@ -0,0 +1,5 @@
+<Project DefaultTargets="Build">
+  <Import Project="$([MSBuild]::GetPathOfFileAbove(Directory.Build.props))" />
+
+  <Import Project="$([MSBuild]::GetPathOfFileAbove(Directory.Build.targets))" />
+</Project>
diff --git a/src/libraries/restore/runtime/runtime.depproj b/src/libraries/restore/runtime/runtime.depproj
index e9ac35f..623a74f 100644
--- a/src/libraries/restore/runtime/runtime.depproj
+++ b/src/libraries/restore/runtime/runtime.depproj
@@ -80,7 +80,6 @@
   </Target>
 
   <Target Name="SetupRuntimePackNative"
-          Condition="'$(RuntimeFlavor)' == 'Mono'"
           AfterTargets="AfterResolveReferences">
     <ItemGroup>
       <BinPlaceItem Include="@(RuntimeFiles)" />
@@ -90,6 +89,7 @@
       <BinPlaceItem Include="@(MonoIncludeFiles)">
         <DestinationSubDirectory>include/%(RecursiveDir)</DestinationSubDirectory>
       </BinPlaceItem>
+      <BinPlaceItem Remove="@(BinPlaceItem)" Condition="'$(RuntimeFlavor)' != 'Mono' and '%(BinPlaceItem.Filename)' == 'System.Private.CoreLib'" />
     </ItemGroup>
     <ItemGroup Condition="'$(TargetsMobile)' != 'true'">
       <TestHostBinPlaceItem Include="@(RuntimeFiles)" />
diff --git a/src/libraries/tests.proj b/src/libraries/tests.proj
index 6e92a43..cb272c9 100644
--- a/src/libraries/tests.proj
+++ b/src/libraries/tests.proj
@@ -8,6 +8,9 @@
     <CoverageReportInputPath>$(ArtifactsBinDir)\*.Tests\**\coverage.opencover.xml</CoverageReportInputPath>
     <CoverageReportDir>$(ArtifactsDir)coverage</CoverageReportDir>
     <EnableCoverageSupport>true</EnableCoverageSupport>
+
+    <TestAssemblies Condition="'$(TestAssemblies)' == ''">true</TestAssemblies>
+    <TestTrimming Condition="'$(TestTrimming)' == ''">false</TestTrimming>
   </PropertyGroup>
   
   <!-- Projects that don't support code coverage measurement. -->
@@ -17,7 +20,7 @@
     <ProjectExclusions Include="$(MSBuildThisFileDirectory)System.Transactions.Local\tests\System.Transactions.Local.Tests.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
+  <ItemGroup Condition="'$(TestAssemblies)' == 'true'">
     <!-- We currently only test with C# projects. -->
     <ProjectReference Include="$(MSBuildThisFileDirectory)*\tests\**\*.Tests.csproj"
                       Exclude="@(ProjectExclusions)"
@@ -26,6 +29,11 @@
                       Condition="'$(BuildAllConfigurations)' == 'true'" />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(TestTrimming)' == 'true'">
+    <ProjectReference Include="$(MSBuildThisFileDirectory)*\tests\**\*.TrimmingTests.proj"
+                      Exclude="@(ProjectExclusions)" />
+  </ItemGroup>
+
   <Target Name="GenerateMergedCoverageReport"
           Condition="'$(Coverage)' == 'true'"
           AfterTargets="Test"
-- 
2.7.4