- Implemented IFileVersionInfoFactory and moved the FileVersionInfo query from IFileInfo to IFileSystem

Kormos Tamás · Kormos Tamás · commit 6e407cd9003f · 2024-12-16T18:20:07.000+01:00
- Added a missing API test for the parity test of IFileVersionInfo and FileVersionInfo
diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileInfo.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileInfo.cs
@@ -333,15 +333,6 @@ public override IDirectoryInfo Directory
             }
         }
 
-        /// <inheritdoc />
-        public override IFileVersionInfo FileVersionInfo
-        {
-            get
-            {
-                return mockFileSystem.GetFile(path).FileVersionInfo;
-            }
-        }
-
         /// <inheritdoc />
         public override string DirectoryName
         {
diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileSystem.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileSystem.cs
@@ -65,6 +65,7 @@ public MockFileSystem(IDictionary<string, MockFileData> files, MockFileSystemOpt
             File = new MockFile(this);
             Directory = new MockDirectory(this, currentDirectory);
             FileInfo = new MockFileInfoFactory(this);
+            FileVersionInfo = new MockFileVersionInfoFactory(this);
             FileStream = new MockFileStreamFactory(this);
             DirectoryInfo = new MockDirectoryInfoFactory(this);
             DriveInfo = new MockDriveInfoFactory(this);
@@ -98,6 +99,8 @@ public MockFileSystem(IDictionary<string, MockFileData> files, MockFileSystemOpt
         /// <inheritdoc />
         public override IFileInfoFactory FileInfo { get; }
         /// <inheritdoc />
+        public override IFileVersionInfoFactory FileVersionInfo { get; }
+        /// <inheritdoc />
         public override IFileStreamFactory FileStream { get; }
         /// <inheritdoc />
         public override IPath Path { get; }
diff --git a/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileVersionInfoFactory.cs b/src/TestableIO.System.IO.Abstractions.TestingHelpers/MockFileVersionInfoFactory.cs
@@ -0,0 +1,44 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace System.IO.Abstractions.TestingHelpers
+{
+    /// <inheritdoc />
+#if FEATURE_SERIALIZABLE
+    [Serializable]
+#endif
+    public class MockFileVersionInfoFactory : IFileVersionInfoFactory
+    {
+        private static IMockFileDataAccessor mockFileSystem;
+
+        /// <inheritdoc />
+        public MockFileVersionInfoFactory(IMockFileDataAccessor mockFileSystem)
+        {
+            MockFileVersionInfoFactory.mockFileSystem = mockFileSystem ?? throw new ArgumentNullException(nameof(mockFileSystem));
+        }
+
+        /// <inheritdoc />
+        public IFileSystem FileSystem => mockFileSystem;
+
+        IFileVersionInfo IFileVersionInfoFactory.GetVersionInfo(string fileName)
+        {
+            return GetVersionInfo(fileName);
+        }
+
+        /// <inheritdoc cref="Diagnostics.FileVersionInfo.GetVersionInfo(string)" />
+        public static IFileVersionInfo GetVersionInfo(string fileName)
+        {
+            MockFileData mockFileData = mockFileSystem.GetFile(fileName);
+
+            if (mockFileData != null)
+            {
+                return mockFileData.FileVersionInfo;
+            }
+
+            throw CommonExceptions.FileNotFound(fileName);
+        }
+    }
+}
diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoBase.cs
@@ -77,9 +77,6 @@ internal FileInfoBase() { }
         /// <inheritdoc cref="IFileInfo.Directory"/>
         public abstract IDirectoryInfo Directory { get; }
 
-        /// <inheritdoc cref="IFileVersionInfo"/>
-        public abstract IFileVersionInfo FileVersionInfo { get; }
-
         /// <inheritdoc cref="IFileInfo.DirectoryName"/>
         public abstract string DirectoryName { get; }
 
diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoWrapper.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoWrapper.cs
@@ -247,12 +247,6 @@ public override IDirectoryInfo Directory
             get { return new DirectoryInfoWrapper(FileSystem, instance.Directory); }
         }
 
-        /// <inheritdoc />
-        public override IFileVersionInfo FileVersionInfo
-        {
-            get { return new FileVersionInfoWrapper(Diagnostics.FileVersionInfo.GetVersionInfo(FullName)); }
-        }
-
         /// <inheritdoc />
         public override string DirectoryName
         {
diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystem.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystem.cs
@@ -12,6 +12,7 @@ public FileSystem()
             DriveInfo = new DriveInfoFactory(this);
             DirectoryInfo = new DirectoryInfoFactory(this);
             FileInfo = new FileInfoFactory(this);
+            FileVersionInfo = new FileVersionInfoFactory(this);
             Path = new PathWrapper(this);
             File = new FileWrapper(this);
             Directory = new DirectoryWrapper(this);
@@ -28,6 +29,9 @@ public FileSystem()
         /// <inheritdoc />
         public override IFileInfoFactory FileInfo { get; }
 
+        /// <inheritdoc />
+        public override IFileVersionInfoFactory FileVersionInfo { get; }
+
         /// <inheritdoc />
         public override IFileStreamFactory FileStream { get; }
 
diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemBase.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileSystemBase.cs
@@ -15,6 +15,9 @@ public abstract class FileSystemBase : IFileSystem
         /// <inheritdoc />
         public abstract IFileInfoFactory FileInfo { get; }
 
+        /// <inheritdoc />
+        public abstract IFileVersionInfoFactory FileVersionInfo { get; }
+
         /// <inheritdoc />
         public abstract IFileStreamFactory FileStream { get; }
 
diff --git a/src/TestableIO.System.IO.Abstractions.Wrappers/FileVersionInfoFactory.cs b/src/TestableIO.System.IO.Abstractions.Wrappers/FileVersionInfoFactory.cs
@@ -0,0 +1,38 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace System.IO.Abstractions
+{
+#if FEATURE_SERIALIZABLE
+    [Serializable]
+#endif
+    internal class FileVersionInfoFactory : IFileVersionInfoFactory
+    {
+        private readonly IFileSystem fileSystem;
+
+        /// <inheritdoc />
+        public FileVersionInfoFactory(IFileSystem fileSystem)
+        {
+            this.fileSystem = fileSystem;
+        }
+
+        /// <inheritdoc />
+        public IFileSystem FileSystem => fileSystem;
+
+        IFileVersionInfo IFileVersionInfoFactory.GetVersionInfo(string fileName)
+        {
+            return GetVersionInfo(fileName);
+        }
+
+        /// <inheritdoc cref="Diagnostics.FileVersionInfo.GetVersionInfo(string)" />
+        public static IFileVersionInfo GetVersionInfo(string fileName)
+        {
+            Diagnostics.FileVersionInfo fileVersionInfo = Diagnostics.FileVersionInfo.GetVersionInfo(fileName);
+            
+            return new FileVersionInfoWrapper(fileVersionInfo);
+        }
+    }
+}
diff --git a/src/TestableIO.System.IO.Abstractions/IFileInfo.cs b/src/TestableIO.System.IO.Abstractions/IFileInfo.cs
@@ -8,9 +8,6 @@ public interface IFileInfo : IFileSystemInfo
         /// <inheritdoc cref="FileInfo.Directory" />
         IDirectoryInfo? Directory { get; }
 
-        /// <inheritdoc cref="IFileVersionInfo" />
-        IFileVersionInfo? FileVersionInfo { get; }
-
         /// <inheritdoc cref="FileInfo.DirectoryName" />
         string? DirectoryName { get; }
 
diff --git a/src/TestableIO.System.IO.Abstractions/IFileSystem.cs b/src/TestableIO.System.IO.Abstractions/IFileSystem.cs
@@ -30,6 +30,9 @@ public interface IFileSystem
         /// </summary>
         IFileInfoFactory FileInfo { get; }
 
+        /// <inheritdoc cref="IFileVersionInfoFactory" />
+        IFileVersionInfoFactory FileVersionInfo { get; }
+
         /// <summary>
         /// A factory for the creation of wrappers for <see cref="System.IO.FileStream" />.
         /// </summary>
diff --git a/src/TestableIO.System.IO.Abstractions/IFileVersionInfoFactory.cs b/src/TestableIO.System.IO.Abstractions/IFileVersionInfoFactory.cs
@@ -0,0 +1,13 @@
+﻿using System.Diagnostics;
+
+namespace System.IO.Abstractions
+{
+    /// <summary>
+    /// A factory for the creation of wrappers for <see cref="FileVersionInfo" /> in a <see cref="IFileSystem" />.
+    /// </summary>
+    public interface IFileVersionInfoFactory : IFileSystemEntity
+    {
+        /// <inheritdoc cref="FileVersionInfo.GetVersionInfo(string)" />
+        IFileVersionInfo GetVersionInfo(string fileName);
+    }
+}
diff --git a/tests/TestableIO.System.IO.Abstractions.TestingHelpers.Tests/MockFileInfoTests.cs b/tests/TestableIO.System.IO.Abstractions.TestingHelpers.Tests/MockFileInfoTests.cs
@@ -489,29 +489,6 @@ public void MockFileInfo_GetDirectory_ShouldReturnDirectoryInfoWithCorrectPath()
             Assert.That(result.FullName, Is.EqualTo(XFS.Path(@"c:\temp\level1\level2")));
         }
 
-        [Test]
-        public void MockFileInfo_GetFileVersionInfo_ShouldReturnTheFileVersionInfoOfTheMockFileData()
-        {
-            // Arrange
-            var fileSystem = new MockFileSystem();
-
-            var fileVersionInfo = new MockFileVersionInfo();
-            var mockFileData = new MockFileData(string.Empty)
-            {
-                FileVersionInfo = fileVersionInfo
-            };
-
-            fileSystem.AddFile(XFS.Path(@"c:\temp\file.txt"), mockFileData);
-
-            var fileInfo = fileSystem.FileInfo.New(XFS.Path(@"c:\temp\file.txt"));
-
-            // Act
-            var result = fileInfo.FileVersionInfo;
-
-            // Assert
-            Assert.That(result, Is.EqualTo(fileVersionInfo));
-        }
-
         [Test]
         public void MockFileInfo_OpenRead_ShouldReturnByteContentOfFile()
         {
diff --git a/tests/TestableIO.System.IO.Abstractions.TestingHelpers.Tests/MockFileVersionInfoFactoryTests.cs b/tests/TestableIO.System.IO.Abstractions.TestingHelpers.Tests/MockFileVersionInfoFactoryTests.cs
@@ -0,0 +1,49 @@
+﻿using NUnit.Framework;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace System.IO.Abstractions.TestingHelpers.Tests
+{
+    [TestFixture]
+    public class MockFileVersionInfoFactoryTests
+    {
+        [Test]
+        public void MockFileVersionInfoFactory_GetVersionInfo_ShouldReturnTheFileVersionInfoOfTheMockFileData()
+        {
+            // Arrange
+            var fileVersionInfo = new MockFileVersionInfo();
+            var fileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
+            {
+                { @"c:\a.txt", new MockFileData("Demo text content") { FileVersionInfo = fileVersionInfo } }
+            });
+            _ = new MockFileVersionInfoFactory(fileSystem); // file system injection
+
+            // Act
+            var result = MockFileVersionInfoFactory.GetVersionInfo(@"c:\a.txt");
+
+            // Assert
+            Assert.That(result, Is.EqualTo(fileVersionInfo));
+        }
+
+        [Test]
+        public void MockFileVersionInfoFactory_GetVersionInfo_ShouldThrowFileNotFoundExceptionIfFileDoesNotExist()
+        {
+            // Arrange
+            var fileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
+            {
+                { @"c:\a.txt", new MockFileData("Demo text content") },
+                { @"c:\a\b\c.txt", new MockFileData("Demo text content") },
+            });
+            _ = new MockFileVersionInfoFactory(fileSystem); // file system injection
+
+            // Act
+            TestDelegate code = () => MockFileVersionInfoFactory.GetVersionInfo(@"c:\foo.txt");
+            
+            // Assert
+            Assert.Throws<FileNotFoundException>(code);
+        }
+    }
+}
diff --git a/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/ApiParityTests.cs b/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/ApiParityTests.cs
@@ -24,6 +24,13 @@ public void FileInfo() =>
                 typeof(System.IO.Abstractions.FileInfoBase)
             );
 
