Implemented MockFile.Create methods (#368)

Fixes #331
Fixes #332
Fixes #333

Implemented MockFile.Create methods as discussed in referenced issues.

No unit test for the overload that just takes a buffer size as it's ignored.

MockFileStream now receives a FileOptions which it checks on close to see if it should delete the file (FileOptions.DeleteOnClose) or encrypt it (FileOptions.Encrypted).

The overload that takes FileSecurity doesn't do anything with the argument, just passes it on. No unit test for this overload.

Author: rkoeninger

System.IO.Abstractions.TestingHelpers.Tests/MockFileCreateTests.cs

@@ -217,5 +217,67 @@ public void MockFile_Create_TruncateShouldClearFileContentsOnOpen()
             // Assert
             Assert.That(fileSystem.File.ReadAllText(testFileName), Is.EqualTo(string.Empty));
         }
+
+        [Test]
+        public void MockFile_Create_DeleteOnCloseOption_FileExistsWhileStreamIsOpen()
+        {
+            var root = XFS.Path(@"C:\");
+            var filePath = XFS.Path(@"C:\test.txt");
+            var fileSystem = new MockFileSystem();
+            fileSystem.Directory.CreateDirectory(root);
+
+            using (fileSystem.File.Create(filePath, 4096, FileOptions.DeleteOnClose))
+            {
+                Assert.IsTrue(fileSystem.File.Exists(filePath));
+            }
+        }
+
+        [Test]
+        public void MockFile_Create_DeleteOnCloseOption_FileDeletedWhenStreamIsClosed()
+        {
+            var root = XFS.Path(@"C:\");
+            var filePath = XFS.Path(@"C:\test.txt");
+            var fileSystem = new MockFileSystem();
+            fileSystem.Directory.CreateDirectory(root);
+
+            using (fileSystem.File.Create(filePath, 4096, FileOptions.DeleteOnClose))
+            {
+            }
+
+            Assert.IsFalse(fileSystem.File.Exists(filePath));
+        }
+
+#if NET40
+        [Test]
+        public void MockFile_Create_EncryptedOption_FileNotYetEncryptedsWhenStreamIsOpen()
+        {
+            var root = XFS.Path(@"C:\");
+            var filePath = XFS.Path(@"C:\test.txt");
+            var fileSystem = new MockFileSystem();
+            fileSystem.Directory.CreateDirectory(root);
+
+            using (var stream = fileSystem.File.Create(filePath, 4096, FileOptions.Encrypted))
+            {
+                var fileInfo = fileSystem.FileInfo.FromFileName(filePath);
+                Assert.IsFalse(fileInfo.Attributes.HasFlag(FileAttributes.Encrypted));
+            }
+        }
+
+        [Test]
+        public void MockFile_Create_EncryptedOption_EncryptsFileWhenStreamIsClose()
+        {
+            var root = XFS.Path(@"C:\");
+            var filePath = XFS.Path(@"C:\test.txt");
+            var fileSystem = new MockFileSystem();
+            fileSystem.Directory.CreateDirectory(root);
+
+            using (var stream = fileSystem.File.Create(filePath, 4096, FileOptions.Encrypted))
+            {
+            }
+
+            var fileInfo = fileSystem.FileInfo.FromFileName(filePath);
+            Assert.IsTrue(fileInfo.Attributes.HasFlag(FileAttributes.Encrypted));
+        }
+#endif
     }
 }

System.IO.Abstractions.TestingHelpers/MockFile.cs

@@ -133,41 +133,46 @@ public override void Copy(string sourceFileName, string destFileName, bool overw
             mockFileDataAccessor.AddFile(destFileName, new MockFileData(sourceFileData));
         }
 
-        public override Stream Create(string path)
+        public override Stream Create(string path) =>
+            Create(path, 4096);
+
+        public override Stream Create(string path, int bufferSize) =>
+            Create(path, bufferSize, FileOptions.None);
+
+        public override Stream Create(string path, int bufferSize, FileOptions options) =>
+            CreateInternal(path, bufferSize, options, null);
+
+#if NET40
+        public override Stream Create(string path, int bufferSize, FileOptions options, FileSecurity fileSecurity) =>
+            CreateInternal(path, bufferSize, options, fileSecurity);
+#endif
+
+        private Stream CreateInternal(string path, int bufferSize, FileOptions options, FileSecurity fileSecurity)
         {
             if (path == null)
             {
                 throw new ArgumentNullException(nameof(path), "Path cannot be null.");
             }
-            mockFileDataAccessor.PathVerifier.IsLegalAbsoluteOrRelative(path, "path");
 
+            mockFileDataAccessor.PathVerifier.IsLegalAbsoluteOrRelative(path, nameof(path));
             var directoryPath = mockPath.GetDirectoryName(path);
+
             if (!mockFileDataAccessor.Directory.Exists(directoryPath))
             {
-                throw new DirectoryNotFoundException(string.Format(CultureInfo.InvariantCulture, StringResources.Manager.GetString("COULD_NOT_FIND_PART_OF_PATH_EXCEPTION"), path));
+                throw new DirectoryNotFoundException(
+                    string.Format(
+                        CultureInfo.InvariantCulture,
+                        StringResources.Manager.GetString("COULD_NOT_FIND_PART_OF_PATH_EXCEPTION"),
+                        path));
             }
 
-            mockFileDataAccessor.AddFile(path, new MockFileData(new byte[0]));
-            var stream = OpenWrite(path);
-            return stream;
-        }
-
-        public override Stream Create(string path, int bufferSize)
-        {
-            throw new NotImplementedException(StringResources.Manager.GetString("NOT_IMPLEMENTED_EXCEPTION"));
-        }
-
-        public override Stream Create(string path, int bufferSize, FileOptions options)
-        {
-            throw new NotImplementedException(StringResources.Manager.GetString("NOT_IMPLEMENTED_EXCEPTION"));
-        }
-
-#if NET40
-        public override Stream Create(string path, int bufferSize, FileOptions options, FileSecurity fileSecurity)
-        {
-            throw new NotImplementedException(StringResources.Manager.GetString("NOT_IMPLEMENTED_EXCEPTION"));
+            var mockFileData = new MockFileData(new byte[0])
+            {
+                AccessControl = fileSecurity
+            };
+            mockFileDataAccessor.AddFile(path, mockFileData);
+            return OpenWriteInternal(path, options);
         }
-#endif
 
         public override StreamWriter CreateText(string path)
         {
@@ -383,7 +388,15 @@ public override Stream Open(string path, FileMode mode, FileAccess access)
             return Open(path, mode, access, FileShare.None);
         }
 
-        public override Stream Open(string path, FileMode mode, FileAccess access, FileShare share)
+        public override Stream Open(string path, FileMode mode, FileAccess access, FileShare share) =>
+            OpenInternal(path, mode, access, share, FileOptions.None);
+
+        private Stream OpenInternal(
+            string path,
+            FileMode mode,
+            FileAccess access,
+            FileShare share,
+            FileOptions options)
         {
             mockFileDataAccessor.PathVerifier.IsLegalAbsoluteOrRelative(path, "path");
 
@@ -412,7 +425,7 @@ public override Stream Open(string path, FileMode mode, FileAccess access, FileS
             else if (mode == FileMode.Append)
                 streamType = MockFileStream.StreamType.APPEND;
 
-            return new MockFileStream(mockFileDataAccessor, path, streamType);
+            return new MockFileStream(mockFileDataAccessor, path, streamType, options);
         }
 
         public override Stream OpenRead(string path)
@@ -430,11 +443,12 @@ public override StreamReader OpenText(string path)
                 OpenRead(path));
         }
 
-        public override Stream OpenWrite(string path)
+        public override Stream OpenWrite(string path) => OpenWriteInternal(path, FileOptions.None);
+
+        private Stream OpenWriteInternal(string path, FileOptions options)
         {
             mockFileDataAccessor.PathVerifier.IsLegalAbsoluteOrRelative(path, "path");
-
-            return Open(path, FileMode.OpenOrCreate, FileAccess.Write, FileShare.None);
+            return OpenInternal(path, FileMode.OpenOrCreate, FileAccess.Write, FileShare.None, options);
         }
 
         public override byte[] ReadAllBytes(string path)

System.IO.Abstractions.TestingHelpers/MockFileStream.cs

@@ -6,6 +6,7 @@ public class MockFileStream : MemoryStream
         private readonly IMockFileDataAccessor mockFileDataAccessor;
         private readonly string path;
         private readonly bool canWrite = true;
+        private readonly FileOptions options;
         private bool disposed;
 
         public enum StreamType
@@ -16,10 +17,23 @@ public enum StreamType
             TRUNCATE
         }
 
