1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Foundation
import LanguageServerProtocol
import SKCore
import TSCBasic
extension Language {
var fileExtension: String {
switch self {
case .objective_c: return "m"
default: return self.rawValue
}
}
init?(fileExtension: String) {
switch fileExtension {
case "c": self = .c
case "cpp": self = .cpp
case "m": self = .objective_c
case "mm": self = .objective_cpp
case "swift": self = .swift
default: return nil
}
}
}
extension DocumentURI {
/// Construct a `DocumentURI` by creating a unique URI for a document of the given language.
public init(for language: Language, testName: String = #function) {
let testBaseName = testName.prefix(while: \.isLetter)
#if os(Windows)
let url = URL(fileURLWithPath: "C:/\(testBaseName)/\(UUID())/test.\(language.fileExtension)")
#else
let url = URL(fileURLWithPath: "/\(testBaseName)/\(UUID())/test.\(language.fileExtension)")
#endif
self.init(url)
}
}
public let cleanScratchDirectories = (ProcessInfo.processInfo.environment["SOURCEKITLSP_KEEP_TEST_SCRATCH_DIR"] == nil)
/// An empty directory in which a test with `#function` name `testName` can store temporary data.
public func testScratchDir(testName: String = #function) throws -> URL {
let testBaseName = testName.prefix(while: \.isLetter)
var uuid = UUID().uuidString[...]
if let firstDash = uuid.firstIndex(of: "-") {
uuid = uuid[..<firstDash]
}
let url = FileManager.default.temporaryDirectory
.realpath
.appendingPathComponent("sourcekit-lsp-test-scratch")
.appendingPathComponent("\(testBaseName)-\(uuid)")
try? FileManager.default.removeItem(at: url)
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
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>(
@_inheritActorContext _ body: @Sendable (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.
///
/// - Note: We need this because `URL.resolvingSymlinksInPath()` not only resolves symlinks but also standardizes the
/// path by stripping away `private` prefixes. Since sourcekitd is not performing this standardization, using
/// `resolvingSymlinksInPath` can lead to slightly mismatched URLs between the sourcekit-lsp response and the test
/// assertion.
var realpath: URL {
#if canImport(Darwin)
return self.path.withCString { path in
guard let realpath = Darwin.realpath(path, nil) else {
return self
}
let result = URL(fileURLWithPath: String(cString: realpath))
free(realpath)
return result
}
#else
// Non-Darwin platforms don't have the `/private` stripping issue, so we can just use `self.resolvingSymlinksInPath`
// here.
return self.resolvingSymlinksInPath()
#endif
}
}
let globalModuleCache: URL? = {
if let customModuleCache = ProcessInfo.processInfo.environment["SOURCEKIT_LSP_TEST_MODULE_CACHE"] {
if customModuleCache.isEmpty {
return nil
}
return URL(fileURLWithPath: customModuleCache)
}
return FileManager.default.temporaryDirectory.realpath
.appendingPathComponent("sourcekit-lsp-test-scratch")
.appendingPathComponent("shared-module-cache")
}()
|
