Skip to content

Commit

Permalink
refactor: testutil network
Browse files Browse the repository at this point in the history
  • Loading branch information
@bryanchriswhite
bryanchriswhite committed Jan 2, 2024
1 parent d3a21e3 commit 191e427
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 693 deletions.
4 changes: 1 addition & 3 deletions testutil/network/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,7 @@ func (cfg *InMemoryNetworkConfig) GetNumKeyringAccounts(t *testing.T) int {

// DefaultConfig will initialize config for the network with custom application,
// genesis and single validator. All other parameters are inherited from cosmos-sdk/testutil/network.DefaultConfig
//
// TODO_UPNEXT(@bryanchriswhite #285): Remove _ prefix after DebugConfig is removed from network.go.
func _DefaultConfig() network.Config {
func DefaultConfig() network.Config {
var (
encoding = app.MakeEncodingConfig()
chainID = "chain-" + rand.NewRand().Str(6)
Expand Down
324 changes: 5 additions & 319 deletions testutil/network/network.go
View file
Original file line number Diff line number Diff line change
@@ -1,44 +1,17 @@
package network

import (
"encoding/json"
"fmt"
"testing"
"time"

sdkmath "cosmossdk.io/math"
tmdb "github.com/cometbft/cometbft-db"
tmrand "github.com/cometbft/cometbft/libs/rand"
"github.com/cosmos/cosmos-sdk/baseapp"
"github.com/cosmos/cosmos-sdk/client/flags"
"github.com/cosmos/cosmos-sdk/crypto/hd"
"github.com/cosmos/cosmos-sdk/crypto/keyring"
servertypes "github.com/cosmos/cosmos-sdk/server/types"
pruningtypes "github.com/cosmos/cosmos-sdk/store/pruning/types"
clitestutil "github.com/cosmos/cosmos-sdk/testutil/cli"
"github.com/cosmos/cosmos-sdk/testutil/network"
simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
sdk "github.com/cosmos/cosmos-sdk/types"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
"github.com/stretchr/testify/require"

"github.com/pokt-network/poktroll/app"
"github.com/pokt-network/poktroll/testutil/sample"
appcli "github.com/pokt-network/poktroll/x/application/client/cli"
apptypes "github.com/pokt-network/poktroll/x/application/types"
gatewaytypes "github.com/pokt-network/poktroll/x/gateway/types"
sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
suppliertypes "github.com/pokt-network/poktroll/x/supplier/types"
)

type (
Network = network.Network
Config = network.Config
"github.com/pokt-network/poktroll/cmd/pocketd/cmd"
)

// New creates instance with fully configured cosmos network.
// Accepts optional config, that will be used in place of the DefaultConfig() if provided.
func New(t *testing.T, configs ...Config) *Network {
func New(t *testing.T, configs ...network.Config) *network.Network {
if len(configs) > 1 {
panic("at most one config should be provided")
}
Expand All @@ -56,294 +29,7 @@ func New(t *testing.T, configs ...Config) *Network {
return net
}

// DefaultConfig will initialize config for the network with custom application,
// genesis and single validator. All other parameters are inherited from cosmos-sdk/testutil/network.DefaultConfig
func DefaultConfig() network.Config {
var (
encoding = app.MakeEncodingConfig()
chainID = "chain-" + tmrand.NewRand().Str(6)
)
return network.Config{
Codec: encoding.Marshaler,
TxConfig: encoding.TxConfig,
LegacyAmino: encoding.Amino,
InterfaceRegistry: encoding.InterfaceRegistry,
AccountRetriever: authtypes.AccountRetriever{},
AppConstructor: func(val network.ValidatorI) servertypes.Application {
return app.New(
val.GetCtx().Logger,
tmdb.NewMemDB(),
nil,
true,
map[int64]bool{},
val.GetCtx().Config.RootDir,
0,
encoding,
simtestutil.EmptyAppOptions{},
baseapp.SetPruning(pruningtypes.NewPruningOptionsFromString(val.GetAppConfig().Pruning)),
baseapp.SetMinGasPrices(val.GetAppConfig().MinGasPrices),
baseapp.SetChainID(chainID),
)
},
GenesisState: app.ModuleBasics.DefaultGenesis(encoding.Marshaler),
TimeoutCommit: 2 * time.Second,
ChainID: chainID,
NumValidators: 1,
BondDenom: sdk.DefaultBondDenom,
MinGasPrices: fmt.Sprintf("0.000006%s", sdk.DefaultBondDenom),
AccountTokens: sdk.TokensFromConsensusPower(1000, sdk.DefaultPowerReduction),
StakingTokens: sdk.TokensFromConsensusPower(500, sdk.DefaultPowerReduction),
BondedTokens: sdk.TokensFromConsensusPower(100, sdk.DefaultPowerReduction),
PruningStrategy: pruningtypes.PruningOptionNothing,
CleanupDir: true,
SigningAlgo: string(hd.Secp256k1Type),
KeyringOptions: []keyring.Option{},
}
}

// TODO_CLEANUP: Refactor the genesis state helpers below to consolidate usage
// and reduce the code footprint.

// DefaultApplicationModuleGenesisState generates a GenesisState object with a given number of applications.
// It returns the populated GenesisState object.
func DefaultApplicationModuleGenesisState(t *testing.T, n int) *apptypes.GenesisState {
t.Helper()
state := apptypes.DefaultGenesis()
for i := 0; i < n; i++ {
stake := sdk.NewCoin("upokt", sdk.NewInt(int64(i+1)))
application := apptypes.Application{
Address: sample.AccAddress(),
Stake: &stake,
ServiceConfigs: []*sharedtypes.ApplicationServiceConfig{
{
Service: &sharedtypes.Service{Id: fmt.Sprintf("svc%d", i)},
},
{
Service: &sharedtypes.Service{Id: fmt.Sprintf("svc%d%d", i, i)},
},
},
}
// TODO_CONSIDERATION: Evaluate whether we need `nullify.Fill` or if we should enforce `(gogoproto.nullable) = false` everywhere
// nullify.Fill(&application)
state.ApplicationList = append(state.ApplicationList, application)
}
return state
}

// ApplicationModuleGenesisStateWithAccount generates a GenesisState object with
// a single application for each of the given addresses.
func ApplicationModuleGenesisStateWithAddresses(t *testing.T, addresses []string) *apptypes.GenesisState {
t.Helper()
state := apptypes.DefaultGenesis()
for _, addr := range addresses {
application := apptypes.Application{
Address: addr,
Stake: &sdk.Coin{Denom: "upokt", Amount: sdk.NewInt(10000)},
ServiceConfigs: []*sharedtypes.ApplicationServiceConfig{
{
Service: &sharedtypes.Service{Id: "svc1"},
},
},
}
state.ApplicationList = append(state.ApplicationList, application)
}

return state
}

// DefaultSupplierModuleGenesisState generates a GenesisState object with a given number of suppliers.
// It returns the populated GenesisState object.
func DefaultSupplierModuleGenesisState(t *testing.T, n int) *suppliertypes.GenesisState {
t.Helper()
state := suppliertypes.DefaultGenesis()
for i := 0; i < n; i++ {
stake := sdk.NewCoin("upokt", sdk.NewInt(int64(i)))
supplier := sharedtypes.Supplier{
Address: sample.AccAddress(),
Stake: &stake,
Services: []*sharedtypes.SupplierServiceConfig{
{
Service: &sharedtypes.Service{Id: fmt.Sprintf("svc%d", i)},
Endpoints: []*sharedtypes.SupplierEndpoint{
{
Url: fmt.Sprintf("http://localhost:%d", i),
RpcType: sharedtypes.RPCType_JSON_RPC,
},
},
},
},
}
// TODO_CONSIDERATION: Evaluate whether we need `nullify.Fill` or if we should enforce `(gogoproto.nullable) = false` everywhere
// nullify.Fill(&supplier)
state.SupplierList = append(state.SupplierList, supplier)
}
return state
}

// SupplierModuleGenesisStateWithAddresses generates a GenesisState object with
// a single supplier for each of the given addresses.
func SupplierModuleGenesisStateWithAddresses(t *testing.T, addresses []string) *suppliertypes.GenesisState {
t.Helper()
state := suppliertypes.DefaultGenesis()
for _, addr := range addresses {
supplier := sharedtypes.Supplier{
Address: addr,
Stake: &sdk.Coin{Denom: "upokt", Amount: sdk.NewInt(10000)},
Services: []*sharedtypes.SupplierServiceConfig{
{
Service: &sharedtypes.Service{Id: "svc1"},
Endpoints: []*sharedtypes.SupplierEndpoint{
{
Url: "http://localhost:1",
RpcType: sharedtypes.RPCType_JSON_RPC,
},
},
},
},
}
state.SupplierList = append(state.SupplierList, supplier)
}

return state
}

// DefaultGatewayModuleGenesisState generates a GenesisState object with a given
// number of gateways. It returns the populated GenesisState object.
func DefaultGatewayModuleGenesisState(t *testing.T, n int) *gatewaytypes.GenesisState {
t.Helper()
state := gatewaytypes.DefaultGenesis()
for i := 0; i < n; i++ {
stake := sdk.NewCoin("upokt", sdk.NewInt(int64(i)))
gateway := gatewaytypes.Gateway{
Address: sample.AccAddress(),
Stake: &stake,
}
// TODO_CONSIDERATION: Evaluate whether we need `nullify.Fill` or if we should enforce `(gogoproto.nullable) = false` everywhere
// nullify.Fill(&gateway)
state.GatewayList = append(state.GatewayList, gateway)
}
return state
}

// GatewayModuleGenesisStateWithAddresses generates a GenesisState object with
// a gateway list full of gateways with the given addresses.
// It returns the populated GenesisState object.
func GatewayModuleGenesisStateWithAddresses(t *testing.T, addresses []string) *gatewaytypes.GenesisState {
t.Helper()
state := gatewaytypes.DefaultGenesis()
for _, addr := range addresses {
gateway := gatewaytypes.Gateway{
Address: addr,
Stake: &sdk.Coin{Denom: "upokt", Amount: sdk.NewInt(10000)},
}
state.GatewayList = append(state.GatewayList, gateway)
}
return state
}

// TODO_CLEANUP: Consolidate all of the helpers below to use shared business
// logic and move into its own helpers file.

// InitAccount initializes an Account by sending it some funds from the validator
// in the network to the address provided
func InitAccount(t *testing.T, net *Network, addr sdk.AccAddress) {
t.Helper()
val := net.Validators[0]
ctx := val.ClientCtx
args := []string{
fmt.Sprintf("--%s=%s", flags.FlagFrom, val.Address.String()),
fmt.Sprintf("--%s=true", flags.FlagSkipConfirmation),
fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastSync),
fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(net.Config.BondDenom, sdkmath.NewInt(10))).String()),
}
amount := sdk.NewCoins(sdk.NewCoin("stake", sdkmath.NewInt(200)))
responseRaw, err := clitestutil.MsgSendExec(ctx, val.Address, addr, amount, args...)
require.NoError(t, err)
var responseJSON map[string]interface{}
err = json.Unmarshal(responseRaw.Bytes(), &responseJSON)
require.NoError(t, err)
require.Equal(t, float64(0), responseJSON["code"], "code is not 0 in the response: %v", responseJSON)
}

// InitAccountWithSequence initializes an Account by sending it some funds from
// the validator in the network to the address provided
func InitAccountWithSequence(
t *testing.T,
net *Network,
addr sdk.AccAddress,
signatureSequencerNumber int,
) {
t.Helper()
val := net.Validators[0]
signerAccountNumber := 0
ctx := val.ClientCtx
args := []string{
fmt.Sprintf("--%s=true", flags.FlagOffline),
fmt.Sprintf("--%s=%d", flags.FlagAccountNumber, signerAccountNumber),
fmt.Sprintf("--%s=%d", flags.FlagSequence, signatureSequencerNumber),

fmt.Sprintf("--%s=%s", flags.FlagFrom, val.Address.String()),
fmt.Sprintf("--%s=true", flags.FlagSkipConfirmation),
fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastSync),
fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(net.Config.BondDenom, sdkmath.NewInt(10))).String()),
}
amount := sdk.NewCoins(sdk.NewCoin("stake", sdkmath.NewInt(200)))
responseRaw, err := clitestutil.MsgSendExec(ctx, val.Address, addr, amount, args...)
require.NoError(t, err)
var responseJSON map[string]interface{}
err = json.Unmarshal(responseRaw.Bytes(), &responseJSON)
require.NoError(t, err)
require.Equal(t, float64(0), responseJSON["code"], "code is not 0 in the response: %v", responseJSON)
}

