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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-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
import Foundation
import XCTest
import SymbolKit
@testable import SwiftDocC
class DocCSymbolRepresentableTests: XCTestCase {
func testDisambiguatedByType() throws {
try performOverloadSymbolDisambiguationTest(
correctLink: """
doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedStruct/secondTestMemberName-swift.property
""",
incorrectLinks: [
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedStruct/secondTestMemberName-swift.method",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedStruct/secondTestMemberName-swift.enum.case",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedStruct/secondTestMemberName",
],
symbolTitle: "secondTestMemberName",
expectedNumberOfAmbiguousSymbols: 2
)
}
func testOverloadedByCaseInsensitivity() throws {
try performOverloadSymbolDisambiguationTest(
correctLink: """
doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedByCaseStruct/ThirdTestMemberName-5vyx9
""",
incorrectLinks: [
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedByCaseStruct/ThirdTestMemberName",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedByCaseStruct/ThirdTestMemberName-swift.enum.case",
],
symbolTitle: "thirdtestmembername",
expectedNumberOfAmbiguousSymbols: 4
)
}
func testProtocolMemberWithUSRHash() throws {
try performOverloadSymbolDisambiguationTest(
correctLink: """
doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/fourthTestMemberName(test:)-961zx
""",
incorrectLinks: [
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/fourthTestMemberName(test:)",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/fourthtestmembername(test:)-961zx",
],
symbolTitle: "fourthTestMemberName(test:)",
expectedNumberOfAmbiguousSymbols: 4
)
}
func testFunctionWithKindIdentifierAndUSRHash() throws {
try performOverloadSymbolDisambiguationTest(
correctLink: """
doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedEnum/firstTestMemberName(_:)-14g8s
""",
incorrectLinks: [
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedEnum/firstTestMemberName(_:)-swift.method-14g8s",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedEnum/firstTestMemberName(_:)-swift.method",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedEnum/firstTestMemberName(_:)",
],
symbolTitle: "firstTestMemberName(_:)",
expectedNumberOfAmbiguousSymbols: 6
)
}
func testSymbolWithNoDisambiguation() throws {
try performOverloadSymbolDisambiguationTest(
correctLink: """
doc://com.shapes.ShapeKit/documentation/ShapeKit/RegularParent/firstMember
""",
incorrectLinks: [
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/firstMember-961zx",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/firstMember-swift.property",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/firstMember-swift.property-961zx",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/RegularParent/firstmember",
],
symbolTitle: "firstMember",
expectedNumberOfAmbiguousSymbols: 1
)
}
func testAmbiguousProtocolMember() throws {
try performOverloadSymbolDisambiguationTest(
correctLink: """
doc://com.shapes.ShapeKit/documentation/ShapeKit/RegularParent/firstMember
""",
incorrectLinks: [
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/firstMember-961zx",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/firstMember-swift.property",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/OverloadedProtocol/firstMember-swift.property-961zx",
"doc://com.shapes.ShapeKit/documentation/ShapeKit/RegularParent/firstmember",
],
symbolTitle: "firstMember",
expectedNumberOfAmbiguousSymbols: 1
)
}
func performOverloadSymbolDisambiguationTest(
correctLink: String,
incorrectLinks: [String],
symbolTitle: String,
expectedNumberOfAmbiguousSymbols: Int
) throws {
// Build a bundle with an unusual number of overloaded symbols
let (_, _, context) = try testBundleAndContext(
copying: "OverloadedSymbols",
excludingPaths: [],
codeListings: [:]
)
// Collect the overloaded symbols nodes from the built bundle
let ambiguousSymbols = context.documentationCache
.compactMap { $0.value.symbol }
.filter { $0.names.title.lowercased() == symbolTitle.lowercased() }
XCTAssertEqual(ambiguousSymbols.count, expectedNumberOfAmbiguousSymbols)
// Find the documentation node based on what we expect the correct link to be
let correctReferenceToSelect = try XCTUnwrap(
context.documentationCache.allReferences.first(where: { $0.absoluteString == correctLink })
)
let correctSymbolToSelect = try XCTUnwrap(
context.documentationCache[correctReferenceToSelect]?.symbol
)
// First confirm the first link does resolve as expected
do {
// Build an absolute symbol link
let absoluteSymbolLinkLastPathComponent = try XCTUnwrap(
AbsoluteSymbolLink(string: correctLink)?.basePathComponents.last
)
// Pass it all of the ambiguous symbols to disambiguate between
let selectedSymbols = absoluteSymbolLinkLastPathComponent.disambiguateBetweenOverloadedSymbols(
ambiguousSymbols
)
// Assert that it selects a single symbol
XCTAssertEqual(selectedSymbols.count, 1)
// Assert that the correct symbol is selected
let selectedSymbol = try XCTUnwrap(selectedSymbols.first)
XCTAssertEqual(correctSymbolToSelect, selectedSymbol)
}
// Now we'll try a couple of imprecise links and verify they don't resolve
try incorrectLinks.forEach { incorrectLink in
let absoluteSymbolLinkLastPathComponent = try XCTUnwrap(
AbsoluteSymbolLink(string: incorrectLink)?.basePathComponents.last
)
// Pass it all of the ambiguous symbols to disambiguate between
let selectedSymbols = absoluteSymbolLinkLastPathComponent.disambiguateBetweenOverloadedSymbols(
ambiguousSymbols
)
// We expect it to return an empty array since the given
// absolute symbol link isn't correct
XCTAssertTrue(selectedSymbols.isEmpty)
}
}
func testLinkComponentInitialization() throws {
let (_, _, context) = try testBundleAndContext(
copying: "OverloadedSymbols",
excludingPaths: [],
codeListings: [:]
)
var count = 0
for (reference, documentationNode) in context.documentationCache {
guard let symbolLink = AbsoluteSymbolLink(string: reference.absoluteString) else {
continue
}
// The `asLinkComponent` property of DocCSymbolRepresentable doesn't have the context
// to know what type disambiguation information it should use, so it always includes
// all the available disambiguation information. Because of this,
// we want to restrict to symbols that require both.
guard case .kindAndPreciseIdentifier = symbolLink.basePathComponents.last?.disambiguationSuffix else {
continue
}
// Create a link component from the symbol information
let linkComponent = try XCTUnwrap(documentationNode.symbol?.asLinkComponent)
// Confirm that link component we created is the same on the compiler
// created in a full documentation build.
XCTAssertEqual(
linkComponent.asLinkComponentString,
documentationNode.reference.lastPathComponent
)
count += 1
}
// It's not necessary to disambiguate with both kind and usr.
XCTAssertEqual(count, 0)
}
}
|