-        public MockFileStream(IMockFileDataAccessor mockFileDataAccessor, string path, StreamType streamType)
+        public MockFileStream(
+            IMockFileDataAccessor mockFileDataAccessor,
+            string path,
+            StreamType streamType)
+            : this(mockFileDataAccessor, path, streamType, FileOptions.None)
+        {
+        }
+
+        public MockFileStream(
+            IMockFileDataAccessor mockFileDataAccessor,
+            string path,
+            StreamType streamType,
+            FileOptions options)
         {
             this.mockFileDataAccessor = mockFileDataAccessor ?? throw new ArgumentNullException(nameof(mockFileDataAccessor));
             this.path = path;
+            this.options = options;
 
             if (mockFileDataAccessor.FileExists(path))
             {
@@ -51,6 +65,7 @@ public MockFileStream(IMockFileDataAccessor mockFileDataAccessor, string path, S
         public override void Close()
         {
             InternalFlush();
+            OnClose();
         }
 #else
         protected override void Dispose(bool disposing)
@@ -61,6 +76,7 @@ protected override void Dispose(bool disposing)
             }
             InternalFlush();
             base.Dispose(disposing);
+            OnClose();
             disposed = true;
         }
 #endif
@@ -84,5 +100,20 @@ private void InternalFlush()
                 mockFileData.Contents = data;
             }
         }
