Skip to content

Create file URLs for bundle files in TestFileSystem #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 17, 2023
Merged

Create file URLs for bundle files in TestFileSystem #661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Sources/SwiftDocCUtilities/Action/Actions/Convert/ConvertAction.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ public struct ConvertAction: Action, RecreatingContext {
engine.add(
DiagnosticConsoleWriter(
formattingOptions: formattingOptions,
baseURL: documentationBundleURL ?? URL(string: fileManager.currentDirectoryPath)
baseURL: documentationBundleURL ?? URL(fileURLWithPath: fileManager.currentDirectoryPath)
)
)
if let diagnosticFilePath = diagnosticFilePath {
Expand Down
2 changes: 1 addition & 1 deletion Tests/SwiftDocCUtilitiesTests/Utility/TestFileSystem.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class TestFileSystem: FileManagerProtocol, DocumentationWorkspaceDataProvider {
for folder in folders {
let files = try addFolder(folder)
if let info = folder.recursiveContent.mapFirst(where: { $0 as? InfoPlist }) {
let files = files.filter({ $0.hasPrefix(folder.absoluteURL.path) }).compactMap({ URL(string: $0) })
let files = files.filter({ $0.hasPrefix(folder.absoluteURL.path) }).compactMap({ URL(fileURLWithPath: $0) })

let markupFiles = files.filter({ DocumentationBundleFileTypes.isMarkupFile($0) })
let miscFiles = files.filter({ !DocumentationBundleFileTypes.isMarkupFile($0) })
Expand Down
25 changes: 25 additions & 0 deletions Tests/SwiftDocCUtilitiesTests/Utility/TestFileSystemTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,4 +259,29 @@ class TestFileSystemTests: XCTestCase {
XCTAssertFalse(fs.contentsEqual(atPath: "/main/test.txt", andPath: "/main/notclone.txt"))
XCTAssertFalse(fs.contentsEqual(atPath: "/main/test.txt", andPath: "/main/missing.txt"))
}

func testBundleUsesFileURLs() throws {
let emptySymbolGraphData = try JSONEncoder().encode(makeSymbolGraph(moduleName: "Something"))

// A docc catalog with an article, a resource, an Info.plist file, and a symbol graph file
let folders = Folder(name: "something.docc", content: [
TextFile(name: "article.md", utf8Content: ""),
DataFile(name: "image.png", data: Data()),
InfoPlist(displayName: "unit-test", identifier: "com.example"),
DataFile(name: "Something.symbols.json", data: emptySymbolGraphData)
])
let fs = try TestFileSystem(folders: [folders])

let bundles = try fs.bundles()
XCTAssertEqual(bundles.count, 1)

let bundle = try XCTUnwrap(bundles.first)
XCTAssertFalse(bundle.markupURLs.isEmpty)
XCTAssertFalse(bundle.miscResourceURLs.isEmpty)
XCTAssertFalse(bundle.symbolGraphURLs.isEmpty)

XCTAssert(bundle.markupURLs.allSatisfy(\.isFileURL))
XCTAssert(bundle.miscResourceURLs.allSatisfy(\.isFileURL))
XCTAssert(bundle.symbolGraphURLs.allSatisfy(\.isFileURL))
}
}