https://github.com/cobbinma/bromide
A snapshot testing library for go 📸
https://github.com/cobbinma/bromide
go golang snapshot snapshot-testing testing testing-tools
Last synced: 26 days ago
JSON representation
A snapshot testing library for go 📸
- Host: GitHub
- URL: https://github.com/cobbinma/bromide
- Owner: cobbinma
- License: mit
- Created: 2024-02-16T09:32:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T12:31:13.000Z (over 2 years ago)
- Last Synced: 2025-02-28T21:46:15.207Z (over 1 year ago)
- Topics: go, golang, snapshot, snapshot-testing, testing, testing-tools
- Language: Go
- Homepage:
- Size: 112 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
bromide
A snapshot testing library for go 📸
## Introduction
Bromide is a snapshot library for Go, designed to simplify managing snapshot tests.
With Bromide, you can easily capture test output and then review any differences against expected values.
## Usage
### 1. Write a Snapshot Test
Install the library:
```sh
go get github.com/cobbinma/bromide
```
Write a test that calls `bromide.Snapshot`:
```go
import github.com/cobbinma/bromide
func TestSomething(t *testing.T) {
text := "world"
something := testStruct{
example: &text,
again: 5,
}
bromide.Snapshot(t, something)
}
```
### 2. Run Your Tests
Run your tests as usual:
```sh
go test ./...
```
If the snapshot does not match, you will see output like:
```
--- FAIL: TestSomething (0.00s)
bromide_test.go:24: snapshot mismatch
bromide_test.go:24:
--- current
+++ incoming
@@ -1,4 +1,4 @@
(bromide_test.testStruct) {
- example: (*string)((len=5) "hello"),
+ example: (*string)((len=5) "world"),
again: (int) 5
}
bromide_test.go:24: to review and approve new snapshots, run `bromide`
FAIL
FAIL github.com/cobbinma/bromide 0.211s
FAIL
```
### 3. Review and Approve Snapshot Changes
Install the Bromide CLI if you haven't already:
```sh
go install github.com/cobbinma/bromide/cmd/bromide@v0.0.2
```
Run the review tool to inspect and approve changed snapshots:
```sh
bromide
```
This will show you a UI to review, approve, or reject snapshot updates.
## See Also
* [cupaloy](https://github.com/bradleyjkemp/cupaloy)
## Thanks
* [cupaloy](https://github.com/bradleyjkemp/cupaloy)
* [insta](https://github.com/mitsuhiko/insta)
* [birdie](https://github.com/giacomocavalieri/birdie)