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
|
/*
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 XCTest
import Foundation
@testable import SwiftDocC
@testable import SwiftDocCUtilities
import SwiftDocCTestUtilities
class StaticHostableTransformerTests: StaticHostingBaseTests {
/// Creates a DocC archive and then archive then executes and TransformForStaticHostingAction on it to produce static content which is then validated.
func testStaticHostableTransformerOutput() throws {
// Convert a test bundle as input for the StaticHostableTransformer
let bundleURL = Bundle.module.url(forResource: "TestBundle", withExtension: "docc", subdirectory: "Test Bundles")!
let targetURL = try createTemporaryDirectory()
let fileManager = FileManager.default
let templateURL = try createTemporaryDirectory().appendingPathComponent("template")
try Folder.emptyHTMLTemplateDirectory.write(to: templateURL)
defer { try? fileManager.removeItem(at: templateURL) }
let targetBundleURL = targetURL.appendingPathComponent("Result.doccarchive")
defer { try? fileManager.removeItem(at: targetBundleURL) }
var action = try ConvertAction(
documentationBundleURL: bundleURL,
outOfProcessResolver: nil,
analyze: false,
targetDirectory: targetBundleURL,
htmlTemplateDirectory: templateURL,
emitDigest: false,
currentPlatforms: nil,
temporaryDirectory: createTemporaryDirectory()
)
_ = try action.perform(logHandle: .none)
let outputURL = try createTemporaryDirectory().appendingPathComponent("output")
let testTemplateURL = try createTemporaryDirectory().appendingPathComponent("testTemplate")
try Folder.testHTMLTemplateDirectory.write(to: testTemplateURL)
let basePath = "test/folder"
let indexHTML = Folder.testHTMLTemplate(basePath: basePath)
let indexHTMLData = try StaticHostableTransformer.indexHTMLData(in: testTemplateURL, with: basePath, fileManager: fileManager)
let dataURL = targetBundleURL.appendingPathComponent(NodeURLGenerator.Path.dataFolderName)
let dataProvider = try LocalFileSystemDataProvider(rootURL: dataURL)
let transformer = StaticHostableTransformer(dataProvider: dataProvider, fileManager: fileManager, outputURL: outputURL, indexHTMLData: indexHTMLData)
try transformer.transform()
var isDirectory: ObjCBool = false
// Test an output folder exists
guard fileManager.fileExists(atPath: outputURL.path, isDirectory: &isDirectory) else {
XCTFail("StaticHostableTransformer failed to create output folder")
return
}
// Test the output folder really is a folder.
XCTAssert(isDirectory.boolValue)
// Test the content of the output folder.
let expectedContent = ["documentation", "tutorials"]
let output = try fileManager.contentsOfDirectory(atPath: outputURL.path).sorted()
XCTAssertEqual(output, expectedContent, "Unexpected output")
for item in output {
// Test the content of the documentation and tutorial folders match the expected content from the doccarchive.
switch item {
case "documentation":
compareJSONFolder(fileManager: fileManager,
output: outputURL.appendingPathComponent("documentation"),
input: dataURL.appendingPathComponent("documentation"),
indexHTML: indexHTML)
case "tutorials":
compareJSONFolder(fileManager: fileManager,
output: outputURL.appendingPathComponent("tutorials"),
input: dataURL.appendingPathComponent("tutorials"),
indexHTML: indexHTML)
default:
continue
}
}
}
/// Creates a DocC archive and then archive then executes and TransformForStaticHostingAction on it to produce static content which is then validated.
func testStaticHostableTransformerBasePaths() throws {
let testTemplateURL = try createTemporaryDirectory().appendingPathComponent("testTemplate")
try Folder.testHTMLTemplateDirectory.write(to: testTemplateURL)
let basePaths = ["test": "test",
"/test": "test",
"test/": "test",
"/test/": "test",
"test/test": "test/test",
"/test/test": "test/test",
"test/test/": "test/test",
"/test/test/": "test/test"]
for (basePath, testValue) in basePaths {
let indexHTMLData = try StaticHostableTransformer.indexHTMLData(in: testTemplateURL, with: basePath, fileManager: FileManager.default)
let testIndexHTML = String(decoding: indexHTMLData, as: UTF8.self)
let indexHTML = Folder.testHTMLTemplate(basePath: testValue)
XCTAssertEqual(indexHTML, testIndexHTML, "Template HTML not transformed as expected")
}
}
func testStaticHostableTransformerIndexHTMLOutput() throws {
// Convert a test bundle as input for the StaticHostableTransformer
let bundleURL = Bundle.module.url(forResource: "TestBundle", withExtension: "docc", subdirectory: "Test Bundles")!
let targetURL = try createTemporaryDirectory()
let templateURL = try createTemporaryDirectory().appendingPathComponent("template")
try Folder.emptyHTMLTemplateDirectory.write(to: templateURL)
let targetBundleURL = targetURL.appendingPathComponent("Result.doccarchive")
var action = try ConvertAction(
documentationBundleURL: bundleURL,
outOfProcessResolver: nil,
analyze: false,
targetDirectory: targetBundleURL,
htmlTemplateDirectory: templateURL,
emitDigest: false,
currentPlatforms: nil,
temporaryDirectory: createTemporaryDirectory()
)
_ = try action.perform(logHandle: .none)
let dataURL = targetBundleURL.appendingPathComponent(NodeURLGenerator.Path.dataFolderName)
let dataProvider = try LocalFileSystemDataProvider(rootURL: dataURL)
let testTemplateURL = try createTemporaryDirectory().appendingPathComponent("testTemplate")
try Folder.testHTMLTemplateDirectory.write(to: testTemplateURL)
let basePaths = ["test": "test",
"/test": "test",
"test/": "test",
"/test/": "test",
"test/test": "test/test",
"/test/test": "test/test",
"test/test/": "test/test",
"/test/test/": "test/test"]
let fileManager = FileManager.default
for (basePath, testValue) in basePaths {
let outputURL = try createTemporaryDirectory().appendingPathComponent("output")
let indexHTMLData = try StaticHostableTransformer.indexHTMLData(in: testTemplateURL, with: basePath, fileManager: FileManager.default)
let transformer = StaticHostableTransformer(dataProvider: dataProvider, fileManager: fileManager, outputURL: outputURL, indexHTMLData: indexHTMLData)
try transformer.transform()
// Test an output folder exists
guard fileManager.fileExists(atPath: outputURL.path) else {
XCTFail("StaticHostableTransformer failed to create output folder")
return
}
let indexHTML = Folder.testHTMLTemplate(basePath: testValue)
try compareIndexHTML(fileManager: fileManager, folder: outputURL, indexHTML: indexHTML)
}
}
private func compareIndexHTML(fileManager: FileManagerProtocol, folder: URL, indexHTML: String) throws {
for item in try fileManager.contentsOfDirectory(atPath: folder.path) {
guard item == "index.html" else {
let subFolder = folder.appendingPathComponent(item)
try compareIndexHTML(fileManager: fileManager, folder: subFolder, indexHTML: indexHTML)
continue
}
let indexFileURL = folder.appendingPathComponent("index.html")
let testHTMLString = try String(contentsOf: indexFileURL)
XCTAssertEqual(testHTMLString, indexHTML, "Unexpected content in index.html at \(indexFileURL)")
}
}
}
|
