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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 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 MentionsRenderSectionTests: XCTestCase {
/// Verify that the Mentioned In section is present when a symbol is mentioned,
/// pointing to the correct article.
func testMentionedInSectionFull() throws {
enableFeatureFlag(\.isExperimentalMentionedInEnabled)
let (bundle, context) = try createMentionedInTestBundle()
let identifier = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/MentionedIn/MyClass",
sourceLanguage: .swift
)
let mentioningArticle = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/MentionedIn/ArticleMentioningSymbol",
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
let mentionsSection = try XCTUnwrap(renderNode.primaryContentSections.mapFirst { $0 as? MentionsRenderSection })
XCTAssertEqual(1, mentionsSection.mentions.count)
let soleMention = try XCTUnwrap(mentionsSection.mentions.first)
XCTAssertEqual(mentioningArticle.url, soleMention)
}
/// If there are no qualifying mentions of a symbol, the Mentioned In section should not appear.
func testMentionedInSectionEmpty() throws {
enableFeatureFlag(\.isExperimentalMentionedInEnabled)
let (bundle, context) = try createMentionedInTestBundle()
let identifier = ResolvedTopicReference(
bundleIdentifier: bundle.identifier,
path: "/documentation/MentionedIn/MyClass/myFunction()",
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
let mentionsSection = renderNode.primaryContentSections.mapFirst { $0 as? MentionsRenderSection }
XCTAssertNil(mentionsSection)
}
}
|
