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
|
/*
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
import Foundation
@testable import SwiftDocC
@testable import SwiftDocCUtilities
import SwiftDocCTestUtilities
class TransformForStaticHostingActionTests: StaticHostingBaseTests {
/// Creates a DocC archive and then archive then executes and TransformForStaticHostingAction on it to produce static content which is then validated.
func testTransformForStaticHostingTestExternalOutput() throws {
// Convert a test bundle as input for the TransformForStaticHostingAction
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: try createTemporaryDirectory()
)
_ = try action.perform(logHandle: .none)
let outputURL = try createTemporaryDirectory()//.appendingPathComponent("output")
let basePath = "test/folder"
let testTemplateURL = try createTemporaryDirectory().appendingPathComponent("testTemplate")
let templateFolder = Folder.testHTMLTemplateDirectory
try templateFolder.write(to: testTemplateURL)
let indexHTML = Folder.testHTMLTemplate(basePath: basePath)
var transformAction = try TransformForStaticHostingAction(documentationBundleURL: targetBundleURL, outputURL: outputURL, hostingBasePath: basePath, htmlTemplateDirectory: testTemplateURL)
_ = try transformAction.perform(logHandle: .none)
let fileManager = FileManager.default
var isDirectory: ObjCBool = false
// Test an output folder exists
guard fileManager.fileExists(atPath: outputURL.path, isDirectory: &isDirectory) else {
XCTFail("TransformForStaticHostingAction failed to create output folder")
return
}
// Test the output folder really is a folder.
XCTAssert(isDirectory.boolValue)
// Test the content of the output folder.
var expectedContent = try fileManager.contentsOfDirectory(atPath: targetBundleURL.path)
expectedContent += templateFolder.content.filter { $0 is Folder }.map{ $0.name }
expectedContent += ["documentation", "tutorials"]
let output = try fileManager.contentsOfDirectory(atPath: outputURL.path)
XCTAssertEqual(Set(output), Set(expectedContent), "Unexpect 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(NodeURLGenerator.Path.documentationFolderName),
input: targetBundleURL.appendingPathComponent(NodeURLGenerator.Path.dataFolderName).appendingPathComponent(NodeURLGenerator.Path.documentationFolderName),
indexHTML: indexHTML)
case "tutorials":
compareJSONFolder(fileManager: fileManager,
output: outputURL.appendingPathComponent(NodeURLGenerator.Path.tutorialsFolderName),
input: targetBundleURL.appendingPathComponent(NodeURLGenerator.Path.dataFolderName).appendingPathComponent(NodeURLGenerator.Path.tutorialsFolderName),
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 testTransformForStaticHostingActionTestInPlaceOutput() throws {
// Convert a test bundle as input for the TransformForStaticHostingAction
let bundleURL = Bundle.module.url(forResource: "TestBundle", withExtension: "docc", subdirectory: "Test Bundles")!
let targetURL = try createTemporaryDirectory()
let fileManager = FileManager.default
try fileManager.createDirectory(at: targetURL, withIntermediateDirectories: true, attributes: nil)
defer { try? fileManager.removeItem(at: targetURL) }
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: try createTemporaryDirectory()
)
_ = try action.perform(logHandle: .none)
let basePath = "test/folder"
let testTemplateURL = try createTemporaryDirectory().appendingPathComponent("testTemplate")
let templateFolder = Folder.testHTMLTemplateDirectory
try templateFolder.write(to: testTemplateURL)
let indexHTML = Folder.testHTMLTemplate(basePath: basePath)
var expectedContent = try fileManager.contentsOfDirectory(atPath: targetBundleURL.path)
var transformAction = try TransformForStaticHostingAction(documentationBundleURL: targetBundleURL, outputURL: nil, hostingBasePath: basePath, htmlTemplateDirectory: testTemplateURL)
_ = try transformAction.perform(logHandle: .none)
var isDirectory: ObjCBool = false
// Test an output folder exists
guard fileManager.fileExists(atPath: targetBundleURL.path, isDirectory: &isDirectory) else {
XCTFail("TransformForStaticHostingAction - Output Folder not Found")
return
}
// Test the output folder really is a folder.
XCTAssert(isDirectory.boolValue)
// Test the content of the output folder.
expectedContent += templateFolder.content.filter { $0 is Folder }.map{ $0.name }
expectedContent += ["documentation", "tutorials"]
let output = try fileManager.contentsOfDirectory(atPath: targetBundleURL.path)
XCTAssertEqual(Set(output), Set(expectedContent), "Unexpect 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: targetBundleURL.appendingPathComponent(NodeURLGenerator.Path.documentationFolderName),
input: targetBundleURL.appendingPathComponent(NodeURLGenerator.Path.dataFolderName).appendingPathComponent(NodeURLGenerator.Path.documentationFolderName),
indexHTML: indexHTML)
case "tutorials":
compareJSONFolder(fileManager: fileManager,
output: targetBundleURL.appendingPathComponent(NodeURLGenerator.Path.tutorialsFolderName),
input: targetBundleURL.appendingPathComponent(NodeURLGenerator.Path.dataFolderName).appendingPathComponent(NodeURLGenerator.Path.tutorialsFolderName),
indexHTML: indexHTML)
default:
continue
}
}
}
}
|
