status-go/rpc/network/db/network_db_test.go

package db_test

import (
	"database/sql"
	"testing"

	"github.com/stretchr/testify/require"
	"github.com/stretchr/testify/suite"

	"github.com/status-im/status-go/api"
	"github.com/status-im/status-go/appdatabase"
	"github.com/status-im/status-go/params"
	"github.com/status-im/status-go/rpc/network/db"
	"github.com/status-im/status-go/rpc/network/testutil"
	"github.com/status-im/status-go/t/helpers"
)

type NetworksPersistenceTestSuite struct {
	suite.Suite
	db                  *sql.DB
	cleanup             func() error
	networksPersistence db.NetworksPersistenceInterface
}

func (s *NetworksPersistenceTestSuite) SetupTest() {
	memDb, cleanup, err := helpers.SetupTestSQLDB(appdatabase.DbInitializer{}, "networks-tests")
	s.Require().NoError(err)
	s.db = memDb
	s.cleanup = cleanup
	s.networksPersistence = db.NewNetworksPersistence(memDb)
}

func (s *NetworksPersistenceTestSuite) TearDownTest() {
	if s.cleanup != nil {
		err := s.cleanup()
		require.NoError(s.T(), err)
	}
}

func TestNetworksPersistenceTestSuite(t *testing.T) {
	suite.Run(t, new(NetworksPersistenceTestSuite))
}

// Helper function to create default providers for a given chainID
func DefaultProviders(chainID uint64) []params.RpcProvider {
	return []params.RpcProvider{
		{
			Name:     "Provider1",
			ChainID:  chainID,
			URL:      "https://rpc.provider1.io",
			Type:     params.UserProviderType,
			Enabled:  true,
			AuthType: params.NoAuth,
		},
		{
			Name:         "Provider2",
			ChainID:      chainID,
			URL:          "https://rpc.provider2.io",
			Type:         params.EmbeddedProxyProviderType,
			Enabled:      true,
			AuthType:     params.BasicAuth,
			AuthLogin:    "user1",
			AuthPassword: "password1",
		},
	}
}

// Helper function to add and verify networks
func (s *NetworksPersistenceTestSuite) addAndVerifyNetworks(networks []*params.Network) {
	networkValues := make([]params.Network, 0, len(networks))
	for _, network := range networks {
		networkValues = append(networkValues, *network)
	}
	err := s.networksPersistence.SetNetworks(networkValues)
	s.Require().NoError(err)

	s.verifyNetworks(networks)
}

// Helper function to verify networks against the database
func (s *NetworksPersistenceTestSuite) verifyNetworks(networks []*params.Network) {
	allNetworks, err := s.networksPersistence.GetAllNetworks()
	s.Require().NoError(err)
	testutil.CompareNetworksList(s.T(), networks, allNetworks)
}

// Helper function to verify network deletion
func (s *NetworksPersistenceTestSuite) verifyNetworkDeletion(chainID uint64) {
	nets, err := s.networksPersistence.GetNetworkByChainID(chainID)
	s.Require().NoError(err)
	s.Require().Len(nets, 0)

	providers, err := s.networksPersistence.GetRpcPersistence().GetRpcProviders(chainID)
	s.Require().NoError(err)
	s.Require().Len(providers, 0)
}

// Tests

func (s *NetworksPersistenceTestSuite) TestAddAndGetNetworkWithProviders() {
	network := testutil.CreateNetwork(api.OptimismChainID, "Optimism Mainnet", []params.RpcProvider{
		testutil.CreateProvider(api.OptimismChainID, "Provider1", params.UserProviderType, true, "https://rpc.optimism.io"),
		testutil.CreateProvider(api.OptimismChainID, "Provider2", params.EmbeddedProxyProviderType, false, "https://backup.optimism.io"),
	})
	s.addAndVerifyNetworks([]*params.Network{network})
}

