Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fulldump/biff
Bifurcation Framework for testing and use cases
https://github.com/fulldump/biff
Last synced: 14 days ago
JSON representation
Bifurcation Framework for testing and use cases
- Host: GitHub
- URL: https://github.com/fulldump/biff
- Owner: fulldump
- License: mit
- Created: 2018-03-28T18:35:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T00:32:50.000Z (almost 2 years ago)
- Last Synced: 2024-07-31T20:52:56.377Z (3 months ago)
- Language: Go
- Homepage:
- Size: 476 KB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - biff - Bifurcation testing framework, BDD compatible. (Testing / Testing Frameworks)
- zero-alloc-awesome-go - biff - Bifurcation testing framework, BDD compatible. (Testing / HTTP Clients)
- awesome-go - biff - Bifurcation Framework for testing and use cases - ★ 5 (Testing)
- awesome-go-extra - biff - 03-28T18:35:53Z|2021-07-18T09:38:46Z| (Testing / Testing Frameworks)
README
Biff stands for BIFurcation Framework based on nesting cases or alternatives. You can take advantage of variable scoping to make your tests simpler and easier to read. Good choice for acceptance and use cases testing, it provides a BBD style exit.
- [Getting started](#getting-started)
- [Get into the buggy line](#get-into-the-buggy-line)
- [Isolated use cases](#isolated-use-cases)
- [BDD on the fly](#bdd-on-the-fly)
- [Take advantage of go function scope](#take-advantage-of-go-function-scope)
- [Supported assertions](#supported-assertions)
- [Contribute](#contribute)
- [Testing](#testing)
- [Example project](#example-project)
## Getting started
```go
biff.Alternative("Instance service", func(a *biff.A) {
s := NewMyService()
a.Alternative("Register user", func(a *biff.A) {
john := s.RegisterUser("[email protected]", "john-123")
a.AssertNotNil(john)
a.Alternative("Bad credentials", func(a *biff.A) {
user := s.Login(john.Email, "bad-password")
a.AssertNil(user)
}).Alternative("Login", func(a *biff.A) {
user := s.Login(john.Email, john.Password)
a.AssertEqual(user, john)
})
})
})
```
Output:
```
=== RUN TestExample
Case: Instance service
Case: Register user
john is &example.User{Email:"[email protected]", Password:"john-123"}
Case: Bad credentials
user is
-------------------------------
Case: Instance service
Case: Register user
john is &example.User{Email:"[email protected]", Password:"john-123"}
Case: Login
user is &example.User{Email:"[email protected]", Password:"john-123"}
-------------------------------
Case: Instance service
Case: Register user
john is &example.User{Email:"[email protected]", Password:"john-123"}
-------------------------------
Case: Instance service
-------------------------------
--- PASS: TestExample (0.00s)
PASS
```
## Get into the buggy line
In case of error, Biff will print something like this:
```
Case: Instance service
Case: Register user
john is &example.User{Email:"[email protected]", Password:"john-123"}
Case: Login
Expected: &example.User{Email:"[email protected]", Password:"1234"}
Obtained: &example.User{Email:"[email protected]", Password:"john-123"}
at biff/example.TestExample.func1.1.2(0xc420096ac0
/home/fulldump/workspace/my-project/src/example/users_test.go:84 +0x12
```
Navigating directly to the line where the fail was produced.
## Isolated use cases
All possible bifurcations are tested in an isolated way.
## BDD on the fly
You do not need to translate your tests behaviour to natural language. Biff will navigate through the execution stack and will parse portions of your testing code to pretty print your assertions.
This testing code:
```go
a.AssertEqual(user, john)
```
will be printed as:
```
user is &example.User{Email:"[email protected]", Password:"john-123"}
```
## Take advantage of go function scope
Avoid testing helpers and auxiliar methods to maintain the status between tests,
take advantage of language varialbe scope itself to write powerful tests easy to write
and easy to read.
## Supported assertions
Most commonly used assertions are implemented:
* `AssertEqual`
* `AssertEqualJson`
* `AssertNil`
* `AssertNotNil`
* `AssertNotEqual`
* `AssertInArray`
* `AssertTrue`
* `AssertFalse`
## Contribute
Feel free to fork, make changes and pull-request to master branch.
If you prefer, [create a new issue](https://github.com/fulldump/biff/issues/new) or email me for new features, issues or whatever.
## Testing
Who will test the tester? ha ha
There are no tests for the moment but there will be, sooner than later.
## Example project
This project includes an example project with some naive business logic plus some Biff tests.