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) 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 XCTest
import Foundation
@testable import SwiftDocCUtilities
import SwiftDocCTestUtilities
class EmitGeneratedCurationsActionTests: XCTestCase {
func testWritesDocumentationExtensionFilesToOutputDir() async throws {
// This can't be in the test file system because `LocalFileSystemDataProvider` doesn't support `FileManagerProtocol`.
let realCatalogURL = try XCTUnwrap(Bundle.module.url(forResource: "MixedLanguageFramework", withExtension: "docc", subdirectory: "Test Bundles"))
func assertOutput(
initialContent: [File],
depthLimit: Int?,
startingPointSymbolLink: String?,
expectedFilesList: [String],
file: StaticString = #file,
line: UInt = #line
) async throws {
let fs = try TestFileSystem(folders: [
Folder(name: "input", content: [
CopyOfFolder(original: realCatalogURL)
]),
Folder(name: "output", content: initialContent),
])
let catalogURL = URL(fileURLWithPath: "/input/MixedLanguageFramework.docc")
let outputDir = URL(fileURLWithPath: "/output/Output.doccarchive")
let action = try EmitGeneratedCurationAction(
documentationCatalog: catalogURL,
additionalSymbolGraphDirectory: nil,
outputURL: outputDir,
depthLimit: depthLimit,
startingPointSymbolLink: startingPointSymbolLink,
fileManager: fs
)
_ = try await action.perform(logHandle: .none)
XCTAssertEqual(try fs.recursiveContentsOfDirectory(atPath: "/output").sorted(), expectedFilesList, file: file, line: line)
}
try await assertOutput(initialContent: [], depthLimit: 0, startingPointSymbolLink: nil, expectedFilesList: [
"Output.doccarchive",
"Output.doccarchive/MixedLanguageFramework.md",
])
try await assertOutput(initialContent: [], depthLimit: nil, startingPointSymbolLink: nil, expectedFilesList: [
"Output.doccarchive",
"Output.doccarchive/MixedLanguageFramework",
"Output.doccarchive/MixedLanguageFramework.md",
"Output.doccarchive/MixedLanguageFramework/Bar.md",
"Output.doccarchive/MixedLanguageFramework/Foo-swift.struct.md",
"Output.doccarchive/MixedLanguageFramework/SwiftOnlyStruct.md",
])
try await assertOutput(initialContent: [], depthLimit: nil, startingPointSymbolLink: "Foo-struct", expectedFilesList: [
"Output.doccarchive",
"Output.doccarchive/MixedLanguageFramework",
"Output.doccarchive/MixedLanguageFramework/Foo-swift.struct.md",
])
}
}
|
