bump to go 1.24.0 - support new testing.TB methods and add a test to cover testing.TB regressions

onsi · onsi · commit 37a511b5bca1 · 2025-03-05T10:53:13.000-07:00
diff --git a/ginkgo_t_dsl.go b/ginkgo_t_dsl.go
@@ -1,6 +1,7 @@
 package ginkgo
 
 import (
+	"context"
 	"testing"
 
 	"github.com/onsi/ginkgo/v2/internal/testingtproxy"
@@ -48,6 +49,8 @@ The portion of the interface returned by GinkgoT() that maps onto methods in the
 */
 type GinkgoTInterface interface {
 	Cleanup(func())
+	Chdir(dir string)
+	Context() context.Context
 	Setenv(kev, value string)
 	Error(args ...any)
 	Errorf(format string, args ...any)
diff --git a/go.mod b/go.mod
@@ -1,8 +1,6 @@
 module github.com/onsi/ginkgo/v2
 
-go 1.22.0
-
-toolchain go1.23.0
+go 1.23.0
 
 require (
 	github.com/go-logr/logr v1.4.2
diff --git a/internal/testingtproxy/testing_t_proxy.go b/internal/testingtproxy/testing_t_proxy.go
@@ -1,6 +1,7 @@
 package testingtproxy
 
 import (
+	"context"
 	"fmt"
 	"io"
 	"os"
@@ -80,6 +81,26 @@ func (t *ginkgoTestingTProxy) Setenv(key, value string) {
 	}
 }
 
+func (t *ginkgoTestingTProxy) Chdir(dir string) {
+	currentDir, err := os.Getwd()
+	if err != nil {
+		t.fail(fmt.Sprintf("Failed to get current directory: %v", err), 1)
+	}
+
+	t.cleanup(os.Chdir, currentDir, internal.Offset(1))
+
+	err = os.Chdir(dir)
+	if err != nil {
+		t.fail(fmt.Sprintf("Failed to change directory: %v", err), 1)
+	}
+}
+
+func (t *ginkgoTestingTProxy) Context() context.Context {
+	ctx, cancel := context.WithCancel(context.Background())
+	t.cleanup(cancel, internal.Offset(1))
+	return ctx
+}
+
 func (t *ginkgoTestingTProxy) Error(args ...any) {
 	t.fail(fmt.Sprintln(args...), t.offset)
 }
diff --git a/internal/testingtproxy/testingtproxy_test.go b/internal/testingtproxy/testingtproxy_test.go
@@ -1,8 +1,11 @@
 package testingtproxy_test
 
 import (
+	"fmt"
 	"os"
+	"reflect"
 	"runtime"
+	"testing"
 	"time"
 
 	. "github.com/onsi/ginkgo/v2"
@@ -87,6 +90,23 @@ var _ = Describe("Testingtproxy", func() {
 			offset)
 	})
 
+	It("satisfies the golang interfaces", func() {
+		tbType := reflect.TypeFor[testing.TB]()
+		gtType := reflect.TypeFor[GinkgoTInterface]()
+
+		fmt.Println("tbType: ", tbType.NumMethod())
+		for i := 0; i < tbType.NumMethod(); i++ {
+			expectedMethod := tbType.Method(i)
+			if expectedMethod.Name == "private" {
+				continue
+			}
+			actualMethod, hasMethod := gtType.MethodByName(expectedMethod.Name)
+			Ω(hasMethod).Should(BeTrue())
+			Ω(actualMethod.Name).Should(Equal(expectedMethod.Name))
+			Ω(actualMethod.Type).Should(Equal(expectedMethod.Type))
+		}
+	})
+
 	Describe("Cleanup", Ordered, func() {
 		var didCleanupAfter bool
 		It("supports cleanup", func() {
@@ -143,6 +163,40 @@ var _ = Describe("Testingtproxy", func() {
 		})
 	})
 
+	Describe("Chdir", Ordered, func() {
+		BeforeAll(func() {
+			os.Mkdir("chdir_test_dir", 0755)
+			DeferCleanup(os.RemoveAll, "chdir_test_dir")
+		})
+
+		It("changes the working directory", func() {
+			t.Chdir("chdir_test_dir")
+			newDir, _ := os.Getwd()
+			Ω(newDir).Should(ContainSubstring("chdir_test_dir"))
+		})
+
+		It("cleans up after itself so the next test is back in the working directory", func() {
+			dir, _ := os.Getwd()
+			Ω(dir).ShouldNot(ContainSubstring("chdir_test_dir"))
+		})
+	})
+
+	Describe("Context", func() {
+		It("returns a context that is closed in a canceled in a clean up", func() {
+			c := make(chan struct{})
+			DeferCleanup(func() {
+				Eventually(c).Should(BeClosed())
+			})
+
+			ctx := t.Context()
+			Ω(ctx.Err()).Should(BeNil())
+			go func() {
+				<-ctx.Done()
+				close(c)
+			}()
+		})
+	})
+
 	Describe("TempDir", Ordered, func() {
 		var tempDirA, tempDirB string
 
