Merge pull request #18 from launchdarkly/eb/sc-166183/set-t-helper

call t.Helper() so our helpers don't mess up the stacktrace

Author: eli-darkly

channels.go

@@ -29,6 +29,9 @@ func TryReceive[V any](ch <-chan V, timeout time.Duration) (V, bool, bool) {
 // RequireValue returns the next value from the channel, or forces an immediate test failure
 // and exit if the timeout expires first.
 func RequireValue[V any](t require.TestingT, ch <-chan V, timeout time.Duration, customMessageAndArgs ...any) V {
+	if t, ok := t.(interface{ Helper() }); ok {
+		t.Helper()
+	}
 	v, ok, closed := TryReceive(ch, timeout)
 	if ok {
 		return v
@@ -53,6 +56,9 @@ func AssertNoMoreValues[V any](
 	timeout time.Duration,
 	customMessageAndArgs ...any,
 ) bool {
+	if t, ok := t.(interface{ Helper() }); ok {
+		t.Helper()
+	}
 	v, ok, closed := TryReceive(ch, timeout)
 	if ok {
 		failWithMessageAndArgs(t, customMessageAndArgs,
@@ -73,6 +79,9 @@ func AssertChannelClosed[V any](
 	timeout time.Duration,
 	customMessageAndArgs ...any,
 ) bool {
+	if t, ok := t.(interface{ Helper() }); ok {
+		t.Helper()
+	}
 	v, ok, closed := TryReceive(ch, timeout)
 	if ok {
 		failWithMessageAndArgs(t, customMessageAndArgs,
@@ -95,6 +104,9 @@ func AssertChannelNotClosed[V any](
 	timeout time.Duration,
 	customMessageAndArgs ...any,
 ) bool {
+	if t, ok := t.(interface{ Helper() }); ok {
+		t.Helper()
+	}
 	deadline := time.NewTimer(timeout)
 	defer deadline.Stop()
 	for {

jsonhelpers/assertions.go

@@ -14,6 +14,9 @@ import (
 // The two values may either be pre-parsed JValue instances, or if they are not, they are
 // converted using the same rules as JValueOf.
 func AssertEqual(t assert.TestingT, expected, actual any) bool {
+	if t, ok := t.(interface{ Helper() }); ok {
+		t.Helper()
+	}
 	ev, av := JValueOf(expected), JValueOf(actual)
 	if ev.err != nil {
 		t.Errorf("invalid expected value (%s): %s", ev.err, ev)

testbox/sandbox.go

@@ -154,6 +154,9 @@ func (m *mockTestingT) runSafely(action func(TestingT)) {
 // ShouldFail is a shortcut for running some action against a testbox.TestingT and
 // asserting that it failed.
 func ShouldFail(t assert.TestingT, action func(TestingT)) bool {
+	if t, ok := t.(interface{ Helper() }); ok {
+		t.Helper()
+	}
 	shouldGetHere := make(chan struct{}, 1)
 	result := SandboxTest(func(t1 TestingT) {
 		action(t1)
@@ -173,6 +176,9 @@ func ShouldFail(t assert.TestingT, action func(TestingT)) bool {
 // ShouldFailAndExitEarly is the same as ShouldFail, except that it also asserts that
 // the test was terminated early with FailNow.
 func ShouldFailAndExitEarly(t assert.TestingT, action func(TestingT)) bool {
+	if t, ok := t.(interface{ Helper() }); ok {
+		t.Helper()
+	}
 	shouldNotGetHere := make(chan struct{}, 1)
 	result := SandboxTest(func(t1 TestingT) {
 		action(t1)