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
|
/*
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 XCTest
import Foundation
@testable import SwiftDocC
@testable import SwiftDocCUtilities
class ConvertActionIndexerTests: XCTestCase {
// Tests the standalone indexer
func testConvertActionIndexer() throws {
let originalURL = Bundle.module.url(
forResource: "TestBundle", withExtension: "docc", subdirectory: "Test Bundles")!
// Create temo folder.
let url = try createTemporaryDirectory()
// Copy TestBundle into a temp folder
let testBundleURL = url.appendingPathComponent("TestBundle.docc")
try FileManager.default.copyItem(at: originalURL, to: testBundleURL)
// Load the test bundle
let workspace = DocumentationWorkspace()
let context = try DocumentationContext(dataProvider: workspace)
let dataProvider = try LocalFileSystemDataProvider(rootURL: testBundleURL)
try workspace.registerProvider(dataProvider)
guard !context.registeredBundles.isEmpty else {
XCTFail("Didn't load test bundle in test.")
return
}
let converter = DocumentationNodeConverter(bundle: context.registeredBundles.first!, context: context)
// Add /documentation/MyKit to the index, verify the tree dump
do {
let reference = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/MyKit", sourceLanguage: .swift)
let renderNode = try converter.convert(context.entity(with: reference), at: nil)
try FileManager.default.createDirectory(at: testBundleURL.appendingPathComponent("index1"), withIntermediateDirectories: false, attributes: nil)
let indexer = try ConvertAction.Indexer(outputURL: testBundleURL.appendingPathComponent("index1"), bundleIdentifier: context.registeredBundles.first!.identifier)
indexer.index(renderNode)
XCTAssertTrue(indexer.finalize(emitJSON: false, emitLMDB: false).isEmpty)
let treeDump = try XCTUnwrap(indexer.dumpTree())
XCTAssertEqual(treeDump, """
[Root]
┗╸Swift
┗╸MyKit
┣╸Basics
┣╸MyKit in Practice
┣╸Global symbols
┗╸Extensions to other frameworks
""")
}
// Add two nodes /documentation/MyKit and /documentation/Test-Bundle/Default-Code-Listing-Syntax to the index
// and verify the tree.
do {
let reference1 = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/MyKit", sourceLanguage: .swift)
let renderNode1 = try converter.convert(context.entity(with: reference1), at: nil)
let reference2 = ResolvedTopicReference(bundleIdentifier: "org.swift.docc.example", path: "/documentation/Test-Bundle/Default-Code-Listing-Syntax", sourceLanguage: .swift)
let renderNode2 = try converter.convert(context.entity(with: reference2), at: nil)
try FileManager.default.createDirectory(at: testBundleURL.appendingPathComponent("index2"), withIntermediateDirectories: false, attributes: nil)
let indexer = try ConvertAction.Indexer(outputURL: testBundleURL.appendingPathComponent("index2"), bundleIdentifier: context.registeredBundles.first!.identifier)
indexer.index(renderNode1)
indexer.index(renderNode2)
XCTAssertTrue(indexer.finalize(emitJSON: false, emitLMDB: false).isEmpty)
let treeDump = try XCTUnwrap(indexer.dumpTree())
XCTAssertEqual(treeDump, """
[Root]
┗╸Swift
┗╸MyKit
┣╸Basics
┣╸MyKit in Practice
┣╸Default Code Listing Syntax
┣╸Global symbols
┗╸Extensions to other frameworks
""")
}
}
}
|
