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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 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 the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import ArgumentParser
import Foundation
import SKCore
import struct TSCBasic.AbsolutePath
import class TSCBasic.Process
import class TSCUtility.PercentProgressAnimation
public struct ReduceCommand: AsyncParsableCommand {
public static let configuration: CommandConfiguration = CommandConfiguration(
commandName: "reduce",
abstract: "Reduce a single sourcekitd crash"
)
@Option(name: .customLong("request-file"), help: "Path to a sourcekitd request to reduce.")
var sourcekitdRequestPath: String
@Option(
name: .customLong("toolchain"),
help: """
The toolchain used to reduce the sourcekitd issue. \
If not specified, the toolchain is found in the same way that sourcekit-lsp finds it
"""
)
var toolchainOverride: String?
#if canImport(Darwin)
// Creating an NSPredicate from a string is not supported in corelibs-foundation.
@Option(
help: """
If the sourcekitd response matches this predicate, consider it as reproducing the issue.
sourcekitd crashes are always considered as reproducers.
The predicate is an NSPredicate. `stdout` and `stderr` are standard output and standard error of the \
sourcekitd execution using `sourcekit-lsp run-sourcekitd-request`, respectively.
"""
)
var predicate: String?
private var nsPredicate: NSPredicate? { predicate.map { NSPredicate(format: $0) } }
#else
private var nsPredicate: NSPredicate? { nil }
#endif
@MainActor
var toolchain: Toolchain? {
get async throws {
if let toolchainOverride {
return Toolchain(try AbsolutePath(validating: toolchainOverride))
}
let installPath = try AbsolutePath(validating: Bundle.main.bundlePath)
return await ToolchainRegistry(installPath: installPath).default
}
}
public init() {}
@MainActor
public func run() async throws {
guard let sourcekitd = try await toolchain?.sourcekitd else {
throw ReductionError("Unable to find sourcekitd.framework")
}
guard let swiftFrontend = try await toolchain?.swiftFrontend else {
throw ReductionError("Unable to find sourcekitd.framework")
}
let progressBar = PercentProgressAnimation(stream: stderrStreamConcurrencySafe, header: "Reducing sourcekitd issue")
let request = try String(contentsOfFile: sourcekitdRequestPath)
let requestInfo = try RequestInfo(request: request)
let executor = OutOfProcessSourceKitRequestExecutor(
sourcekitd: sourcekitd.asURL,
swiftFrontend: swiftFrontend,
reproducerPredicate: nsPredicate
)
let reduceRequestInfo = try await requestInfo.reduce(using: executor) { progress, message in
progressBar.update(step: Int(progress * 100), total: 100, text: message)
}
progressBar.complete(success: true)
let reducedSourceFile = FileManager.default.temporaryDirectory.appendingPathComponent("reduced.swift")
try reduceRequestInfo.fileContents.write(to: reducedSourceFile, atomically: true, encoding: .utf8)
print("Reduced Request:")
print(try reduceRequestInfo.request(for: reducedSourceFile))
}
}
|