File: DocumentationWorkspaceTests.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 (204 lines) | stat: -rw-r--r-- 8,622 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
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
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2021 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 XCTest
@testable import SwiftDocC

class DocumentationWorkspaceTests: XCTestCase {
    func testEmptyWorkspace() {
        let workspace = DocumentationWorkspace()
        let workspaceDelegate = SimpleWorkspaceDelegate()
        workspace.delegate = workspaceDelegate
        
        XCTAssertEqual(workspace.bundles.count, 0)
        
        XCTAssertEqual(workspaceDelegate.record, [])
        
        checkTestWorkspaceContents(workspace: workspace, bundles: [SimpleDataProvider.bundle1, SimpleDataProvider.bundle2], filled: false)
    }
    
    func testRegisterProvider() throws {
        let provider = SimpleDataProvider(bundles: [SimpleDataProvider.bundle1, SimpleDataProvider.bundle2])
        let workspace = DocumentationWorkspace()
        let workspaceDelegate = SimpleWorkspaceDelegate()
        workspace.delegate = workspaceDelegate
        
        try workspace.registerProvider(provider)
        
        let events: [SimpleWorkspaceDelegate.Event] = provider._bundles.map { .add($0.identifier) }
        
        XCTAssertEqual(workspace.bundles.count, 2)
        for bundlePair in workspace.bundles {
            XCTAssertEqual(bundlePair.key, bundlePair.value.identifier)
        }
        
        XCTAssertEqual(Set(workspace.bundles.map { $0.value.identifier }), Set(provider._bundles.map { $0.identifier }))
        XCTAssertEqual(workspaceDelegate.record, events)
        
        checkTestWorkspaceContents(workspace: workspace, bundles: provider._bundles, filled: true)
    }
    
    func testUnregisterProvider() throws {
        let provider = SimpleDataProvider(bundles: [SimpleDataProvider.bundle1, SimpleDataProvider.bundle2])
        let workspace = DocumentationWorkspace()
        let workspaceDelegate = SimpleWorkspaceDelegate()
        workspace.delegate = workspaceDelegate
        
        try workspace.registerProvider(provider)
        
        var events: [SimpleWorkspaceDelegate.Event] = provider._bundles.map { .add($0.identifier) }
        
        XCTAssertEqual(workspace.bundles.count, 2)
        for bundlePair in workspace.bundles {
            XCTAssertEqual(bundlePair.key, bundlePair.value.identifier)
        }
        
        XCTAssertEqual(Set(workspace.bundles.map { $0.value.identifier }), Set(provider._bundles.map { $0.identifier }))
        XCTAssertEqual(workspaceDelegate.record, events)
        
        checkTestWorkspaceContents(workspace: workspace, bundles: provider._bundles, filled: true)
        
        try workspace.unregisterProvider(provider)
        
        events.append(contentsOf: provider._bundles.map { .remove($0.identifier) })
        
        XCTAssertEqual(workspace.bundles.count, 0)
        XCTAssertEqual(workspaceDelegate.record, events)
        
        checkTestWorkspaceContents(workspace: workspace, bundles: provider._bundles, filled: false)
    }
    
    func testMultipleProviders() throws {
        let provider1 = SimpleDataProvider(bundles: [SimpleDataProvider.bundle1, SimpleDataProvider.bundle2])
        let workspace = DocumentationWorkspace()
        let workspaceDelegate = SimpleWorkspaceDelegate()
        workspace.delegate = workspaceDelegate
        
        try workspace.registerProvider(provider1)
        
        var events: [SimpleWorkspaceDelegate.Event] = provider1._bundles.map { .add($0.identifier) }
        
        XCTAssertEqual(workspace.bundles.count, 2)
        for bundlePair in workspace.bundles {
            XCTAssertEqual(bundlePair.key, bundlePair.value.identifier)
        }
        
        XCTAssertEqual(Set(workspace.bundles.map { $0.value.identifier }), Set(provider1._bundles.map { $0.identifier }))
        XCTAssertEqual(workspaceDelegate.record, events)
        
        checkTestWorkspaceContents(workspace: workspace, bundles: provider1._bundles, filled: true)
        
        let provider2 = SimpleDataProvider(bundles: [SimpleDataProvider.bundle3, SimpleDataProvider.bundle4])
        try workspace.registerProvider(provider2)
        
        events.append(contentsOf: provider2._bundles.map { .add($0.identifier) })
        
        XCTAssertEqual(workspace.bundles.count, 4)
        for bundlePair in workspace.bundles {
            XCTAssertEqual(bundlePair.key, bundlePair.value.identifier)
        }
        
        XCTAssertEqual(Set(workspace.bundles.map { $0.value.identifier }), Set(provider1._bundles.map { $0.identifier } + provider2._bundles.map { $0.identifier }))
        XCTAssertEqual(workspaceDelegate.record, events)
        
        checkTestWorkspaceContents(workspace: workspace, bundles: provider1._bundles + provider2._bundles, filled: true)
    }
    
