Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/norio-nomura/xctassertcrash
Asserts that an expression crashes by using Mach Exception Handler or POSIX Signal Handler.
https://github.com/norio-nomura/xctassertcrash
ios linux macos swift testing xctassert xctest
Last synced: 11 days ago
JSON representation
Asserts that an expression crashes by using Mach Exception Handler or POSIX Signal Handler.
- Host: GitHub
- URL: https://github.com/norio-nomura/xctassertcrash
- Owner: norio-nomura
- License: mit
- Created: 2019-07-21T08:55:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-04T10:21:56.000Z (about 5 years ago)
- Last Synced: 2024-10-14T03:23:55.400Z (25 days ago)
- Topics: ios, linux, macos, swift, testing, xctassert, xctest
- Language: Swift
- Size: 63.5 KB
- Stars: 51
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# XCTAssertCrash
Asserts that an expression crashes by using Mach Exception Handler or POSIX Signal Handler.
On Apple Platforms except tvOS, it uses Mach Exception Handler.
On other Platforms like Linux or tvOS, it uses POSIX Signal Handler.
[](https://launch-editor.github.com/actions?workflowID=SwiftPM&event=pull_request&nwo=norio-nomura%2FXCTAssertCrash)
[](https://launch-editor.github.com/actions?workflowID=xcodebuild&event=pull_request&nwo=norio-nomura%2FXCTAssertCrash)
[](https://launch-editor.github.com/actions?workflowID=Nightly&event=pull_request&nwo=norio-nomura%2FXCTAssertCrash)
## Usage
```swift
/// Asserts that an expression crashes.
/// - Parameters:
/// - expression: An `expression` that can crash.
/// - message: An optional description of the failure.
/// - file: The file in which failure occurred.
/// Defaults to the file name of the test case in which this function was called.
/// - line: The line number on which failure occurred.
/// Defaults to the line number on which this function was called.
/// - signalHandler: An optional handler for signal that are produced by `expression`.
/// `SIGILL`, `SIGABRT` or `0` (if `expression` did not crash)
/// - stdoutHandler: An optional handler for stdout that are produced by `expression`.
/// - stderrHandler: An optional handler for stderr that are produced by `expression`.
/// - skipIfBeingDebugged: Skip `expression` if process is being debugged.
/// Use `skipXCTAssertCrashIfIsBeingDebugged` as default.
/// - Returns: A value of type `T?`, the result of evaluating the given `expression`.
/// `nil` if `expression` crashed.
@discardableResult
public func XCTAssertCrash(
_ expression: @escaping @autoclosure () -> T,
_ message: @autoclosure () -> String = "",
file: StaticString = #file,
line: UInt = #line,
signalHandler: (Int32) -> Void = { _ in },
stdoutHandler: (String) -> Void = { _ in },
stderrHandler: (String) -> Void = { _ in },
skipIfBeingDebugged: Bool = skipXCTAssertCrashIfIsBeingDebugged
) -> T?
```
## Limitations
### Mach Exception Handler
- `XCTAssertCrash` can not handle crashes caused by `abort()`.
- `XCTAssertCrash` can not handle a breakpoint set in expression. On detecting a stop at a breakpoint set by the debugger, `XCTAssertCrash` generates `assertionFailure()`.
### POSIX Signal Handler
- `lldb` will catch the signal and stop on crash before `XCTAssertCrash` detects it.
- **So, if the process is being debugged, `XCTAssertCrash` will skip the evaluation of the expression by default.**
To avoid this behavior,
- Set `skipXCTAssertCrashIfIsBeingDebugged` to `false`.
or
- Disable debug.
e.g. In Xcode, go to 'Edit Scheme > Test > Info' and uncheck 'Debug Executable'.
## Author
Norio Nomura
## License
This package is available under the MIT license. See the LICENSE file for more info.
## References
- [Partial functions in Swift, Part 2: Catching precondition failures](http://www.cocoawithlove.com/blog/2016/02/02/partial-functions-part-two-catching-precondition-failures.html) by Matt Gallagher
- [Friday Q&A 2013-01-11: Mach Exception Handlers](https://www.mikeash.com/pyblog/friday-qa-2013-01-11-mach-exception-handlers.html) by Landon Fuller
- Mac OS X and iOS Internals by Jonathan Levin
- [The Darwin Kernel](https://github.com/apple/darwin-xnu) by Apple