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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2022 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 SwiftDocC
class DeprecationSummaryTests: XCTestCase {
func testDecodeDeprecatedSymbol() throws {
let deprecatedSymbolURL = try XCTUnwrap(Bundle.module.url(
forResource: "deprecated-symbol", withExtension: "json",
subdirectory: "Rendering Fixtures"))
let data = try Data(contentsOf: deprecatedSymbolURL)
let symbol = try RenderNode.decode(fromJSON: data)
//
// Deprecation Details
//
XCTAssertEqual(symbol.deprecationSummary?.firstParagraph, [.text("This symbol is deprecated.")])
}
/// This test verifies that a symbol's deprecation summary comes from its sidecar doc
/// and it's preferred over the original deprecation note in the code docs.
func testAuthoredDeprecatedSummary() throws {
let (bundle, context) = try testBundleAndContext(named: "TestBundle")
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/SideKit/SideClass/init()", sourceLanguage: .swift))
// Compile docs and verify contents
let symbol = try XCTUnwrap(node.semantic as? Symbol)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = try XCTUnwrap(translator.visit(symbol) as? RenderNode, "Could not compile the node")
XCTAssertEqual(renderNode.deprecationSummary?.firstParagraph, [.text("This initializer has been deprecated.")])
}
/// Test for a warning when symbol is not deprecated
func testIncorrectlyAuthoredDeprecatedSummary() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle", excludingPaths: [], codeListings: [:], configureBundle: { url in
// Add a sidecar file with wrong deprecated summary
try """
# ``SideKit/SideClass``
@DeprecationSummary {
This class has been deprecated.
}
Abstract for `SideClass`.
""".write(to: url.appendingPathComponent("documentation/sideclass.md"), atomically: true, encoding: .utf8)
})
// Verify the context contains a warning about it.
XCTAssertNotNil(context.problems.first { problem -> Bool in
return problem.diagnostic.identifier == "org.swift.docc.DeprecationSummaryForAvailableSymbol"
})
// Verify the deprecation is still rendered.
let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/SideKit/SideClass", sourceLanguage: .swift))
// Compile docs and verify contents
let symbol = try XCTUnwrap(node.semantic as? Symbol)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = try XCTUnwrap(translator.visit(symbol) as? RenderNode, "Could not compile the node")
XCTAssertEqual(renderNode.deprecationSummary?.firstParagraph, [.text("This class has been deprecated.")])
// Verify that the in-abstract directive didn't make the context overflow into the discussion
XCTAssertEqual((node.semantic as? Symbol)?.abstract?.format().trimmingCharacters(in: .whitespacesAndNewlines), "Abstract for `SideClass`.")
}
/// This test verifies that a symbol's deprecation summary comes from its documentation extension file
/// and it's preferred over the original deprecation note in the code docs.
/// (r69719494)
func testAuthoredDeprecatedSummaryAsSoleItemInFile() throws {
let (bundle, context) = try testBundleAndContext(named: "BundleWithLonelyDeprecationDirective")
let node = try context.entity(
with: ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/CoolFramework/CoolClass",
sourceLanguage: .swift
)
)
// Compile docs and verify contents
let symbol = try XCTUnwrap(node.semantic as? Symbol)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
guard let renderNode = translator.visit(symbol) as? RenderNode else {
XCTFail("Could not compile the node")
return
}
XCTAssertEqual(renderNode.deprecationSummary?.firstParagraph, [
.text("Use the "),
SwiftDocC.RenderInlineContent.reference(
identifier: SwiftDocC.RenderReferenceIdentifier("doc://org.swift.docc.example/documentation/CoolFramework/CoolClass/coolFunc()"),
isActive: true,
overridingTitle: nil,
overridingTitleInlineContent: nil
),
SwiftDocC.RenderInlineContent.text(" "),
SwiftDocC.RenderInlineContent.text("initializer instead."),
])
}
func testSymbolDeprecatedSummary() throws {
let (bundle, context) = try testBundleAndContext(named: "BundleWithLonelyDeprecationDirective")
let node = try context.entity(
with: ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/CoolFramework/CoolClass/doUncoolThings(with:)",
sourceLanguage: .swift
)
)
// Compile docs and verify contents
let symbol = try XCTUnwrap(node.semantic as? Symbol)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = try XCTUnwrap(translator.visit(symbol) as? RenderNode, "Could not compile the node")
// `doUncoolThings(with:)` has a blanket deprecation notice from the class, but no curated article - verify that the deprecation notice from the class still shows up on the rendered page
XCTAssertEqual(renderNode.deprecationSummary?.firstParagraph, [
.text("This class is deprecated."),
])
}
func testDeprecationOverride() throws {
let (bundle, context) = try testBundleAndContext(named: "BundleWithLonelyDeprecationDirective")
let node = try context.entity(
with: ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/CoolFramework/CoolClass/init()",
sourceLanguage: .swift
)
)
// Compile docs and verify contents
let symbol = try XCTUnwrap(node.semantic as? Symbol)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = try XCTUnwrap(translator.visit(symbol) as? RenderNode, "Could not compile the node")
// `init()` has deprecation information in both the symbol graph and the documentation extension; when there are extra headings in an extension file, we need to make sure we correctly parse out the deprecation message from the extension and display that
XCTAssertEqual(renderNode.deprecationSummary?.firstParagraph, [
.text("Use the "),
.reference(
identifier: SwiftDocC.RenderReferenceIdentifier("doc://org.swift.docc.example/documentation/CoolFramework/CoolClass/init(config:cache:)"),
isActive: true,
overridingTitle: nil,
overridingTitleInlineContent: nil
),
.text(" initializer instead."),
])
}
func testDeprecationSummaryInDiscussionSection() throws {
let (bundle, context) = try testBundleAndContext(named: "BundleWithLonelyDeprecationDirective")
let node = try context.entity(
with: ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/CoolFramework/CoolClass/coolFunc()",
sourceLanguage: .swift
)
)
// Compile docs and verify contents
let symbol = try XCTUnwrap(node.semantic as? Symbol)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = try XCTUnwrap(translator.visit(symbol) as? RenderNode, "Could not compile the node")
// `coolFunc()` has deprecation information in both the symbol graph and the documentation extension; the deprecation information is part of the "Overview" section of the markup but it should still be parsed as expected.
XCTAssertEqual(renderNode.deprecationSummary?.firstParagraph, [
.text("Use the "),
.reference(
identifier: SwiftDocC.RenderReferenceIdentifier("doc://org.swift.docc.example/documentation/CoolFramework/CoolClass/init()"),
isActive: true,
overridingTitle: nil,
overridingTitleInlineContent: nil
),
.text(" initializer instead."),
])
}
func testDeprecationSummaryWithMultiLineCommentSymbol() throws {
let (bundle, context) = try testBundleAndContext(named: "BundleWithLonelyDeprecationDirective")
let node = try context.entity(
with: ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/CoolFramework/CoolClass/init(config:cache:)",
sourceLanguage: .swift
)
)
// Compile docs and verify contents
let symbol = try XCTUnwrap(node.semantic as? Symbol)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: nil)
let renderNode = try XCTUnwrap(translator.visit(symbol) as? RenderNode, "Could not compile the node")
// `init(config:cache:)` has deprecation information in both the symbol graph and the documentation extension; the symbol graph has multiple lines of documentation comments for the function, but adding deprecation information in the documentation extension should still work.
XCTAssertEqual(renderNode.deprecationSummary?.firstParagraph, [
.text("This initializer is deprecated as of version 1.0.0."),
])
}
}
|
