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
|
/*
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 XCTest
@_spi(ExternalLinks) @testable import SwiftDocC
import Markdown
class ExternalTopicsGraphHashTests: XCTestCase {
let externalResolver = ExternalReferenceResolverTests.TestExternalReferenceResolver()
let externalSymbolResolver = TestSymbolResolver()
/// A resolver returning mock symbols.
class TestSymbolResolver: GlobalExternalSymbolResolver {
func symbolReferenceAndEntity(withPreciseIdentifier preciseIdentifier: String) -> (ResolvedTopicReference, LinkResolver.ExternalEntity)? {
let reference = ResolvedTopicReference(bundleIdentifier: "com.test.symbols", path: "/\(preciseIdentifier)", sourceLanguage: SourceLanguage.swift)
let entity = LinkResolver.ExternalEntity(
topicRenderReference: TopicRenderReference(
identifier: .init(preciseIdentifier),
title: preciseIdentifier,
abstract: [],
url: "/" + preciseIdentifier,
kind: .symbol,
estimatedTime: nil
),
renderReferenceDependencies: .init(),
sourceLanguages: [.swift]
)
return (reference, entity)
}
}
func testNoMetricAddedIfNoExternalTopicsAreResolved() throws {
// Load bundle without using external resolvers
let (_, context) = try testBundleAndContext(named: "TestBundle")
XCTAssertTrue(context.externallyResolvedLinks.isEmpty)
// Try adding external topics metrics
let testBenchmark = Benchmark()
benchmark(add: Benchmark.ExternalTopicsHash(context: context), benchmarkLog: testBenchmark)
// Verify the metric has no value
XCTAssertNil(testBenchmark.metrics.first?.result, "Metric was added but there was no external links or symbols")
}
func testExternalLinksSameHash() throws {
let externalResolver = self.externalResolver
// Add external links and verify the checksum is always the same
let hashes: [String] = try (0...10).map { _ -> MetricValue? in
let (_, _, context) = try testBundleAndContext(copying: "TestBundle", externalResolvers: [externalResolver.bundleIdentifier: externalResolver]) { url in
try """
# ``SideKit/SideClass``
Curate some of the children and leave the rest for automatic curation.
## Topics
### External references
- <doc://\(externalResolver.bundleIdentifier)/path/to/external/symbol1>
- <doc://\(externalResolver.bundleIdentifier)/path/to/external/symbol2>
""".write(to: url.appendingPathComponent("documentation/sideclass.md"), atomically: true, encoding: .utf8)
}
// Verify that links were resolved
XCTAssertFalse(context.externallyResolvedLinks.isEmpty)
let testBenchmark = Benchmark()
benchmark(add: Benchmark.ExternalTopicsHash(context: context), benchmarkLog: testBenchmark)
// Verify that a metric was added
XCTAssertNotNil(testBenchmark.metrics[0].result)
return testBenchmark.metrics[0].result
}
.compactMap { value -> String? in
guard let value,
case MetricValue.checksum(let hash) = value else { return nil }
return hash
}
// Verify the produced topic graph hash is repeatedly the same
XCTAssertTrue(hashes.allSatisfy({ $0 == hashes.first }))
}
func testLinksAndSymbolsSameHash() throws {
let externalResolver = self.externalResolver
// Add external links and verify the checksum is always the same
let hashes: [String] = try (0...10).map { _ -> MetricValue? in
let (_, _, context) = try testBundleAndContext(copying: "TestBundle", externalResolvers: [externalResolver.bundleIdentifier: externalResolver], externalSymbolResolver: externalSymbolResolver) { url in
try """
# ``SideKit/SideClass``
Curate some of the children and leave the rest for automatic curation.
## Topics
### External references
- <doc://\(externalResolver.bundleIdentifier)/path/to/external/symbol1>
- <doc://\(externalResolver.bundleIdentifier)/path/to/external/symbol2>
""".write(to: url.appendingPathComponent("documentation/sideclass.md"), atomically: true, encoding: .utf8)
}
// Verify that links and symbols were resolved
XCTAssertFalse(context.externallyResolvedLinks.isEmpty)
let testBenchmark = Benchmark()
benchmark(add: Benchmark.ExternalTopicsHash(context: context), benchmarkLog: testBenchmark)
// Verify that a metric was added
XCTAssertNotNil(testBenchmark.metrics[0].result)
return testBenchmark.metrics[0].result
}
.compactMap { value -> String? in
guard let value,
case MetricValue.checksum(let hash) = value else { return nil }
return hash
}
// Verify the produced topic graph hash is repeatedly the same
XCTAssertTrue(hashes.allSatisfy({ $0 == hashes.first }))
}
func testExternalTopicsDetectsChanges() throws {
let externalResolver = self.externalResolver
// Load a bundle with external links
let (_, _, context) = try testBundleAndContext(copying: "TestBundle", externalResolvers: [externalResolver.bundleIdentifier: externalResolver]) { url in
try """
# ``SideKit/SideClass``
Curate some of the children and leave the rest for automatic curation.
## Topics
### External references
- <doc://\(externalResolver.bundleIdentifier)/path/to/external/symbol1>
- <doc://\(externalResolver.bundleIdentifier)/path/to/external/symbol2>
""".write(to: url.appendingPathComponent("documentation/sideclass.md"), atomically: true, encoding: .utf8)
}
XCTAssertFalse(context.externallyResolvedLinks.isEmpty)
guard !context.externallyResolvedLinks.isEmpty else { return }
// Produce checksum #1
let testBenchmark = Benchmark()
benchmark(add: Benchmark.ExternalTopicsHash(context: context), benchmarkLog: testBenchmark)
let result1 = try XCTUnwrap(testBenchmark.metrics.last?.result)
guard case MetricValue.checksum(let checksum1) = result1 else {
XCTFail("Didn't produce string checksum #1")
return
}
// Remove one external link
let linkURL = context.externallyResolvedLinks.keys.first!
let linkReference = context.externallyResolvedLinks[linkURL]!
context.externallyResolvedLinks.removeValue(forKey: linkURL)
// Produce checksum #2
benchmark(add: Benchmark.ExternalTopicsHash(context: context), benchmarkLog: testBenchmark)
let result2 = try XCTUnwrap(testBenchmark.metrics.last?.result)
guard case MetricValue.checksum(let checksum2) = result2 else {
XCTFail("Didn't produce string checksum #2")
return
}
XCTAssertNotEqual(checksum1, checksum2, "The checksum didn't change when a link was removed")
// Add back the same external link
context.externallyResolvedLinks[linkURL] = linkReference
// Produce checksum #3
benchmark(add: Benchmark.ExternalTopicsHash(context: context), benchmarkLog: testBenchmark)
let result3 = try XCTUnwrap(testBenchmark.metrics.last?.result)
guard case MetricValue.checksum(let checksum3) = result3 else {
XCTFail("Didn't produce string checksum #3")
return
}
XCTAssertNotEqual(checksum2, checksum3, "The checksum didn't change when a link was added back")
XCTAssertEqual(checksum1, checksum3, "The checksum wasn't identical for identical sources")
}
}
|
