diff options
| author | Taras Madan <tarasmadan@google.com> | 2025-01-22 16:07:17 +0100 |
|---|---|---|
| committer | Taras Madan <tarasmadan@google.com> | 2025-01-23 10:42:36 +0000 |
| commit | 7b4377ad9d8a7205416df8d6217ef2b010f89481 (patch) | |
| tree | e6fec4fd12ff807a16d847923f501075bf71d16c /vendor/github.com/moricho/tparallel/README.md | |
| parent | 475a4c203afb8b7d3af51c4fd32bb170ff32a45e (diff) | |
vendor: delete
Diffstat (limited to 'vendor/github.com/moricho/tparallel/README.md')
| -rw-r--r-- | vendor/github.com/moricho/tparallel/README.md | 112 |
1 files changed, 0 insertions, 112 deletions
diff --git a/vendor/github.com/moricho/tparallel/README.md b/vendor/github.com/moricho/tparallel/README.md deleted file mode 100644 index c4f1efd01..000000000 --- a/vendor/github.com/moricho/tparallel/README.md +++ /dev/null @@ -1,112 +0,0 @@ -# tparallel - -[](https://github.com/moricho/tparallel/actions) -[](https://goreportcard.com/report/github.com/moricho/tparallel) -[](LICENSE) - -`tparallel` finds inappropriate usage of `t.Parallel()` method in your Go test codes. -It detects the following: - -- `t.Parallel()` is called in either a top-level test function or a sub-test function only -- Although `t.Parallel()` is called in the sub-test function, it is post-processed by `defer` instead of `t.Cleanup()` - -This tool was inspired by this blog: [Test parallelization in Go: Understanding the t.Parallel() method](https://engineering.mercari.com/en/blog/entry/20220408-how_to_use_t_parallel/) - -## Installation - -### From GitHub Releases - -Please see [GitHub Releases](https://github.com/moricho/tparallel/releases). -Available binaries are: - -- macOS -- Linux -- Windows - -### macOS - -```sh -$ brew tap moricho/tparallel -$ brew install tparallel -``` - -### go get - -```sh -$ go get -u github.com/moricho/tparallel/cmd/tparallel -``` - -## Usage - -### golangci-lint - -[golangci-lint](https://github.com/golangci/golangci-lint) now supports `tparallel`, so you can enable this linter and use in it. - -### shell - -```sh -$ go vet -vettool=`which tparallel` <pkgname> -``` - -## Example - -```go -package sample - -import ( - "testing" -) - -func Test_Table1(t *testing.T) { - teardown := setup("Test_Table1") - defer teardown() - - tests := []struct { - name string - }{ - { - name: "Table1_Sub1", - }, - { - name: "Table1_Sub2", - }, - } - - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - t.Parallel() - call(tt.name) - }) - } -} - -func Test_Table2(t *testing.T) { - teardown := setup("Test_Table2") - t.Cleanup(teardown) - t.Parallel() - - tests := []struct { - name string - }{ - { - name: "Table2_Sub1", - }, - { - name: "Table2_Sub2", - }, - } - - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - call(tt.name) - }) - } -} -``` - -```console -# github.com/moricho/tparallel/testdata/src/sample -testdata/src/sample/table_test.go:7:6: Test_Table1 should use t.Cleanup -testdata/src/sample/table_test.go:7:6: Test_Table1 should call t.Parallel on the top level as well as its subtests -testdata/src/sample/table_test.go:30:6: Test_Table2's subtests should call t.Parallel -``` |
