Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kylef/Spectre
BDD Framework and test runner for Swift projects and playgrounds
https://github.com/kylef/Spectre
Last synced: about 1 month ago
JSON representation
BDD Framework and test runner for Swift projects and playgrounds
- Host: GitHub
- URL: https://github.com/kylef/Spectre
- Owner: kylef
- License: bsd-2-clause
- Created: 2015-10-09T18:03:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-09-07T19:43:18.000Z (over 2 years ago)
- Last Synced: 2024-03-26T19:02:47.614Z (2 months ago)
- Language: Swift
- Homepage:
- Size: 378 KB
- Stars: 402
- Watchers: 15
- Forks: 41
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-swift - Spectre - BDD Framework. (Libs / Testing)
- awesome-swift - Spectre - BDD Framework. (Libs / Testing)
- awesome-swifty - Spectre - BDD Framework. (Libs / Testing)
- awesome-swift4 - Spectre - BDD Framework. (Libs / Testing)
- awesome-swiftqq - Spectre - BDD Framework. (Libs / Testing)
- awesome-system-swift - Spectre
- awesome-swiftxx - Spectre - BDD Framework. (Libs / Testing)
- fucking-awesome-swift - Spectre - BDD Framework. (Libs / Testing)
- awesome-swifte - Spectre - BDD Framework. (Libs / Testing)
- awesome-swift-cn - Spectre - BDD Framework for Swift. (Libs / Testing)
- awesome-swift - Spectre - BDD Framework. (Libs / Testing)
README
# Spectre
[](https://travis-ci.org/kylef/Spectre)
[*Sp*ecial *E*xecutive for *C*ommand-line *T*est *R*unning and
*E*xecution](https://en.wikipedia.org/wiki/SPECTRE).
A behavior-driven development (BDD) framework and test runner for Swift projects
and playgrounds. It's compatible with both OS X and Linux.
## Usage
```swift
describe("a person") {
let person = Person(name: "Kyle")
$0.it("has a name") {
try expect(person.name) == "Kyle"
}
$0.it("returns the name as description") {
try expect(person.description) == "Kyle"
}
}
```
### Reporters
Spectre currently has two built-in reporters, Standard and the Dot reporter.
Custom reporters are supported, make a type that conforms to `Reporter`.
- Standard
- Dot Reporter (`-t`)
- Tap Reporter (`--tap)` - [Test Anything Protocol](http://testanything.org/)-compatible output
The default reporter can be configured via an environment variable. For
example:
```shell
$ env SPECTRE_REPORTER=dot swift test
$ env SPECTRE_REPORTER=tap swift test
```
#### Standard
The standard reporter produces output as follows:
##### Passing Tests
##### Failing Tests
#### Dot
Using the `-t` argument, you can use the dot reporter.
##### Passing Tests
##### Failing Tests
### Expectation
#### Equivalence
```swift
try expect(name) == "Kyle"
try expect(name) != "Kyle"
```
#### Truthiness
```swift
try expect(alive).to.beTrue()
try expect(alive).to.beFalse()
try expect(alive).to.beNil()
```
#### Error handling
```swift
try expect(try write()).toThrow()
try expect(try write()).toThrow(FileError.NoPermission)
```
#### Comparable
```swift
try expect(5) > 2
try expect(5) >= 2
try expect(5) < 10
try expect(5) <= 10
```
#### Types
```swift
try expect("kyle").to.beOfType(String.self)
```
#### Causing a failure
```swift
throw failure("Everything is broken.")
```
#### Custom assertions
You can easily provide your own assertions, you just need to throw a
failure when the assertion does not meet expectaions.
## Examples
The following projects use Spectre:
- [Commander](https://github.com/kylef/Commander)
- [Stencil](https://github.com/stencilproject/Stencil)
## Installation / Running
### Swift Package Manager
Check out [Commander](https://github.com/kylef/Commander) as an example.
### Playground
You can use Spectre in an Xcode Playground, open `Spectre.playground` in
this repository, failures are printed in the console.