+
+        private void OnClose()
+        {
+            if (options.HasFlag(FileOptions.DeleteOnClose) && mockFileDataAccessor.FileExists(path))
+            {
+                mockFileDataAccessor.RemoveFile(path);
+            }
+
+#if NET40
+            if (options.HasFlag(FileOptions.Encrypted) && mockFileDataAccessor.FileExists(path))
+            {
+                mockFileDataAccessor.FileInfo.FromFileName(path).Encrypt();
+            }
+#endif
+        }
     }
 }

System.IO.Abstractions.TestingHelpers/MockFileStreamFactory.cs

@@ -24,17 +24,17 @@ public Stream Create(string path, FileMode mode, FileAccess access, FileShare sh
             => new MockFileStream(mockFileSystem, path, GetStreamType(mode, access));
 
         public Stream Create(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize, FileOptions options)
-            => new MockFileStream(mockFileSystem, path, GetStreamType(mode, access));
+            => new MockFileStream(mockFileSystem, path, GetStreamType(mode, access), options);
 
         public Stream Create(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize, bool useAsync)
             => new MockFileStream(mockFileSystem, path, GetStreamType(mode, access));
 
 #if NET40
         public Stream Create(string path, FileMode mode, FileSystemRights rights, FileShare share, int bufferSize, FileOptions options, FileSecurity fileSecurity)
-            => new MockFileStream(mockFileSystem, path, GetStreamType(mode));
+            => new MockFileStream(mockFileSystem, path, GetStreamType(mode), options);
 
         public Stream Create(string path, FileMode mode, FileSystemRights rights, FileShare share, int bufferSize, FileOptions options)
-            => new MockFileStream(mockFileSystem, path, GetStreamType(mode));
+            => new MockFileStream(mockFileSystem, path, GetStreamType(mode), options);
 #endif
 
 #if NET40 || NETSTANDARD_20