feat: Add GetFileSystemEntries with SearchOption (#878)

rkm · fgreinacher · web-flow · commit de4facf329c9 · 2022-09-10T13:48:31.000Z
* Add GetFileSystemEntries with SearchOption

* Bump version

* Add test for GetFileSystemEntries with SearchOption

* call GetFileSystemEntries from EnumerateFileSystemEntries to reduce duplication

Co-authored-by: Florian Greinacher &lt;florian@greinacher.de&gt;
diff --git a/src/System.IO.Abstractions.TestingHelpers/MockDirectory.cs b/src/System.IO.Abstractions.TestingHelpers/MockDirectory.cs
@@ -380,6 +380,15 @@ public override string[] GetFileSystemEntries(string path, string searchPattern)
             return dirs.Union(files).ToArray();
         }
 
+        /// <inheritdoc />
+        public override string[] GetFileSystemEntries(string path, string searchPattern, SearchOption searchOption)
+        {
+            var dirs = GetDirectories(path, searchPattern, searchOption);
+            var files = GetFiles(path, searchPattern, searchOption);
+
+            return dirs.Union(files).ToArray();
+        }
+
         /// <inheritdoc />
         public override DateTime GetLastAccessTime(string path)
         {
@@ -644,25 +653,19 @@ public override IEnumerable<string> EnumerateFiles(string path, string searchPat
         /// <inheritdoc />
         public override IEnumerable<string> EnumerateFileSystemEntries(string path)
         {
-            var fileSystemEntries = new List<string>(GetFiles(path));
-            fileSystemEntries.AddRange(GetDirectories(path));
-            return fileSystemEntries;
+            return GetFileSystemEntries(path);
         }
 
         /// <inheritdoc />
         public override IEnumerable<string> EnumerateFileSystemEntries(string path, string searchPattern)
         {
-            var fileSystemEntries = new List<string>(GetFiles(path, searchPattern));
-            fileSystemEntries.AddRange(GetDirectories(path, searchPattern));
-            return fileSystemEntries;
+            return GetFileSystemEntries(path, searchPattern);
         }
 
         /// <inheritdoc />
         public override IEnumerable<string> EnumerateFileSystemEntries(string path, string searchPattern, SearchOption searchOption)
         {
-            var fileSystemEntries = new List<string>(GetFiles(path, searchPattern, searchOption));
-            fileSystemEntries.AddRange(GetDirectories(path, searchPattern, searchOption));
-            return fileSystemEntries;
+            return GetFileSystemEntries(path, searchPattern, searchOption);
         }
 
 #if FEATURE_ENUMERATION_OPTIONS
diff --git a/src/System.IO.Abstractions/DirectoryBase.cs b/src/System.IO.Abstractions/DirectoryBase.cs
@@ -95,6 +95,9 @@ internal DirectoryBase() { }
         /// <inheritdoc cref="IDirectory.GetFileSystemEntries(string,string)"/>
         public abstract string[] GetFileSystemEntries(string path, string searchPattern);
 
+        /// <inheritdoc cref="IDirectory.GetFileSystemEntries(string,string,SearchOption)"/>
+        public abstract string[] GetFileSystemEntries(string path, string searchPattern, SearchOption searchOption);
+
         /// <inheritdoc cref="IDirectory.GetLastAccessTime"/>
         public abstract DateTime GetLastAccessTime(string path);
 
diff --git a/src/System.IO.Abstractions/DirectoryWrapper.cs b/src/System.IO.Abstractions/DirectoryWrapper.cs
@@ -156,6 +156,12 @@ public override string[] GetFileSystemEntries(string path, string searchPattern)
             return Directory.GetFileSystemEntries(path, searchPattern);
         }
 
+        /// <inheritdoc />
+        public override string[] GetFileSystemEntries(string path, string searchPattern, SearchOption searchOption)
+        {
+            return Directory.GetFileSystemEntries(path, searchPattern, searchOption);
+        }
+
         /// <inheritdoc />
         public override DateTime GetLastAccessTime(string path)
         {
diff --git a/src/System.IO.Abstractions/IDirectory.cs b/src/System.IO.Abstractions/IDirectory.cs
@@ -77,6 +77,8 @@ public interface IDirectory
         string[] GetFileSystemEntries(string path);
         /// <inheritdoc cref="Directory.GetFileSystemEntries(string,string)"/>
         string[] GetFileSystemEntries(string path, string searchPattern);
+        /// <inheritdoc cref="Directory.GetFileSystemEntries(string,string,SearchOption)"/>
+        string[] GetFileSystemEntries(string path, string searchPattern, SearchOption searchOption);
         /// <inheritdoc cref="Directory.GetLastAccessTime"/>
         DateTime GetLastAccessTime(string path);
         /// <inheritdoc cref="Directory.GetLastAccessTimeUtc"/>
diff --git a/tests/System.IO.Abstractions.TestingHelpers.Tests/MockDirectoryTests.cs b/tests/System.IO.Abstractions.TestingHelpers.Tests/MockDirectoryTests.cs
@@ -1,4 +1,4 @@
-﻿using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using System.Runtime.Versioning;
 using System.Security.AccessControl;
@@ -956,6 +956,24 @@ public void MockDirectory_GetFileSystemEntries_Returns_Files_And_Directories()
             Assert.AreEqual(testPath, entries.Last());
         }
 
+        [Test]
+        public void MockDirectory_GetFileSystemEntries_ShouldNotReturnSubDirectory_WithSearchOption()
+        {
+            string testPath = XFS.Path(@"c:\foo\bar.txt");
+            string testDir = XFS.Path(@"c:\foo\bar");
+            string testSubDir = XFS.Path(@"c:\foo\bar\baz");
+            var fileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
+            {
+                { testPath, new MockFileData("Demo text content") },
+                { testSubDir,  new MockDirectoryData() },
+            });
+
+            var entries = fileSystem.Directory.GetFileSystemEntries(XFS.Path(@"c:\foo"), "*", SearchOption.TopDirectoryOnly).OrderBy(k => k);
+            Assert.AreEqual(2, entries.Count());
+            Assert.AreEqual(testDir, entries.First());
+            Assert.AreEqual(testPath, entries.Last());
+        }
+
         [Test]
         public void MockDirectory_GetFiles_ShouldThrowArgumentNullException_IfPathParamIsNull()
         {
diff --git a/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET 5.0.snap b/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET 5.0.snap
@@ -6,7 +6,6 @@
     "Void SetAccessControl(System.String, System.Security.AccessControl.DirectorySecurity)"
   ],
   "MissingMembers": [
-    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)",
-    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)"
+    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)"
   ]
 }
