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
|
/*
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 ArgumentParser
@testable import SwiftDocCUtilities
@testable import SwiftDocC
import SwiftDocCTestUtilities
class MergeSubcommandTests: XCTestCase {
func testCommandLineArgumentValidation() throws {
let originalMergeCommandFileManager = Docc.Merge._fileManager
defer {
Docc.Merge._fileManager = originalMergeCommandFileManager
}
_ = try TestFileSystem(folders: [])
// No input
XCTAssertThrowsError(try Docc.Merge.parse([])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "Missing expected argument '<archive-path> ...'")
}
Docc.Merge._fileManager = try TestFileSystem(folders: [])
// Input archive with unexpected path extension
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/not-an-archive"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "Missing 'doccarchive' path extension for archive '/path/to/not-an-archive'")
}
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/not-an-archive.something"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "Path extension 'something' is not 'doccarchive' for archive '/path/to/not-an-archive.something'")
}
// Missing input
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/First.doccarchive"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "No directory exists at '/path/to/First.doccarchive'")
}
// Found archive input
var fileSystem = try TestFileSystem(folders: [
Folder(name: "path", content: [
Folder(name: "to", content: [
Folder(name: "First.doccarchive", content: []),
Folder(name: "Second.doccarchive", content: []),
])
])
])
Docc.Merge._fileManager = fileSystem
XCTAssertNoThrow(try Docc.Merge.parse(["/path/to/First.doccarchive"]))
do {
let command = try Docc.Merge.parse(["/path/to/First.doccarchive", "/path/to/Second.doccarchive"])
XCTAssertEqual(command.archives, [
URL(fileURLWithPath: "/path/to/First.doccarchive"),
URL(fileURLWithPath: "/path/to/Second.doccarchive"),
])
XCTAssertNil(command.landingPageCatalog)
XCTAssertEqual(command.outputURL, URL(fileURLWithPath: fileSystem.currentDirectoryPath).appendingPathComponent("Combined.doccarchive", isDirectory: true))
}
// Incomplete catalog argument
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/First.doccarchive", "--landing-page-catalog"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "Missing value for '--landing-page-catalog <catalog-path>'")
}
// Input catalog with unexpected path extension
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/First.doccarchive", "--landing-page-catalog", "/path/to/not-a-catalog"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "Missing 'docc' path extension for catalog '/path/to/not-a-catalog'")
}
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/First.doccarchive", "--landing-page-catalog", "/path/to/not-a-catalog.something"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "Path extension 'something' is not 'docc' for catalog '/path/to/not-a-catalog.something'")
}
// Missing input catalog
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/First.doccarchive", "--landing-page-catalog", "/path/to/LandingPage.docc"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "No directory exists at '/path/to/LandingPage.docc'")
}
// Found catalog input
fileSystem = try TestFileSystem(folders: [
Folder(name: "path", content: [
Folder(name: "to", content: [
Folder(name: "First.doccarchive", content: []),
Folder(name: "Second.doccarchive", content: []),
Folder(name: "LandingPage.docc", content: []),
])
])
])
Docc.Merge._fileManager = fileSystem
XCTAssertNoThrow(try Docc.Merge.parse(["/path/to/First.doccarchive", "--landing-page-catalog", "/path/to/LandingPage.docc"]))
do {
let command = try Docc.Merge.parse([
"/path/to/First.doccarchive",
"/path/to/Second.doccarchive",
"--landing-page-catalog", "/path/to/LandingPage.docc"
])
XCTAssertEqual(command.archives, [
URL(fileURLWithPath: "/path/to/First.doccarchive"),
URL(fileURLWithPath: "/path/to/Second.doccarchive"),
])
XCTAssertEqual(command.landingPageCatalog, URL(fileURLWithPath: "/path/to/LandingPage.docc"))
XCTAssertEqual(command.outputURL, URL(fileURLWithPath: fileSystem.currentDirectoryPath).appendingPathComponent("Combined.doccarchive", isDirectory: true))
}
// Incomplete output argument
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/First.doccarchive", "--output-path"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "Missing value for '--output-path <output-path>'")
}
// Unexpected path extension for output argument
XCTAssertThrowsError(try Docc.Merge.parse(["/path/to/First.doccarchive", "--output-path", "/other/path/to/output-dir"])) { error in
XCTAssertEqual(Docc.Merge.message(for: error), "Missing intermediate directory at '/other/path/to' for output path")
}
// Found output path
fileSystem = try TestFileSystem(folders: [
Folder(name: "path", content: [
Folder(name: "to", content: [
Folder(name: "First.doccarchive", content: []),
Folder(name: "Second.doccarchive", content: []),
Folder(name: "LandingPage.docc", content: []),
])
]),
Folder(name: "other", content: [
Folder(name: "path", content: [
Folder(name: "to", content: [
// Intentionally empty
])
])
])
])
Docc.Merge._fileManager = fileSystem
XCTAssertNoThrow(try Docc.Merge.parse(["/path/to/First.doccarchive", "--output-path", "/other/path/to/output-dir"]))
do {
let command = try Docc.Merge.parse([
"/path/to/First.doccarchive",
"/path/to/Second.doccarchive",
"--landing-page-catalog", "/path/to/LandingPage.docc",
"--output-path", "/other/path/to/output-dir"
])
XCTAssertEqual(command.archives, [
URL(fileURLWithPath: "/path/to/First.doccarchive"),
URL(fileURLWithPath: "/path/to/Second.doccarchive"),
])
XCTAssertEqual(command.landingPageCatalog, URL(fileURLWithPath: "/path/to/LandingPage.docc"))
XCTAssertEqual(command.outputURL, URL(fileURLWithPath: "/other/path/to/output-dir"))
}
}
}
|