Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rzajac/testkit
Package testkit provides all sorts of test helpers.
https://github.com/rzajac/testkit
Last synced: 3 days ago
JSON representation
Package testkit provides all sorts of test helpers.
- Host: GitHub
- URL: https://github.com/rzajac/testkit
- Owner: rzajac
- License: bsd-2-clause
- Created: 2020-12-07T08:30:23.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-04T11:18:36.000Z (almost 3 years ago)
- Last Synced: 2023-12-12T19:57:28.201Z (11 months ago)
- Language: Go
- Size: 52.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## Test Kit
[](https://goreportcard.com/report/github.com/rzajac/testkit)
[](https://pkg.go.dev/github.com/rzajac/testkit)
Package testkit provides all sorts of test helpers which take `*testing.T`
instance and report errors if something goes wrong. See GoDoc for the
documentation and examples.
## Motivation
In my opinion constantly checking errors while setting up a test reduces its
readability.
Example test:
```
func Test_MyFunction(t *testing.T) {
// --- Given ---
fil, err := ioutil.TempFile(t.TempDir(), "test_*.txt")
if err != nil {
t.Fatal(err)
}
defer fil.Close()
content := []byte("line1\nline2\nend")
if _, err := fil.Write(content); err != nil {
t.Fatal(err)
}
// --- When ---
// Do some operations on the test file.
// --- Then ---
chk, err := os.Open(fil.Name())
if err != nil {
t.Fatal(err)
}
got, err := ioutil.ReadAll(chk)
if err != nil {
t.Fatal(err)
}
expected := []byte{0, 1, 2, 3}
if !bytes.Equal(expected, got) {
t.Errorf("expected %v got %v", expected, got)
}
}
```
The same test using testkit:
```
import (
kit "github.com/rzajac/testkit"
)
func Test_MyFunction(t *testing.T) {
// --- Given ---
content := []byte("line1\nline2\nend")
pth := kit.TempFileBuf(t, t.TempDir(), content)
// --- When ---
// Do some operations on the test file.
// --- Then ---
got := kit.ReadFile(t, pth)
expected := []byte{0, 1, 2, 3}
if !bytes.Equal(expected, got) {
t.Errorf("expected %v got %v", expected, got)
}
}
```
`TempFileBuf` creates and writes to temporary file from a buffer. Returns
path to created file. It registers cleanup function with t removing the created
file. Calls t.Fatal() on error. Similarly `ReadFile` is a wrapper
around `ioutil.ReadFile()` which calls t.Fatal() on error.
## License
BSD-2-Clause