Simplify versioning handling (#1879)

microsoft · Dec 5, 2023 · 6a0895d · 6a0895d
1 parent 05cd400
commit 6a0895d
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 21 deletions.
diff --git a/Directory.Build.Local.props b/Directory.Build.Local.props
@@ -50,12 +50,6 @@
 
   <!-- Build config -->
   <PropertyGroup>
-    <!--
-      It appears that AssemblyVersion should always be set to 14.0.0.0 for some backward compatibility cases,
-      but we don't have any information about these cases.
-     -->
-    <AssemblyVersion>14.0.0.0</AssemblyVersion>
-    <AssemblyFileVersion>14.0.0.0</AssemblyFileVersion>
     <FixupTestingPlatformVersion>true</FixupTestingPlatformVersion>
     <!-- Prevent warning about deprecated target frameworks -->
     <CheckEolTargetFramework>false</CheckEolTargetFramework>

diff --git a/Directory.Build.Local.targets b/Directory.Build.Local.targets
@@ -10,4 +10,13 @@
     <TargetFramework Condition=" '$(TargetFramework)' != '' ">$(NetCoreAppLatestStableVersion)</TargetFramework>
   </PropertyGroup>
 
+  <PropertyGroup Condition=" '$(UseAssemblyVersion14)' == 'true' ">
+    <!--
+      It appears that AssemblyVersion should always be set to 14.0.0.0 for some backward compatibility cases,
+      but we don't have any information about these cases.
+     -->
+    <AssemblyVersion>14.0.0.0</AssemblyVersion>
+    <AssemblyFileVersion>14.0.0.0</AssemblyFileVersion>
+  </PropertyGroup>
+
 </Project>
diff --git a/src/Adapter/MSTest.TestAdapter/MSTest.TestAdapter.csproj b/src/Adapter/MSTest.TestAdapter/MSTest.TestAdapter.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;$(NetCoreAppCurrent);$(NetCoreAppMinimum);$(NetFrameworkMinimum)</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
+    <UseAssemblyVersion14>true</UseAssemblyVersion14>
   </PropertyGroup>
 
   <PropertyGroup>

diff --git a/src/Adapter/MSTestAdapter.PlatformServices/MSTestAdapter.PlatformServices.csproj b/src/Adapter/MSTestAdapter.PlatformServices/MSTestAdapter.PlatformServices.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>$(UwpMinimum);$(WinUiMinimum);netstandard2.0;$(NetFrameworkMinimum);$(NetCoreAppMinimum);$(NetCoreAppCurrent)</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
+    <UseAssemblyVersion14>true</UseAssemblyVersion14>
   </PropertyGroup>
 
   <PropertyGroup>

diff --git a/src/TestFramework/TestFramework.Extensions/TestFramework.Extensions.csproj b/src/TestFramework/TestFramework.Extensions/TestFramework.Extensions.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>$(UwpMinimum);$(WinUiMinimum);netstandard2.0;$(NetCoreAppCurrent);$(NetCoreAppMinimum);$(NetFrameworkMinimum)</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
+    <UseAssemblyVersion14>true</UseAssemblyVersion14>
   </PropertyGroup>
 
   <PropertyGroup>

diff --git a/src/TestFramework/TestFramework/TestFramework.csproj b/src/TestFramework/TestFramework/TestFramework.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;$(NetCoreAppCurrent);$(NetCoreAppMinimum);$(NetFrameworkMinimum)</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
+    <UseAssemblyVersion14>true</UseAssemblyVersion14>
   </PropertyGroup>
 
   <PropertyGroup>

diff --git a/.../MSTestAdapter.PlatformServices.UnitTests/MSTestAdapter.PlatformServices.UnitTests.csproj b/.../MSTestAdapter.PlatformServices.UnitTests/MSTestAdapter.PlatformServices.UnitTests.csproj
@@ -4,6 +4,7 @@
     <NetStandardNetFrameworkHolder>net48</NetStandardNetFrameworkHolder>
     <TargetFrameworks>net462;$(NetStandardNetFrameworkHolder);netcoreapp3.1;net6.0;$(WinUiMinimum)</TargetFrameworks>
     <IsNetCoreApp Condition=" '$(TargetFramework)' == 'netcoreapp3.1' OR '$(TargetFramework)' == 'net6.0' OR '$(TargetFramework)' == '$(WinUiMinimum)' ">true</IsNetCoreApp>
+    <UseAssemblyVersion14>true</UseAssemblyVersion14>
   </PropertyGroup>
 
   <!-- Properties specific to WinUI -->

diff --git a/test/UnitTests/MSTestAdapter.PlatformServices.UnitTests/Utilities/XmlUtilitiesTests.cs b/test/UnitTests/MSTestAdapter.PlatformServices.UnitTests/Utilities/XmlUtilitiesTests.cs
@@ -16,12 +16,7 @@ namespace MSTestAdapter.PlatformServices.UnitTests.Utilities;
 
 public class XmlUtilitiesTests : TestContainer
 {
-    private readonly TestableXmlUtilities _testableXmlUtilities;
-
-    public XmlUtilitiesTests()
-    {
-        _testableXmlUtilities = new TestableXmlUtilities();
-    }
+    private readonly TestableXmlUtilities _testableXmlUtilities = new();
 
     public void AddAssemblyRedirectionShouldAddRedirectionToAnEmptyXml()
     {
@@ -35,8 +30,19 @@ public void AddAssemblyRedirectionShouldAddRedirectionToAnEmptyXml()
             assemblyName.Version.ToString());
 
         // Assert.
-        var expectedXml =
-            "<?xml version=\"1.0\" encoding=\"utf-8\"?><configuration><runtime><assemblyBinding xmlns=\"urn:schemas-microsoft-com:asm.v1\"><dependentAssembly><assemblyIdentity name=\"MSTestAdapter.PlatformServices.UnitTests\" publicKeyToken=\"b03f5f7f11d50a3a\" culture=\"neutral\" /><bindingRedirect oldVersion=\"99.99.99.99\" newVersion=\"14.0.0.0\" /></dependentAssembly></assemblyBinding></runtime></configuration>";
+        var expectedXml = """
+            <?xml version="1.0" encoding="utf-8"?>
+            <configuration>
+                <runtime>
+                    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
+                        <dependentAssembly>
+                            <assemblyIdentity name="MSTestAdapter.PlatformServices.UnitTests" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
+                            <bindingRedirect oldVersion="99.99.99.99" newVersion="14.0.0.0" />
+                        </dependentAssembly>
+                    </assemblyBinding>
+                </runtime>
+            </configuration>
+            """;
         var doc = new XmlDocument();
         doc.LoadXml(expectedXml);
         byte[] expectedConfigBytes = null;
@@ -64,8 +70,19 @@ public void AddAssemblyRedirectionShouldAddRedirectionToAnEmptyConfig()
             assemblyName.Version.ToString());
 
         // Assert.
-        var expectedXml =
-            "<?xml version=\"1.0\" encoding=\"utf-8\"?><configuration><runtime><assemblyBinding xmlns=\"urn:schemas-microsoft-com:asm.v1\"><dependentAssembly><assemblyIdentity name=\"MSTestAdapter.PlatformServices.UnitTests\" publicKeyToken=\"b03f5f7f11d50a3a\" culture=\"neutral\" /><bindingRedirect oldVersion=\"99.99.99.99\" newVersion=\"14.0.0.0\" /></dependentAssembly></assemblyBinding></runtime></configuration>";
+        var expectedXml = """
+            <?xml version="1.0" encoding="utf-8"?>
+            <configuration>
+                <runtime>
+                    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
+                        <dependentAssembly>
+                            <assemblyIdentity name="MSTestAdapter.PlatformServices.UnitTests" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
+                            <bindingRedirect oldVersion="99.99.99.99" newVersion="14.0.0.0" />
+                        </dependentAssembly>
+                    </assemblyBinding>
+                </runtime>
+            </configuration>
+            """;
         var doc = new XmlDocument();
         doc.LoadXml(expectedXml);
         byte[] expectedConfigBytes = null;
@@ -95,8 +112,19 @@ public void AddAssemblyRedirectionShouldAddRedirectionToAConfigWithARuntimeSecti
             assemblyName.Version.ToString());
 
         // Assert.
