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
|
/*
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 SwiftDocC
@testable import SwiftDocCUtilities
class JSONEncodingRenderNodeWriterTests: XCTestCase {
/// Verifies that if we fail during writing a JSON file the execution
/// does not deadlock.
func testThrowingDuringWritingDoesNotDeadlock() throws {
let temporaryDirectory = try createTemporaryDirectory()
let indexHTML = temporaryDirectory.appendingPathComponent("index.html", isDirectory: false)
try "html".write(
to: indexHTML,
atomically: true,
encoding: .utf8
)
// Setting up the URL generator with a lengthy target folder path
// that is guaranteed to throw if we try writing a file.
let writer = JSONEncodingRenderNodeWriter(
targetFolder: URL(fileURLWithPath: String(repeating: "A", count: 4096)),
fileManager: FileManager.default,
transformForStaticHostingIndexHTML: indexHTML
)
let renderNode = RenderNode(identifier: .init(bundleIdentifier: "com.test", path: "/documentation/test", sourceLanguage: .swift), kind: .article)
// We take precautions in case we deadlock to stop the execution with a failing code.
// In case the original issue is present and we deadlock, we fatalError from a bg thread.
let didReleaseExecution = expectation(description: "Did release execution")
DispatchQueue.global(qos: .default).async {
do {
try writer.write(renderNode, encoder: RenderJSONEncoder.makeEncoder())
XCTFail("Did not throw when writing to invalid path.")
} catch {
didReleaseExecution.fulfill()
}
}
waitForExpectations(timeout: 2.0)
}
}
|
