From 509661e54f2d985c568adc491d02327ab7fe9bce Mon Sep 17 00:00:00 2001
From: Doug Bunting <6431421+dougbu@users.noreply.github.com>
Date: Wed, 15 Mar 2023 15:20:25 -0700
Subject: [PATCH] Separate Microsoft.TestCommon more (#400)

- pre-restore and prebuild the project before anything that depends on it
  - avoid references from other test projects doing any real work
- make ordering even more explicit
  - avoid confusion between batching builds and `$(BuildInParallel)`
- turns out this also reduces the number of double writes binary logs show significantly
---
 Runtime.msbuild | 44 +++++++++++++++++++++++++++++++++++---------
 1 file changed, 35 insertions(+), 9 deletions(-)

diff --git a/Runtime.msbuild b/Runtime.msbuild
index c77f8bc72..815aaf93e 100644
--- a/Runtime.msbuild
+++ b/Runtime.msbuild
@@ -52,14 +52,26 @@
     <Exec Command='"$(NuGetExe)" restore .nuget\packages.config -PackagesDirectory packages -NonInteractive -Verbosity quiet' />
   </Target>
 
+  <ItemGroup>
+    <_Testing_NetStandard1_3 Include="true;false" />
+  </ItemGroup>
+
   <Target Name="RestorePackages" DependsOnTargets="DownloadNuGet">
-    <ItemGroup>
-      <_ToRestore Include="Runtime.sln" />
-      <_ToRestore Include="test\Microsoft.TestCommon\Microsoft.TestCommon.csproj"
-          AdditionalProperties="Testing_NetStandard1_3=true" />
-    </ItemGroup>
     <Message Text="%0ARestoring NuGet packages..." Importance="High" />
-    <MSBuild Projects="@(_ToRestore)" Targets="Restore"
+
+    <!--
+      Pre-restore Microsoft.TestCommon due to the many dependencies on this project. Batch it to cover the full
+      set of references. Remove $(Platform) to avoid 'Any CPU' appearing in output paths. Can always restore in
+      parallel because $(Testing_NetStandard1_3) changes both obj/ and bin/ folders entirely.
+    -->
+    <MSBuild Projects="test\Microsoft.TestCommon\Microsoft.TestCommon.csproj" Targets="Restore"
+      BuildInParallel="true"
+      Properties="Configuration=$(Configuration);CodeAnalysis=$(CodeAnalysis);StyleCopEnabled=$(StyleCopEnabled);
+                  RestorePackagesConfig=true;VisualStudioVersion=$(VisualStudioVersion);
+                  Testing_NetStandard1_3=%(_Testing_NetStandard1_3.Identity)"
+      RemoveProperties="Platform" />
+
+    <MSBuild Projects="Runtime.sln" Targets="Restore"
       BuildInParallel="$(RestoreInParallel)"
       Properties="Configuration=$(Configuration);CodeAnalysis=$(CodeAnalysis);StyleCopEnabled=$(StyleCopEnabled);
                   RestorePackagesConfig=true;VisualStudioVersion=$(VisualStudioVersion)" />
@@ -79,14 +91,28 @@
   </Target>
 
   <Target Name="Build" DependsOnTargets="RestoreSkipStrongNames;RestorePackages;BuildTools">
-    <!-- we need to batch the solution files since they both build Microsoft.TestCommon -->
-    <Error Condition=" '$(CodeAnalysis)' == 'true' and '$(Configuration)' == 'Release' " Text="Unable to run code analysis in Release configuration. Release assemblies do not include SuppressMessage attributes (so code analysis would always fail with the errors that are normally suppressed)." />
+    <Error Condition=" '$(CodeAnalysis)' == 'true' and '$(Configuration)' == 'Release' "
+      Text="Unable to run code analysis in Release configuration. Release assemblies do not include SuppressMessage attributes (so code analysis would always fail with the errors that are normally suppressed)." />
     <MakeDir Directories="bin\$(Configuration)" />
+
+    <!--
+      Prebuild Microsoft.TestCommon due to the many dependencies on this project. Batch it to cover the full
+      set of references. Remove $(Platform) to avoid 'Any CPU' appearing in output paths. Can always build in
+      parallel because $(Testing_NetStandard1_3) changes both obj/ and bin/ folders entirely.
+    -->
+    <MSBuild Projects="test\Microsoft.TestCommon\Microsoft.TestCommon.csproj" Targets="Build"
+      BuildInParallel="true"
+      Properties="Configuration=$(Configuration);CodeAnalysis=$(CodeAnalysis);StyleCopEnabled=$(StyleCopEnabled);
+                  VisualStudioVersion=$(VisualStudioVersion);
+                  Testing_NetStandard1_3=%(_Testing_NetStandard1_3.Identity)"
+      RemoveProperties="Platform" />
+
     <MSBuild
         Projects="Runtime.sln"
         BuildInParallel="$(BuildInParallel)"
         Targets="Build"
-        Properties="Configuration=$(Configuration);CodeAnalysis=$(CodeAnalysis);StyleCopEnabled=$(StyleCopEnabled);VisualStudioVersion=$(VisualStudioVersion)" />
+        Properties="Configuration=$(Configuration);CodeAnalysis=$(CodeAnalysis);StyleCopEnabled=$(StyleCopEnabled);
+                    VisualStudioVersion=$(VisualStudioVersion)" />
   </Target>
 
   <Target Name="UnitTest" DependsOnTargets="Build;PrintTestRunSummary" />