Refactor EndToEndTests

mattt · mattt · commit 445bbd8f3909 · 2020-10-06T09:06:01.000-07:00
Create helper methods on Process and Bundle
diff --git a/Tests/EndToEndTests/EndToEndTests.swift b/Tests/EndToEndTests/EndToEndTests.swift
diff --git a/Tests/EndToEndTests/GenerateSubcommandTests.swift b/Tests/EndToEndTests/GenerateSubcommandTests.swift
@@ -0,0 +1,34 @@
+import class Foundation.Bundle
+import XCTest
+
+final class GenerateSubcommandTests: XCTestCase {
+    func testHTMLGeneration() throws {
+        let command = Bundle.productsDirectory.appendingPathComponent("swift-doc")
+        let outputDirectory = try temporaryDirectory()
+
+        defer { try? FileManager.default.removeItem(at: outputDirectory) }
+        try Process.run(command: command,
+                        arguments: [
+                            "generate",
+                            "--module-name", "SwiftDoc",
+                            "--format", "html",
+                            "--output", outputDirectory.path,
+                            "Sources"
+                        ]
+        ) { result in
+            XCTAssertEqual(result.terminationStatus, EXIT_SUCCESS)
+            XCTAssertEqual(result.output, "")
+            XCTAssertEqual(result.error, "")
+
+            do {
+                let html = try String(contentsOf: outputDirectory.appendingPathComponent("index.html"))
+                XCTAssertTrue(html.contains("<!DOCTYPE html>"))
+            }
+
+            do {
+                let css = try String(contentsOf: outputDirectory.appendingPathComponent("all.css"))
+                XCTAssertTrue(css.contains(":root"))
+            }
+        }
+    }
+}
diff --git a/Tests/EndToEndTests/Helpers/Bundle+Extensions.swift b/Tests/EndToEndTests/Helpers/Bundle+Extensions.swift
@@ -0,0 +1,14 @@
+import Foundation
+
+extension Bundle {
+    static var productsDirectory: URL = {
+        #if os(macOS)
+        for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(".xctest") {
+            return bundle.bundleURL.deletingLastPathComponent()
+        }
+        fatalError("couldn't find the products directory")
+        #else
+        return Bundle.main.bundleURL
+        #endif
+    }()
+}
diff --git a/Tests/EndToEndTests/Helpers/Process+Extensions.swift b/Tests/EndToEndTests/Helpers/Process+Extensions.swift
@@ -0,0 +1,34 @@
+import Foundation
+
+extension Process {
+    typealias Result = (terminationStatus: Int32, output: String?, error: String?)
+
+    static func run(command executableURL: URL, arguments: [String] = [], completion: (Result) throws -> Void) throws {
+        let process = Process()
+        if #available(OSX 10.13, *) {
+            process.executableURL = executableURL
+        } else {
+            process.launchPath = executableURL.path
+        }
+        process.arguments = arguments
+
+        let standardOutput = Pipe()
+        process.standardOutput = standardOutput
+
+        let standardError = Pipe()
+        process.standardError = standardError
+
+        if #available(OSX 10.13, *) {
+          try process.run()
+        } else {
+          process.launch()
+        }
+        process.waitUntilExit()
+
+        let output = String(data: standardOutput.fileHandleForReading.readDataToEndOfFile(), encoding: .utf8)
+        let error = String(data: standardError.fileHandleForReading.readDataToEndOfFile(), encoding: .utf8)
+
+        try completion((numericCast(process.terminationStatus), output, error))
+    }
+
+}
diff --git a/Tests/EndToEndTests/Helpers/temporaryDirectory.swift b/Tests/EndToEndTests/Helpers/temporaryDirectory.swift
@@ -0,0 +1,9 @@
+import Foundation
+
+func temporaryDirectory() throws -> URL {
+    let temporaryDirectoryURL = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent(ProcessInfo.processInfo.globallyUniqueString)
+    try FileManager.default.createDirectory(at: temporaryDirectoryURL, withIntermediateDirectories: true)
+
+    return temporaryDirectoryURL
+}
+
