[Testing, Docs] refactor: move /internal/... to /testutil/... for god…

…ocs (#153) * refactor: move /internal pkgs to /testutil * chore: cleanup
pokt-network · Nov 7, 2023 · c66c251 · c66c251
1 parent 5b3fd95
commit c66c251
Show file tree

Hide file tree

Showing 26 changed files with 51 additions and 54 deletions.
diff --git a/internal/mocks/mocks.go b/internal/mocks/mocks.go
diff --git a/pkg/client/block/client_integration_test.go b/pkg/client/block/client_integration_test.go
@@ -12,8 +12,8 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/testclient/testblock"
 	"github.com/pokt-network/poktroll/pkg/client"
+	"github.com/pokt-network/poktroll/testutil/testclient/testblock"
 )
 
 const blockIntegrationSubTimeout = 5 * time.Second

diff --git a/pkg/client/block/client_test.go b/pkg/client/block/client_test.go
@@ -10,10 +10,10 @@ import (
 	comettypes "github.com/cometbft/cometbft/types"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/testclient"
-	"github.com/pokt-network/poktroll/internal/testclient/testeventsquery"
 	"github.com/pokt-network/poktroll/pkg/client"
 	"github.com/pokt-network/poktroll/pkg/client/block"
+	"github.com/pokt-network/poktroll/testutil/testclient"
+	"github.com/pokt-network/poktroll/testutil/testclient/testeventsquery"
 )
 
 const (

diff --git a/pkg/client/events_query/client_integration_test.go b/pkg/client/events_query/client_integration_test.go
@@ -9,7 +9,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/testclient/testeventsquery"
+	"github.com/pokt-network/poktroll/testutil/testclient/testeventsquery"
 )
 
 // The query use to subscribe for new block events on the websocket endpoint exposed by CometBFT nodes

diff --git a/pkg/client/events_query/client_test.go b/pkg/client/events_query/client_test.go
@@ -13,14 +13,15 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/mocks/mockclient"
-	"github.com/pokt-network/poktroll/internal/testchannel"
-	"github.com/pokt-network/poktroll/internal/testclient/testeventsquery"
-	"github.com/pokt-network/poktroll/internal/testerrors"
+	"github.com/pokt-network/poktroll/testutil/mockclient"
+
 	eventsquery "github.com/pokt-network/poktroll/pkg/client/events_query"
 	"github.com/pokt-network/poktroll/pkg/client/events_query/websocket"
 	"github.com/pokt-network/poktroll/pkg/either"
 	"github.com/pokt-network/poktroll/pkg/observable"
+	"github.com/pokt-network/poktroll/testutil/testchannel"
+	"github.com/pokt-network/poktroll/testutil/testclient/testeventsquery"
+	"github.com/pokt-network/poktroll/testutil/testerrors"
 )
 
 func TestEventsQueryClient_Subscribe_Succeeds(t *testing.T) {

diff --git a/pkg/client/interface.go b/pkg/client/interface.go
@@ -1,9 +1,9 @@
-//go:generate mockgen -destination=../../internal/mocks/mockclient/events_query_client_mock.go -package=mockclient . Dialer,Connection,EventsQueryClient
-//go:generate mockgen -destination=../../internal/mocks/mockclient/block_client_mock.go -package=mockclient . Block,BlockClient
-//go:generate mockgen -destination=../../internal/mocks/mockclient/tx_client_mock.go -package=mockclient . TxContext,TxClient
-//go:generate mockgen -destination=../../internal/mocks/mockclient/cosmos_tx_builder_mock.go -package=mockclient github.com/cosmos/cosmos-sdk/client TxBuilder
-//go:generate mockgen -destination=../../internal/mocks/mockclient/cosmos_keyring_mock.go -package=mockclient github.com/cosmos/cosmos-sdk/crypto/keyring Keyring
-//go:generate mockgen -destination=../../internal/mocks/mockclient/cosmos_client_mock.go -package=mockclient github.com/cosmos/cosmos-sdk/client AccountRetriever
+//go:generate mockgen -destination=../../testutil/mockclient/events_query_client_mock.go -package=mockclient . Dialer,Connection,EventsQueryClient
+//go:generate mockgen -destination=../../testutil/mockclient/block_client_mock.go -package=mockclient . Block,BlockClient
+//go:generate mockgen -destination=../../testutil/mockclient/tx_client_mock.go -package=mockclient . TxContext,TxClient
+//go:generate mockgen -destination=../../testutil/mockclient/cosmos_tx_builder_mock.go -package=mockclient github.com/cosmos/cosmos-sdk/client TxBuilder
+//go:generate mockgen -destination=../../testutil/mockclient/cosmos_keyring_mock.go -package=mockclient github.com/cosmos/cosmos-sdk/crypto/keyring Keyring
+//go:generate mockgen -destination=../../testutil/mockclient/cosmos_client_mock.go -package=mockclient github.com/cosmos/cosmos-sdk/client AccountRetriever
 
 package client
 

diff --git a/pkg/client/supplier/client_integration_test.go b/pkg/client/supplier/client_integration_test.go
@@ -8,7 +8,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/testclient/testsupplier"
+	"github.com/pokt-network/poktroll/testutil/testclient/testsupplier"
 	sessiontypes "github.com/pokt-network/poktroll/x/session/types"
 )
 

