Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bayashi/actually
A testing library focused on turning failure into success
https://github.com/bayashi/actually
actually assertion assertions go go-testing golang golang-testing testing testing-golang
Last synced: about 2 months ago
JSON representation
A testing library focused on turning failure into success
- Host: GitHub
- URL: https://github.com/bayashi/actually
- Owner: bayashi
- License: mit
- Created: 2023-04-09T22:53:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-02T16:12:32.000Z (4 months ago)
- Last Synced: 2024-10-11T21:19:14.282Z (2 months ago)
- Topics: actually, assertion, assertions, go, go-testing, golang, golang-testing, testing, testing-golang
- Language: Go
- Homepage: https://github.com/bayashi/actually/wiki
- Size: 250 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Actually
A testing library focused on turning failure into success, `actually`.
* Builder interface to make test code obvious
* Consistent method name to reduce things you have to remember
* Specific fail report to save your time
* There are helpers to see details of a failure
## Usage
```go
package main // https://go.dev/play/p/d57qXq3q6dl
import (
"testing"
a "github.com/bayashi/actually"
)
func Test(t *testing.T) {
love, err := getLove()
// Assert 1 object
a.Got(err).NoError(t)
a.Got(love).True(t)
// Assert 2 objects
heart := &love
body := heart
a.Got(heart).Expect(body).SamePointer(t)
}
func getLove() (bool, error) {
return true, nil
}
```
## Assertions
### [For 1 object](https://github.com/bayashi/actually/wiki/All-assertion-methods#assertion-for-1-object)
* True, False, Nil, NotNil, NoError
### [For 2 objects](https://github.com/bayashi/actually/wiki/All-assertion-methods#assertion-for-2-objects)
* Same, SameConvertibleNumber, SamePointer, SameType
* Cmp, CmpAllowUnexported, (CmpOpt)
* NotSame, NotSameConvertibleNumber, NotSamePointer, NotSameType
### [For panic](https://github.com/bayashi/actually/wiki/All-assertion-methods#assertion-for-panic)
* Panic, PanicMessage, NoPanic
### [For string value by regexp](https://github.com/bayashi/actually/wiki/All-assertion-methods#assertion-for-string-value-by-regexp)
* Match, NotMatch
### [For length of an object](https://github.com/bayashi/actually/wiki/All-assertion-methods#assertion-for-length-of-an-object)
* Len
[Here is a Wiki of full API documentation](https://github.com/bayashi/actually/wiki).
-----
## Fail reports
`actually` will help you with evident fail report:
```
builder_test.go:133:
Test name: TestTree
Trace: /path/to/src/github.com/bayashi/goverview/builder_test.go:133
Fail reason: Not same
Expected: Dump: "\n┌ 001/\n├── .gitignore\n├── LICENSE: License MIT\n├── go.mod: go 1.18\n└───+ main.go: main\n Func: X\n const: X\n"
Actually got: Dump: "\n┌ 001/\n├── .gitignore\n├── LICENSE: License MIT\n├── go.mod: go 1.19\n└──* main.go: main\n Func: X\n Const: X\n"
Diff Details: --- Expected
+++ Actually got
@@ -4,6 +4,6 @@
├── LICENSE: License MIT
-├── go.mod: go 1.18
-└───+ main.go: main
+├── go.mod: go 1.19
+└──* main.go: main
Func: X
- const: X
+ Const: X
Raw Expect: ---
┌ 001/
├── .gitignore
├── LICENSE: License MIT
├── go.mod: go 1.18
└───+ main.go: main
Func: X
const: X
---
Raw Got: ---
┌ 001/
├── .gitignore
├── LICENSE: License MIT
├── go.mod: go 1.19
└──* main.go: main
Func: X
Const: X
```
`actually` has the `Debug("label", any_variable)` method to show additional data only in fail report.
Like below, `src` variable will be dumped nicely only on fail.
```go
res := someFunc(src)
actually.Got(res).Debug("src", src).True(t)
```
[See more helper functions](https://github.com/bayashi/actually/wiki/Helper-functions).
-----
## Installation
go get github.com/bayashi/actually
## License
MIT License
## Author
Dai Okabayashi: https://github.com/bayashi
## See Also
* https://github.com/bayashi/witness
## Special Thanks
Inspired by:
* https://github.com/stretchr/testify
* https://github.com/matryer/is
* https://github.com/fluentassert/verify
* https://metacpan.org/pod/Test::Arrow