diff --git a/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET 6.0.snap b/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET 6.0.snap
@@ -7,7 +7,6 @@
   ],
   "MissingMembers": [
     "System.IO.Abstractions.IFileSystemInfo ResolveLinkTarget(System.String, Boolean)",
-    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)",
-    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)"
+    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)"
   ]
 }
diff --git a/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET Core 2.1.snap b/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET Core 2.1.snap
@@ -11,7 +11,6 @@
     "System.Collections.Generic.IEnumerable`1[System.String] EnumerateFiles(System.String, System.String, System.IO.EnumerationOptions)",
     "System.String[] GetDirectories(System.String, System.String, System.IO.EnumerationOptions)",
     "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)",
-    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)",
     "System.String[] GetFiles(System.String, System.String, System.IO.EnumerationOptions)"
   ]
 }
diff --git a/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET Core 3.1.snap b/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET Core 3.1.snap
@@ -6,7 +6,6 @@
     "Void SetAccessControl(System.String, System.Security.AccessControl.DirectorySecurity)"
   ],
   "MissingMembers": [
-    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)",
-    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)"
+    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)"
   ]
 }
diff --git a/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET Framework 4.6.1.snap b/tests/System.IO.Abstractions.Tests/__snapshots__/ApiParityTests.Directory_.NET Framework 4.6.1.snap
@@ -1,6 +1,4 @@
 ﻿{
   "ExtraMembers": [],
-  "MissingMembers": [
-    "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)"
-  ]
+  "MissingMembers": []
 }
diff --git a/version.json b/version.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "17.1",
+  "version": "17.2",
   "assemblyVersion": {
     "precision": "major"
   },

Original file line number	Diff line number	Diff line change
`@@ -380,6 +380,15 @@ public override string[] GetFileSystemEntries(string path, string searchPattern)`
`380`	`380`	`return dirs.Union(files).ToArray();`
`381`	`381`	`}`
`382`	`382`
	`383`	`+ /// <inheritdoc />`
	`384`	`+ public override string[] GetFileSystemEntries(string path, string searchPattern, SearchOption searchOption)`
	`385`	`+ {`
	`386`	`+ var dirs = GetDirectories(path, searchPattern, searchOption);`
	`387`	`+ var files = GetFiles(path, searchPattern, searchOption);`
	`388`	`+`
	`389`	`+ return dirs.Union(files).ToArray();`
	`390`	`+ }`
	`391`	`+`
