Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitaly.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--STYLE.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/STYLE.md b/STYLE.md
index 667973ee5..3b2ee4b79 100644
--- a/STYLE.md
+++ b/STYLE.md
@@ -194,6 +194,19 @@ func TestT_M_suffix() { ... }
func TestT_M_suffixWithMultipleWords() { ... }
```
+### Test helpers
+
+Helper functions for test helpers should be clearly marked with `t.Helper()` so
+that stack traces become more usable. `testing.TB` arguments should always be
+passed as first parameter, followed by `context.Context` if required.
+
+```go
+func testHelper(tb testing.TB, ctx context.Context) {
+ tb.Helper()
+ ...
+}
+```
+
### Table-driven tests
We like table-driven tests ([Table-driven tests using subtests](https://blog.golang.org/subtests#TOC_4.), [Cheney blog post], [Golang wiki]).