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
|
/*
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 SymbolKit
class GeneratedDataProviderTests: XCTestCase {
func testGeneratingBundles() throws {
let firstSymbolGraph = SymbolGraph(
metadata: .init(
formatVersion: .init(major: 0, minor: 0, patch: 1),
generator: "unit-test"
),
module: .init(
name: "FirstModuleName",
platform: .init()
),
symbols: [],
relationships: []
)
var secondSymbolGraph = firstSymbolGraph
secondSymbolGraph.module.name = "SecondModuleName"
let thirdSymbolGraph = firstSymbolGraph // Another symbol graph with the same module name
let dataProvider = GeneratedDataProvider(
symbolGraphDataLoader: {
switch $0.lastPathComponent {
case "first.symbols.json":
return try? JSONEncoder().encode(firstSymbolGraph)
case "second.symbols.json":
return try? JSONEncoder().encode(secondSymbolGraph)
case "third.symbols.json":
return try? JSONEncoder().encode(thirdSymbolGraph)
default:
return nil
}
}
)
let options = BundleDiscoveryOptions(
infoPlistFallbacks: [
"CFBundleDisplayName": "Custom Display Name",
"CFBundleIdentifier": "com.test.example",
],
additionalSymbolGraphFiles: [
URL(fileURLWithPath: "first.symbols.json"),
URL(fileURLWithPath: "second.symbols.json"),
URL(fileURLWithPath: "third.symbols.json"),
]
)
let bundles = try dataProvider.bundles(options: options)
XCTAssertEqual(bundles.count, 1)
let bundle = try XCTUnwrap(bundles.first)
XCTAssertEqual(bundle.displayName, "Custom Display Name")
XCTAssertEqual(bundle.symbolGraphURLs.map { $0.lastPathComponent }.sorted(), [
"first.symbols.json",
"second.symbols.json",
"third.symbols.json",
])
XCTAssertEqual(bundle.markupURLs.map { $0.path }.sorted(), [
"FirstModuleName.md",
"SecondModuleName.md",
// No third file since that symbol graph has the same module name as the first
])
XCTAssertEqual(
try String(data: dataProvider.contentsOfURL(URL(fileURLWithPath: "FirstModuleName.md")), encoding: .utf8),
"# ``FirstModuleName``"
)
XCTAssertEqual(
try String(data: dataProvider.contentsOfURL(URL(fileURLWithPath: "SecondModuleName.md")), encoding: .utf8),
"# ``SecondModuleName``"
)
}
func testGeneratingSingleModuleBundle() throws {
let firstSymbolGraph = SymbolGraph(
metadata: .init(
formatVersion: .init(major: 0, minor: 0, patch: 1),
generator: "unit-test"
),
module: .init(
name: "FirstModuleName",
platform: .init()
),
symbols: [],
relationships: []
)
let secondSymbolGraph = firstSymbolGraph // Another symbol graph with the same module name
let dataProvider = GeneratedDataProvider(
symbolGraphDataLoader: {
switch $0.lastPathComponent {
case "first.symbols.json":
return try? JSONEncoder().encode(firstSymbolGraph)
case "second.symbols.json":
return try? JSONEncoder().encode(secondSymbolGraph)
default:
return nil
}
}
)
let options = BundleDiscoveryOptions(
infoPlistFallbacks: [
"CFBundleDisplayName": "Custom Display Name",
"CFBundleIdentifier": "com.test.example",
],
additionalSymbolGraphFiles: [
URL(fileURLWithPath: "first.symbols.json"),
URL(fileURLWithPath: "second.symbols.json"),
]
)
let bundles = try dataProvider.bundles(options: options)
XCTAssertEqual(bundles.count, 1)
let bundle = try XCTUnwrap(bundles.first)
XCTAssertEqual(bundle.displayName, "Custom Display Name")
XCTAssertEqual(bundle.symbolGraphURLs.map { $0.lastPathComponent }.sorted(), [
"first.symbols.json",
"second.symbols.json",
])
XCTAssertEqual(bundle.markupURLs.map { $0.path }.sorted(), [
"FirstModuleName.md",
// No second file since that symbol graph has the same module name as the first
])
XCTAssertEqual(
try String(data: dataProvider.contentsOfURL(URL(fileURLWithPath: "FirstModuleName.md")), encoding: .utf8), """
# ``FirstModuleName``
@Metadata {
@DisplayName("Custom Display Name")
}
"""
)
}
}
|
