fix(tooling): use AppContext to set EnableUnsafeBinaryFormatterSerial…

…ization (#1349)
nuke-build · Jul 14, 2024 · 5be064d · 5be064d
1 parent 8dd7fe4
commit 5be064d
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 9 deletions.
diff --git a/source/Directory.Build.props b/source/Directory.Build.props
@@ -8,7 +8,6 @@
     <DebugType>embedded</DebugType>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
-    <EnableUnsafeBinaryFormatterSerialization>true</EnableUnsafeBinaryFormatterSerialization>
   </PropertyGroup>
 
   <PropertyGroup>

diff --git a/source/Nuke.Common/Nuke.Common.props b/source/Nuke.Common/Nuke.Common.props
@@ -5,7 +5,6 @@
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
     <MSBuildWarningsAsErrors>$(MSBuildWarningsAsErrors);CS8785</MSBuildWarningsAsErrors>
     <NoWarn>$(NoWarn);SYSLIB0050;SYSLIB0051</NoWarn>
-    <EnableUnsafeBinaryFormatterSerialization>true</EnableUnsafeBinaryFormatterSerialization>
   </PropertyGroup>
 
 </Project>
diff --git a/source/Nuke.Tooling.Tests/NewInstanceTest.cs b/source/Nuke.Tooling.Tests/NewInstanceTest.cs
@@ -0,0 +1,31 @@
+// Copyright 2023 Maintainers of NUKE.
+// Distributed under the MIT License.
+// https://github.com/nuke-build/nuke/blob/master/LICENSE
+
+using FluentAssertions;
+using Nuke.Common.Tooling;
+using System;
+using Xunit;
+
+namespace Nuke.Common.Tests;
+
+public class NewInstanceTest
+{
+    [Serializable]
+    public class SimpleEntity : ISettingsEntity
+    {
+        public int Integer { get; set; }
+        public string String { get; set; }
+    }
+
+    [Fact]
+    public void TestSimpleEntity()
+    {
+        var entity = new SimpleEntity { Integer = 1, String = "test" };
+        var newInstance = entity.NewInstance();
+
+        newInstance.Integer.Should().Be(entity.Integer);
+        newInstance.String.Should().Be(entity.String);
+    }
+
+}
diff --git a/source/Nuke.Tooling.Tests/Nuke.Tooling.Tests.csproj b/source/Nuke.Tooling.Tests/Nuke.Tooling.Tests.csproj
@@ -1,7 +1,7 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/source/Nuke.Tooling/SettingsEntity.NewInstance.cs b/source/Nuke.Tooling/SettingsEntity.NewInstance.cs
@@ -1,4 +1,4 @@
-// Copyright 2023 Maintainers of NUKE.
+// Copyright 2024 Maintainers of NUKE.
 // Distributed under the MIT License.
 // https://github.com/nuke-build/nuke/blob/master/LICENSE
 
@@ -7,6 +7,7 @@
 using System.Linq;
 using System.Runtime.Serialization.Formatters.Binary;
 using JetBrains.Annotations;
+
 #pragma warning disable SYSLIB0011
 
 namespace Nuke.Common.Tooling;
@@ -17,18 +18,20 @@ public static partial class SettingsEntityExtensions
     public static T NewInstance<T>(this T settingsEntity)
         where T : ISettingsEntity
     {
+        AppContext.SetSwitch("System.Runtime.Serialization.EnableUnsafeBinaryFormatterSerialization", isEnabled: true);
+
         var binaryFormatter = new BinaryFormatter();
 
         using var memoryStream = new MemoryStream();
         binaryFormatter.Serialize(memoryStream, settingsEntity);
         memoryStream.Seek(offset: 0, loc: SeekOrigin.Begin);
 
-        var newInstance = (T) binaryFormatter.Deserialize(memoryStream);
+        var newInstance = (T)binaryFormatter.Deserialize(memoryStream);
         if (newInstance is ToolSettings toolSettings)
         {
-            toolSettings.ProcessArgumentConfigurator = ((ToolSettings) (object) settingsEntity).ProcessArgumentConfigurator;
-            toolSettings.ProcessLogger = ((ToolSettings) (object) settingsEntity).ProcessLogger;
-            toolSettings.ProcessExitHandler = ((ToolSettings) (object) settingsEntity).ProcessExitHandler;
+            toolSettings.ProcessArgumentConfigurator = ((ToolSettings)(object)settingsEntity).ProcessArgumentConfigurator;
+            toolSettings.ProcessLogger = ((ToolSettings)(object)settingsEntity).ProcessLogger;
+            toolSettings.ProcessExitHandler = ((ToolSettings)(object)settingsEntity).ProcessExitHandler;
         }
 
         return newInstance;