diff --git a/pkg/client/supplier/client_test.go b/pkg/client/supplier/client_test.go
@@ -11,11 +11,12 @@ import (
 	"github.com/pokt-network/smt"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/mocks/mockclient"
-	"github.com/pokt-network/poktroll/internal/testclient/testkeyring"
-	"github.com/pokt-network/poktroll/internal/testclient/testtx"
+	"github.com/pokt-network/poktroll/testutil/mockclient"
+
 	"github.com/pokt-network/poktroll/pkg/client/keyring"
 	"github.com/pokt-network/poktroll/pkg/client/supplier"
+	"github.com/pokt-network/poktroll/testutil/testclient/testkeyring"
+	"github.com/pokt-network/poktroll/testutil/testclient/testtx"
 	sessiontypes "github.com/pokt-network/poktroll/x/session/types"
 )
 

diff --git a/pkg/client/tx/client_integration_test.go b/pkg/client/tx/client_integration_test.go
@@ -10,12 +10,12 @@ import (
 	"github.com/cosmos/cosmos-sdk/types"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/testclient/testkeyring"
 	"github.com/pokt-network/poktroll/pkg/client/tx"
+	"github.com/pokt-network/poktroll/testutil/testclient/testblock"
+	"github.com/pokt-network/poktroll/testutil/testclient/testeventsquery"
+	"github.com/pokt-network/poktroll/testutil/testclient/testkeyring"
+	"github.com/pokt-network/poktroll/testutil/testclient/testtx"
 
-	"github.com/pokt-network/poktroll/internal/testclient/testblock"
-	"github.com/pokt-network/poktroll/internal/testclient/testeventsquery"
-	"github.com/pokt-network/poktroll/internal/testclient/testtx"
 	"github.com/pokt-network/poktroll/pkg/client"
 	apptypes "github.com/pokt-network/poktroll/x/application/types"
 )

diff --git a/pkg/client/tx/client_test.go b/pkg/client/tx/client_test.go
@@ -13,16 +13,17 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/mocks/mockclient"
-	"github.com/pokt-network/poktroll/internal/testclient"
-	"github.com/pokt-network/poktroll/internal/testclient/testblock"
-	"github.com/pokt-network/poktroll/internal/testclient/testeventsquery"
-	"github.com/pokt-network/poktroll/internal/testclient/testkeyring"
-	"github.com/pokt-network/poktroll/internal/testclient/testtx"
+	"github.com/pokt-network/poktroll/testutil/mockclient"
+
 	"github.com/pokt-network/poktroll/pkg/client"
 	"github.com/pokt-network/poktroll/pkg/client/keyring"
 	"github.com/pokt-network/poktroll/pkg/client/tx"
 	"github.com/pokt-network/poktroll/pkg/either"
