Add integration tests for building combined documentation

swiftlang · Aug 20, 2024 · 1df6bb8 · 1df6bb8
1 parent 39d886c
commit 1df6bb8
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 1 deletion.
diff --git a/IntegrationTests/Tests/MixedTargetsTests.swift b/IntegrationTests/Tests/MixedTargetsTests.swift
@@ -78,6 +78,62 @@ final class MixedTargetsTests: ConcurrencyRequiringTestCase {
 
         XCTAssertEqual(libraryDataDirectoryContents, expectedLibraryDataFiles)
     }
+
+    func testCombinedDocumentation() throws {
+#if compiler(>=6.0)
+        let result = try swiftPackage(
+            "generate-documentation", "--target", "Executable", "--target", "Library",
+            "--enable-experimental-combined-documentation",
+            workingDirectory: try setupTemporaryDirectoryForFixture(named: "MixedTargets")
+        )
+
+        result.assertExitStatusEquals(0)
+        let outputArchives = result.referencedDocCArchives
+        XCTAssertEqual(outputArchives.count, 1)
+        XCTAssertEqual(outputArchives.map(\.lastPathComponent), [
+            "MixedTargets.doccarchive",
+        ])
+
+        let combinedArchiveURL = try XCTUnwrap(outputArchives.first)
+        let combinedDataDirectoryContents = try filesIn(.dataSubdirectory, of: combinedArchiveURL)
+            .map(\.relativePath)
+            .sorted()
+
+        XCTAssertEqual(combinedDataDirectoryContents, expectedExecutableDataFiles + expectedLibraryDataFiles)
+#else
+        XCTSkip("This test requires a Swift-DocC version that support the link-dependencies feature")
+#endif
+    }
+
+    func testCombinedDocumentationWithOutputPath() throws {
+#if compiler(>=6.0)
+        let outputDirectory = try temporaryDirectory().appendingPathComponent("output")
+
+        let result = try swiftPackage(
+            "--disable-sandbox",
+            "generate-documentation", "--target", "Executable", "--target", "Library",
+            "--enable-experimental-combined-documentation",
+            "--output-path", outputDirectory.path,
+            workingDirectory: try setupTemporaryDirectoryForFixture(named: "MixedTargets")
+        )
+
+        result.assertExitStatusEquals(0)
+        let outputArchives = result.referencedDocCArchives
+        XCTAssertEqual(outputArchives.count, 1)
+        XCTAssertEqual(outputArchives.map(\.path), [
+            outputDirectory.path
+        ])
+
+        let combinedArchiveURL = try XCTUnwrap(outputArchives.first)
+        let combinedDataDirectoryContents = try filesIn(.dataSubdirectory, of: combinedArchiveURL)
+            .map(\.relativePath)
+            .sorted()
+
+        XCTAssertEqual(combinedDataDirectoryContents, expectedExecutableDataFiles + expectedLibraryDataFiles)
+#else
+        XCTSkip("This test requires a Swift-DocC version that support the link-dependencies feature")
+#endif
+    }
 }
 
 private let expectedExecutableDataFiles = [

diff --git a/IntegrationTests/Tests/Utility/XCTestCase+swiftPackage.swift b/IntegrationTests/Tests/Utility/XCTestCase+swiftPackage.swift
@@ -150,7 +150,7 @@ struct SwiftInvocationResult {
             .components(separatedBy: .newlines)
             .reversed()
             // Gather the lines that list archive names
-            .prefix(while: { $0.hasSuffix(".doccarchive") })
+            .prefix(while: { !$0.hasPrefix("Generated ") })
             // Create absolute URLs for each archive
             .map { URL(fileURLWithPath: $0.trimmingCharacters(in: .whitespaces)) }
             // Restore the original output order