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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift 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 http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Basics
import PackageLoading
import PackageModel
import SPMTestSupport
import XCTest
import class TSCBasic.InMemoryFileSystem
class ModuleMapGeneration: XCTestCase {
func testModuleNameHeaderInInclude() throws {
let root: AbsolutePath = .root
let fs = InMemoryFileSystem(emptyFiles:
root.appending(components: "include", "Foo.h").pathString,
root.appending(components: "Foo.c").pathString
)
ModuleMapTester("Foo", in: fs) { result in
result.check(contents: """
module Foo {
umbrella header "\(root.appending(components: "include", "Foo.h"))"
export *
}
""")
}
}
func testModuleNameDirAndHeaderInInclude() throws {
let root: AbsolutePath = .root
let fs = InMemoryFileSystem(emptyFiles:
root.appending(components: "include", "Foo", "Foo.h").pathString,
root.appending(components: "Foo.c").pathString
)
ModuleMapTester("Foo", in: fs) { result in
result.check(contents: """
module Foo {
umbrella header "\(root.appending(components: "include", "Foo", "Foo.h").pathString)"
export *
}
""")
}
}
func testOtherCases() throws {
let root: AbsolutePath = .root
var fs: InMemoryFileSystem
fs = InMemoryFileSystem(emptyFiles:
root.appending(components: "include", "Bar.h").pathString,
root.appending(components: "Foo.c").pathString
)
ModuleMapTester("Foo", in: fs) { result in
result.check(contents: """
module Foo {
umbrella "\(root.appending(components: "include"))"
export *
}
""")
}
fs = InMemoryFileSystem(emptyFiles:
root.appending(components: "include", "Baz.h").pathString,
root.appending(components: "include", "Bar.h").pathString,
root.appending(components: "Foo.c").pathString
)
ModuleMapTester("Foo", in: fs) { result in
result.check(contents: """
module Foo {
umbrella "\(root.appending(components: "include"))"
export *
}
""")
}
fs = InMemoryFileSystem(emptyFiles:
root.appending(components: "include", "Baz", "Foo.h").pathString,
root.appending(components: "include", "Bar", "Bar.h").pathString,
root.appending(components: "Foo.c").pathString
)
ModuleMapTester("Foo", in: fs) { result in
result.check(contents: """
module Foo {
umbrella "\(root.appending(components: "include"))"
export *
}
""")
}
}
func testWarnings() throws {
let root: AbsolutePath = .root
var fs = InMemoryFileSystem(emptyFiles:
root.appending(components: "Foo.c").pathString
)
ModuleMapTester("Foo", in: fs) { result in
result.checkNotCreated()
result.checkDiagnostics { result in
let diagnostic = result.check(
diagnostic: "no include directory found for target \'Foo\'; libraries cannot be imported without public headers",
severity: .warning
)
XCTAssertEqual(diagnostic?.metadata?.moduleName, "Foo")
}
}
fs = InMemoryFileSystem(emptyFiles:
root.appending(components: "include", "F-o-o.h").pathString,
root.appending(components: "Foo.c").pathString
)
ModuleMapTester("F-o-o", in: fs) { result in
result.check(contents: """
module F_o_o {
umbrella "\(root.appending(components: "include"))"
export *
}
""")
result.checkDiagnostics { result in
let diagnostic = result.check(
diagnostic: "\(root.appending(components: "include", "F-o-o.h")) should be renamed to \(root.appending(components: "include", "F_o_o.h")) to be used as an umbrella header",
severity: .warning
)
XCTAssertEqual(diagnostic?.metadata?.moduleName, "F-o-o")
}
}
}
func testUnsupportedLayouts() throws {
let include: AbsolutePath = "/include"
var fs = InMemoryFileSystem(emptyFiles:
include.appending(components: "Foo", "Foo.h").pathString,
include.appending(components: "Bar", "Foo.h").pathString
)
ModuleMapTester("Foo", in: fs) { result in
result.checkNotCreated()
result.checkDiagnostics { result in
let diagnostic = result.check(
diagnostic: "target 'Foo' has invalid header layout: umbrella header found at '\(include.appending(components: "Foo", "Foo.h"))', but more than one directory exists next to its parent directory: \(include.appending(components: "Bar")); consider reducing them to one",
severity: .error
)
XCTAssertEqual(diagnostic?.metadata?.moduleName, "Foo")
}
}
fs = InMemoryFileSystem(emptyFiles:
include.appending(components: "Foo.h").pathString,
include.appending(components: "Bar", "Foo.h").pathString
)
ModuleMapTester("Foo", in: fs) { result in
result.checkNotCreated()
result.checkDiagnostics { result in
let diagnostic = result.check(
diagnostic: "target 'Foo' has invalid header layout: umbrella header found at '\(include.appending(components: "Foo.h"))', but directories exist next to it: \(include.appending(components: "Bar")); consider removing them",
severity: .error
)
XCTAssertEqual(diagnostic?.metadata?.moduleName, "Foo")
}
}
}
}
/// Helper function to test module map generation. Given a target name and optionally the name of a public-headers directory, this function determines the module map type of the public-headers directory by examining the contents of a file system and invokes a given block to check the module result (including any diagnostics).
func ModuleMapTester(_ targetName: String, includeDir: String = "include", in fileSystem: FileSystem, _ body: (ModuleMapResult) -> Void) {
let observability = ObservabilitySystem.makeForTesting()
// Create a module map generator, and determine the type of module map to use for the header directory. This may emit diagnostics.
let moduleMapGenerator = ModuleMapGenerator(targetName: targetName, moduleName: targetName.spm_mangledToC99ExtendedIdentifier(), publicHeadersDir: AbsolutePath.root.appending(component: includeDir), fileSystem: fileSystem)
let moduleMapType = moduleMapGenerator.determineModuleMapType(observabilityScope: observability.topScope)
// Generate a module map and capture any emitted diagnostics.
let generatedModuleMapPath = AbsolutePath.root.appending(components: "module.modulemap")
observability.topScope.trap {
if let generatedModuleMapType = moduleMapType.generatedModuleMapType {
try moduleMapGenerator.generateModuleMap(type: generatedModuleMapType, at: generatedModuleMapPath)
}
}
// Invoke the closure to check the results.
let result = ModuleMapResult(diagnostics: observability.diagnostics, path: generatedModuleMapPath, fs: fileSystem)
body(result)
// Check for any unexpected diagnostics (the ones the closure didn't check for).
result.validateDiagnostics()
}
final class ModuleMapResult {
private var diagnostics: [Basics.Diagnostic]
private var diagsChecked: Bool
private let path: AbsolutePath
private let fs: FileSystem
init(diagnostics: [Basics.Diagnostic], path: AbsolutePath, fs: FileSystem) {
self.diagnostics = diagnostics
self.diagsChecked = false
self.path = path
self.fs = fs
}
func validateDiagnostics(file: StaticString = #file, line: UInt = #line) {
if diagsChecked || diagnostics.isEmpty { return }
XCTFail("Unchecked diagnostics: \(diagnostics)", file: (file), line: line)
}
func checkDiagnostics(_ handler: (DiagnosticsTestResult) throws -> Void) {
testDiagnostics(diagnostics, handler: handler)
diagsChecked = true
}
func checkNotCreated(file: StaticString = #file, line: UInt = #line) {
XCTAssertEqual(isCreated, false, "unexpected modulemap created: \(contents)", file: (file), line: line)
}
private var contents: String {
return try! fs.readFileContents(path).replacingOccurrences(of: "\\\\", with: "\\")
}
private var isCreated: Bool {
return fs.isFile(path)
}
func check(contents: String, file: StaticString = #file, line: UInt = #line) {
guard isCreated else {
return XCTFail("Can't compare values, modulemap not generated.", file: (file), line: line)
}
XCTAssertEqual(contents, self.contents, file: (file), line: line)
}
}
|
