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
|
/*
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 RoleTests: XCTestCase {
let expectedRoles: [String: String] = [
"/documentation/MyKit/MyClass": "symbol",
"/documentation/MyKit/globalFunction(_:considering:)": "symbol",
"/tutorials/Test-Bundle/TestTutorial2": "project",
"/documentation/SideKit": "collection",
"/documentation/Test-Bundle/article": "collectionGroup", // it has topic groups
"/tutorials/Test-Bundle/TestTutorialArticle": "article",
"/tutorials/TestOverview": "overview",
"/documentation/SideKit/SideClass/init()": "symbol",
]
func testNodeRoles() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle")
// Compile docs and verify contents
for (path, expectedRole) in expectedRoles {
let identifier = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: path, fragment: nil, sourceLanguage: .swift)
let source = context.documentURL(for: identifier)
do {
let node = try context.entity(with: identifier)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: source)
let renderNode = translator.visit(node.semantic) as! RenderNode
XCTAssertEqual(expectedRole, renderNode.metadata.role, "Unexpected role \(renderNode.metadata.role!.singleQuoted) for identifier \(identifier.path)")
} catch {
XCTFail("Failed to convert \(identifier.path). \(error.localizedDescription)")
return
}
}
}
func testDocumentationRenderReferenceRoles() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle")
let identifier = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/MyKit", fragment: nil, sourceLanguage: .swift)
let source = context.documentURL(for: identifier)
let node = try context.entity(with: identifier)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: source)
let renderNode = translator.visit(node.semantic) as! RenderNode
XCTAssertEqual((renderNode.references["doc://org.swift.docc.example/documentation/MyKit"] as? TopicRenderReference)?.role, "collection")
XCTAssertEqual((renderNode.references["doc://org.swift.docc.example/documentation/MyKit/globalFunction(_:considering:)"] as? TopicRenderReference)?.role, "symbol")
XCTAssertEqual((renderNode.references["doc://org.swift.docc.example/documentation/Test-Bundle/article2"] as? TopicRenderReference)?.role, "collectionGroup")
}
func testTutorialsRenderReferenceRoles() throws {
let (_, bundle, context) = try testBundleAndContext(copying: "TestBundle")
let identifier = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/tutorials/Test-Bundle/TestTutorial", fragment: nil, sourceLanguage: .swift)
let source = context.documentURL(for: identifier)
let node = try context.entity(with: identifier)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: source)
let renderNode = translator.visit(node.semantic) as! RenderNode
XCTAssertEqual((renderNode.references["doc://org.swift.docc.example/tutorials/TestOverview"] as? TopicRenderReference)?.role, "overview")
XCTAssertEqual((renderNode.references["doc://org.swift.docc.example/tutorials/Test-Bundle/TestTutorialArticle"] as? TopicRenderReference)?.role, "article")
XCTAssertEqual((renderNode.references["doc://org.swift.docc.example/tutorials/Test-Bundle/TestTutorial#Create-a-New-AR-Project-%F0%9F%92%BB"] as? TopicRenderReference)?.role, "pseudoSymbol")
}
}
|
