Merge pull request #506 from abertelrud/move-rmfiletree-to-basic

Move `removeFileTree()` down from Utility to Basics

Author: abertelrud

Sources/Basic/PathShims.swift

@@ -71,6 +71,15 @@ public func makeDirectories(_ path: AbsolutePath) throws {
   #endif
 }
 
+/// Recursively deletes the file system entity at `path`.  If there is no file system entity at `path`, this function does nothing (in particular, this is not considered to be an error).
+public func removeFileTree(_ path: AbsolutePath) throws {
+  #if os(Linux)
+    try FileManager.default().removeItem(atPath: path.asString)
+  #else
+    try FileManager.default.removeItem(atPath: path.asString)
+  #endif
+}
+
 /// Creates a symbolic link at `path` whose content points to `dest`.  If `relative` is true, the symlink contents will be a relative path, otherwise it will be absolute.
 public func symlink(_ path: AbsolutePath, pointingAt dest: AbsolutePath, relative: Bool = true) throws {
     let destString = relative ? dest.relative(to: path.parentDirectory).asString : dest.asString

Sources/Commands/SwiftBuildTool.swift

@@ -150,14 +150,14 @@ public struct SwiftBuildTool: SwiftTool {
 
             case .clean(.dist):
                 if opts.path.packages.asString.exists {
-                    try Utility.removeFileTree(opts.path.packages.asString)
+                    try removeFileTree(opts.path.packages)
                 }
                 fallthrough
 
             case .clean(.build):
                 // FIXME: This test is lame, `removeFileTree` shouldn't error on this.
                 if opts.path.build.asString.exists {
-                    try Utility.removeFileTree(opts.path.build.asString)
+                    try removeFileTree(opts.path.build)
                 }
             }
 

Sources/Commands/SwiftPackageTool.swift

@@ -195,7 +195,7 @@ public struct SwiftPackageTool: SwiftTool {
                             throw Error.repositoryHasChanges(item.asString)
                         }
                     }
-                    try Utility.removeFileTree(opts.path.packages.asString)
+                    try removeFileTree(opts.path.packages)
                 }
                 fallthrough
 

Sources/PackageLoading/ManifestLoader.swift

@@ -126,7 +126,7 @@ public final class ManifestLoader {
         guard let toml = try localFileSystem.readFileContents(filePath).asString else {
             throw ManifestParseError.invalidEncoding
         }
-        try Utility.removeFileTree(filePath.asString) // Delete the temp file after reading it
+        try removeFileTree(filePath)  // Delete the temp file after reading it
 
         return toml != "" ? toml : nil
     }

Sources/Utility/removeFileTree.swift

@@ -58,8 +58,38 @@ class PathShimTests : XCTestCase {
         try! makeDirectories(dirPath)
     }
 
+    func testRecursiveDirectoryRemoval() {
+        // For the tests we'll need a temporary directory.
+        let tmpDir = try! TemporaryDirectory(removeTreeOnDeinit: true)
+        
+        // Create a couple of directories.  The first one shouldn't end up getting removed, the second one will.
+        let keepDirPath = tmpDir.path.appending(components: "abc1")
+        try! makeDirectories(keepDirPath)
+        let tossDirPath = tmpDir.path.appending(components: "abc2", "def", "ghi", "mno", "pqr")
+        try! makeDirectories(tossDirPath)
+        
+        // Create a symbolic link in a directory to be removed; it points to a directory to not remove.
+        let slnkPath = tossDirPath.appending(components: "slnk")
+        try! symlink(create: slnkPath.asString, pointingAt: keepDirPath.asString, relativeTo: tossDirPath.asString)
+        
+        // Make sure the symbolic link got set up correctly.
+        XCTAssertTrue(slnkPath.asString.isSymlink)
+        XCTAssertEqual(resolveSymlinks(slnkPath), keepDirPath)
+        XCTAssertTrue(resolveSymlinks(slnkPath).asString.isDirectory)
+        
+        // Now remove the directory hierarchy that contains the symlink.
+        try! removeFileTree(tossDirPath)
+        
+        // Make sure it got removed, along with the symlink, but that the target of the symlink remains.
+        XCTAssertFalse(tossDirPath.asString.exists)
+        XCTAssertFalse(tossDirPath.asString.isDirectory)
+        XCTAssertTrue(keepDirPath.asString.exists)
+        XCTAssertTrue(keepDirPath.asString.isDirectory)
+    }
+    
     static var allTests = [
-        ("testResolvingSymlinks",  testResolvingSymlinks),
-        ("testRescursiveDirectoryCreation",  testRescursiveDirectoryCreation)
+        ("testResolvingSymlinks",            testResolvingSymlinks),
+        ("testRescursiveDirectoryCreation",  testRescursiveDirectoryCreation),
+        ("testRecursiveDirectoryRemoval",    testRecursiveDirectoryRemoval)
     ]
 }