+        [Test]
+        public void FileVersionInfo() =>
+            AssertParity(
+                typeof(System.Diagnostics.FileVersionInfo),
+                typeof(System.IO.Abstractions.FileVersionInfoBase)
+            );
+
         [Test]
         public void Directory() =>
             AssertParity(
@@ -72,13 +79,12 @@ static IEnumerable<string> GetMembers(Type type) => type
                 .Select(x => x.Replace("System.IO.FileInfo", "System.IO.Abstractions.IFileInfo"))
                 .Select(x => x.Replace("System.IO.DirectoryInfo", "System.IO.Abstractions.IDirectoryInfo"))
                 .Select(x => x.Replace("System.IO.DriveInfo", "System.IO.Abstractions.IDriveInfo"))
-                .Select(x => x.Replace("System.IO.WaitForChangedResult", "System.IO.Abstractions.IWaitForChangedResult"));
+                .Select(x => x.Replace("System.IO.WaitForChangedResult", "System.IO.Abstractions.IWaitForChangedResult"))
+                .Where(x => x != "System.Diagnostics.FileVersionInfo GetVersionInfo(System.String)");
             var abstractionMembers = GetMembers(abstractionType)
                 .Where(x => !x.Contains("op_Implicit"))
                 .Where(x => x != "System.IO.Abstractions.IFileSystem get_FileSystem()")
-                .Where(x => x != "System.IO.Abstractions.IFileSystem FileSystem")
-                .Where(x => x != "System.IO.Abstractions.IFileVersionInfo get_FileVersionInfo()")
-                .Where(x => x != "System.IO.Abstractions.IFileVersionInfo FileVersionInfo");
+                .Where(x => x != "System.IO.Abstractions.IFileSystem FileSystem");
             var diff = new ApiDiff(
                 extraMembers: abstractionMembers.Except(referenceMembers),
                 missingMembers: referenceMembers.Except(abstractionMembers)
diff --git a/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/__snapshots__/ApiParityTests.FileVersionInfo_.NET 6.0.snap b/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/__snapshots__/ApiParityTests.FileVersionInfo_.NET 6.0.snap
@@ -0,0 +1,4 @@
+﻿{
+  "ExtraMembers": [],
+  "MissingMembers": []
+}
diff --git a/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/__snapshots__/ApiParityTests.FileVersionInfo_.NET 7.0.snap b/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/__snapshots__/ApiParityTests.FileVersionInfo_.NET 7.0.snap
@@ -0,0 +1,4 @@
+﻿{
+  "ExtraMembers": [],
+  "MissingMembers": []
+}
diff --git a/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/__snapshots__/ApiParityTests.FileVersionInfo_.NET 8.0.snap b/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/__snapshots__/ApiParityTests.FileVersionInfo_.NET 8.0.snap
@@ -0,0 +1,4 @@
+﻿{
+  "ExtraMembers": [],
+  "MissingMembers": []
+}
diff --git a/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/__snapshots__/ApiParityTests.FileVersionInfo_.NET Framework 4.6.2.snap b/tests/TestableIO.System.IO.Abstractions.Wrappers.Tests/__snapshots__/ApiParityTests.FileVersionInfo_.NET Framework 4.6.2.snap
@@ -0,0 +1,4 @@
+﻿{
+  "ExtraMembers": [],
+  "MissingMembers": []
+}

Original file line number	Diff line number	Diff line change
`@@ -333,15 +333,6 @@ public override IDirectoryInfo Directory`
`333`	`333`	`}`
`334`	`334`	`}`
`335`	`335`
`336`		`- /// <inheritdoc />`
`337`		`- public override IFileVersionInfo FileVersionInfo`
`338`		`- {`
`339`		`- get`
`340`		`- {`
`341`		`- return mockFileSystem.GetFile(path).FileVersionInfo;`
`342`		`- }`
`343`		`- }`
`344`		`-`
`345`	`336`	`/// <inheritdoc />`
`346`	`337`	`public override string DirectoryName`
`347`	`338`	`{`
Original file line number	Diff line number	Diff line change
`@@ -247,12 +247,6 @@ public override IDirectoryInfo Directory`
`247`	`247`	`get { return new DirectoryInfoWrapper(FileSystem, instance.Directory); }`
`248`	`248`	`}`
`249`	`249`
`250`		`- /// <inheritdoc />`
`251`		`- public override IFileVersionInfo FileVersionInfo`
`252`		`- {`
`253`		`- get { return new FileVersionInfoWrapper(Diagnostics.FileVersionInfo.GetVersionInfo(FullName)); }`
`254`		`- }`
`255`		`-`
`256`	`250`	`/// <inheritdoc />`
`257`	`251`	`public override string DirectoryName`
`258`	`252`	`{`