Merge pull request #3336 from sttts/sttts-testing-t

🌱 Replace *testing.T with interface for integration with test frameworks

Author: kcp-ci-bot

sdk/testing/helpers/eventually.go

@@ -18,7 +18,6 @@ package helpers
 
 import (
 	"fmt"
-	"testing"
 	"time"
 
 	"github.com/stretchr/testify/require"
@@ -33,7 +32,7 @@ import (
 // Eventually asserts that given condition will be met in waitFor time, periodically checking target function
 // each tick. In addition to require.Eventually, this function t.Logs the reason string value returned by the condition
 // function (eventually after 20% of the wait time) to aid in debugging.
-func Eventually(t *testing.T, condition func() (success bool, reason string), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) {
+func Eventually(t TestingT, condition func() (success bool, reason string), waitFor time.Duration, tick time.Duration, msgAndArgs ...interface{}) {
 	t.Helper()
 
 	var last string
@@ -55,7 +54,7 @@ func Eventually(t *testing.T, condition func() (success bool, reason string), wa
 }
 
 // EventuallyReady asserts that the object returned by getter() eventually has a ready condition.
-func EventuallyReady(t *testing.T, getter func() (conditions.Getter, error), msgAndArgs ...interface{}) {
+func EventuallyReady(t TestingT, getter func() (conditions.Getter, error), msgAndArgs ...interface{}) {
 	t.Helper()
 	EventuallyCondition(t, getter, Is(conditionsv1alpha1.ReadyCondition), msgAndArgs...)
 }
@@ -117,7 +116,7 @@ func (c *ConditionEvaluator) WithReason(reason string) *ConditionEvaluator {
 }
 
 // EventuallyCondition asserts that the object returned by getter() eventually has a condition that matches the evaluator.
-func EventuallyCondition(t *testing.T, getter func() (conditions.Getter, error), evaluator *ConditionEvaluator, msgAndArgs ...interface{}) {
+func EventuallyCondition(t TestingT, getter func() (conditions.Getter, error), evaluator *ConditionEvaluator, msgAndArgs ...interface{}) {
 	t.Helper()
 	Eventually(t, func() (bool, string) {
 		obj, err := getter()

sdk/testing/helpers/testing.go

@@ -0,0 +1,27 @@
+/*
+Copyright 2025 The KCP Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package helpers
+
+// TestingT is implemented by *testing.T and potentially other test frameworks.
+type TestingT interface {
+	Cleanup(func())
+	Errorf(format string, args ...any)
+	FailNow()
+	Helper()
+	Log(args ...any)
+	Logf(format string, args ...any)
+}

sdk/testing/kcp.go

@@ -20,7 +20,6 @@ import (
 	"context"
 	"embed"
 	"path/filepath"
-	"testing"
 
 	"github.com/stretchr/testify/require"
 
@@ -34,7 +33,7 @@ var fs embed.FS
 
 // PrivateKcpServer returns a new kcp server fixture managing a new
 // server process that is not intended to be shared between tests.
-func PrivateKcpServer(t *testing.T, options ...kcptestingserver.Option) kcptestingserver.RunningServer {
+func PrivateKcpServer(t TestingT, options ...kcptestingserver.Option) kcptestingserver.RunningServer {
 	t.Helper()
 
 	serverName := "main"
@@ -71,7 +70,7 @@ func PrivateKcpServer(t *testing.T, options ...kcptestingserver.Option) kcptesti
 // `--kcp-kubeconfig` or `--use-default-kcp-server` is supplied to the test
 // runner. Otherwise a test-managed server will be started. Only tests
 // that are known to be hermetic are compatible with shared fixture.
-func SharedKcpServer(t *testing.T) kcptestingserver.RunningServer {
+func SharedKcpServer(t TestingT) kcptestingserver.RunningServer {
 	t.Helper()
 
 	setupExternal()
@@ -122,7 +121,7 @@ func SharedKcpServer(t *testing.T) kcptestingserver.RunningServer {
 	return f[c.Name]
 }
 
-func createClientCA(t *testing.T) (string, string) {
+func createClientCA(t TestingT) (string, string) {
 	clientCADir := t.TempDir()
 	_, err := crypto.MakeSelfSignedCA(
 		filepath.Join(clientCADir, "client-ca.crt"),

sdk/testing/server/external.go

@@ -28,7 +28,6 @@ import (
 	"math/big"
 	"os"
 	"path/filepath"
-	"testing"
 	"time"
 
 	"github.com/stretchr/testify/require"
@@ -87,7 +86,7 @@ func (s *externalKCPServer) CADirectory() string {
 	return s.caDir
 }
 
-func (s *externalKCPServer) ClientCAUserConfig(t *testing.T, config *rest.Config, name string, groups ...string) *rest.Config {
+func (s *externalKCPServer) ClientCAUserConfig(t TestingT, config *rest.Config, name string, groups ...string) *rest.Config {
 	return clientCAUserConfig(t, config, s.caDir, name, groups...)
 }
 
@@ -104,7 +103,7 @@ func (s *externalKCPServer) RawConfig() (clientcmdapi.Config, error) {
 }
 
 // BaseConfig returns a rest.Config for the "base" context. Client-side throttling is disabled (QPS=-1).
-func (s *externalKCPServer) BaseConfig(t *testing.T) *rest.Config {
+func (s *externalKCPServer) BaseConfig(t TestingT) *rest.Config {
 	t.Helper()
 
 	raw, err := s.cfg.RawConfig()
@@ -122,14 +121,14 @@ func (s *externalKCPServer) BaseConfig(t *testing.T) *rest.Config {
 }
 
 // RootShardSystemMasterBaseConfig returns a rest.Config for the "shard-base" context. Client-side throttling is disabled (QPS=-1).
-func (s *externalKCPServer) RootShardSystemMasterBaseConfig(t *testing.T) *rest.Config {
+func (s *externalKCPServer) RootShardSystemMasterBaseConfig(t TestingT) *rest.Config {
 	t.Helper()
 
 	return s.ShardSystemMasterBaseConfig(t, corev1alpha1.RootShard)
 }
 
 // ShardSystemMasterBaseConfig returns a rest.Config for the "shard-base" context of the given shard. Client-side throttling is disabled (QPS=-1).
-func (s *externalKCPServer) ShardSystemMasterBaseConfig(t *testing.T, shard string) *rest.Config {
+func (s *externalKCPServer) ShardSystemMasterBaseConfig(t TestingT, shard string) *rest.Config {
 	t.Helper()
 
 	cfg, found := s.shardCfgs[shard]
@@ -155,7 +154,7 @@ func (s *externalKCPServer) ShardNames() []string {
 	return sets.StringKeySet(s.shardCfgs).List()
 }
 
-func (s *externalKCPServer) Artifact(t *testing.T, producer func() (runtime.Object, error)) {
+func (s *externalKCPServer) Artifact(t TestingT, producer func() (runtime.Object, error)) {
 	t.Helper()
 	artifact(t, s, producer)
 }
@@ -183,7 +182,7 @@ func loadKubeConfig(kubeconfigPath, contextName string) (clientcmd.ClientConfig,
 
 // clientCAUserConfig returns a config based on a dynamically created client certificate.
 // The returned client CA is signed by "test/e2e/framework/client-ca.crt".
-func clientCAUserConfig(t *testing.T, cfg *rest.Config, clientCAConfigDirectory, username string, groups ...string) *rest.Config {
+func clientCAUserConfig(t TestingT, cfg *rest.Config, clientCAConfigDirectory, username string, groups ...string) *rest.Config {
 	t.Helper()
 	caBytes, err := os.ReadFile(filepath.Join(clientCAConfigDirectory, "client-ca.crt"))
 	require.NoError(t, err, "error reading CA file")

sdk/testing/server/fixture.go

@@ -31,7 +31,6 @@ import (
 	"strings"
 	"sync"
 	"syscall"
-	"testing"
 	"time"
 
 	"github.com/egymgmbh/go-prefix-writer/prefixer"
@@ -61,15 +60,15 @@ const kcpBinariesDirEnvDir = "KCP_BINARIES_DIR"
 
 // RunInProcessFunc instantiates the kcp server in process for easier debugging.
 // It is here to decouple the rest of the code from kcp core dependencies.
-var RunInProcessFunc func(t *testing.T, dataDir string, args []string) (<-chan struct{}, error)
+var RunInProcessFunc func(t TestingT, dataDir string, args []string) (<-chan struct{}, error)
 
 // Fixture manages the lifecycle of a set of kcp servers.
 //
 // Deprecated for use outside this package. Prefer PrivateKcpServer().
 type Fixture = map[string]RunningServer
 
 // NewFixture returns a new kcp server fixture.
-func NewFixture(t *testing.T, cfgs ...Config) Fixture {
+func NewFixture(t TestingT, cfgs ...Config) Fixture {
 	t.Helper()
 
 	// Initialize servers from the provided configuration
@@ -170,10 +169,10 @@ type kcpServer struct {
 	cfg            clientcmd.ClientConfig
 	kubeconfigPath string
 
-	t *testing.T
+	t TestingT
 }
 
-func newKcpServer(t *testing.T, cfg Config, artifactDir, dataDir, clientCADir string) (*kcpServer, error) {
+func newKcpServer(t TestingT, cfg Config, artifactDir, dataDir, clientCADir string) (*kcpServer, error) {
 	t.Helper()
 
 	kcpListenPort, err := GetFreePort(t)
@@ -462,12 +461,12 @@ func (c *kcpServer) config(context string) (*rest.Config, error) {
 	return restConfig, nil
 }
 
-func (c *kcpServer) ClientCAUserConfig(t *testing.T, config *rest.Config, name string, groups ...string) *rest.Config {
+func (c *kcpServer) ClientCAUserConfig(t TestingT, config *rest.Config, name string, groups ...string) *rest.Config {
 	return clientCAUserConfig(t, config, c.clientCADir, name, groups...)
 }
 
 // BaseConfig returns a rest.Config for the "base" context. Client-side throttling is disabled (QPS=-1).
-func (c *kcpServer) BaseConfig(t *testing.T) *rest.Config {
+func (c *kcpServer) BaseConfig(t TestingT) *rest.Config {
 	t.Helper()
 
 	cfg, err := c.config("base")
@@ -477,7 +476,7 @@ func (c *kcpServer) BaseConfig(t *testing.T) *rest.Config {
 }
 
 // RootShardSystemMasterBaseConfig returns a rest.Config for the "shard-base" context. Client-side throttling is disabled (QPS=-1).
-func (c *kcpServer) RootShardSystemMasterBaseConfig(t *testing.T) *rest.Config {
+func (c *kcpServer) RootShardSystemMasterBaseConfig(t TestingT) *rest.Config {
 	t.Helper()
 
 	cfg, err := c.config("shard-base")
@@ -488,7 +487,7 @@ func (c *kcpServer) RootShardSystemMasterBaseConfig(t *testing.T) *rest.Config {
 }
 
 // ShardSystemMasterBaseConfig returns a rest.Config for the "shard-base" context of a given shard. Client-side throttling is disabled (QPS=-1).
-func (c *kcpServer) ShardSystemMasterBaseConfig(t *testing.T, shard string) *rest.Config {
+func (c *kcpServer) ShardSystemMasterBaseConfig(t TestingT, shard string) *rest.Config {
 	t.Helper()
 
 	if shard != corev1alpha1.RootShard {
@@ -545,14 +544,14 @@ func (c *kcpServer) CADirectory() string {
 	return c.dataDir
 }
 
-func (c *kcpServer) Artifact(t *testing.T, producer func() (runtime.Object, error)) {
+func (c *kcpServer) Artifact(t TestingT, producer func() (runtime.Object, error)) {
 	t.Helper()
 	artifact(t, c, producer)
 }
 
 // artifact registers the data-producing function to run and dump the YAML-formatted output
 // to the artifact directory for the test before the kcp process is terminated.
-func artifact(t *testing.T, server RunningServer, producer func() (runtime.Object, error)) {
+func artifact(t TestingT, server RunningServer, producer func() (runtime.Object, error)) {
 	t.Helper()
 
 	subDir := filepath.Join("artifacts", "kcp", server.Name())

sdk/testing/server/interface.go

@@ -17,8 +17,6 @@ limitations under the License.
 package server
 
 import (
-	"testing"
-
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/rest"
 	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
@@ -28,11 +26,11 @@ type RunningServer interface {
 	Name() string
 	KubeconfigPath() string
 	RawConfig() (clientcmdapi.Config, error)
-	BaseConfig(t *testing.T) *rest.Config
-	RootShardSystemMasterBaseConfig(t *testing.T) *rest.Config
-	ShardSystemMasterBaseConfig(t *testing.T, shard string) *rest.Config
+	BaseConfig(t TestingT) *rest.Config
+	RootShardSystemMasterBaseConfig(t TestingT) *rest.Config
+	ShardSystemMasterBaseConfig(t TestingT, shard string) *rest.Config
 	ShardNames() []string
-	Artifact(t *testing.T, producer func() (runtime.Object, error))
-	ClientCAUserConfig(t *testing.T, config *rest.Config, name string, groups ...string) *rest.Config
+	Artifact(t TestingT, producer func() (runtime.Object, error))
+	ClientCAUserConfig(t TestingT, config *rest.Config, name string, groups ...string) *rest.Config
 	CADirectory() string
 }

sdk/testing/server/metrics.go

@@ -26,7 +26,6 @@ import (
 	"os"
 	"path/filepath"
 	"syscall"
-	"testing"
 	"time"
 
 	"github.com/stretchr/testify/require"
@@ -39,7 +38,7 @@ import (
 	kcptestinghelpers "github.com/kcp-dev/kcp/sdk/testing/helpers"
 )
 
-func gatherMetrics(ctx context.Context, t *testing.T, server RunningServer, directory string) {
+func gatherMetrics(ctx context.Context, t TestingT, server RunningServer, directory string) {
 	cfg := server.RootShardSystemMasterBaseConfig(t)
 	client, err := kcpclientset.NewForConfig(cfg)
 	if err != nil {
@@ -61,7 +60,7 @@ func gatherMetrics(ctx context.Context, t *testing.T, server RunningServer, dire
 	}
 }
 
-func scrapeMetricsForServer(t *testing.T, srv RunningServer) {
+func scrapeMetricsForServer(t TestingT, srv RunningServer) {
 	promUrl, set := os.LookupEnv("PROMETHEUS_URL")
 	if !set || promUrl == "" {
 		t.Logf("PROMETHEUS_URL environment variable unset, skipping Prometheus scrape config generation")

sdk/testing/server/port.go

@@ -23,11 +23,10 @@ import (
 	"os"
 	"path/filepath"
 	"strconv"
-	"testing"
 )
 
 // GetFreePort asks the kernel for a free open port that is ready to use.
-func GetFreePort(t *testing.T) (string, error) {
+func GetFreePort(t TestingT) (string, error) {
 	t.Helper()
 
 	for {

sdk/testing/server/ready.go

@@ -21,7 +21,6 @@ import (
 	"errors"
 	"fmt"
 	"strings"
-	"testing"
 	"time"
 
 	"k8s.io/apimachinery/pkg/util/sets"
@@ -68,7 +67,7 @@ func waitForEndpoint(ctx context.Context, client *rest.RESTClient, endpoint stri
 }
 
 // MonitorEndpoints keeps watching the given endpoints and fails t on error.
-func MonitorEndpoints(t *testing.T, client *rest.Config, endpoints ...string) {
+func MonitorEndpoints(t TestingT, client *rest.Config, endpoints ...string) {
 	ctx, cancel := context.WithCancel(context.Background())
 	t.Cleanup(cancel)
 	for _, endpoint := range endpoints {
@@ -78,7 +77,7 @@ func MonitorEndpoints(t *testing.T, client *rest.Config, endpoints ...string) {
 	}
 }
 
-func monitorEndpoint(ctx context.Context, t *testing.T, cfg *rest.Config, endpoint string) {
+func monitorEndpoint(ctx context.Context, t TestingT, cfg *rest.Config, endpoint string) {
 	cfg = rest.CopyConfig(cfg)
 	if cfg.NegotiatedSerializer == nil {
 		cfg.NegotiatedSerializer = kubernetesscheme.Codecs.WithoutConversion()
@@ -89,13 +88,6 @@ func monitorEndpoint(ctx context.Context, t *testing.T, cfg *rest.Config, endpoi
 		return
 	}
 
-	// we need a shorter deadline than the server, or else:
-	// timeout.go:135] post-timeout activity - time-elapsed: 23.784917ms, GET "/livez" result: Header called after Handler finished
-	if deadline, ok := t.Deadline(); ok {
-		deadlinedCtx, deadlinedCancel := context.WithDeadline(ctx, deadline.Add(-20*time.Second))
-		ctx = deadlinedCtx
-		t.Cleanup(deadlinedCancel) // this does not really matter but govet is upset
-	}
 	var errCount int
 	errs := sets.New[string]()
 	wait.UntilWithContext(ctx, func(ctx context.Context) {
@@ -108,7 +100,14 @@ func monitorEndpoint(ctx context.Context, t *testing.T, cfg *rest.Config, endpoi
 			errCount++
 			errs.Insert(fmt.Sprintf("failed components: %v", unreadyComponentsFromError(err)))
 			if errCount == 2 {
-				t.Errorf("error contacting %s: %v", endpoint, sets.List[string](errs))
+				select {
+				case <-ctx.Done():
+					// ignore error if we're already shutting down
+				default:
+					if !t.Failed() {
+						t.Errorf("error contacting %s: %v", endpoint, sets.List[string](errs))
+					}
+				}
 			}
 		}
 		// otherwise, reset the counters