From 7f252c2fb65f8be8ac7671164a344d8a793ac707 Mon Sep 17 00:00:00 2001
From: Nicholas Molnar <65710+neekolas@users.noreply.github.com>
Date: Thu, 29 Aug 2024 16:27:28 -0700
Subject: [PATCH] Rename testing to testutils (#121)

## tl;dr

- It was annoying having to alias the `testing` package everywhere it was used because the name conflicts with the standard `testing` package. This renames it
---
 pkg/api/service_test.go                       | 8 ++++----
 pkg/db/subscription_test.go                   | 4 ++--
 pkg/indexer/blockchain/rpcLogStreamer_test.go | 2 +-
 pkg/indexer/indexer_test.go                   | 2 +-
 pkg/indexer/storer/groupMessage_test.go       | 2 +-
 pkg/registrant/registrant_test.go             | 8 ++++----
 pkg/registry/contractRegistry_test.go         | 8 ++++----
 pkg/server/server_test.go                     | 6 +++---
 pkg/{testing => testutils}/config.go          | 2 +-
 pkg/{testing => testutils}/contracts.go       | 2 +-
 pkg/{testing => testutils}/hex.go             | 2 +-
 pkg/{testing => testutils}/log.go             | 2 +-
 pkg/{testing => testutils}/random.go          | 2 +-
 pkg/{testing => testutils}/store.go           | 2 +-
 14 files changed, 26 insertions(+), 26 deletions(-)
 rename pkg/{testing => testutils}/config.go (98%)
 rename pkg/{testing => testutils}/contracts.go (98%)
 rename pkg/{testing => testutils}/hex.go (94%)
 rename pkg/{testing => testutils}/log.go (95%)
 rename pkg/{testing => testutils}/random.go (97%)
 rename pkg/{testing => testutils}/store.go (98%)

diff --git a/pkg/api/service_test.go b/pkg/api/service_test.go
index c91ba4cc..47b7a628 100644
--- a/pkg/api/service_test.go
+++ b/pkg/api/service_test.go
@@ -14,17 +14,17 @@ import (
 	"github.com/xmtp/xmtpd/pkg/proto/xmtpv4/message_api"
 	"github.com/xmtp/xmtpd/pkg/registrant"
 	"github.com/xmtp/xmtpd/pkg/registry"
-	test "github.com/xmtp/xmtpd/pkg/testing"
+	"github.com/xmtp/xmtpd/pkg/testutils"
 	"google.golang.org/protobuf/proto"
 )
 
 func newTestService(t *testing.T) (*Service, *sql.DB, func()) {
 	ctx := context.Background()
-	log := test.NewLog(t)
-	db, _, dbCleanup := test.NewDB(t, ctx)
+	log := testutils.NewLog(t)
+	db, _, dbCleanup := testutils.NewDB(t, ctx)
 	privKey, err := crypto.GenerateKey()
 	require.NoError(t, err)
-	privKeyStr := "0x" + test.HexEncode(crypto.FromECDSA(privKey))
+	privKeyStr := "0x" + testutils.HexEncode(crypto.FromECDSA(privKey))
 	mockRegistry := mocks.NewMockNodeRegistry(t)
 	mockRegistry.EXPECT().GetNodes().Return([]registry.Node{
 		{NodeID: 1, SigningKey: &privKey.PublicKey},
diff --git a/pkg/db/subscription_test.go b/pkg/db/subscription_test.go
index 0fecef7c..afaefbd4 100644
--- a/pkg/db/subscription_test.go
+++ b/pkg/db/subscription_test.go
@@ -9,7 +9,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 	"github.com/xmtp/xmtpd/pkg/db/queries"
-	test "github.com/xmtp/xmtpd/pkg/testing"
+	"github.com/xmtp/xmtpd/pkg/testutils"
 	"go.uber.org/zap"
 )
 
@@ -37,7 +37,7 @@ func insertGatewayEnvelopes(
 
 func setup(t *testing.T) (*sql.DB, *zap.Logger, func()) {
 	ctx := context.Background()
-	db, _, dbCleanup := test.NewDB(t, ctx)
+	db, _, dbCleanup := testutils.NewDB(t, ctx)
 	log, err := zap.NewDevelopment()
 	require.NoError(t, err)
 
diff --git a/pkg/indexer/blockchain/rpcLogStreamer_test.go b/pkg/indexer/blockchain/rpcLogStreamer_test.go
index e7e6629c..fd38166d 100644
--- a/pkg/indexer/blockchain/rpcLogStreamer_test.go
+++ b/pkg/indexer/blockchain/rpcLogStreamer_test.go
@@ -6,7 +6,7 @@ import (
 	"testing"
 
 	"github.com/xmtp/xmtpd/pkg/mocks"
-	testutils "github.com/xmtp/xmtpd/pkg/testing"
+	"github.com/xmtp/xmtpd/pkg/testutils"
 
 	ethereum "github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/common"
diff --git a/pkg/indexer/indexer_test.go b/pkg/indexer/indexer_test.go
index aa11859e..1f1a9702 100644
--- a/pkg/indexer/indexer_test.go
+++ b/pkg/indexer/indexer_test.go
@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/mock"
 	"github.com/xmtp/xmtpd/pkg/indexer/storer"
 	"github.com/xmtp/xmtpd/pkg/mocks"
-	testutils "github.com/xmtp/xmtpd/pkg/testing"
+	"github.com/xmtp/xmtpd/pkg/testutils"
 )
 
 func TestIndexLogsSuccess(t *testing.T) {
diff --git a/pkg/indexer/storer/groupMessage_test.go b/pkg/indexer/storer/groupMessage_test.go
index 416c4a9d..9af75b1b 100644
--- a/pkg/indexer/storer/groupMessage_test.go
+++ b/pkg/indexer/storer/groupMessage_test.go
@@ -11,7 +11,7 @@ import (
 	"github.com/xmtp/xmtpd/pkg/db"
 	"github.com/xmtp/xmtpd/pkg/db/queries"
 	"github.com/xmtp/xmtpd/pkg/indexer/blockchain"
-	testutils "github.com/xmtp/xmtpd/pkg/testing"
+	"github.com/xmtp/xmtpd/pkg/testutils"
 	"github.com/xmtp/xmtpd/pkg/utils"
 )
 
diff --git a/pkg/registrant/registrant_test.go b/pkg/registrant/registrant_test.go
index 858767c2..8ed5d794 100644
--- a/pkg/registrant/registrant_test.go
+++ b/pkg/registrant/registrant_test.go
@@ -13,7 +13,7 @@ import (
 	"github.com/xmtp/xmtpd/pkg/proto/xmtpv4/message_api"
 	"github.com/xmtp/xmtpd/pkg/registrant"
 	"github.com/xmtp/xmtpd/pkg/registry"
-	test "github.com/xmtp/xmtpd/pkg/testing"
+	"github.com/xmtp/xmtpd/pkg/testutils"
 	"google.golang.org/protobuf/proto"
 )
 
@@ -30,7 +30,7 @@ type deps struct {
 func setup(t *testing.T) (deps, func()) {
 	ctx := context.Background()
 	mockRegistry := mocks.NewMockNodeRegistry(t)
-	db, _, dbCleanup := test.NewDB(t, ctx)
+	db, _, dbCleanup := testutils.NewDB(t, ctx)
 	queries := queries.New(db)
 	privKey1, err := crypto.GenerateKey()
 	require.NoError(t, err)
@@ -38,7 +38,7 @@ func setup(t *testing.T) (deps, func()) {
 	require.NoError(t, err)
 	privKey3, err := crypto.GenerateKey()
 	require.NoError(t, err)
-	privKey1Str := "0x" + test.HexEncode(crypto.FromECDSA(privKey1))
+	privKey1Str := "0x" + testutils.HexEncode(crypto.FromECDSA(privKey1))
 
 	return deps{
 		ctx:         ctx,
@@ -179,7 +179,7 @@ func TestNewRegistrantPrivateKeyNo0x(t *testing.T) {
 		deps.ctx,
 		deps.db,
 		deps.registry,
-		test.HexEncode(crypto.FromECDSA(deps.privKey1)),
+		testutils.HexEncode(crypto.FromECDSA(deps.privKey1)),
 	)
 	require.NoError(t, err)
 }
diff --git a/pkg/registry/contractRegistry_test.go b/pkg/registry/contractRegistry_test.go
index d54e9441..e749634c 100644
--- a/pkg/registry/contractRegistry_test.go
+++ b/pkg/registry/contractRegistry_test.go
@@ -13,13 +13,13 @@ import (
 	"github.com/xmtp/xmtpd/pkg/config"
 	"github.com/xmtp/xmtpd/pkg/mocks"
 	r "github.com/xmtp/xmtpd/pkg/registry"
-	testUtils "github.com/xmtp/xmtpd/pkg/testing"
+	"github.com/xmtp/xmtpd/pkg/testutils"
 )
 
 func TestContractRegistryNewNodes(t *testing.T) {
 	registry, err := r.NewSmartContractRegistry(
 		nil,
-		testUtils.NewLog(t),
+		testutils.NewLog(t),
 		config.ContractsOptions{RefreshInterval: 100 * time.Millisecond},
 	)
 	require.NoError(t, err)
@@ -53,7 +53,7 @@ func TestContractRegistryNewNodes(t *testing.T) {
 func TestContractRegistryChangedNodes(t *testing.T) {
 	registry, err := r.NewSmartContractRegistry(
 		nil,
-		testUtils.NewLog(t),
+		testutils.NewLog(t),
 		config.ContractsOptions{RefreshInterval: 10 * time.Millisecond},
 	)
 	require.NoError(t, err)
@@ -100,7 +100,7 @@ func TestContractRegistryChangedNodes(t *testing.T) {
 func TestStopOnContextCancel(t *testing.T) {
 	registry, err := r.NewSmartContractRegistry(
 		nil,
-		testUtils.NewLog(t),
+		testutils.NewLog(t),
 		config.ContractsOptions{RefreshInterval: 10 * time.Millisecond},
 	)
 	require.NoError(t, err)
diff --git a/pkg/server/server_test.go b/pkg/server/server_test.go
index 2fdd7311..a8609c30 100644
--- a/pkg/server/server_test.go
+++ b/pkg/server/server_test.go
@@ -13,7 +13,7 @@ import (
 	"github.com/xmtp/xmtpd/pkg/mocks"
 	r "github.com/xmtp/xmtpd/pkg/registry"
 	s "github.com/xmtp/xmtpd/pkg/server"
-	test "github.com/xmtp/xmtpd/pkg/testing"
+	"github.com/xmtp/xmtpd/pkg/testutils"
 )
 
 func NewTestServer(
@@ -22,7 +22,7 @@ func NewTestServer(
 	registry r.NodeRegistry,
 	privateKey *ecdsa.PrivateKey,
 ) *s.ReplicationServer {
-	log := test.NewLog(t)
+	log := testutils.NewLog(t)
 
 	server, err := s.NewReplicationServer(context.Background(), log, config.ServerOptions{
 		PrivateKeyString: hex.EncodeToString(crypto.FromECDSA(privateKey)),
@@ -36,7 +36,7 @@ func NewTestServer(
 }
 
 func TestCreateServer(t *testing.T) {
-	dbs, dbCleanup := test.NewDBs(t, context.Background(), 2)
+	dbs, dbCleanup := testutils.NewDBs(t, context.Background(), 2)
 	defer dbCleanup()
 	privateKey1, err := crypto.GenerateKey()
 	require.NoError(t, err)
diff --git a/pkg/testing/config.go b/pkg/testutils/config.go
similarity index 98%
rename from pkg/testing/config.go
rename to pkg/testutils/config.go
index 021fe3f1..fee127c3 100644
--- a/pkg/testing/config.go
+++ b/pkg/testutils/config.go
@@ -1,4 +1,4 @@
-package testing
+package testutils
 
 import (
 	"encoding/json"
diff --git a/pkg/testing/contracts.go b/pkg/testutils/contracts.go
similarity index 98%
rename from pkg/testing/contracts.go
rename to pkg/testutils/contracts.go
index 783ea366..035cfff5 100644
--- a/pkg/testing/contracts.go
+++ b/pkg/testutils/contracts.go
@@ -1,4 +1,4 @@
-package testing
+package testutils
 
 import (
 	"testing"
diff --git a/pkg/testing/hex.go b/pkg/testutils/hex.go
similarity index 94%
rename from pkg/testing/hex.go
rename to pkg/testutils/hex.go
index 7416dbdc..565b6551 100644
--- a/pkg/testing/hex.go
+++ b/pkg/testutils/hex.go
@@ -1,4 +1,4 @@
-package testing
+package testutils
 
 import "encoding/hex"
 
diff --git a/pkg/testing/log.go b/pkg/testutils/log.go
similarity index 95%
rename from pkg/testing/log.go
rename to pkg/testutils/log.go
index cbfd3fd0..068ea348 100644
--- a/pkg/testing/log.go
+++ b/pkg/testutils/log.go
@@ -1,4 +1,4 @@
-package testing
+package testutils
 
 import (
 	"flag"
diff --git a/pkg/testing/random.go b/pkg/testutils/random.go
similarity index 97%
rename from pkg/testing/random.go
rename to pkg/testutils/random.go
index 6e7249ab..363db5aa 100644
--- a/pkg/testing/random.go
+++ b/pkg/testutils/random.go
@@ -1,4 +1,4 @@
-package testing
+package testutils
 
 import (
 	cryptoRand "crypto/rand"
diff --git a/pkg/testing/store.go b/pkg/testutils/store.go
similarity index 98%
rename from pkg/testing/store.go
rename to pkg/testutils/store.go
index a975832c..f1106ac5 100644
--- a/pkg/testing/store.go
+++ b/pkg/testutils/store.go
@@ -1,4 +1,4 @@
-package testing
+package testutils
 
 import (
 	"context"