refactor: prepare serialization infrastructure for .NET 8+ (#1034)

This fixes #1033: As [BinaryFormatter becomes obsolete](https://github.com/dotnet/designs/blob/main/accepted/2020/better-obsoletion/binaryformatter-obsoletion.md), remove the tests for serialization on .NET8.0 or greater. Also move the `Serialization` attribute behind a feature flag, which is currently always active, but will be disabled with .NET9.
TestableIO · Sep 12, 2023 · 475b8c1 · 475b8c1
1 parent d8ecbd8
commit 475b8c1
Show file tree

Hide file tree

Showing 43 changed files with 103 additions and 4 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -15,6 +15,7 @@
     <DefineConstants Condition="'$(TargetFramework)' == 'net7.0' OR '$(TargetFramework)' == 'net6.0' OR '$(TargetFramework)' == 'net5.0'">$(DefineConstants);FEATURE_FILE_MOVE_WITH_OVERWRITE;FEATURE_SUPPORTED_OS_ATTRIBUTE;FEATURE_FILE_SYSTEM_WATCHER_FILTERS;FEATURE_ENDS_IN_DIRECTORY_SEPARATOR;FEATURE_PATH_JOIN_WITH_PARAMS;FEATURE_PATH_JOIN_WITH_FOUR_PATHS</DefineConstants>
     <DefineConstants Condition="'$(TargetFramework)' == 'net7.0' OR '$(TargetFramework)' == 'net6.0'">$(DefineConstants);FEATURE_FILE_SYSTEM_INFO_LINK_TARGET;FEATURE_CREATE_SYMBOLIC_LINK;FEATURE_FILESTREAM_OPTIONS</DefineConstants>
     <DefineConstants Condition="'$(TargetFramework)' == 'net7.0'">$(DefineConstants);FEATURE_PATH_EXISTS;FEATURE_FILE_SYSTEM_WATCHER_WAIT_WITH_TIMESPAN;FEATURE_FILE_ATTRIBUTES_VIA_HANDLE;FEATURE_CREATE_TEMP_SUBDIRECTORY;FEATURE_READ_LINES_ASYNC;FEATURE_UNIX_FILE_MODE</DefineConstants>
+    <DefineConstants>$(DefineConstants);FEATURE_SERIALIZABLE</DefineConstants>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Nerdbank.GitVersioning" Version="3.6.133">

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDirectory.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDirectory.cs
@@ -10,8 +10,9 @@ namespace System.IO.Abstractions.TestingHelpers
 
 
     /// <inheritdoc />
-
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockDirectory : DirectoryBase
     {
         private readonly IMockFileDataAccessor mockFileDataAccessor;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDirectoryData.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDirectoryData.cs
@@ -4,11 +4,14 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockDirectoryData : MockFileData
     {
-
+#if FEATURE_SERIALIZABLE
         [NonSerialized]
+#endif
         private DirectorySecurity accessControl;
 
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDirectoryInfo.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDirectoryInfo.cs
@@ -8,7 +8,9 @@ namespace System.IO.Abstractions.TestingHelpers
     using XFS = MockUnixSupport;
 
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockDirectoryInfo : DirectoryInfoBase, IFileSystemAclSupport
     {
         private readonly IMockFileDataAccessor mockFileDataAccessor;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDirectoryInfoFactory.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDirectoryInfoFactory.cs
@@ -1,7 +1,9 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockDirectoryInfoFactory : IDirectoryInfoFactory
     {
         readonly IMockFileDataAccessor mockFileSystem;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDriveInfo.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDriveInfo.cs
@@ -1,7 +1,9 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockDriveInfo : DriveInfoBase
     {
         private readonly IMockFileDataAccessor mockFileDataAccessor;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDriveInfoFactory.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockDriveInfoFactory.cs
@@ -3,7 +3,9 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockDriveInfoFactory : IDriveInfoFactory
     {
         private readonly IMockFileDataAccessor mockFileSystem;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFile.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFile.cs
@@ -9,7 +9,9 @@ namespace System.IO.Abstractions.TestingHelpers
     using XFS = MockUnixSupport;
 
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public partial class MockFile : FileBase
     {
         private readonly IMockFileDataAccessor mockFileDataAccessor;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileData.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileData.cs
@@ -8,7 +8,9 @@ namespace System.IO.Abstractions.TestingHelpers
     /// <summary>
     /// The class represents the associated data of a file.
     /// </summary>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockFileData
     {
         /// <summary>
@@ -36,7 +38,9 @@ public class MockFileData
         /// <summary>
         /// The access control of the <see cref="MockFileData"/>.
         /// </summary>
+#if FEATURE_SERIALIZABLE
         [NonSerialized]
+#endif
         private FileSecurity accessControl;
 
         /// <summary>

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileInfo.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileInfo.cs
@@ -4,7 +4,9 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockFileInfo : FileInfoBase, IFileSystemAclSupport
     {
         private readonly IMockFileDataAccessor mockFileSystem;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileInfoFactory.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileInfoFactory.cs
@@ -1,7 +1,9 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockFileInfoFactory : IFileInfoFactory
     {
         private readonly IMockFileDataAccessor mockFileSystem;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileStream.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileStream.cs
@@ -6,7 +6,9 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockFileStream : FileSystemStream, IFileSystemAclSupport
     {
         /// <summary>

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileStreamFactory.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileStreamFactory.cs
@@ -4,7 +4,9 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockFileStreamFactory : IFileStreamFactory
     {
         private readonly IMockFileDataAccessor mockFileSystem;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileSystem.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileSystem.cs
@@ -8,15 +8,19 @@ namespace System.IO.Abstractions.TestingHelpers
     using XFS = MockUnixSupport;
 
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockFileSystem : FileSystemBase, IMockFileDataAccessor
     {
         private const string DEFAULT_CURRENT_DIRECTORY = @"C:\";
         private const string TEMP_DIRECTORY = @"C:\temp";
 
         private readonly IDictionary<string, FileSystemEntry> files;
         private readonly PathVerifier pathVerifier;
+#if FEATURE_SERIALIZABLE
         [NonSerialized]
+#endif
         private Func<DateTime> dateTimeProvider = defaultDateTimeProvider;
         private static Func<DateTime> defaultDateTimeProvider = () => DateTime.UtcNow;
 
@@ -516,7 +520,9 @@ private bool FileIsReadOnly(string path)
             return (GetFile(path).Attributes & FileAttributes.ReadOnly) == FileAttributes.ReadOnly;
         }
 
-        [Serializable]
+#if FEATURE_SERIALIZABLE
+    [Serializable]
+#endif
         private class FileSystemEntry
         {
             public string Path { get; set; }

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileSystemWatcherFactory.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileSystemWatcherFactory.cs
@@ -1,7 +1,9 @@
 namespace System.IO.Abstractions.TestingHelpers
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockFileSystemWatcherFactory : IFileSystemWatcherFactory
     {
 

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockPath.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockPath.cs
@@ -7,7 +7,9 @@ namespace System.IO.Abstractions.TestingHelpers
     /// <summary>
     /// PathWrapper calls direct to Path but all this does is string manipulation so we can inherit directly from PathWrapper as no IO is done
     /// </summary>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class MockPath : PathWrapper
     {
         private readonly IMockFileDataAccessor mockFileDataAccessor;

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/PathVerifier.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/PathVerifier.cs
@@ -7,7 +7,9 @@ namespace System.IO.Abstractions.TestingHelpers
     /// <summary>
     /// Provides helper methods for verifying paths.
     /// </summary>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class PathVerifier
     {
         private static readonly char[] AdditionalInvalidPathChars = { '*', '?' };

diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/StringOperations.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/StringOperations.cs
@@ -4,7 +4,9 @@
     /// <summary>
     /// Provides operations against path strings dependeing on the case-senstivity of the runtime platform.
     /// </summary>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class StringOperations
     {
         private readonly bool caseSensitive;

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryBase.cs
@@ -5,7 +5,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc cref="Directory"/>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public abstract class DirectoryBase : IDirectory
     {
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoBase.cs
@@ -4,7 +4,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc cref="IDirectoryInfo"/>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public abstract class DirectoryInfoBase : FileSystemInfoBase, IDirectoryInfo
     {
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoFactory.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoFactory.cs
@@ -1,6 +1,8 @@
 namespace System.IO.Abstractions
 {
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     internal class DirectoryInfoFactory : IDirectoryInfoFactory
     {
         private readonly IFileSystem fileSystem;

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoWrapper.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoWrapper.cs
@@ -7,7 +7,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class DirectoryInfoWrapper : DirectoryInfoBase, IFileSystemAclSupport
     {
         private readonly DirectoryInfo instance;

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryWrapper.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryWrapper.cs
@@ -4,7 +4,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class DirectoryWrapper : DirectoryBase
     {
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/DriveInfoBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/DriveInfoBase.cs
@@ -1,7 +1,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public abstract class DriveInfoBase : IDriveInfo
     {
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/DriveInfoFactory.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/DriveInfoFactory.cs
@@ -1,6 +1,8 @@
 namespace System.IO.Abstractions
 {
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     internal class DriveInfoFactory : IDriveInfoFactory
     {
         private readonly IFileSystem fileSystem;

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/DriveInfoWrapper.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/DriveInfoWrapper.cs
@@ -5,7 +5,9 @@ namespace System.IO.Abstractions
     /// <summary>
     /// The wrapper for a <see cref="DriveInfo"/>.
     /// </summary>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class DriveInfoWrapper : DriveInfoBase
     {
         /// <summary>

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileBase.cs
@@ -5,7 +5,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc cref="File"/>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public abstract partial class FileBase : IFile
     {
         ///

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoBase.cs
@@ -3,7 +3,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc cref="FileInfo"/>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public abstract class FileInfoBase : FileSystemInfoBase, IFileInfo
     {
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoFactory.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoFactory.cs
@@ -1,6 +1,8 @@
 namespace System.IO.Abstractions
 {
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     internal class FileInfoFactory : IFileInfoFactory
     {
         private readonly IFileSystem fileSystem;

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoWrapper.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoWrapper.cs
@@ -4,7 +4,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class FileInfoWrapper : FileInfoBase, IFileSystemAclSupport
     {
         private readonly FileInfo instance;

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileStreamFactory.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileStreamFactory.cs
@@ -2,7 +2,9 @@
 
 namespace System.IO.Abstractions
 {
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     internal sealed class FileStreamFactory : IFileStreamFactory
     {
         public FileStreamFactory(IFileSystem fileSystem)

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystem.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystem.cs
@@ -1,7 +1,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class FileSystem : FileSystemBase
     {
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemBase.cs
@@ -1,7 +1,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public abstract class FileSystemBase : IFileSystem
     {
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemInfoBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemInfoBase.cs
@@ -3,7 +3,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc cref="FileSystemInfo"/>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public abstract class FileSystemInfoBase : IFileSystemInfo
     {
         ///

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemWatcherBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemWatcherBase.cs
@@ -3,7 +3,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc cref="FileSystemWatcher"/>
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public abstract class FileSystemWatcherBase : IFileSystemWatcher
     {
         /// <inheritdoc />

diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemWatcherFactory.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemWatcherFactory.cs
@@ -1,7 +1,9 @@
 namespace System.IO.Abstractions
 {
     /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
     [Serializable]
+#endif
     public class FileSystemWatcherFactory : IFileSystemWatcherFactory
     {
         ///