Skip to content

Commit 67b17fd

Browse files
authored
doc(README): add missing tdsuite info
1 parent b0ce62c commit 67b17fd

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ go-testdeep
2020
- [Available operators](https://go-testdeep.zetta.rocks/operators/)
2121
- [Helpers](#helpers)
2222
- [`tdhttp` or HTTP API testing helper](https://pkg.go.dev/github.com/maxatome/go-testdeep/helpers/tdhttp)
23+
- [`tdsuite` or testing suite helper](https://pkg.go.dev/github.com/maxatome/go-testdeep/helpers/tdsuite)
2324
- [`tdutil` aka the helper of helpers](https://pkg.go.dev/github.com/maxatome/go-testdeep/helpers/tdutil)
2425
- [See also](#see-also)
2526
- [License](#license)
@@ -105,7 +106,8 @@ import (
105106
"testing"
106107
"time"
107108

108-
"github.com/maxatome/go-testdeep/helpers/tdhttp"
109+
"github.com/maxatome/go-testdeep/helpers/
110+
"
109111
"github.com/maxatome/go-testdeep/td"
110112
)
111113

@@ -226,6 +228,18 @@ See [`tdhttp`] documentation for details or
226228
[FAQ](https://go-testdeep.zetta.rocks/faq/#what-about-testing-the-response-using-my-api) for an
227229
example of use.
228230

231+
### `tdsuite` or testing suite helper
232+
233+
The package `github.com/maxatome/go-testdeep/helpers/tdsuite` adds tests
234+
suite feature to go-testdeep in a non-intrusive way, but easily and powerfully.
235+
236+
A tests suite is a set of tests run sequentially that share some data.
237+
238+
Some hooks can be set to be automatically called before the suite is run,
239+
before, after and/or between each test, and at the end of the suite.
240+
241+
See [`tdsuite`] documentation for details.
242+
229243
### `tdutil` aka the helper of helpers
230244

231245
The package `github.com/maxatome/go-testdeep/helpers/tdutil` allows to
@@ -273,6 +287,7 @@ See [FAQ](https://go-testdeep.zetta.rocks/faq/).
273287
[`Cmp`]: https://pkg.go.dev/github.com/maxatome/go-testdeep/td#Cmp
274288

275289
[`tdhttp`]: https://pkg.go.dev/github.com/maxatome/go-testdeep/helpers/tdhttp
290+
[`tdsuite`]: https://pkg.go.dev/github.com/maxatome/go-testdeep/helpers/tdsuite
276291

277292
[`BeLax` config flag]: https://pkg.go.dev/github.com/maxatome/go-testdeep/td#ContextConfig
278293
[`error`]: https://pkg.go.dev/builtin/#error

0 commit comments

Comments
 (0)