Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bayashi/witness
A test helper to make an evident report on a fail of your test.
https://github.com/bayashi/witness
go golang golang-testing testing
Last synced: 2 months ago
JSON representation
A test helper to make an evident report on a fail of your test.
- Host: GitHub
- URL: https://github.com/bayashi/witness
- Owner: bayashi
- License: mit
- Created: 2023-12-05T10:00:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-07T06:31:34.000Z (6 months ago)
- Last Synced: 2024-07-07T07:33:55.330Z (6 months ago)
- Topics: go, golang, golang-testing, testing
- Language: Go
- Homepage:
- Size: 79.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# witness
`witness` is a test helper to make an evident report on a fail of your test.
## Usage
Simple case.
```go
package main
import (
"testing"
w "github.com/bayashi/witness"
)
func TestExample(t *testing.T) {
g := "a\nb\nc"
e := "a\nd\nc"
if g != e {
w.Fail(t, "Not same", g, e)
}
}
```
below result will be shown:
```go
Test name: TestExample
Trace: /home/usr/go/src/github.com/bayashi/witness/witness_test.go:14
Fail reason: Not same
Type: Expect:string, Got:string
Expected: "a\nd\nc"
Actually got: "a\nb\nc"
```
There is a builder interface to specify waht you report.
```go
w.Got(g).Expect(e).Fail(t, "Not same")
```
There are switches to show more additional info:
```go
w.Got(g).Expect(e).ShowAll().Fail(t, "Not same")
```
And then,
```go
Test name: TestExample
Trace: /home/usr/go/src/github.com/bayashi/witness/witness_test.go:14
Fail reason: Not same
Type: Expect:string, Got:string
Expected: "a\nd\nc"
Actually got: "a\nb\nc"
Diff details: --- Expected
+++ Actually got
@@ -1,3 +1,3 @@
a
-d
+b
c
Raw Expect: ---
a
d
c
---
Raw Got: ---
a
b
c
---
```
See [witness-showcase](https://github.com/bayashi/witness-showcase) for actual outputs on fail.
Also see [Witness Package reference](https://pkg.go.dev/github.com/bayashi/witness) for more details.
## Installation
```cmd
go get github.com/bayashi/witness
```
## License
MIT License
## Author
Dai Okabayashi: https://github.com/bayashi
## See Also
https://github.com/bayashi/actually
## Special Thanks To
https://github.com/stretchr/testify