+	"github.com/pokt-network/poktroll/testutil/testclient"
+	"github.com/pokt-network/poktroll/testutil/testclient/testblock"
+	"github.com/pokt-network/poktroll/testutil/testclient/testeventsquery"
+	"github.com/pokt-network/poktroll/testutil/testclient/testkeyring"
+	"github.com/pokt-network/poktroll/testutil/testclient/testtx"
 	apptypes "github.com/pokt-network/poktroll/x/application/types"
 )
 

diff --git a/pkg/observable/channel/observable_test.go b/pkg/observable/channel/observable_test.go
@@ -10,10 +10,10 @@ import (
 	"github.com/stretchr/testify/require"
 	"golang.org/x/sync/errgroup"
 
-	"github.com/pokt-network/poktroll/internal/testchannel"
-	"github.com/pokt-network/poktroll/internal/testerrors"
 	"github.com/pokt-network/poktroll/pkg/observable"
 	"github.com/pokt-network/poktroll/pkg/observable/channel"
+	"github.com/pokt-network/poktroll/testutil/testchannel"
+	"github.com/pokt-network/poktroll/testutil/testerrors"
 )
 
 const (

diff --git a/pkg/observable/channel/replay_test.go b/pkg/observable/channel/replay_test.go
@@ -8,8 +8,8 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/testerrors"
 	"github.com/pokt-network/poktroll/pkg/observable/channel"
+	"github.com/pokt-network/poktroll/testutil/testerrors"
 )
 
 func TestReplayObservable(t *testing.T) {

diff --git a/internal/mocks/mockclient/mocks.go → testutil/mockclient/mocks.go b/internal/mocks/mockclient/mocks.go → testutil/mockclient/mocks.go
diff --git a/internal/testchannel/drain.go → testutil/testchannel/drain.go b/internal/testchannel/drain.go → testutil/testchannel/drain.go
diff --git a/internal/testclient/keyring.go → testutil/testclient/keyring.go b/internal/testclient/keyring.go → testutil/testclient/keyring.go
diff --git a/internal/testclient/localnet.go → testutil/testclient/localnet.go b/internal/testclient/localnet.go → testutil/testclient/localnet.go
diff --git a/internal/testclient/testblock/client.go → testutil/testclient/testblock/client.go b/internal/testclient/testblock/client.go → testutil/testclient/testblock/client.go
@@ -8,12 +8,13 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/mocks/mockclient"
-	"github.com/pokt-network/poktroll/internal/testclient"
-	"github.com/pokt-network/poktroll/internal/testclient/testeventsquery"
+	"github.com/pokt-network/poktroll/testutil/mockclient"
+
 	"github.com/pokt-network/poktroll/pkg/client"
 	"github.com/pokt-network/poktroll/pkg/client/block"
 	"github.com/pokt-network/poktroll/pkg/observable/channel"
+	"github.com/pokt-network/poktroll/testutil/testclient"
+	"github.com/pokt-network/poktroll/testutil/testclient/testeventsquery"
 )
 
 // NewLocalnetClient creates and returns a new BlockClient that's configured for

diff --git a/internal/testclient/testblock/godoc.go → testutil/testclient/testblock/godoc.go b/internal/testclient/testblock/godoc.go → testutil/testclient/testblock/godoc.go
diff --git a/...rnal/testclient/testeventsquery/client.go → ...util/testclient/testeventsquery/client.go b/...rnal/testclient/testeventsquery/client.go → ...util/testclient/testeventsquery/client.go
@@ -10,12 +10,13 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/mocks/mockclient"
-	"github.com/pokt-network/poktroll/internal/testclient"
+	"github.com/pokt-network/poktroll/testutil/mockclient"
+
 	"github.com/pokt-network/poktroll/pkg/client"
 	eventsquery "github.com/pokt-network/poktroll/pkg/client/events_query"
 	"github.com/pokt-network/poktroll/pkg/either"
 	"github.com/pokt-network/poktroll/pkg/observable/channel"