    func checkTestWorkspaceContents(workspace: DocumentationWorkspace, bundles: [DocumentationBundle], filled: Bool, line: UInt = #line) {
        func check(file: URL, bundle: DocumentationBundle, line: UInt) {
            if filled {
                XCTAssertEqual(try workspace.contentsOfURL(file, in: bundle), SimpleDataProvider.files[file]!, line: line)
            } else {
                XCTAssertThrowsError(try workspace.contentsOfURL(file, in: bundle), line: line)
            }
        }
        
        for bundle in bundles {
            check(file: SimpleDataProvider.testMarkupFile, bundle: bundle, line: line)
            check(file: SimpleDataProvider.testResourceFile, bundle: bundle, line: line)
            check(file: SimpleDataProvider.testSymbolGraphFile, bundle: bundle, line: line)
        }
    }
    
    struct SimpleDataProvider: DocumentationWorkspaceDataProvider {
        let identifier: String = UUID().uuidString
        
        static let testMarkupFile = URL(fileURLWithPath: "/test.documentation/markup.md")
        static let testResourceFile = URL(fileURLWithPath: "/test.documentation/resource.png")
        static let testSymbolGraphFile = URL(fileURLWithPath: "/test.documentation/graph.json")
        
        static var files: [URL: Data] = [
            testMarkupFile: staticDataFromString("markup"),
            testResourceFile: staticDataFromString("image"),
            testSymbolGraphFile: staticDataFromString("symbols"),
        ]
        
        private static func staticDataFromString(_ string: String) -> Data {
            return string.data(using: .utf8)!
        }
        
        static func bundle(_ suffix: String) -> DocumentationBundle {
            return DocumentationBundle(
                info: DocumentationBundle.Info(
                    displayName: "Test" + suffix,
                    identifier: "com.example.test" + suffix,
                    version: "0.1.0"
                ),
                symbolGraphURLs: [testSymbolGraphFile],
                markupURLs: [testMarkupFile],
                miscResourceURLs: [testResourceFile]
            )
        }
        
        static let bundle1 = bundle("1")
        static let bundle2 = bundle("2")
        static let bundle3 = bundle("3")
        static let bundle4 = bundle("4")
        
        enum ProviderError: Error {
            case missing
        }
        
        func contentsOfURL(_ url: URL) throws -> Data {
            guard let data = SimpleDataProvider.files[url] else {
                throw ProviderError.missing
            }
            
            return data
        }
        
        var _bundles: [DocumentationBundle] = []
        
        func bundles(options: BundleDiscoveryOptions) throws -> [DocumentationBundle] {
            // Ignore the bundle discovery options. These test bundles are already built.
            return _bundles
        }
        
        init(bundles: [DocumentationBundle]) {
            self._bundles = bundles
        }
    }
    
    class SimpleWorkspaceDelegate: DocumentationContextDataProviderDelegate {
        enum Event: Equatable {
            case add(String)
            case remove(String)
        }
        var record: [Event] = []
        
        func dataProvider(_ dataProvider: DocumentationContextDataProvider, didAddBundle bundle: DocumentationBundle) throws {
            record.append(.add(bundle.identifier))
        }
        
        func dataProvider(_ dataProvider: DocumentationContextDataProvider, didRemoveBundle bundle: DocumentationBundle) throws {
            record.append(.remove(bundle.identifier))
        }
    }
}