Use withTestScratchDir instead of withTemporaryDirectory

`withTestScratchDir` respects the SourceKit-LSP test environment variable to keep temporary files.

Author: ahoppen

Sources/SKTestSupport/Utils.swift

@@ -13,6 +13,7 @@
 import Foundation
 import LanguageServerProtocol
 import SKCore
+import TSCBasic
 
 extension Language {
   var fileExtension: String {
@@ -63,6 +64,25 @@ public func testScratchDir(testName: String = #function) throws -> URL {
   return url
 }
 
+/// Execute `body` with a path to a temporary scratch directory for the given
+/// test name.
+///
+/// The temporary directory will be deleted at the end of `directory` unless the
+/// `SOURCEKITLSP_KEEP_TEST_SCRATCH_DIR` environment variable is set.
+public func withTestScratchDir<T>(
+  _ body: (AbsolutePath) async throws -> T,
+  testName: String = #function
+) async throws -> T {
+  let scratchDirectory = try testScratchDir(testName: testName)
+  try FileManager.default.createDirectory(at: scratchDirectory, withIntermediateDirectories: true)
+  defer {
+    if cleanScratchDirectories {
+      try? FileManager.default.removeItem(at: scratchDirectory)
+    }
+  }
+  return try await body(try AbsolutePath(validating: scratchDirectory.path))
+}
+
 fileprivate extension URL {
   /// Assuming this is a file URL, resolves all symlinks in the path.
   ///

Tests/SKCoreTests/ToolchainRegistryTests.swift

@@ -13,6 +13,7 @@
 import LSPTestSupport
 @_spi(Testing) import SKCore
 import SKSupport
+import SKTestSupport
 import TSCBasic
 import XCTest
 
@@ -341,7 +342,7 @@ final class ToolchainRegistryTests: XCTestCase {
   func testFromDirectory() async throws {
     // This test uses the real file system because the in-memory system doesn't support marking files executable.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       let path = tempDir.appending(components: "A.xctoolchain", "usr")
       try makeToolchain(
         binPath: path.appending(component: "bin"),

Tests/SKSwiftPMWorkspaceTests/SwiftPMWorkspaceTests.swift

@@ -31,7 +31,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
 
   func testNoPackage() async throws {
     let fs = InMemoryFileSystem()
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -53,7 +53,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
 
   func testUnparsablePackage() async throws {
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -80,7 +80,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
 
   func testNoToolchain() async throws {
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -108,7 +108,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testBasicSwiftArgs() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -168,7 +168,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testBuildSetup() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -214,7 +214,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testManifestArgs() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -247,7 +247,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testMultiFileSwift() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -285,7 +285,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testMultiTargetSwift() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -351,7 +351,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testUnknownFile() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -387,7 +387,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testBasicCXXArgs() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -481,7 +481,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testDeploymentTargetSwift() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -524,7 +524,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testSymlinkInWorkspaceSwift() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -579,7 +579,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testSymlinkInWorkspaceCXX() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -629,7 +629,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
   func testSwiftDerivedSources() async throws {
     // FIXME: should be possible to use InMemoryFileSystem.
     let fs = localFileSystem
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [
@@ -670,7 +670,7 @@ final class SwiftPMWorkspaceTests: XCTestCase {
 
   func testNestedInvalidPackageSwift() async throws {
     let fs = InMemoryFileSystem()
-    try await withTemporaryDirectory(removeTreeOnDeinit: true) { tempDir in
+    try await withTestScratchDir { tempDir in
       try fs.createFiles(
         root: tempDir,
         files: [