+	"github.com/pokt-network/poktroll/testutil/testclient"
 )
 
 // NewLocalnetClient creates and returns a new events query client that's configured

diff --git a/.../testclient/testeventsquery/connection.go → .../testclient/testeventsquery/connection.go b/.../testclient/testeventsquery/connection.go → .../testclient/testeventsquery/connection.go
@@ -5,8 +5,8 @@ import (
 
 	"github.com/golang/mock/gomock"
 
-	"github.com/pokt-network/poktroll/internal/mocks/mockclient"
 	"github.com/pokt-network/poktroll/pkg/either"
+	"github.com/pokt-network/poktroll/testutil/mockclient"
 )
 
 // NewOneTimeMockConnAndDialer returns a new mock connection and mock dialer that

diff --git a/internal/testclient/testeventsquery/godoc.go → testutil/testclient/testeventsquery/godoc.go b/internal/testclient/testeventsquery/godoc.go → testutil/testclient/testeventsquery/godoc.go
diff --git a/internal/testclient/testkeyring/keyring.go → testutil/testclient/testkeyring/keyring.go b/internal/testclient/testkeyring/keyring.go → testutil/testclient/testkeyring/keyring.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/crypto/keyring"
 
-	"github.com/pokt-network/poktroll/internal/testclient"
+	"github.com/pokt-network/poktroll/testutil/testclient"
 )
 
 // NewTestKeyringWithKey creates a new in-memory keyring with a test key

diff --git a/internal/testclient/testsupplier/client.go → testutil/testclient/testsupplier/client.go b/internal/testclient/testsupplier/client.go → testutil/testclient/testsupplier/client.go
@@ -6,10 +6,10 @@ import (
 	"cosmossdk.io/depinject"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/testclient/testtx"
 	"github.com/pokt-network/poktroll/pkg/client"
 	"github.com/pokt-network/poktroll/pkg/client/supplier"
 	"github.com/pokt-network/poktroll/pkg/client/tx"
+	"github.com/pokt-network/poktroll/testutil/testclient/testtx"
 )
 
 // NewLocalnetClient creates and returns a new supplier client that connects to

diff --git a/internal/testclient/testtx/client.go → testutil/testclient/testtx/client.go b/internal/testclient/testtx/client.go → testutil/testclient/testtx/client.go
@@ -10,12 +10,13 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/mocks/mockclient"
-	"github.com/pokt-network/poktroll/internal/testclient/testblock"
-	"github.com/pokt-network/poktroll/internal/testclient/testeventsquery"
+	"github.com/pokt-network/poktroll/testutil/mockclient"
+
 	"github.com/pokt-network/poktroll/pkg/client"
 	"github.com/pokt-network/poktroll/pkg/client/tx"
 	"github.com/pokt-network/poktroll/pkg/either"
+	"github.com/pokt-network/poktroll/testutil/testclient/testblock"
+	"github.com/pokt-network/poktroll/testutil/testclient/testeventsquery"
 )
 
 type signAndBroadcastFn func(context.Context, cosmostypes.Msg) either.AsyncError

diff --git a/internal/testclient/testtx/context.go → testutil/testclient/testtx/context.go b/internal/testclient/testtx/context.go → testutil/testclient/testtx/context.go
@@ -17,10 +17,11 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/require"
 
-	"github.com/pokt-network/poktroll/internal/mocks/mockclient"
-	"github.com/pokt-network/poktroll/internal/testclient"
+	"github.com/pokt-network/poktroll/testutil/mockclient"
+
 	"github.com/pokt-network/poktroll/pkg/client"
 	"github.com/pokt-network/poktroll/pkg/client/tx"
+	"github.com/pokt-network/poktroll/testutil/testclient"
 )
 
 // NewLocalnetContext creates and returns a new transaction context configured

diff --git a/internal/testerrors/require.go → testutil/testerrors/require.go b/internal/testerrors/require.go → testutil/testerrors/require.go