func (s *NetworksPersistenceTestSuite) TestDeleteNetworkWithProviders() {
	network := testutil.CreateNetwork(api.OptimismChainID, "Optimism Mainnet", DefaultProviders(api.OptimismChainID))
	s.addAndVerifyNetworks([]*params.Network{network})

	err := s.networksPersistence.DeleteNetwork(network.ChainID)
	s.Require().NoError(err)

	s.verifyNetworkDeletion(network.ChainID)
}

func (s *NetworksPersistenceTestSuite) TestUpdateNetworkAndProviders() {
	network := testutil.CreateNetwork(api.OptimismChainID, "Optimism Mainnet", DefaultProviders(api.OptimismChainID))
	s.addAndVerifyNetworks([]*params.Network{network})

	// Update fields
	network.ChainName = "Updated Optimism Mainnet"
	network.RpcProviders = []params.RpcProvider{
		testutil.CreateProvider(api.OptimismChainID, "UpdatedProvider", params.UserProviderType, true, "https://rpc.optimism.updated.io"),
	}

	s.addAndVerifyNetworks([]*params.Network{network})
}

func (s *NetworksPersistenceTestSuite) TestDeleteAllNetworks() {
	networks := []*params.Network{
		testutil.CreateNetwork(api.MainnetChainID, "Ethereum Mainnet", DefaultProviders(api.MainnetChainID)),
		testutil.CreateNetwork(api.SepoliaChainID, "Sepolia Testnet", DefaultProviders(api.SepoliaChainID)),
	}
	s.addAndVerifyNetworks(networks)

	err := s.networksPersistence.DeleteAllNetworks()
	s.Require().NoError(err)

	allNetworks, err := s.networksPersistence.GetAllNetworks()
	s.Require().NoError(err)
	s.Require().Len(allNetworks, 0)
}

func (s *NetworksPersistenceTestSuite) TestSetNetworks() {
	initialNetworks := []*params.Network{
		testutil.CreateNetwork(api.MainnetChainID, "Ethereum Mainnet", DefaultProviders(api.MainnetChainID)),
		testutil.CreateNetwork(api.SepoliaChainID, "Sepolia Testnet", DefaultProviders(api.SepoliaChainID)),
	}
	newNetworks := []*params.Network{
		testutil.CreateNetwork(api.OptimismChainID, "Optimism Mainnet", DefaultProviders(api.OptimismChainID)),
	}

	// Add initial networks
	s.addAndVerifyNetworks(initialNetworks)

	// Replace with new networks
	s.addAndVerifyNetworks(newNetworks)

	// Verify old networks are removed
	s.verifyNetworkDeletion(api.MainnetChainID)
	s.verifyNetworkDeletion(api.SepoliaChainID)
}

func (s *NetworksPersistenceTestSuite) TestValidationForNetworksAndProviders() {
	// Invalid Network: Missing required ChainName
	invalidNetwork := testutil.CreateNetwork(api.MainnetChainID, "", DefaultProviders(api.MainnetChainID))

	// Invalid Provider: Missing URL
	invalidProvider := params.RpcProvider{
		Name:    "InvalidProvider",
		ChainID: api.MainnetChainID,
		URL:     "", // Invalid
		Type:    params.UserProviderType,
		Enabled: true,
	}

	// Add invalid provider to a valid network
	validNetworkWithInvalidProvider := testutil.CreateNetwork(api.OptimismChainID, "Optimism Mainnet", []params.RpcProvider{invalidProvider})

	// Invalid networks and providers should fail validation
	networksToValidate := []*params.Network{
		invalidNetwork,
		validNetworkWithInvalidProvider,
	}

	for _, network := range networksToValidate {
		err := s.networksPersistence.UpsertNetwork(network)
		s.Require().Error(err, "Expected validation to fail for invalid network or provider")
	}

	// Ensure no invalid data is saved in the database
	allNetworks, err := s.networksPersistence.GetAllNetworks()
	s.Require().NoError(err)
	s.Require().Len(allNetworks, 0, "No invalid networks should be saved")
}