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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
/*
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 SwiftDocC
class PlatformAvailabilityTests: XCTestCase {
func testDecodePlatformAvailability() throws {
let platformAvailabilityURL = Bundle.module.url(
forResource: "platform-availability", withExtension: "json", subdirectory: "Rendering Fixtures")!
let data = try Data(contentsOf: platformAvailabilityURL)
let symbol = try RenderNode.decode(fromJSON: data)
guard let platforms = symbol.metadata.platforms else {
XCTFail("No platform data found in fixture")
return
}
// The "macOS" platform in the fixture is unconditionally deprecated
XCTAssertEqual(true, platforms.first { $0.name == "macOS" }?.unconditionallyDeprecated)
// The "iOS" platform in the fixture is unconditionally unavailable
XCTAssertEqual(true, platforms.first { $0.name == "iOS" }?.unconditionallyUnavailable)
}
/// Ensure that adding `@Available` directives in an article causes the final RenderNode to contain the appropriate availability data.
func testPlatformAvailabilityFromArticle() throws {
let (bundle, context) = try testBundleAndContext(named: "AvailabilityBundle")
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/AvailableArticle",
sourceLanguage: .swift
)
let article = try XCTUnwrap(context.entity(with: reference).semantic as? Article)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitArticle(article) as? RenderNode)
let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
XCTAssertEqual(availability.count, 1)
let iosAvailability = try XCTUnwrap(availability.first)
XCTAssertEqual(iosAvailability.name, "iOS")
XCTAssertEqual(iosAvailability.introduced, "16.0")
XCTAssert(iosAvailability.isBeta != true)
}
/// Ensure that adding `@Available` directives in an extension file overrides the symbol's availability.
func testPlatformAvailabilityFromExtension() throws {
let (bundle, context) = try testBundleAndContext(named: "AvailabilityBundle")
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/MyKit/MyClass",
sourceLanguage: .swift
)
let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
XCTAssertEqual(availability.count, 1)
let iosAvailability = try XCTUnwrap(availability.first)
XCTAssertEqual(iosAvailability.name, "iOS")
XCTAssertEqual(iosAvailability.introduced, "16.0")
XCTAssert(iosAvailability.isBeta != true)
}
func testMultiplePlatformAvailabilityFromArticle() throws {
let (bundle, context) = try testBundleAndContext(named: "AvailabilityBundle")
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/AvailabilityBundle/ComplexAvailable",
sourceLanguage: .swift
)
let article = try XCTUnwrap(context.entity(with: reference).semantic as? Article)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitArticle(article) as? RenderNode)
let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
XCTAssertEqual(availability.count, 3)
XCTAssert(availability.contains(where: { item in
item.name == "iOS" && item.introduced == "15.0"
}))
XCTAssert(availability.contains(where: { item in
item.name == "macOS" && item.introduced == "12.0"
}))
XCTAssert(availability.contains(where: { item in
item.name == "watchOS" && item.introduced == "7.0"
}))
XCTAssert(availability.allSatisfy { item in
item.isBeta != true
})
}
func testArbitraryPlatformAvailability() throws {
let (bundle, context) = try testBundleAndContext(named: "AvailabilityBundle")
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/AvailabilityBundle/ArbitraryPlatforms",
sourceLanguage: .swift
)
let article = try XCTUnwrap(context.entity(with: reference).semantic as? Article)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitArticle(article) as? RenderNode)
let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
XCTAssertEqual(availability.count, 2)
XCTAssert(availability.contains(where: { item in
item.name == "SomePackage" && item.introduced == "1.0"
}))
XCTAssert(availability.contains(where: { item in
item.name == "My Package" && item.introduced == "2.0"
}))
XCTAssert(availability.allSatisfy { item in
item.isBeta != true
})
}
// Test that the Info.plist default availability does not affect the deprecated/unavailable availabilities provided by the symbol graph.
func testAvailabilityParserWithInfoPlistDefaultAvailability() throws {
let (bundle, context) = try testBundleAndContext(named: "AvailabilityOverrideBundle")
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/MyKit/MyClass",
sourceLanguage: .swift
)
let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
XCTAssertEqual(availability.count, 5)
XCTAssert(availability.contains(where: { platform in
platform.name == "iOS" && platform.deprecated != nil
}))
XCTAssert(availability.contains(where: { platform in
platform.name == "macOS" && platform.deprecated != nil
}))
XCTAssert(availability.contains(where: { platform in
platform.name == "watchOS" && platform.deprecated != nil
}))
XCTAssert(availability.contains(where: { platform in
platform.name == "Mac Catalyst" && platform.deprecated != nil
}))
XCTAssert(availability.contains(where: { platform in
platform.name == "iPadOS" && platform.deprecated != nil
}))
XCTAssertFalse(availability.contains(where: { platform in
platform.name == "tvOS"
}))
XCTAssert(availability.allSatisfy { item in
item.isBeta != true
})
}
/// Ensure that adding `@Available` directives for platform versions marked as beta in an article causes the final RenderNode to contain the appropriate availability data.
func testBetaPlatformAvailabilityFromArticle() throws {
let platformMetadata = [
"iOS": PlatformVersion(VersionTriplet(16, 0, 0), beta: true),
]
let (bundle, context) = try testBundleWithConfiguredPlatforms(named: "AvailabilityBundle", platformMetadata: platformMetadata)
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/AvailableArticle",
sourceLanguage: .swift
)
let article = try XCTUnwrap(context.entity(with: reference).semantic as? Article)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitArticle(article) as? RenderNode)
let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
XCTAssertEqual(availability.count, 1)
let iosAvailability = try XCTUnwrap(availability.first)
XCTAssertEqual(iosAvailability.name, "iOS")
XCTAssertEqual(iosAvailability.introduced, "16.0")
XCTAssert(iosAvailability.isBeta == true)
}
func testMultipleBetaPlatformAvailabilityFromArticle() throws {
let platformMetadata = [
"iOS": PlatformVersion(VersionTriplet(15, 0, 0), beta: true),
"macOS": PlatformVersion(VersionTriplet(12, 0, 0), beta: true),
"watchOS": PlatformVersion(VersionTriplet(7, 0, 0), beta: true),
]
let (bundle, context) = try testBundleWithConfiguredPlatforms(named: "AvailabilityBundle", platformMetadata: platformMetadata)
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/AvailabilityBundle/ComplexAvailable",
sourceLanguage: .swift
)
let article = try XCTUnwrap(context.entity(with: reference).semantic as? Article)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitArticle(article) as? RenderNode)
let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
XCTAssertEqual(availability.count, 3)
XCTAssert(availability.contains(where: { item in
item.name == "iOS" && item.introduced == "15.0"
}))
XCTAssert(availability.contains(where: { item in
item.name == "macOS" && item.introduced == "12.0"
}))
XCTAssert(availability.contains(where: { item in
item.name == "watchOS" && item.introduced == "7.0"
}))
XCTAssert(availability.allSatisfy { item in
item.isBeta == true
})
}
/// Ensure that adding `@Available` directives in an extension file overrides the symbol's availability.
func testBetaPlatformAvailabilityFromExtension() throws {
let platformMetadata = [
"iOS": PlatformVersion(VersionTriplet(16, 0, 0), beta: true),
]
let (bundle, context) = try testBundleWithConfiguredPlatforms(named: "AvailabilityBundle", platformMetadata: platformMetadata)
let reference = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/MyKit/MyClass",
sourceLanguage: .swift
)
let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
var translator = RenderNodeTranslator(
context: context,
bundle: bundle,
identifier: reference,
source: nil
)
let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
XCTAssertEqual(availability.count, 1)
let iosAvailability = try XCTUnwrap(availability.first)
XCTAssertEqual(iosAvailability.name, "iOS")
XCTAssertEqual(iosAvailability.introduced, "16.0")
XCTAssert(iosAvailability.isBeta == true)
}
func testBundleWithConfiguredPlatforms(named testBundleName: String, platformMetadata: [String : PlatformVersion]) throws -> (DocumentationBundle, DocumentationContext) {
let bundleURL = try XCTUnwrap(Bundle.module.url(forResource: testBundleName, withExtension: "docc", subdirectory: "Test Bundles"))
let (_, bundle, context) = try loadBundle(from: bundleURL) { context in
context.externalMetadata.currentPlatforms = platformMetadata
}
return (bundle, context)
}
}
|
