File: DocumentationContextConverterTests.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (107 lines) | stat: -rw-r--r-- 4,595 bytes parent folder | download
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
/*
 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 DocumentationContextConverterTests: XCTestCase {
    func testRenderNodesAreIdentical() throws {
        let (bundle, context) = try testBundleAndContext(named: "TestBundle")
        
        // We'll use this to convert nodes ad-hoc
        let perNodeConverter = DocumentationNodeConverter(bundle: bundle, context: context)
        
        // We'll use these to convert nodes in bulk
        let renderContext = RenderContext(documentationContext: context, bundle: bundle)
        let bulkNodeConverter = DocumentationContextConverter(bundle: bundle, context: context, renderContext: renderContext)
        let encoder = JSONEncoder()
        
        for identifier in context.knownPages {
            let documentationNode = try XCTUnwrap(try context.entity(with: identifier))
            
            let renderNode1 = try perNodeConverter.convert(documentationNode, at: nil)
            let renderNode2 = try bulkNodeConverter.renderNode(for: documentationNode, at: nil)
            
            // Compare the two nodes are identical
            let data1 = try encoder.encode(renderNode1)
            let data2 = try encoder.encode(renderNode2)
            
            // We compare the length of the data which should allow for arrays where the element order isn't
            // significant to not produce false mismatches.
            XCTAssertEqual(data1.count, data2.count, "Encoded data didn't match for '\(identifier.absoluteString)'")
        }
    }
    
    func testSymbolLocationsAreOnlyIncludedWhenRequested() throws {
        let (bundle, context) = try testBundleAndContext(named: "TestBundle")
        let renderContext = RenderContext(documentationContext: context, bundle: bundle)
        
        let fillIntroducedSymbolNode = try XCTUnwrap(
            context.documentationCache["s:14FillIntroduced19macOSOnlyDeprecatedyyF"]
        )
        
        do {
            let documentationContextConverter = DocumentationContextConverter(
                bundle: bundle,
                context: context,
                renderContext: renderContext,
                emitSymbolSourceFileURIs: true)
            
            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(
                for: fillIntroducedSymbolNode, at: nil))
            XCTAssertEqual(renderNode.metadata.sourceFileURI, "file:///tmp/FillIntroduced.swift")
        }
        
        do {
            let documentationContextConverter = DocumentationContextConverter(
                bundle: bundle,
                context: context,
                renderContext: renderContext)
            
            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(
                for: fillIntroducedSymbolNode, at: nil))
            XCTAssertNil(renderNode.metadata.sourceFileURI)
        }
    }
    
    func testSymbolAccessLevelsAreOnlyIncludedWhenRequested() throws {
        let (bundle, context) = try testBundleAndContext(named: "TestBundle")
        let renderContext = RenderContext(documentationContext: context, bundle: bundle)
        
        let fillIntroducedSymbolNode = try XCTUnwrap(
            context.documentationCache["s:14FillIntroduced19macOSOnlyDeprecatedyyF"]
        )
        
        do {
            let documentationContextConverter = DocumentationContextConverter(
                bundle: bundle,
                context: context,
                renderContext: renderContext,
                emitSymbolAccessLevels: true
            )
            
            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(
                for: fillIntroducedSymbolNode, at: nil))
            XCTAssertEqual(renderNode.metadata.symbolAccessLevel, "public")
        }
        
        do {
            let documentationContextConverter = DocumentationContextConverter(
                bundle: bundle,
                context: context,
                renderContext: renderContext)
            
            let renderNode = try XCTUnwrap(documentationContextConverter.renderNode(
                for: fillIntroducedSymbolNode, at: nil))
            XCTAssertNil(renderNode.metadata.symbolAccessLevel)
        }
    }
}