Tests/Basic/PathShimTests.swift

@@ -33,7 +33,7 @@ class InvalidLayoutsTestCase: XCTestCase {
         */
         fixture(name: "InvalidLayouts/Generic1") { prefix in
             XCTAssertBuildFails(prefix)
-            try Utility.removeFileTree(prefix.appending("main.swift").asString)
+            try removeFileTree(prefix.appending("main.swift"))
             XCTAssertBuilds(prefix)
         }
     }
@@ -48,7 +48,7 @@ class InvalidLayoutsTestCase: XCTestCase {
         */
         fixture(name: "InvalidLayouts/Generic2") { prefix in
             XCTAssertBuildFails(prefix)
-            try Utility.removeFileTree(prefix.appending("main.swift").asString)
+            try removeFileTree(prefix.appending("main.swift"))
             XCTAssertBuilds(prefix)
         }
     }
@@ -63,7 +63,7 @@ class InvalidLayoutsTestCase: XCTestCase {
         */
         fixture(name: "InvalidLayouts/Generic3") { prefix in
             XCTAssertBuildFails(prefix)
-            try Utility.removeFileTree(prefix.appending("Sources").appending("main.swift").asString)
+            try removeFileTree(prefix.appending("Sources").appending("main.swift"))
             XCTAssertBuilds(prefix)
         }
     }
@@ -78,7 +78,7 @@ class InvalidLayoutsTestCase: XCTestCase {
         */
         fixture(name: "InvalidLayouts/Generic4") { prefix in
             XCTAssertBuildFails(prefix)
-            try Utility.removeFileTree(prefix.appending("main.swift").asString)
+            try removeFileTree(prefix.appending("main.swift"))
             XCTAssertBuilds(prefix)
         }
     }
@@ -100,8 +100,8 @@ class InvalidLayoutsTestCase: XCTestCase {
             // determineTargets() but also we are saying: this
             // layout is only for *very* simple projects.
 
-            try Utility.removeFileTree(prefix.appending("Foo").appending("Foo.swift").asString)
-            try Utility.removeFileTree(prefix.appending("Foo").asString)
+            try removeFileTree(prefix.appending("Foo").appending("Foo.swift"))
+            try removeFileTree(prefix.appending("Foo"))
             XCTAssertBuilds(prefix)
         }
     }

Tests/Functional/InvalidLayoutTests.swift

@@ -181,8 +181,8 @@ class StatTests: XCTestCase {
             XCTAssertTrue(root.appending("symlink").asString.isDirectory)
             XCTAssertTrue(root.appending("symlink").asString.isSymlink)
 
-            try removeFileTree(root.appending("foo/bar").asString)
-            try removeFileTree(root.appending("foo").asString)
+            try removeFileTree(root.appending("foo/bar"))
+            try removeFileTree(root.appending("foo"))
 
             XCTAssertTrue(root.appending("symlink").asString.isSymlink)
             XCTAssertFalse(root.appending("symlink").asString.isDirectory)

Tests/Utility/PathTests.swift

@@ -19,7 +19,6 @@ public func allTests() -> [XCTestCaseEntry] {
         testCase(PathTests.allTests),
         testCase(PkgConfigParserTests.allTests),
         testCase(RelativePathTests.allTests),
-        testCase(RmtreeTests.allTests),
         testCase(ShellTests.allTests),
         testCase(StatTests.allTests),
         testCase(StringTests.allTests),