Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrackwitz/CatchingFire
Test Library for Swift's Error Handling
https://github.com/mrackwitz/CatchingFire
Last synced: 3 months ago
JSON representation
Test Library for Swift's Error Handling
- Host: GitHub
- URL: https://github.com/mrackwitz/CatchingFire
- Owner: mrackwitz
- License: mit
- Created: 2015-07-09T21:59:49.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-04-04T13:03:03.000Z (almost 9 years ago)
- Last Synced: 2024-10-27T12:29:31.633Z (3 months ago)
- Language: Swift
- Size: 140 KB
- Stars: 75
- Watchers: 5
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-swift-cn - CatchingFire - Test Library for Swift's Error Handling. (Libs / Testing)
README
# CatchingFire
[](https://github.com/mrackwitz/CatchingFire/blob/master/LICENSE)
[](https://github.com/mrackwitz/CatchingFire)
CatchingFire is a Swift test framework, which helps making expectations against the error handling of your code. It provides for this purpose two higher-order functions, which take throwing functions and check whether the given closure throws or not. It integrates seamlessly with the expecters provided by `XCTest`.
## Usage
### AssertNoThrow
`AssertNoThrow` allows you to write safe tests for the happy path of failable functions.
It helps you to avoid the `try!` operator in tests.
If you want to test a function, which may fail in general, you may think of using `try`.
But this would mean that you have to declare your test method as throwing, which causes that
XCTest doesn't execute the test anymore.
So in consequence, you would usually need to write:
```swift
XCTAssertEqual(try! fib(x), 21)
```
If the expression fails, your whole test suite doesn't execute further and aborts immediately,
which is very undesirable, especially on CI, but also for your workflow when you use TDD.
Instead you can write now:
```swift
AssertNoThrow {
XCTAssertEqual(try fib(x), 21)
}
```
Or alternatively:
```swift
AssertNoThrow(try fib(x)).map { (y: Int) in
XCTAssertEqual(y, 21)
}
```
If the expression fails, your test fails.
### AssertThrow
`AssertThrow` allows to easily write exhaustive tests for the exception paths of failable functions.
It helps you to avoid writing the same boilerplate code over and over again for tests.
If you want to test a function, that it fails for given arguments, you would usually need
to write:
```swift
do {
try fib(-1)
XCTFail("Expected to fail, but did not failed!")
} catch Error.ArgumentMayNotBeNegative {
// succeed silently
} catch error {
XCTFail("Failed with a different error than expected!")
}
```
Instead you can write now:
```swift
AssertThrow(Error.ArgumentMayNotBeNegative) {
try fib(-1)
}
```
If the expression or closure doesn't throw the expected error, your test fails.
## Installation
CatchingFire is available through [CocoaPods](http://cocoapods.org). To install
it, simply add it to your test target in your Podfile:
```ruby
use_frameworks!
target "AppTest" do
pod 'CatchingFire'
end
```
## Author
Marius Rackwitz, [email protected]
Find me on Twitter as [@mrackwitz](https://twitter.com/mrackwitz).
## License
Version is available under the MIT license. See the LICENSE file for more info.