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
|
/*
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 XCTest
@testable import SymbolKit
@testable import SwiftDocC
class SymbolGraphRelationshipsBuilderTests: XCTestCase {
private func createSymbols(
documentationCache: inout DocumentationContext.ContentCache<DocumentationNode>,
bundle: DocumentationBundle,
sourceType: SymbolGraph.Symbol.Kind,
targetType: SymbolGraph.Symbol.Kind
) -> SymbolGraph.Relationship {
let sourceIdentifier = SymbolGraph.Symbol.Identifier(precise: "A", interfaceLanguage: SourceLanguage.swift.id)
let targetIdentifier = SymbolGraph.Symbol.Identifier(precise: "B", interfaceLanguage: SourceLanguage.swift.id)
let sourceRef = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/A", sourceLanguage: .swift)
let targetRef = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/B", sourceLanguage: .swift)
let moduleRef = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit", sourceLanguage: .swift)
let sourceSymbol = SymbolGraph.Symbol(identifier: sourceIdentifier, names: SymbolGraph.Symbol.Names(title: "A", navigator: nil, subHeading: nil, prose: nil), pathComponents: ["MyKit", "A"], docComment: nil, accessLevel: .init(rawValue: "public"), kind: sourceType, mixins: [:])
let targetSymbol = SymbolGraph.Symbol(identifier: targetIdentifier, names: SymbolGraph.Symbol.Names(title: "B", navigator: nil, subHeading: nil, prose: nil), pathComponents: ["MyKit", "B"], docComment: nil, accessLevel: .init(rawValue: "public"), kind: targetType, mixins: [:])
let engine = DiagnosticEngine()
documentationCache.add(
DocumentationNode(reference: sourceRef, symbol: sourceSymbol, platformName: "macOS", moduleReference: moduleRef, article: nil, engine: engine),
reference: sourceRef,
symbolID: "A"
)
documentationCache.add(
DocumentationNode(reference: targetRef, symbol: targetSymbol, platformName: "macOS", moduleReference: moduleRef, article: nil, engine: engine),
reference: targetRef,
symbolID: "B"
)
XCTAssert(engine.problems.isEmpty)
return SymbolGraph.Relationship(source: sourceIdentifier.precise, target: targetIdentifier.precise, kind: .defaultImplementationOf, targetFallback: nil)
}
private let swiftSelector = UnifiedSymbolGraph.Selector(interfaceLanguage: "swift", platform: nil)
func testImplementsRelationship() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
var documentationCache = DocumentationContext.ContentCache<DocumentationNode>()
let engine = DiagnosticEngine()
let edge = createSymbols(documentationCache: &documentationCache, bundle: bundle, sourceType: .init(parsedIdentifier: .class, displayName: "Class"), targetType: .init(parsedIdentifier: .protocol, displayName: "Protocol"))
// Adding the relationship
SymbolGraphRelationshipsBuilder.addImplementationRelationship(edge: edge, selector: swiftSelector, in: bundle, context: context, localCache: documentationCache, engine: engine)
// Test default implementation was added
XCTAssertFalse((documentationCache["B"]!.semantic as! Symbol).defaultImplementations.implementations.isEmpty)
}
func testConformsRelationship() throws {
let bundle = try testBundle(named: "TestBundle")
var documentationCache = DocumentationContext.ContentCache<DocumentationNode>()
let engine = DiagnosticEngine()
let edge = createSymbols(documentationCache: &documentationCache, bundle: bundle, sourceType: .init(parsedIdentifier: .class, displayName: "Class"), targetType: .init(parsedIdentifier: .protocol, displayName: "Protocol"))
// Adding the relationship
SymbolGraphRelationshipsBuilder.addConformanceRelationship(edge: edge, selector: swiftSelector, in: bundle, localCache: documentationCache, externalCache: .init(), engine: engine)
// Test default conforms to was added
guard let conformsTo = (documentationCache["A"]!.semantic as! Symbol).relationships.groups.first(where: { group -> Bool in
return group.kind == RelationshipsGroup.Kind.conformsTo
}) else {
XCTFail("Conforms to group not added")
return
}
XCTAssertEqual(conformsTo.destinations.first?.url?.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/B")
// Test default conformance was added
guard let conforming = (documentationCache["B"]!.semantic as! Symbol).relationships.groups.first(where: { group -> Bool in
return group.kind == RelationshipsGroup.Kind.conformingTypes
}) else {
XCTFail("Conforming types not added")
return
}
XCTAssertEqual(conforming.destinations.first?.url?.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/A")
}
func testInheritanceRelationship() throws {
let bundle = try testBundle(named: "TestBundle")
var documentationCache = DocumentationContext.ContentCache<DocumentationNode>()
let engine = DiagnosticEngine()
let edge = createSymbols(documentationCache: &documentationCache, bundle: bundle, sourceType: .init(parsedIdentifier: .class, displayName: "Class"), targetType: .init(parsedIdentifier: .protocol, displayName: "Protocol"))
// Adding the relationship
SymbolGraphRelationshipsBuilder.addInheritanceRelationship(edge: edge, selector: swiftSelector, in: bundle, localCache: documentationCache, externalCache: .init(), engine: engine)
// Test inherits was added
guard let inherits = (documentationCache["A"]!.semantic as! Symbol).relationships.groups.first(where: { group -> Bool in
return group.kind == RelationshipsGroup.Kind.inheritsFrom
}) else {
XCTFail("Inherits from not added")
return
}
XCTAssertEqual(inherits.destinations.first?.url?.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/B")
// Test descendants were added
guard let inherited = (documentationCache["B"]!.semantic as! Symbol).relationships.groups.first(where: { group -> Bool in
return group.kind == RelationshipsGroup.Kind.inheritedBy
}) else {
XCTFail("Inherited by types not added")
return
}
XCTAssertEqual(inherited.destinations.first?.url?.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/A")
}
func testInheritanceRelationshipFromOtherFramework() throws {
let bundle = try testBundle(named: "TestBundle")
var documentationCache = DocumentationContext.ContentCache<DocumentationNode>()
let engine = DiagnosticEngine()
let sourceIdentifier = SymbolGraph.Symbol.Identifier(precise: "A", interfaceLanguage: SourceLanguage.swift.id)
let targetIdentifier = SymbolGraph.Symbol.Identifier(precise: "B", interfaceLanguage: SourceLanguage.swift.id)
let sourceRef = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit/A", sourceLanguage: .swift)
let moduleRef = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/MyKit", sourceLanguage: .swift)
let sourceSymbol = SymbolGraph.Symbol(identifier: sourceIdentifier, names: SymbolGraph.Symbol.Names(title: "A", navigator: nil, subHeading: nil, prose: nil), pathComponents: ["MyKit", "A"], docComment: nil, accessLevel: .init(rawValue: "public"), kind: SymbolGraph.Symbol.Kind(parsedIdentifier: .class, displayName: "Class"), mixins: [:])
documentationCache.add(
DocumentationNode(reference: sourceRef, symbol: sourceSymbol, platformName: "macOS", moduleReference: moduleRef, article: nil, engine: engine),
reference: sourceRef,
symbolID: "A"
)
XCTAssert(engine.problems.isEmpty)
let edge = SymbolGraph.Relationship(source: sourceIdentifier.precise, target: targetIdentifier.precise, kind: .inheritsFrom, targetFallback: "MyOtherKit.B")
SymbolGraphRelationshipsBuilder.addInheritanceRelationship(edge: edge, selector: swiftSelector, in: bundle, localCache: documentationCache, externalCache: .init(), engine: engine)
let relationships = (documentationCache["A"]!.semantic as! Symbol).relationships
guard let inheritsShouldHaveFallback = relationships.groups.first(where: { group -> Bool in
return group.kind == RelationshipsGroup.Kind.inheritsFrom
}) else {
XCTFail("Inherits from not added")
return
}
XCTAssert(inheritsShouldHaveFallback.destinations.contains(where: { destination -> Bool in
return relationships.targetFallbacks[destination] == "MyOtherKit.B"
}), "Could not fallback for parent in inherits from relationship")
}
func testRequirementRelationship() throws {
let bundle = try testBundle(named: "TestBundle")
var documentationCache = DocumentationContext.ContentCache<DocumentationNode>()
let engine = DiagnosticEngine()
let edge = createSymbols(documentationCache: &documentationCache, bundle: bundle, sourceType: .init(parsedIdentifier: .method, displayName: "Method"), targetType: .init(parsedIdentifier: .protocol, displayName: "Protocol"))
// Adding the relationship
SymbolGraphRelationshipsBuilder.addRequirementRelationship(edge: edge, localCache: documentationCache, engine: engine)
// Test default implementation was added
XCTAssertTrue((documentationCache["A"]!.semantic as! Symbol).isRequired)
}
func testOptionalRequirementRelationship() throws {
let bundle = try testBundle(named: "TestBundle")
var documentationCache = DocumentationContext.ContentCache<DocumentationNode>()
let engine = DiagnosticEngine()
let edge = createSymbols(documentationCache: &documentationCache, bundle: bundle, sourceType: .init(parsedIdentifier: .method, displayName: "Method"), targetType: .init(parsedIdentifier: .protocol, displayName: "Protocol"))
// Adding the relationship
SymbolGraphRelationshipsBuilder.addOptionalRequirementRelationship(edge: edge, localCache: documentationCache, engine: engine)
// Test default implementation was added
XCTAssertFalse((documentationCache["A"]!.semantic as! Symbol).isRequired)
}
}
|