-        var expectedXml =
-            "<?xml version=\"1.0\" encoding=\"utf-8\"?><configuration><runtime><assemblyBinding xmlns=\"urn:schemas-microsoft-com:asm.v1\"><dependentAssembly><assemblyIdentity name=\"MSTestAdapter.PlatformServices.UnitTests\" publicKeyToken=\"b03f5f7f11d50a3a\" culture=\"neutral\" /><bindingRedirect oldVersion=\"99.99.99.99\" newVersion=\"14.0.0.0\" /></dependentAssembly></assemblyBinding></runtime></configuration>";
+        var expectedXml = """
+            <?xml version="1.0" encoding="utf-8"?>
+            <configuration>
+                <runtime>
+                    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
+                        <dependentAssembly>
+                            <assemblyIdentity name="MSTestAdapter.PlatformServices.UnitTests" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
+                            <bindingRedirect oldVersion="99.99.99.99" newVersion="14.0.0.0" />
+                        </dependentAssembly>
+                    </assemblyBinding>
+                </runtime>
+            </configuration>
+            """;
         var doc = new XmlDocument();
 #pragma warning disable CA3075 // Insecure DTD processing in XML
         doc.LoadXml(expectedXml);
@@ -114,7 +142,19 @@ public void AddAssemblyRedirectionShouldAddRedirectionToAConfigWithARuntimeSecti
 
     public void AddAssemblyRedirectionShouldAddRedirectionToAConfigWithRedirections()
     {
-        _testableXmlUtilities.ConfigXml = "<?xml version=\"1.0\" encoding=\"utf-8\" ?><configuration><runtime><assemblyBinding xmlns=\"urn:schemas-microsoft-com:asm.v1\"><dependentAssembly><assemblyIdentity name=\"Random.UnitTests\" publicKeyToken=\"b03f5f7f11d50a3a\" culture=\"neutral\" /><bindingRedirect oldVersion=\"99.99.99.99\" newVersion=\"14.0.0.0\" /></dependentAssembly></assemblyBinding></runtime></configuration>";
+        _testableXmlUtilities.ConfigXml = """
+            <?xml version="1.0" encoding="utf-8" ?>
+            <configuration>
+                <runtime>
+                    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
+                        <dependentAssembly>
+                            <assemblyIdentity name="Random.UnitTests" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
+                            <bindingRedirect oldVersion="99.99.99.99" newVersion="14.0.0.0" />
+                        </dependentAssembly>
+                    </assemblyBinding>
+                </runtime>
+            </configuration>
+            """;
         var assemblyName = Assembly.GetExecutingAssembly().GetName();
 
         var configBytes = _testableXmlUtilities.AddAssemblyRedirection(
@@ -124,8 +164,23 @@ public void AddAssemblyRedirectionShouldAddRedirectionToAConfigWithRedirections(
             assemblyName.Version.ToString());
 
         // Assert.
-        var expectedXml =
-            "<?xml version=\"1.0\" encoding=\"utf-8\"?><configuration><runtime><assemblyBinding xmlns=\"urn:schemas-microsoft-com:asm.v1\"><dependentAssembly><assemblyIdentity name=\"Random.UnitTests\" publicKeyToken=\"b03f5f7f11d50a3a\" culture=\"neutral\" /><bindingRedirect oldVersion=\"99.99.99.99\" newVersion=\"14.0.0.0\" /></dependentAssembly><dependentAssembly><assemblyIdentity name=\"MSTestAdapter.PlatformServices.UnitTests\" publicKeyToken=\"b03f5f7f11d50a3a\" culture=\"neutral\" /><bindingRedirect oldVersion=\"99.99.99.99\" newVersion=\"14.0.0.0\" /></dependentAssembly></assemblyBinding></runtime></configuration>";
+        var expectedXml = """
+            <?xml version="1.0" encoding="utf-8"?>
+            <configuration>
+                <runtime>
+                    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
+                        <dependentAssembly>
+                            <assemblyIdentity name="Random.UnitTests" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
+                            <bindingRedirect oldVersion="99.99.99.99" newVersion="14.0.0.0" />
+                        </dependentAssembly>
+                        <dependentAssembly>
+                            <assemblyIdentity name="MSTestAdapter.PlatformServices.UnitTests" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
+                            <bindingRedirect oldVersion="99.99.99.99" newVersion="14.0.0.0" />
+                        </dependentAssembly>
+                    </assemblyBinding>
+                </runtime>
+            </configuration>
+            """;
         var doc = new XmlDocument();
         doc.LoadXml(expectedXml);
         byte[] expectedConfigBytes = null;