chore: adjust network testing API

This used to accept a context and a logger; now make it accept a
testing.T and a context instead.

The rationale here is that it is easy for a test to provides its own
logger related to the T, but relying on context cancellation for cleanup
is inferior to using T.Cleanup.

The downside of this is that there is no way for a test to set
attributes on the logger, but it doesn't look like any tests set any
attributes so far anyway.

Author: mark-rushakoff

tm/tmintegration/daisychain.go

@@ -2,7 +2,7 @@ package tmintegration
 
 import (
 	"context"
-	"log/slog"
+	"testing"
 
 	"github.com/gordian-engine/gordian/gcrypto"
 	"github.com/gordian-engine/gordian/tm/tmgossip"
@@ -18,11 +18,11 @@ func NewDaisyChainFactory(e *Env) DaisyChainFactory {
 	return DaisyChainFactory{e: e}
 }
 
-func (f DaisyChainFactory) NewNetwork(ctx context.Context, log *slog.Logger, reg *gcrypto.Registry) (tmp2ptest.Network, error) {
+func (f DaisyChainFactory) NewNetwork(t *testing.T, ctx context.Context, reg *gcrypto.Registry) (tmp2ptest.Network, error) {
 	// We don't need the gcrypto registry for the daisy chain network,
 	// because we only transmit in-memory values,
 	// without serializing and deserializing across the network.
-	n := tmp2ptest.NewDaisyChainNetwork(ctx, log)
+	n := tmp2ptest.NewDaisyChainNetwork(t, ctx)
 
 	return &tmp2ptest.GenericNetwork[*tmp2ptest.DaisyChainConnection]{
 		Network: n,

tm/tmintegration/factory.go

@@ -3,6 +3,7 @@ package tmintegration
 import (
 	"context"
 	"log/slog"
+	"testing"
 
 	"github.com/gordian-engine/gordian/gcrypto"
 	"github.com/gordian-engine/gordian/tm/tmconsensus"
@@ -46,7 +47,7 @@ type Factory interface {
 	// NewNetwork will be called only once per test.
 	// The implementer may assume that the context will be canceled
 	// at or before the test's completion.
-	NewNetwork(context.Context, *slog.Logger, *gcrypto.Registry) (tmp2ptest.Network, error)
+	NewNetwork(*testing.T, context.Context, *gcrypto.Registry) (tmp2ptest.Network, error)
 
 	NewActionStore(context.Context, int) (tmstore.ActionStore, error)
 	NewCommittedHeaderStore(context.Context, int) (tmstore.CommittedHeaderStore, error)

tm/tmintegration/integration.go

@@ -36,7 +36,7 @@ func RunIntegrationTest(t *testing.T, nf NewFactoryFunc) {
 		const netSize = 2
 		fx := f.NewConsensusFixture(netSize)
 
-		n, err := f.NewNetwork(ctx, log, &fx.Registry)
+		n, err := f.NewNetwork(t, ctx, &fx.Registry)
 		require.NoError(t, err)
 		defer n.Wait()
 		defer cancel()
@@ -200,7 +200,7 @@ func RunIntegrationTest(t *testing.T, nf NewFactoryFunc) {
 		const pickN = 4   // How many validators participate in rounds beyond initial height.
 		fx := f.NewConsensusFixture(netSize)
 
-		n, err := f.NewNetwork(ctx, log, &fx.Registry)
+		n, err := f.NewNetwork(t, ctx, &fx.Registry)
 		require.NoError(t, err)
 		defer n.Wait()
 		defer cancel()

tm/tmintegration/libp2p.go

@@ -3,9 +3,10 @@ package tmintegration
 import (
 	"context"
 	"fmt"
-	"log/slog"
+	"testing"
 
 	"github.com/gordian-engine/gordian/gcrypto"
+	"github.com/gordian-engine/gordian/internal/gtest"
 	"github.com/gordian-engine/gordian/tm/tmcodec/tmjson"
 	"github.com/gordian-engine/gordian/tm/tmgossip"
 	"github.com/gordian-engine/gordian/tm/tmp2p"
@@ -24,11 +25,11 @@ func NewLibp2pFactory(e *Env) Libp2pFactory {
 	return Libp2pFactory{e: e}
 }
 
-func (f Libp2pFactory) NewNetwork(ctx context.Context, log *slog.Logger, reg *gcrypto.Registry) (tmp2ptest.Network, error) {
+func (f Libp2pFactory) NewNetwork(t *testing.T, ctx context.Context, reg *gcrypto.Registry) (tmp2ptest.Network, error) {
 	codec := tmjson.MarshalCodec{
 		CryptoRegistry: reg,
 	}
-	n, err := tmlibp2ptest.NewNetwork(ctx, log, codec)
+	n, err := tmlibp2ptest.NewNetwork(ctx, gtest.NewLogger(t), codec)
 	if err != nil {
 		return nil, fmt.Errorf("failed to build network: %w", err)
 	}

tm/tmp2p/tmlibp2p/tmlibp2ptest/network_test.go

@@ -2,10 +2,10 @@ package tmlibp2ptest_test
 
 import (
 	"context"
-	"log/slog"
 	"testing"
 
 	"github.com/gordian-engine/gordian/gcrypto"
+	"github.com/gordian-engine/gordian/internal/gtest"
 	"github.com/gordian-engine/gordian/tm/tmcodec/tmjson"
 	"github.com/gordian-engine/gordian/tm/tmp2p/tmlibp2p"
 	"github.com/gordian-engine/gordian/tm/tmp2p/tmlibp2p/tmlibp2ptest"
@@ -15,13 +15,13 @@ import (
 func TestLibp2pNetwork_Compliance(t *testing.T) {
 	tmp2ptest.TestNetworkCompliance(
 		t,
-		func(ctx context.Context, log *slog.Logger) (tmp2ptest.Network, error) {
+		func(t *testing.T, ctx context.Context) (tmp2ptest.Network, error) {
 			reg := new(gcrypto.Registry)
 			gcrypto.RegisterEd25519(reg)
 			codec := tmjson.MarshalCodec{
 				CryptoRegistry: reg,
 			}
-			n, err := tmlibp2ptest.NewNetwork(ctx, log, codec)
+			n, err := tmlibp2ptest.NewNetwork(ctx, gtest.NewLogger(t), codec)
 			if err != nil {
 				return nil, err
 			}

tm/tmp2p/tmp2ptest/daisychainnetwork.go

@@ -7,9 +7,11 @@ import (
 	"log/slog"
 	"sync"
 	"sync/atomic"
+	"testing"
 
 	"github.com/gordian-engine/gordian/gexchange"
 	"github.com/gordian-engine/gordian/internal/gchan"
+	"github.com/gordian-engine/gordian/internal/gtest"
 	"github.com/gordian-engine/gordian/tm/tmconsensus"
 	"github.com/gordian-engine/gordian/tm/tmp2p"
 )
@@ -46,9 +48,9 @@ type dcSetHandlerRequest struct {
 
 // NewDaisyChainNetwork returns a new DaisyChainNetwork.
 // Cancelling the context will stop the network and disconnect all created connections.
-func NewDaisyChainNetwork(ctx context.Context, log *slog.Logger) *DaisyChainNetwork {
+func NewDaisyChainNetwork(t *testing.T, ctx context.Context) *DaisyChainNetwork {
 	n := &DaisyChainNetwork{
-		log: log.With("net_idx", atomic.AddUint64(&dcNetworkIdxCounter, 1)),
+		log: gtest.NewLogger(t).With("net_idx", atomic.AddUint64(&dcNetworkIdxCounter, 1)),
 
 		newConnRequests: make(chan dcConnectRequest), // Unbuffered since this is effectively synchronous.
 

tm/tmp2p/tmp2ptest/daisychainnetwork_test.go

@@ -2,7 +2,6 @@ package tmp2ptest_test
 
 import (
 	"context"
-	"log/slog"
 	"testing"
 
 	"github.com/gordian-engine/gordian/tm/tmp2p/tmp2ptest"
@@ -11,8 +10,8 @@ import (
 func TestDaisyChainNetwork_Compliance(t *testing.T) {
 	tmp2ptest.TestNetworkCompliance(
 		t,
-		func(ctx context.Context, log *slog.Logger) (tmp2ptest.Network, error) {
-			n := tmp2ptest.NewDaisyChainNetwork(ctx, log)
+		func(t *testing.T, ctx context.Context) (tmp2ptest.Network, error) {
+			n := tmp2ptest.NewDaisyChainNetwork(t, ctx)
 			return &tmp2ptest.GenericNetwork[*tmp2ptest.DaisyChainConnection]{
 				Network: n,
 			}, nil

tm/tmp2p/tmp2ptest/networkcompliance.go

@@ -2,7 +2,6 @@ package tmp2ptest
 
 import (
 	"context"
-	"log/slog"
 	"testing"
 	"time"
 
@@ -37,7 +36,8 @@ type Network interface {
 }
 
 // NetworkConstructor is used within [TestNetworkCompliance] to create a Network.
-type NetworkConstructor func(context.Context, *slog.Logger) (Network, error)
+// The testing.T parameter is available for tests to register cleanup.
+type NetworkConstructor func(*testing.T, context.Context) (Network, error)
 
 // GenericNetwork is a convenience wrapper type that allows
 // a concrete network implementation to have a Connect method
@@ -82,9 +82,7 @@ func TestNetworkCompliance(t *testing.T, newNet NetworkConstructor) {
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
 
-		log := gtest.NewLogger(t)
-
-		net, err := newNet(ctx, log)
+		net, err := newNet(t, ctx)
 		require.NoError(t, err)
 		defer net.Wait()
 		defer cancel()
@@ -136,9 +134,7 @@ func TestNetworkCompliance(t *testing.T, newNet NetworkConstructor) {
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
 
-		log := gtest.NewLogger(t)
-
-		net, err := newNet(ctx, log)
+		net, err := newNet(t, ctx)
 		require.NoError(t, err)
 		defer net.Wait()
 		defer cancel()
@@ -178,9 +174,7 @@ func TestNetworkCompliance(t *testing.T, newNet NetworkConstructor) {
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
 
-		log := gtest.NewLogger(t)
-
-		net, err := newNet(ctx, log)
+		net, err := newNet(t, ctx)
 		require.NoError(t, err)
 		defer net.Wait()
 		defer cancel()
@@ -247,9 +241,7 @@ func TestNetworkCompliance(t *testing.T, newNet NetworkConstructor) {
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
 
-		log := gtest.NewLogger(t)
-
-		net, err := newNet(ctx, log)
+		net, err := newNet(t, ctx)
 		require.NoError(t, err)
 		defer net.Wait()
 		defer cancel()
@@ -309,9 +301,7 @@ func TestNetworkCompliance(t *testing.T, newNet NetworkConstructor) {
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
 
-		log := gtest.NewLogger(t)
-
-		net, err := newNet(ctx, log)
+		net, err := newNet(t, ctx)
 		require.NoError(t, err)
 		defer net.Wait()
 		defer cancel()