`383`	`392`	`/// <inheritdoc />`
`384`	`393`	`public override DateTime GetLastAccessTime(string path)`
`385`	`394`	`{`
`@@ -644,25 +653,19 @@ public override IEnumerable<string> EnumerateFiles(string path, string searchPat`
`644`	`653`	`/// <inheritdoc />`
`645`	`654`	`public override IEnumerable<string> EnumerateFileSystemEntries(string path)`
`646`	`655`	`{`
`647`		`- var fileSystemEntries = new List<string>(GetFiles(path));`
`648`		`- fileSystemEntries.AddRange(GetDirectories(path));`
`649`		`- return fileSystemEntries;`
	`656`	`+ return GetFileSystemEntries(path);`
`650`	`657`	`}`
`651`	`658`
`652`	`659`	`/// <inheritdoc />`
`653`	`660`	`public override IEnumerable<string> EnumerateFileSystemEntries(string path, string searchPattern)`
`654`	`661`	`{`
`655`		`- var fileSystemEntries = new List<string>(GetFiles(path, searchPattern));`
`656`		`- fileSystemEntries.AddRange(GetDirectories(path, searchPattern));`
`657`		`- return fileSystemEntries;`
	`662`	`+ return GetFileSystemEntries(path, searchPattern);`
`658`	`663`	`}`
`659`	`664`
`660`	`665`	`/// <inheritdoc />`
`661`	`666`	`public override IEnumerable<string> EnumerateFileSystemEntries(string path, string searchPattern, SearchOption searchOption)`
`662`	`667`	`{`
`663`		`- var fileSystemEntries = new List<string>(GetFiles(path, searchPattern, searchOption));`
`664`		`- fileSystemEntries.AddRange(GetDirectories(path, searchPattern, searchOption));`
`665`		`- return fileSystemEntries;`
	`668`	`+ return GetFileSystemEntries(path, searchPattern, searchOption);`
`666`	`669`	`}`
`667`	`670`
`668`	`671`	`#if FEATURE_ENUMERATION_OPTIONS`
Original file line number	Diff line number	Diff line change
`@@ -156,6 +156,12 @@ public override string[] GetFileSystemEntries(string path, string searchPattern)`
`156`	`156`	`return Directory.GetFileSystemEntries(path, searchPattern);`
`157`	`157`	`}`
`158`	`158`
	`159`	`+ /// <inheritdoc />`
	`160`	`+ public override string[] GetFileSystemEntries(string path, string searchPattern, SearchOption searchOption)`
	`161`	`+ {`
	`162`	`+ return Directory.GetFileSystemEntries(path, searchPattern, searchOption);`
	`163`	`+ }`
	`164`	`+`
`159`	`165`	`/// <inheritdoc />`
`160`	`166`	`public override DateTime GetLastAccessTime(string path)`
`161`	`167`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@`
`6`	`6`	`"Void SetAccessControl(System.String, System.Security.AccessControl.DirectorySecurity)"`
`7`	`7`	`],`
`8`	`8`	`"MissingMembers": [`
`9`		`- "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)",`
`10`		`- "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)"`
	`9`	`+ "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)"`
`11`	`10`	`]`
`12`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`],`
`8`	`8`	`"MissingMembers": [`
`9`	`9`	`"System.IO.Abstractions.IFileSystemInfo ResolveLinkTarget(System.String, Boolean)",`
`10`		`- "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)",`
`11`		`- "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)"`
	`10`	`+ "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)"`
`12`	`11`	`]`
`13`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@`
`11`	`11`	"System.Collections.Generic.IEnumerable`1[System.String] EnumerateFiles(System.String, System.String, System.IO.EnumerationOptions)",
`12`	`12`	`"System.String[] GetDirectories(System.String, System.String, System.IO.EnumerationOptions)",`
`13`	`13`	`"System.String[] GetFileSystemEntries(System.String, System.String, System.IO.EnumerationOptions)",`
`14`		`- "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)",`
`15`	`14`	`"System.String[] GetFiles(System.String, System.String, System.IO.EnumerationOptions)"`
`16`	`15`	`]`
`17`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"ExtraMembers": [],`
`3`		`- "MissingMembers": [`
`4`		`- "System.String[] GetFileSystemEntries(System.String, System.String, System.IO.SearchOption)"`
`5`		`- ]`
	`3`	`+ "MissingMembers": []`
`6`	`4`	`}`