// DelegateAppToGateway delegates the provided application to the provided gateway
func DelegateAppToGateway(
t *testing.T,
net *Network,
appAddr string,
gatewayAddr string,
) {
t.Helper()
val := net.Validators[0]
ctx := val.ClientCtx
args := []string{
gatewayAddr,
fmt.Sprintf("--%s=%s", flags.FlagFrom, appAddr),
fmt.Sprintf("--%s=true", flags.FlagSkipConfirmation),
fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastSync),
fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(net.Config.BondDenom, sdkmath.NewInt(10))).String()),
}
responseRaw, err := clitestutil.ExecTestCLICmd(ctx, appcli.CmdDelegateToGateway(), args)
require.NoError(t, err)
var resp sdk.TxResponse
require.NoError(t, net.Config.Codec.UnmarshalJSON(responseRaw.Bytes(), &resp))
require.NotNil(t, resp)
require.NotNil(t, resp.TxHash)
require.Equal(t, uint32(0), resp.Code)
}

// UndelegateAppFromGateway undelegates the provided application from the provided gateway
func UndelegateAppFromGateway(
t *testing.T,
net *Network,
appAddr string,
gatewayAddr string,
) {
t.Helper()
val := net.Validators[0]
ctx := val.ClientCtx
args := []string{
gatewayAddr,
fmt.Sprintf("--%s=%s", flags.FlagFrom, appAddr),
fmt.Sprintf("--%s=true", flags.FlagSkipConfirmation),
fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastSync),
fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(net.Config.BondDenom, sdkmath.NewInt(10))).String()),
}
responseRaw, err := clitestutil.ExecTestCLICmd(ctx, appcli.CmdUndelegateFromGateway(), args)
require.NoError(t, err)
var resp sdk.TxResponse
require.NoError(t, net.Config.Codec.UnmarshalJSON(responseRaw.Bytes(), &resp))
require.NotNil(t, resp)
require.NotNil(t, resp.TxHash)
require.Equal(t, uint32(0), resp.Code)
// init initializes the SDK configuration.
func init() {
cmd.InitSDKConfig()
}
6 changes: 3 additions & 3 deletions testutil/testkeyring/keyring.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ import (
func CreatePreGeneratedKeyringAccounts(
t *testing.T,
kr keyring.Keyring,
limit int,
numAccounts int,
) []*PreGeneratedAccount {
t.Helper()

accounts := make([]*PreGeneratedAccount, limit)
accounts := make([]*PreGeneratedAccount, numAccounts)
for i := range accounts {
preGeneratedAccount := MustPreGeneratedAccountAtIndex(uint32(i))

Expand All @@ -43,5 +43,5 @@ func CreatePreGeneratedKeyringAccounts(
accounts[i] = preGeneratedAccount
}

return accounts[:limit]
return accounts[:numAccounts]
}
Loading

0 comments on commit 191e427

Please sign in to comment.