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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2023-2024 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 Foundation
@testable import SwiftDocC
import SymbolKit
import XCTest
class SemaToRenderNodeDictionaryDataTests: XCTestCase {
func testBaseRenderNodeFromDictionaryData() throws {
let (_, context) = try testBundleAndContext(named: "DictionaryData")
let expectedPageUSRsAndLangs: [String : Set<SourceLanguage>] = [
// Artist dictionary - ``Artist``:
"data:test:Artist": [.data],
// Genre string type - ``Genre``:
"data:test:Genre": [.data],
// Module - ``DictionaryData``:
"DictionaryData": [.data, .swift, .objectiveC],
// ObjC class - ``FooObjC``:
"c:FooObjC": [.objectiveC],
// Swift class - ``FooSwift``:
"s:FooSwift": [.swift],
]
let expectedPageUSRs: Set<String> = Set(expectedPageUSRsAndLangs.keys)
let expectedNonpageUSRs: Set<String> = [
// Name string field - ``name``:
"data:test:Artist@name",
// Genre string field - ``genre``:
"data:test:Artist@genre",
// Month of birth string field - ``monthOfBirth``:
"data:test:Artist@monthOfBirth",
// Age integer field - ``age``:
"data:test:Artist@age",
]
// Verify we have the right number of cached nodes.
XCTAssertEqual(context.documentationCache.count, expectedPageUSRsAndLangs.count + expectedNonpageUSRs.count)
// Verify each node matches the expectations.
for (_, documentationNode) in context.documentationCache {
let symbolUSR = try XCTUnwrap((documentationNode.semantic as? Symbol)?.externalID)
if documentationNode.kind.isPage {
XCTAssertTrue(
expectedPageUSRs.contains(symbolUSR),
"Unexpected symbol page: \(symbolUSR)"
)
XCTAssertEqual(documentationNode.availableSourceLanguages, expectedPageUSRsAndLangs[symbolUSR])
} else {
XCTAssertTrue(
expectedNonpageUSRs.contains(symbolUSR),
"Unexpected symbol non-page: \(symbolUSR)"
)
}
}
}
func testFrameworkRenderNodeHasExpectedContent() throws {
let outputConsumer = try renderNodeConsumer(for: "DictionaryData")
let frameworkRenderNode = try outputConsumer.renderNode(
withIdentifier: "DictionaryData"
)
assertExpectedContent(
frameworkRenderNode,
sourceLanguage: "swift", // Swift wins default when multiple languages present
symbolKind: "module",
title: "DictionaryData",
navigatorTitle: nil,
abstract: "DictionaryData framework.",
declarationTokens: nil,
discussionSection: ["Root level discussion."],
topicSectionIdentifiers: [
// Data symbols are present, but FooObjC is missing from swift rendering
"doc://org.swift.docc.DictionaryData/documentation/DictionaryData/Artist",
"doc://org.swift.docc.DictionaryData/documentation/DictionaryData/Genre",
"doc://org.swift.docc.DictionaryData/documentation/DictionaryData/FooSwift",
],
referenceTitles: [
"Artist",
"DictionaryData",
"FooObjC",
"FooSwift",
"Genre",
],
referenceFragments: [
"object Artist",
"string Genre",
],
failureMessage: { fieldName in
"'DictionaryData' module has unexpected content for '\(fieldName)'."
}
)
let objcFrameworkNode = try renderNodeApplying(variant: "occ", to: frameworkRenderNode)
assertExpectedContent(
objcFrameworkNode,
sourceLanguage: "occ",
symbolKind: "module",
title: "DictionaryData",
navigatorTitle: nil,
abstract: "DictionaryData framework.",
declarationTokens: nil,
discussionSection: ["Root level discussion."],
topicSectionIdentifiers: [
// Data symbols are present, but FooSwift is missing from ObjC rendering
"doc://org.swift.docc.DictionaryData/documentation/DictionaryData/Artist",
"doc://org.swift.docc.DictionaryData/documentation/DictionaryData/Genre",
"doc://org.swift.docc.DictionaryData/documentation/DictionaryData/FooObjC",
],
referenceTitles: [
"Artist",
"DictionaryData",
"FooObjC",
"FooSwift",
"Genre",
],
referenceFragments: [
"object Artist",
"string Genre",
],
failureMessage: { fieldName in
"'DictionaryData' module has unexpected content for '\(fieldName)'."
}
)
}
func testDictionaryRenderNodeHasExpectedContent() throws {
let outputConsumer = try renderNodeConsumer(for: "DictionaryData")
let artistRenderNode = try outputConsumer.renderNode(withIdentifier: "data:test:Artist")
assertExpectedContent(
artistRenderNode,
sourceLanguage: "data",
symbolKind: "dictionary",
title: "Artist",
navigatorTitle: "Artist",
abstract: "Artist object.",
declarationTokens: [
"object ",
"Artist",
],
discussionSection: [
"The artist discussion.",
],
topicSectionIdentifiers: [],
referenceTitles: [
"Artist",
"DictionaryData",
"Genre",
],
referenceFragments: [
"object Artist",
"string Genre",
],
failureMessage: { fieldName in
"'Artist' symbol has unexpected content for '\(fieldName)'."
}
)
guard let propertiesSection = (artistRenderNode.primaryContentSections[1] as? PropertiesRenderSection) else {
XCTFail("Second primary content section not a render section")
return
}
XCTAssertEqual(propertiesSection.kind, .properties)
XCTAssertEqual(propertiesSection.items.count, 4)
let ageProperty = propertiesSection.items[0]
XCTAssertEqual(ageProperty.name, "age")
XCTAssertTrue(ageProperty.deprecated ?? false)
var attributeTitles = ageProperty.attributes?.map{$0.title.lowercased()}.sorted() ?? []
XCTAssertEqual(attributeTitles, ["maximum", "minimum"])
let genreProperty = propertiesSection.items[1]
XCTAssertEqual(genreProperty.name, "genre")
XCTAssertTrue(genreProperty.readOnly ?? false)
attributeTitles = genreProperty.attributes?.map{$0.title.lowercased()}.sorted() ?? []
XCTAssertEqual(attributeTitles, ["default value", "possible values"])
let monthProperty = propertiesSection.items[2]
XCTAssertEqual(monthProperty.name, "monthOfBirth")
XCTAssertNotNil(monthProperty.typeDetails)
if let details = monthProperty.typeDetails {
XCTAssertEqual(details.count, 2)
XCTAssertEqual(details[0].baseType, "integer")
XCTAssertEqual(details[1].baseType, "string")
}
attributeTitles = monthProperty.attributes?.map{$0.title.lowercased()}.sorted() ?? []
XCTAssertEqual(attributeTitles, ["possible types"])
monthProperty.attributes?.forEach { attribute in
if case let .allowedTypes(decls) = attribute {
XCTAssertEqual(decls.count, 2)
XCTAssertEqual(decls[0][0].text, "integer")
XCTAssertEqual(decls[1][0].text, "string")
}
}
let nameProperty = propertiesSection.items[3]
XCTAssertEqual(nameProperty.name, "name")
XCTAssertTrue(nameProperty.required ?? false)
XCTAssert((nameProperty.attributes ?? []).isEmpty)
}
func testTypeRenderNodeHasExpectedContent() throws {
let outputConsumer = try renderNodeConsumer(for: "DictionaryData")
let genreRenderNode = try outputConsumer.renderNode(withIdentifier: "data:test:Genre")
let type1 = DeclarationRenderSection.Token(fragment: SymbolGraph.Symbol.DeclarationFragments.Fragment(kind: .text, spelling: "string", preciseIdentifier: nil), identifier: nil)
let type2 = DeclarationRenderSection.Token(fragment: SymbolGraph.Symbol.DeclarationFragments.Fragment(kind: .text, spelling: "GENCODE", preciseIdentifier: nil), identifier: nil)
assertExpectedContent(
genreRenderNode,
sourceLanguage: "data",
symbolKind: "typealias",
title: "Genre",
navigatorTitle: nil,
abstract: nil,
attributes: [.maximumLength("40"), .allowedTypes([[type1], [type2]]), .allowedValues(["Classic Rock", "Folk", "null"])],
declarationTokens: [
"string ",
"Genre"
],
discussionSection: nil,
topicSectionIdentifiers: [],
referenceTitles: [
"Artist",
"DictionaryData",
"Genre",
],
referenceFragments: [
"object Artist",
"string Genre",
],
failureMessage: { fieldName in
"'Genre' symbol has unexpected content for '\(fieldName)'."
}
)
}
}
|
