Skip to content
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

Jump to bottom

Remove long disabled integration test #1034

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+0 −471
Open

Remove long disabled integration test #1034

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
159 changes: 0 additions & 159 deletions Tests/SwiftDocCUtilitiesTests/PreviewActionIntegrationTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,6 @@ import XCTest
import SwiftDocCTestUtilities

class PreviewActionIntegrationTests: XCTestCase {
func json(contentsOf url: URL) throws -> [String: Any] {
let data = try Data(contentsOf: url)
guard let result = try JSONSerialization.jsonObject(with: data, options: []) as? [String: Any] else {
XCTFail("Failed to load JSON from \(url.path)")
return [:]
}
return result
}

private func createMinimalDocsBundle() -> Folder {
let overviewURL = Bundle.module.url(
forResource: "Overview", withExtension: "tutorial", subdirectory: "Test Resources")!
Expand Down Expand Up @@ -72,156 +63,6 @@ class PreviewActionIntegrationTests: XCTestCase {
return (sourceURL: sourceURL, outputURL: outputURL, templateURL: templateURL)
}

/// Test the fix for <rdar://problem/48615392>.
func testWatchRecoversAfterConversionErrors() throws {
#if os(macOS)
throw XCTSkip("This test is flaky rdar://90866510")

// // Source files.
// let source = createMinimalDocsBundle()
// let (sourceURL, outputURL, templateURL) = try createPreviewSetup(source: source)
//
// let logStorage = LogHandle.LogStorage()
// var logHandle = LogHandle.memory(logStorage)
//
// let convertActionTempDirectory = try createTemporaryDirectory()
// let createConvertAction = {
// try ConvertAction(
// documentationBundleURL: sourceURL,
// outOfProcessResolver: nil,
// analyze: false,
// targetDirectory: outputURL,
// htmlTemplateDirectory: templateURL,
// emitDigest: false,
// currentPlatforms: nil,
// fileManager: FileManager.default,
// temporaryDirectory: convertActionTempDirectory)
// }
//
// guard let preview = try? PreviewAction(
// tlsCertificateKey: nil,
// tlsCertificateChain: nil,
// serverUsername: nil,
// serverPassword: nil,
// port: 8080, // We ignore this value when we set the `bindServerToSocketPath` property below.
// createConvertAction: createConvertAction) else {
// XCTFail("Could not create preview action from parameters")
// return
// }
//
// let socketURL = try createTemporaryDirectory().appendingPathComponent("sock")
// preview.bindServerToSocketPath = socketURL.path
//
// // The technology output file URL
// let convertedOverviewURL = outputURL
// .appendingPathComponent("data")
// .appendingPathComponent("tutorials")
// .appendingPathComponent("Overview.json")
//
// // Start watching the source and get the initial (successful) state.
// do {
// let logOutputExpectation = asyncLogExpectation(log: logStorage, description: "Did produce log output") { $0.contains("=======") }
//
// // Start the preview and keep it running for the asserts that follow inside this test.
// DispatchQueue.global().async {
// var action = preview as Action
// do {
// let result = try action.perform(logHandle: logHandle)
//
// guard !result.problems.containsErrors else {
// throw ErrorsEncountered()
// }
//
// if !result.problems.isEmpty {
// print(result.problems.localizedDescription, to: &logHandle)
// }
// } catch {
// XCTFail(error.localizedDescription)
// }
// }
//
// wait(for: [logOutputExpectation], timeout: 20.0)
//
// // Check the log output to confirm that expected informational
// // text is printed
// let logOutput = logStorage.text
//
// // rdar://71318888
// let expectedLogIntroductoryOutput = """
// Input: \(sourceURL.path)
// Template: \(templateURL.path)
// """
// XCTAssertTrue(logOutput.hasPrefix(expectedLogIntroductoryOutput), """
// Missing expected input and template information in log/print output
// """)
//
// if let previewInfoStart = logOutput.range(of: "=====\n")?.upperBound,
// let previewInfoEnd = logOutput[previewInfoStart...].range(of: "\n=====")?.lowerBound {
// XCTAssertEqual(logOutput[previewInfoStart..<previewInfoEnd], """
// Starting Local Preview Server
// \t Address: http://localhost:8080/documentation/mykit
// \t http://localhost:8080/tutorials/overview
// """)
// } else {
// XCTFail("Missing preview information in log/print output")
// }
//
// XCTAssertTrue(FileManager.default.fileExists(atPath: convertedOverviewURL.path, isDirectory: nil))
// }
//
// // Verify conversion result.
// let json1 = try json(contentsOf: convertedOverviewURL)
// guard let sections = json1["sections"] as? [[String: Any]],
// let intro = sections.first( where: { $0["kind"] as? String == "hero" }),
// let initialIntroTitle = intro["title"] as? String else {
// XCTFail("Couldn't parse converted markdown")
// return
// }
//
// XCTAssertEqual(initialIntroTitle, "Technology X")
//
// let invalidJSONSymbolGraphURL = sourceURL.appendingPathComponent("invalid-incomplete-data.symbols.json")
//
// // Start watching the source and detect failed conversion.
// do {
// let outputExpectation = asyncLogExpectation(log: logStorage, description: "Did produce output") { $0.contains("Compilation failed") }
//
// // this is invalid JSON and will result in an error
// try "{".write(to: invalidJSONSymbolGraphURL, atomically: true, encoding: .utf8)
//
// // Wait for watch to produce output.
// wait(for: [outputExpectation], timeout: 20.0)
// }
//
// // Start watching the source and detect recovery and successful conversion after a failure.
// do {
// let outputExpectation = asyncLogExpectation(log: logStorage, description: "Did finish conversion") { $0.contains("Done") }
//
// try FileManager.default.removeItem(at: invalidJSONSymbolGraphURL)
//
// // Wait for watch to produce output.
// wait(for: [outputExpectation], timeout: 20.0)
//
// // Check conversion result.
// let finalJSON = try json(contentsOf: convertedOverviewURL)
// guard let sections = finalJSON["sections"] as? [[String: Any]],
// let intro = sections.first( where: { $0["kind"] as? String == "hero" }),
// let finalIntroTitle = intro["title"] as? String else {
// XCTFail("Couldn't parse converted markdown")
// return
// }
// XCTAssertEqual(finalIntroTitle, "Technology X")
// }
//
// // Make sure to stop the preview process so it doesn't stay alive on the machine running the tests.
// try preview.stop()
//
// try FileManager.default.removeItem(at: sourceURL)
// try FileManager.default.removeItem(at: outputURL)
// try FileManager.default.removeItem(at: templateURL)
#endif
}

class MemoryOutputChecker {
init(storage: LogHandle.LogStorage, expectation: XCTestExpectation, condition: @escaping (String)->Bool) {
self.storage = storage
Expand Down
102 changes: 0 additions & 102 deletions Tests/SwiftDocCUtilitiesTests/PreviewServer/HTTPClient.swift
View file
Open in desktop

This file was deleted.

Loading