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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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 Swift project authors
*/
import XCTest
@testable import SwiftDocC
import SwiftDocCTestUtilities
class BundleDiscoveryTests: XCTestCase {
private let testBundleLocation = Bundle.module.url(
forResource: "TestBundle", withExtension: "docc", subdirectory: "Test Bundles")!
private lazy var allFiles: [URL] = ((try? FileManager.default.subpathsOfDirectory(atPath: testBundleLocation.path)) ?? [])
.map { testBundleLocation.appendingPathComponent($0) }
.filter { !$0.pathComponents.dropFirst(testBundleLocation.pathComponents.count).contains(where: { $0.hasPrefix(".") }) }
func testFirstBundle() throws {
let url = try createTemporaryDirectory()
// Create 3 minimal doc bundles
for i in 1 ... 3 {
let nestedBundle = Folder(name: "TestBundle\(i).docc", content: [
InfoPlist(displayName: "Test Bundle \(i)", identifier: "com.example.bundle\(i)"),
TextFile(name: "Root.md", utf8Content: """
# Test Bundle \(i)
@Metadata {
@TechnologyRoot
}
Abstract.
Content.
"""),
])
_ = try nestedBundle.write(inside: url)
}
let workspace = DocumentationWorkspace()
let context = try DocumentationContext(dataProvider: workspace)
let dataProvider = try LocalFileSystemDataProvider(rootURL: url)
try workspace.registerProvider(dataProvider)
// Verify all bundles are loaded
XCTAssertEqual(context.registeredBundles.map { $0.identifier }.sorted(),
["com.example.bundle1", "com.example.bundle2", "com.example.bundle3"]
)
// Verify the first one is bundle1
let converter = DocumentationConverter(documentationBundleURL: url, emitDigest: false, documentationCoverageOptions: .noCoverage, currentPlatforms: nil, workspace: workspace, context: context, dataProvider: dataProvider, bundleDiscoveryOptions: .init())
XCTAssertEqual(converter.firstAvailableBundle()?.identifier, "com.example.bundle1")
}
func testLoadComplexWorkspace() throws {
let workspace = Folder(name: "TestWorkspace", content: [
CopyOfFile(original: testBundleLocation),
Folder(name: "nested", content: [
Folder(name: "irrelevant", content: [
TextFile(name: "irrelevant.txt", utf8Content: "distraction"),
]),
TextFile(name: "irrelevant.txt", utf8Content: "distraction"),
Folder(name: "TestBundle2.docc", content: [
InfoPlist(displayName: "Test Bundle", identifier: "com.example.bundle2"),
Folder(name: "Subfolder", content: // All files flattened into one folder
allFiles.map { CopyOfFile(original: $0) }
),
]),
]),
])
let tempURL = try createTemporaryDirectory()
let workspaceURL = try workspace.write(inside: tempURL)
let dataProvider = try LocalFileSystemDataProvider(rootURL: workspaceURL)
let bundles = (try dataProvider.bundles()).sorted { (bundle1, bundle2) -> Bool in
return bundle1.identifier < bundle2.identifier
}
XCTAssertEqual(bundles.count, 2)
guard bundles.count == 2 else { return }
XCTAssertEqual(bundles[0].identifier, "com.example.bundle2")
XCTAssertEqual(bundles[1].identifier, "org.swift.docc.example")
func checkBundle(_ bundle: DocumentationBundle) {
XCTAssertEqual(bundle.displayName, "Test Bundle")
XCTAssertEqual(bundle.symbolGraphURLs.count, 4)
XCTAssertTrue(bundle.symbolGraphURLs.map { $0.lastPathComponent }.contains("mykit-iOS.symbols.json"))
XCTAssertTrue(bundle.symbolGraphURLs.map { $0.lastPathComponent }.contains("MyKit@SideKit.symbols.json"))
XCTAssertTrue(bundle.symbolGraphURLs.map { $0.lastPathComponent }.contains("sidekit.symbols.json"))
XCTAssertTrue(bundle.symbolGraphURLs.map { $0.lastPathComponent }.contains("FillIntroduced.symbols.json"))
XCTAssertFalse(bundle.markupURLs.isEmpty)
XCTAssertTrue(bundle.miscResourceURLs.map { $0.lastPathComponent }.sorted().contains("intro.png"))
}
for bundle in bundles {
checkBundle(bundle)
}
}
func testBundleFormat() throws {
func parsedBundle(from folder: File) throws -> DocumentationBundle? {
let tempURL = try createTemporaryDirectory()
let workspaceURL = try folder.write(inside: tempURL)
let dataProvider = try LocalFileSystemDataProvider(rootURL: workspaceURL)
let bundles = try dataProvider.bundles()
XCTAssertEqual(bundles.count, 1)
return bundles.first
}
guard let expectedBundle = try parsedBundle(from: CopyOfFolder(original: testBundleLocation)) else {
XCTFail("Failed to parse the Test Bundle")
return
}
func checkExpectedFilesFoundIn(_ folder: File, file: StaticString = #file, line: UInt = #line) throws {
guard let bundle = try parsedBundle(from: folder) else {
XCTFail("Failed to parse bundle for folder structure")
return
}
XCTAssertEqual(bundle.identifier, expectedBundle.identifier)
XCTAssertEqual(bundle.displayName, expectedBundle.displayName)
func assertEqualFiles(_ got: [URL], _ expected: [URL], file: StaticString = #file, line: UInt = #line) {
let gotFileNames = Set(got.map { $0.lastPathComponent })
let expectedFileNames = Set(expected.map { $0.lastPathComponent })
XCTAssertEqual(gotFileNames, expectedFileNames, file: (file), line: line)
XCTAssertEqual(gotFileNames.count, expectedFileNames.count, file: (file), line: line)
let extraFiles = gotFileNames.subtracting(expectedFileNames)
XCTAssert(extraFiles.isEmpty, "Got these extra files: \(extraFiles.sorted().map({ $0.singleQuoted }).joined(separator: ", "))", file: (file), line: line)
let missingFiles = expectedFileNames.subtracting(gotFileNames)
XCTAssert(missingFiles.isEmpty, "Missing these files: \(extraFiles.sorted().map({ $0.singleQuoted }).joined(separator: ", "))", file: (file), line: line)
}
assertEqualFiles(bundle.symbolGraphURLs, expectedBundle.symbolGraphURLs, file: (file), line: line)
assertEqualFiles(bundle.markupURLs, expectedBundle.markupURLs, file: (file), line: line)
assertEqualFiles(bundle.miscResourceURLs, expectedBundle.miscResourceURLs, file: (file), line: line)
}
// The TestBundle as-is.
try checkExpectedFilesFoundIn(
CopyOfFolder(original: testBundleLocation, newName: "TestBundle.docc")
)
// Compatibility with previous format
try checkExpectedFilesFoundIn( // All in one folder
Folder(name: "TestBundle.docc", content:
allFiles.map { CopyOfFile(original: $0) }
)
)
try checkExpectedFilesFoundIn( // Separate subfolders for symbols and resources
Folder(name: "TestBundle.docc", content: [
// Symbol graphs in the Symbols folder
Folder(name: "Symbols", content:
allFiles.filter { $0.lastPathComponent.lowercased().hasSuffix(".symbols.json") }.map { CopyOfFile(original: $0) }
),
// Other files in the Resources folder
Folder(name: "Resources", content:
allFiles.filter { !$0.lastPathComponent.lowercased().hasSuffix(".symbols.json") }.map { CopyOfFile(original: $0) }
),
// The original Info.plist
CopyOfFile(original: allFiles.first(where: { $0.lastPathComponent.lowercased() == "info.plist" })!),
])
)
// Deeply nested subfolders inside the bundle
try checkExpectedFilesFoundIn(
Folder(name: "TestBundle.docc", content: [
// The original Info.plist
CopyOfFile(original: allFiles.first(where: { $0.lastPathComponent.lowercased() == "info.plist" })!),
// Put all the other files in deeper and deeper folders
Folder(name: "One", content: allFiles[..<10].map { CopyOfFile(original: $0) }).appendingFile(
Folder(name: "Two", content: allFiles[10..<20].map { CopyOfFile(original: $0) }).appendingFile(
Folder(name: "Three", content: allFiles[20..<30].map { CopyOfFile(original: $0) }).appendingFile(
Folder(name: "Four", content: allFiles[30...].map { CopyOfFile(original: $0) })
)
)
),
])
)
}
func testBundleDiscoveryOptions() throws {
let workspace = Folder(name: "TestWorkspace", content: [
// The test bundle without all the symbol graph files
CopyOfFolder(original: testBundleLocation, filter: { !DocumentationBundleFileTypes.isSymbolGraphFile($0) }),
// Just the symbol graph files in a non-bundle folder
CopyOfFolder(original: testBundleLocation, newName: "Not a doc bundle", filter: { DocumentationBundleFileTypes.isSymbolGraphFile($0) }),
])
let tempURL = try createTemporaryDirectory()
let workspaceURL = try workspace.write(inside: tempURL)
let dataProvider = try LocalFileSystemDataProvider(rootURL: workspaceURL)
let bundleDiscoveryOptions = BundleDiscoveryOptions(
infoPlistFallbacks: [
"CFBundleDisplayName": "Fallback Display Name",
],
additionalSymbolGraphFiles: [
tempURL.appendingPathComponent("TestWorkspace/Not a doc bundle/mykit-iOS.symbols.json"),
tempURL.appendingPathComponent("TestWorkspace/Not a doc bundle/sidekit.symbols.json"),
tempURL.appendingPathComponent("TestWorkspace/Not a doc bundle/MyKit@SideKit.symbols.json"),
]
)
let bundles = try dataProvider.bundles(options: bundleDiscoveryOptions)
XCTAssertEqual(bundles.count, 1)
guard let bundle = bundles.first else { return }
// The bundle information was overridden from the options
XCTAssertEqual(bundle.identifier, "org.swift.docc.example")
XCTAssertEqual(bundle.displayName, "Test Bundle") // The fallback should not override this value
// The additional symbol graph files are part of the bundle
XCTAssertEqual(bundle.symbolGraphURLs.count, 3)
XCTAssertTrue(bundle.symbolGraphURLs.map { $0.lastPathComponent }.contains("mykit-iOS.symbols.json"))
XCTAssertTrue(bundle.symbolGraphURLs.map { $0.lastPathComponent }.contains("MyKit@SideKit.symbols.json"))
XCTAssertTrue(bundle.symbolGraphURLs.map { $0.lastPathComponent }.contains("sidekit.symbols.json"))
// The symbol graph files are not located inside the doc bundle
for symbolGraphFile in bundle.symbolGraphURLs {
XCTAssertFalse(symbolGraphFile.pathComponents.contains(where: { $0.hasSuffix(".docc") }))
}
}
func testNoInfoPlist() throws {
let workspace = Folder(name: "TestWorkspace", content: [
// The test bundle without the Info.plist file
CopyOfFolder(original: testBundleLocation, filter: { !DocumentationBundleFileTypes.isInfoPlistFile($0) }),
])
XCTAssertFalse(workspace.recursiveContent.contains(where: { $0.name == "Info.plist" }), "This bundle shouldn't contain an Info.plist file")
let tempURL = try createTemporaryDirectory()
let workspaceURL = try workspace.write(inside: tempURL)
let dataProvider = try LocalFileSystemDataProvider(rootURL: workspaceURL)
// All the required information is passed via overrides
let bundleDiscoveryOptions = BundleDiscoveryOptions(
infoPlistFallbacks: [
"CFBundleDisplayName": "Fallback Display Name",
"CFBundleIdentifier": "com.fallback.bundle.identifier",
"CFBundleVersion": "1.2.3",
],
additionalSymbolGraphFiles: []
)
let bundles = try dataProvider.bundles(options: bundleDiscoveryOptions)
XCTAssertEqual(bundles.count, 1)
guard let bundle = bundles.first else { return }
// The bundle information was specified via the options
XCTAssertEqual(bundle.identifier, "com.fallback.bundle.identifier")
XCTAssertEqual(bundle.displayName, "Fallback Display Name")
XCTAssertEqual(bundle.version, "1.2.3")
}
func testNoCustomTemplates() throws {
let workspace = Folder(name: "TestWorkspace", content: [
CopyOfFolder(original: testBundleLocation),
])
let tempURL = try createTemporaryDirectory()
let workspaceURL = try workspace.write(inside: tempURL)
let dataProvider = try LocalFileSystemDataProvider(rootURL: workspaceURL)
let bundles = try dataProvider.bundles(options: BundleDiscoveryOptions())
XCTAssertEqual(bundles.count, 1)
guard let bundle = bundles.first else { return }
// Ensure that `customHeader` is `nil` if no top level `header.html`
// file was found in the bundle
XCTAssertNil(bundle.customHeader)
// Ensure that `customFooter` is `nil` if no top level `footer.html`
// file was found in the bundle
XCTAssertNil(bundle.customFooter)
// Ensure that `themeSettings` is `nil` if no `theme-settings.json`
// file was found in the bundle
XCTAssertNil(bundle.themeSettings)
}
func testCustomTemplatesFound() throws {
let workspace = Folder(name: "TestBundle.docc", content:
allFiles.map { CopyOfFile(original: $0) } + [
TextFile(name: "header.html", utf8Content: """
<header><marquee>hello world</marquee></header>
"""),
TextFile(name: "footer.html", utf8Content: """
<footer><marquee>goodbye world</marquee></footer>
"""),
]
)
let tempURL = try createTemporaryDirectory()
let workspaceURL = try workspace.write(inside: tempURL)
let dataProvider = try LocalFileSystemDataProvider(rootURL: workspaceURL)
let bundles = try dataProvider.bundles(options: BundleDiscoveryOptions())
XCTAssertEqual(bundles.count, 1)
guard let bundle = bundles.first else { return }
// Ensure that `customHeader` points to the location of a top level
// `header.html` file if one is found in the bundle
XCTAssertEqual(bundle.customHeader?.lastPathComponent, "header.html")
// Ensure that `customFooter` points to the location of a top level
// `footer.html` file if one is found in the bundle
XCTAssertEqual(bundle.customFooter?.lastPathComponent, "footer.html")
}
func testThemeSettingsFound() throws {
let workspace = Folder(name: "TestBundle.docc", content:
allFiles.map { CopyOfFile(original: $0) } + [
TextFile(name: "theme-settings.json", utf8Content: """
{
"meta": {},
"theme": {
"colors": {
"text": "#ff0000"
}
},
"features": {}
}
"""),
]
)
let tempURL = try createTemporaryDirectory()
let workspaceURL = try workspace.write(inside: tempURL)
let dataProvider = try LocalFileSystemDataProvider(rootURL: workspaceURL)
let bundles = try dataProvider.bundles(options: BundleDiscoveryOptions())
XCTAssertEqual(bundles.count, 1)
guard let bundle = bundles.first else { return }
// Ensure that `themeSettings` points to the location of a
// `theme-settings.json` file if one is found in the bundle
XCTAssertEqual(bundle.themeSettings?.lastPathComponent, "theme-settings.json")
}
}
|
