feat: Improve CopyTo directory extension to allow overwrites (#58)

* Basic implementation of overwrite within a directory copy to method

* check when not overwriting to enure that partial overwrite doesn't happen

* Move new argument to end of function

* remove overwrite checks

Author: alwaysbusy

src/System.IO.Abstractions.Extensions/IDirectoryInfoExtensions.cs

@@ -199,18 +199,20 @@ public static void ForEachFile(
         /// </summary>
         /// <param name="source">Source directory</param>
         /// <param name="destination">Destination directory</param>
-        /// <param name="recursive">If true the copy will be recursive and will include subfolders of <paramref name="info"/>. Defaults to false</param>
+        /// <param name="recursive">If true the copy will be recursive and will include subfolders of <paramref name="source"/>. Defaults to false</param>
+        /// <param name="overwrite">If true the copy will overwrite any existing files in <paramref name="destination"/>. Defaults to false</param>
         /// <param name="filesSearchPattern">Search pattern to apply when searching files, defaults to '*'</param>
         /// <param name="directoriesSearchPattern">Search pattern to apply when searching directories, defaults to '*'</param>
         public static void CopyTo(
             this IDirectoryInfo source,
             IDirectoryInfo destination,
             bool recursive = false,
             string filesSearchPattern = "*",
-            string directoriesSearchPattern = "*")
+            string directoriesSearchPattern = "*",
+            bool overwrite = false)
         {
             source.ForEachFile(
-                (file, destDir) => file.CopyTo(destDir.GetFilePath(file.Name)),
+                (file, destDir) => file.CopyTo(destDir.GetFilePath(file.Name), overwrite),
                 subDirectory => source.TranslatePaths(subDirectory, destination, true),
                 recursive,
                 filesSearchPattern,

tests/System.IO.Abstractions.Extensions.Tests/DirectoryInfoExtensionsTests.cs

@@ -388,5 +388,91 @@ public void CopyTo_TargetDirAndParentDoesNotExist_CreatesTargetDirectoryHierarch
 
             Assert.IsFalse(fs.File.Exists(workingDir.FullName));
         }
+
+        [Test]
+        public void CopyTo_Overwrite_OverwritesWhenSet()
+        {
+            //arrange
+            var fs = new FileSystem();
+            var workingDir = fs.DirectoryInfo.New(fs.Directory.GetCurrentDirectory()).CreateSubdirectory(Guid.NewGuid().ToString());
+
+            //create directories
+            var source = fs.DirectoryInfo.New(fs.Path.Combine(workingDir.FullName, "SourceDir"));
+            var dest = fs.DirectoryInfo.New(fs.Path.Combine(workingDir.FullName, "DestDir"));
+
+            source.Create();
+            dest.Create();
+
+            //create files
+            var sourceFile = fs.FileInfo.New(fs.Path.Combine(source.FullName, "file.txt"));
+            var destFile = fs.FileInfo.New(fs.Path.Combine(dest.FullName, "file.txt"));
+
+            var sourceFileContent = new[] { nameof(sourceFile) };
+            sourceFile.WriteLines(sourceFileContent);
+            var destFileContent = new[] { nameof(destFile) };
+            destFile.WriteLines(destFileContent);
+
+            //make sure everything is set up as expected
+            Assert.IsTrue(fs.Directory.Exists(source.FullName));
+            Assert.IsTrue(fs.File.Exists(sourceFile.FullName));
+            Assert.AreEqual(fs.File.ReadAllLines(sourceFile.FullName), sourceFileContent);
+            Assert.IsTrue(fs.Directory.Exists(dest.FullName));
+            Assert.IsTrue(fs.File.Exists(destFile.FullName));
+            Assert.AreEqual(fs.File.ReadAllLines(destFile.FullName), destFileContent);
+
+            //act
+            source.CopyTo(dest, overwrite: true);
+
+            //assert
+            Assert.AreEqual(fs.File.ReadAllLines(destFile.FullName), sourceFileContent);
+
+            //cleanup
+            workingDir.Delete(recursive: true);
+
+            Assert.IsFalse(fs.File.Exists(workingDir.FullName));
+        }
+
+        [Test]
+        public void CopyTo_Overwrite_DoesNotOverwritesWhenNotSet()
+        {
+            //arrange
+            var fs = new FileSystem();
+            var workingDir = fs.DirectoryInfo.New(fs.Directory.GetCurrentDirectory()).CreateSubdirectory(Guid.NewGuid().ToString());
+
+            //create directories
+            var source = fs.DirectoryInfo.New(fs.Path.Combine(workingDir.FullName, "SourceDir"));
+            var dest = fs.DirectoryInfo.New(fs.Path.Combine(workingDir.FullName, "DestDir"));
+
+            source.Create();
+            dest.Create();
+
+            //create files
+            var sourceFile = fs.FileInfo.New(fs.Path.Combine(source.FullName, "file.txt"));
+            var destFile = fs.FileInfo.New(fs.Path.Combine(dest.FullName, "file.txt"));
+
+            var sourceFileContent = new[] { nameof(sourceFile) };
+            sourceFile.WriteLines(sourceFileContent);
+            var destFileContent = new[] { nameof(destFile) };
+            destFile.WriteLines(destFileContent);
+
+            //make sure everything is set up as expected
+            Assert.IsTrue(fs.Directory.Exists(source.FullName));
+            Assert.IsTrue(fs.File.Exists(sourceFile.FullName));
+            Assert.AreEqual(fs.File.ReadAllLines(sourceFile.FullName), sourceFileContent);
+            Assert.IsTrue(fs.Directory.Exists(dest.FullName));
+            Assert.IsTrue(fs.File.Exists(destFile.FullName));
+            Assert.AreEqual(fs.File.ReadAllLines(destFile.FullName), destFileContent);
+
+            //act
+            Assert.That(() => source.CopyTo(dest, overwrite: false), Throws.Exception.TypeOf<IOException>().And.Message.Contains(destFile.FullName));
+
+            //assert
+            Assert.AreEqual(fs.File.ReadAllLines(destFile.FullName), destFileContent);
+
+            //cleanup
+            workingDir.Delete(recursive: true);
+
+            Assert.IsFalse(fs.File.Exists(workingDir.FullName));
+        }
     }
 }

version.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "2.1",
+  "version": "2.2",
   "assemblyVersion": {
     "precision": "major"
   },