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 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
@testable import Basics
import SPMTestSupport
import XCTest
import class Basics.AsyncProcess
final class CancellatorTests: XCTestCase {
func testHappyCase() throws {
let observability = ObservabilitySystem.makeForTesting()
let cancellator = Cancellator(observabilityScope: observability.topScope)
let worker = Worker(name: "test")
cancellator.register(name: worker.name, handler: worker.cancel)
let startSemaphore = DispatchSemaphore(value: 0)
let finishSemaphore = DispatchSemaphore(value: 0)
let finishDeadline = DispatchTime.now() + .seconds(5)
DispatchQueue.sharedConcurrent.async() {
startSemaphore.signal()
defer { finishSemaphore.signal() }
if case .timedOut = worker.work(deadline: finishDeadline) {
XCTFail("worker \(worker.name) timed out")
}
}
XCTAssertEqual(.success, startSemaphore.wait(timeout: .now() + .seconds(1)), "timeout starting tasks")
let cancelled = cancellator._cancel(deadline: finishDeadline + .seconds(5))
XCTAssertEqual(cancelled, 1)
XCTAssertEqual(.success, finishSemaphore.wait(timeout: finishDeadline + .seconds(5)), "timeout finishing tasks")
XCTAssertNoDiagnostics(observability.diagnostics)
}
func testTSCProcess() throws {
#if os(macOS)
try withTemporaryDirectory { temporaryDirectory in
let scriptPath = temporaryDirectory.appending("script")
try localFileSystem.writeFileContents(
scriptPath,
string: """
set -e
echo "process started"
sleep 10
echo "exit normally"
"""
)
let observability = ObservabilitySystem.makeForTesting()
let cancellator = Cancellator(observabilityScope: observability.topScope)
// outputRedirection used to signal that the process started
let startSemaphore = ProcessStartedSemaphore(term: "process started")
let process = AsyncProcess(
arguments: ["bash", scriptPath.pathString],
outputRedirection: .stream(
stdout: startSemaphore.handleOutput,
stderr: startSemaphore.handleOutput
)
)
let registrationKey = cancellator.register(process)
XCTAssertNotNil(registrationKey)
let finishSemaphore = DispatchSemaphore(value: 0)
DispatchQueue.sharedConcurrent.async {
defer { finishSemaphore.signal() }
do {
try process.launch()
let result = try process.waitUntilExit()
print("process finished")
XCTAssertEqual(result.exitStatus, .signalled(signal: SIGINT))
} catch {
XCTFail("failed launching process: \(error)")
}
}
XCTAssertEqual(.success, startSemaphore.wait(timeout: .now() + .seconds(5)), "timeout starting tasks")
print("process started")
let canncelled = cancellator._cancel(deadline: .now() + .seconds(1))
XCTAssertEqual(canncelled, 1)
XCTAssertEqual(.success, finishSemaphore.wait(timeout: .now() + .seconds(5)), "timeout finishing tasks")
XCTAssertNoDiagnostics(observability.diagnostics)
}
#else
try XCTSkipIf(true, "skipping on non-macOS, signal traps do not work well on docker")
#endif
}
func testTSCProcessForceKill() throws {
#if os(macOS)
try withTemporaryDirectory { temporaryDirectory in
let scriptPath = temporaryDirectory.appending("script")
try localFileSystem.writeFileContents(
scriptPath,
string: """
set -e
trap_handler() {
echo "SIGINT trap"
sleep 10
echo "exit SIGINT trap"
}
echo "process started"
trap trap_handler SIGINT
echo "trap installed"
sleep 10
echo "exit normally"
"""
)
let observability = ObservabilitySystem.makeForTesting()
let cancellator = Cancellator(observabilityScope: observability.topScope)
// outputRedirection used to signal that the process SIGINT traps have been set up
let startSemaphore = ProcessStartedSemaphore(term: "trap installed")
let process = AsyncProcess(
arguments: ["bash", scriptPath.pathString],
outputRedirection: .stream(
stdout: startSemaphore.handleOutput,
stderr: startSemaphore.handleOutput
)
)
let registrationKey = cancellator.register(process)
XCTAssertNotNil(registrationKey)
let finishSemaphore = DispatchSemaphore(value: 0)
DispatchQueue.sharedConcurrent.async {
defer { finishSemaphore.signal() }
do {
try process.launch()
let result = try process.waitUntilExit()
print("process finished")
XCTAssertEqual(result.exitStatus, .signalled(signal: SIGKILL))
} catch {
XCTFail("failed launching process: \(error)")
}
}
XCTAssertEqual(.success, startSemaphore.wait(timeout: .now() + .seconds(5)), "timeout starting tasks")
print("process started")
let cancelled = cancellator._cancel(deadline: .now() + .seconds(1))
XCTAssertEqual(cancelled, 1)
XCTAssertEqual(.success, finishSemaphore.wait(timeout: .now() + .seconds(5)), "timeout finishing tasks")
XCTAssertNoDiagnostics(observability.diagnostics)
}
#else
try XCTSkipIf(true, "skipping on non-macOS, signal traps do not work well on docker")
#endif
}
func testFoundationProcess() throws {
#if os(macOS)
try withTemporaryDirectory { temporaryDirectory in
let scriptPath = temporaryDirectory.appending("script")
try localFileSystem.writeFileContents(
scriptPath,
string: """
set -e
echo "process started"
sleep 10
echo "exit normally"
"""
)
let observability = ObservabilitySystem.makeForTesting()
let cancellator = Cancellator(observabilityScope: observability.topScope)
// pipe used to signal that the process started
let startSemaphore = ProcessStartedSemaphore(term: "process started")
let process = Foundation.Process()
process.executableURL = URL(fileURLWithPath: "/bin/bash")
process.arguments = [scriptPath.pathString]
let stdoutPipe = Pipe()
stdoutPipe.fileHandleForReading.readabilityHandler = { fileHandle in
startSemaphore.handleOutput([UInt8](fileHandle.availableData))
}
let stderrPipe = Pipe()
stderrPipe.fileHandleForReading.readabilityHandler = { fileHandle in
startSemaphore.handleOutput([UInt8](fileHandle.availableData))
}
process.standardOutput = stdoutPipe
process.standardError = stderrPipe
let registrationKey = cancellator.register(process)
XCTAssertNotNil(registrationKey)
let finishSemaphore = DispatchSemaphore(value: 0)
DispatchQueue.sharedConcurrent.async {
defer { finishSemaphore.signal() }
process.launch()
process.waitUntilExit()
print("process finished")
XCTAssertEqual(process.terminationStatus, SIGINT)
}
XCTAssertEqual(.success, startSemaphore.wait(timeout: .now() + .seconds(5)), "timeout starting tasks")
print("process started")
let canncelled = cancellator._cancel(deadline: .now() + .seconds(1))
XCTAssertEqual(canncelled, 1)
XCTAssertEqual(.success, finishSemaphore.wait(timeout: .now() + .seconds(5)), "timeout finishing tasks")
print(startSemaphore.output)
XCTAssertNoDiagnostics(observability.diagnostics)
}
#else
try XCTSkipIf(true, "skipping on non-macOS, signal traps do not work well on docker")
#endif
}
func testFoundationProcessForceKill() throws {
#if os(macOS)
try withTemporaryDirectory { temporaryDirectory in
let scriptPath = temporaryDirectory.appending("script")
try localFileSystem.writeFileContents(
scriptPath,
string: """
set -e
trap_handler() {
echo "SIGINT trap"
sleep 10
echo "exit SIGINT trap"
}
echo "process started"
trap trap_handler SIGINT
echo "trap installed"
sleep 10
echo "exit normally"
"""
)
let observability = ObservabilitySystem.makeForTesting()
let cancellator = Cancellator(observabilityScope: observability.topScope)
// pipe used to signal that the process SIGINT traps have been set up
let startSemaphore = ProcessStartedSemaphore(term: "trap installed")
let process = Foundation.Process()
process.executableURL = URL(fileURLWithPath: "/bin/bash")
process.arguments = [scriptPath.pathString]
let stdoutPipe = Pipe()
stdoutPipe.fileHandleForReading.readabilityHandler = { fileHandle in
startSemaphore.handleOutput([UInt8](fileHandle.availableData))
}
let stderrPipe = Pipe()
stderrPipe.fileHandleForReading.readabilityHandler = { fileHandle in
startSemaphore.handleOutput([UInt8](fileHandle.availableData))
}
process.standardOutput = stdoutPipe
process.standardError = stderrPipe
let registrationKey = cancellator.register(process)
XCTAssertNotNil(registrationKey)
let finishSemaphore = DispatchSemaphore(value: 0)
DispatchQueue.sharedConcurrent.async {
defer { finishSemaphore.signal() }
process.launch()
process.waitUntilExit()
print("process finished")
XCTAssertEqual(process.terminationStatus, SIGTERM)
}
XCTAssertEqual(.success, startSemaphore.wait(timeout: .now() + .seconds(5)), "timeout starting tasks")
print("process started")
print(startSemaphore.output)
let cancelled = cancellator._cancel(deadline: .now() + .seconds(1))
XCTAssertEqual(cancelled, 1)
XCTAssertEqual(.success, finishSemaphore.wait(timeout: .now() + .seconds(5)), "timeout finishing tasks")
XCTAssertNoDiagnostics(observability.diagnostics)
}
#else
try XCTSkipIf(true, "skipping on non-macOS, signal traps do not work well on docker")
#endif
}
func testConcurrency() throws {
let observability = ObservabilitySystem.makeForTesting()
let cancellator = Cancellator(observabilityScope: observability.topScope)
let total = Concurrency.maxOperations
let workers: [Worker] = (0 ..< total).map { index in
let worker = Worker(name: "worker \(index)")
cancellator.register(name: worker.name, handler: worker.cancel)
return worker
}
let startGroup = DispatchGroup()
let finishGroup = DispatchGroup()
let finishDeadline = DispatchTime.now() + .seconds(5)
let results = ThreadSafeKeyValueStore<String, DispatchTimeoutResult>()
for worker in workers {
startGroup.enter()
DispatchQueue.sharedConcurrent.async(group: finishGroup) {
startGroup.leave()
results[worker.name] = worker.work(deadline: finishDeadline)
}
}
XCTAssertEqual(.success, startGroup.wait(timeout: .now() + .seconds(1)), "timeout starting tasks")
let cancelled = cancellator._cancel(deadline: finishDeadline + .seconds(5))
XCTAssertEqual(cancelled, total)
XCTAssertEqual(.success, finishGroup.wait(timeout: finishDeadline + .seconds(5)), "timeout finishing tasks")
XCTAssertEqual(results.count, total)
for (name, result) in results.get() {
if case .timedOut = result {
XCTFail("worker \(name) timed out")
}
}
XCTAssertNoDiagnostics(observability.diagnostics)
}
func testTimeout() throws {
struct Worker {
func work() {}
func cancel() {
Thread.sleep(forTimeInterval: 5)
}
}
let observability = ObservabilitySystem.makeForTesting()
let cancellator = Cancellator(observabilityScope: observability.topScope)
let worker = Worker()
cancellator.register(name: "test", handler: worker.cancel)
let startSemaphore = DispatchSemaphore(value: 0)
DispatchQueue.sharedConcurrent.async {
startSemaphore.signal()
worker.work()
}
XCTAssertEqual(.success, startSemaphore.wait(timeout: .now() + .seconds(1)), "timeout starting tasks")
let cancelled = cancellator._cancel(deadline: .now() + .seconds(1))
XCTAssertEqual(cancelled, 0)
testDiagnostics(observability.diagnostics) { result in
result.check(
diagnostic: .contains("timeout waiting for cancellation"),
severity: .warning
)
}
}
}
fileprivate struct Worker {
let name: String
let semaphore = DispatchSemaphore(value: 0)
init(name: String) {
self.name = name
}
func work(deadline: DispatchTime) -> DispatchTimeoutResult {
print("\(self.name) work")
return self.semaphore.wait(timeout: deadline)
}
func cancel() {
print("\(self.name) cancel")
self.semaphore.signal()
}
}
class ProcessStartedSemaphore {
let term: String
let underlying = DispatchSemaphore(value: 0)
let lock = NSLock()
var trapped = false
var output = ""
init(term: String) {
self.term = term
}
func handleOutput(_ bytes: [UInt8]) {
self.lock.withLock {
guard !self.trapped else {
return
}
if let output = String(bytes: bytes, encoding: .utf8) {
self.output += output
}
if self.output.contains(self.term) {
self.trapped = true
self.underlying.signal()
}
}
}
func wait(timeout: DispatchTime) -> DispatchTimeoutResult {
self.underlying.wait(timeout: timeout)
}
}
|