GOMODULES
/
testify
mirror of https://github.com/stretchr/testify.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document suite's lack of support for t.Parallel

pull/1645/head
Bracken Dawson 2024-10-01 23:55:16 +01:00 committed by Olivier Mengué
parent 5dc934f9aa
commit fed9ee68dc
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -223,6 +223,8 @@ You can use the [mockery tool](https://vektra.github.io/mockery/latest/) to auto
[`suite`](https://pkg.go.dev/github.com/stretchr/testify/suite "API documentation") package [`suite`](https://pkg.go.dev/github.com/stretchr/testify/suite "API documentation") package
----------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------
> [!WARNING]
> The suite package does not support parallel tests. See [#934](https://github.com/stretchr/testify/issues/934).
The `suite` package provides functionality that you might be used to from more common object-oriented languages. With it, you can build a testing suite as a struct, build setup/teardown methods and testing methods on your struct, and run them with 'go test' as per normal. The `suite` package provides functionality that you might be used to from more common object-oriented languages. With it, you can build a testing suite as a struct, build setup/teardown methods and testing methods on your struct, and run them with 'go test' as per normal.

4
suite/doc.go
View File

@ -5,6 +5,8 @@
// or individual tests (depending on which interface(s) you // or individual tests (depending on which interface(s) you
// implement). // implement).
// //
// The suite package does not support parallel tests. See [issue 934].
//
// A testing suite is usually built by first extending the built-in // A testing suite is usually built by first extending the built-in
// suite functionality from suite.Suite in testify. Alternatively, // suite functionality from suite.Suite in testify. Alternatively,
// you could reproduce that logic on your own if you wanted (you // you could reproduce that logic on your own if you wanted (you
@ -63,4 +65,6 @@
// func TestExampleTestSuite(t *testing.T) { // func TestExampleTestSuite(t *testing.T) {
// suite.Run(t, new(ExampleTestSuite)) // suite.Run(t, new(ExampleTestSuite))
// } // }
//
// [issue 934]: https://github.com/stretchr/testify/issues/934
package suite package suite