Files
gocryptotrader/config/config_test.go
Gareth Kirwan 219ed903bc Config: Add versioning (#1671)
* Config: Version Management

* Engine: Improve visibility of TestConfigAllJsonResponse failures

* Config: Update cmd/config to allow upgrades

* Config: Add Version2 to rename GDAX

* Config: Restructure versioning to share types

This restructure allows us to share types between versions, avoids
needing to import the versions, and puts the test fixtures in same
package.
It's a win on all fronts

* Config: Fix SetNTPCheck using log

Called from engine before logger is inited, and also just wrong to use
log to communicate with user

* Config: Improve TestMigrateConfig

* Config: Drop requirement for versions to be registered in sequence

Checking the versions at Deploy is much saner.

* Config: Fix file encrypted but flag not set

* Config: Add -edit and encryption upgrade to cmd/config

This simplifies the handling for encryption prompts by moving it to a
field on config, allowing us to simplify all the places were were
passing around config

Also moves password entry to being secure (echo-off)

* Tests: Fix inconsistent should/must assertions
2024-12-09 15:04:16 +11:00

2150 lines
56 KiB
Go

package config
import (
"errors"
"os"
"path/filepath"
"runtime"
"slices"
"strings"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/thrasher-corp/gocryptotrader/common"
"github.com/thrasher-corp/gocryptotrader/common/convert"
"github.com/thrasher-corp/gocryptotrader/common/file"
"github.com/thrasher-corp/gocryptotrader/communications/base"
"github.com/thrasher-corp/gocryptotrader/connchecker"
"github.com/thrasher-corp/gocryptotrader/currency"
"github.com/thrasher-corp/gocryptotrader/database"
"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
gctscript "github.com/thrasher-corp/gocryptotrader/gctscript/vm"
"github.com/thrasher-corp/gocryptotrader/log"
"github.com/thrasher-corp/gocryptotrader/portfolio/banking"
)
const (
testFakeExchangeName = "Stampbit"
testPair = "BTC-USD"
testString = "test"
bfx = "Bitfinex"
)
func TestGetNonExistentDefaultFilePathDoesNotCreateDefaultDir(t *testing.T) {
dir := common.GetDefaultDataDir(runtime.GOOS)
if file.Exists(dir) {
t.Skip("The default directory already exists before running the test")
}
if _, _, err := GetFilePath(""); err != nil {
t.Fatal(err)
}
if file.Exists(dir) {
t.Fatalf("The target directory was created in %s", dir)
}
}
func TestGetCurrencyConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
Currency: currency.Config{
ForeignExchangeUpdateDuration: time.Second,
},
}
cCFG := cfg.GetCurrencyConfig()
if cCFG.ForeignExchangeUpdateDuration != cfg.Currency.ForeignExchangeUpdateDuration {
t.Error("did not retrieve correct currency config")
}
}
func TestGetClientBankAccounts(t *testing.T) {
t.Parallel()
cfg := &Config{BankAccounts: []banking.Account{
{
SupportedCurrencies: "USD",
SupportedExchanges: "Kraken",
},
}}
_, err := cfg.GetClientBankAccounts("Kraken", "USD")
if err != nil {
t.Error("GetExchangeBankAccounts error", err)
}
_, err = cfg.GetClientBankAccounts("noob exchange", "USD")
if err == nil {
t.Fatal("error cannot be nil")
}
}
func TestGetExchangeBankAccounts(t *testing.T) {
t.Parallel()
cfg := &Config{
Exchanges: []Exchange{{
Name: bfx,
Enabled: true,
BankAccounts: []banking.Account{
{
SupportedCurrencies: "USD",
SupportedExchanges: bfx,
},
},
}},
}
_, err := cfg.GetExchangeBankAccounts(bfx, "", "USD")
require.NoError(t, err)
_, err = cfg.GetExchangeBankAccounts("Not an exchange", "", "Not a currency")
require.ErrorIs(t, err, ErrExchangeNotFound)
}
func TestCheckBankAccountConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
BankAccounts: []banking.Account{
{
Enabled: true,
},
},
}
cfg.CheckBankAccountConfig()
if cfg.BankAccounts[0].Enabled {
t.Error("validation should have changed it to false")
}
cfg.BankAccounts[0] = banking.Account{
Enabled: true,
ID: "1337",
BankName: "1337",
BankAddress: "1337",
BankPostalCode: "1337",
BankPostalCity: "1337",
BankCountry: "1337",
AccountName: "1337",
AccountNumber: "1337",
SWIFTCode: "1337",
IBAN: "1337",
BSBNumber: "1337",
BankCode: 1337,
SupportedCurrencies: "1337",
SupportedExchanges: "1337",
}
cfg.CheckBankAccountConfig()
if !cfg.BankAccounts[0].Enabled {
t.Error("validation should have not have changed result")
}
}
func TestUpdateExchangeBankAccounts(t *testing.T) {
t.Parallel()
cfg := &Config{
Exchanges: []Exchange{
{
Name: bfx,
Enabled: true,
},
},
}
b := []banking.Account{{Enabled: false}}
err := cfg.UpdateExchangeBankAccounts(bfx, b)
if err != nil {
t.Error("UpdateExchangeBankAccounts error", err)
}
var count int
for i := range cfg.Exchanges {
if cfg.Exchanges[i].Name == bfx {
if !cfg.Exchanges[i].BankAccounts[0].Enabled {
count++
}
}
}
if count != 1 {
t.Error("UpdateExchangeBankAccounts error")
}
err = cfg.UpdateExchangeBankAccounts("Not an exchange", b)
if err == nil {
t.Error("UpdateExchangeBankAccounts, no error returned for invalid exchange")
}
}
func TestUpdateClientBankAccounts(t *testing.T) {
t.Parallel()
cfg := &Config{
BankAccounts: []banking.Account{
{
BankName: testString,
AccountNumber: "1337",
},
},
}
b := banking.Account{Enabled: false, BankName: testString, AccountNumber: "1337"}
err := cfg.UpdateClientBankAccounts(&b)
if err != nil {
t.Error("UpdateClientBankAccounts error", err)
}
err = cfg.UpdateClientBankAccounts(&banking.Account{})
if err == nil {
t.Error("UpdateClientBankAccounts error")
}
var count int
for _, bank := range cfg.BankAccounts {
if bank.BankName == b.BankName {
if !bank.Enabled {
count++
}
}
}
if count != 1 {
t.Error("UpdateClientBankAccounts error")
}
}
func TestCheckClientBankAccounts(t *testing.T) {
t.Parallel()
cfg := &Config{}
cfg.CheckClientBankAccounts()
if len(cfg.BankAccounts) == 0 {
t.Error("expected a placeholder account")
}
cfg.BankAccounts = nil
cfg.BankAccounts = []banking.Account{
{
Enabled: true,
},
}
cfg.CheckClientBankAccounts()
if cfg.BankAccounts[0].Enabled {
t.Error("unexpected result")
}
b := banking.Account{
Enabled: true,
BankName: "Commonwealth Bank of Awesome",
BankAddress: "123 Fake Street",
BankPostalCode: "1337",
BankPostalCity: "Satoshiville",
BankCountry: "Genesis",
AccountName: "Satoshi Nakamoto",
AccountNumber: "1231006505",
SupportedCurrencies: "USD",
}
cfg.BankAccounts = []banking.Account{b}
cfg.CheckClientBankAccounts()
if cfg.BankAccounts[0].Enabled ||
cfg.BankAccounts[0].SupportedExchanges != "ALL" {
t.Error("unexpected result")
}
// AU based bank, with no BSB number (required for domestic and international
// transfers)
b.SupportedCurrencies = "AUD"
b.SWIFTCode = "BACXSI22"
cfg.BankAccounts = []banking.Account{b}
cfg.CheckClientBankAccounts()
if cfg.BankAccounts[0].Enabled {
t.Error("unexpected result")
}
// Valid AU bank
b.BSBNumber = "061337"
cfg.BankAccounts = []banking.Account{b}
cfg.CheckClientBankAccounts()
if !cfg.BankAccounts[0].Enabled {
t.Error("unexpected result")
}
// Valid SWIFT/IBAN compliant bank
b.Enabled = true
b.IBAN = "SI56290000170073837"
b.SWIFTCode = "BACXSI22"
cfg.BankAccounts = []banking.Account{b}
cfg.CheckClientBankAccounts()
if !cfg.BankAccounts[0].Enabled {
t.Error("unexpected result")
}
}
func TestPurgeExchangeCredentials(t *testing.T) {
t.Parallel()
var c Config
c.Exchanges = []Exchange{
{
Name: testString,
API: APIConfig{
AuthenticatedSupport: true,
AuthenticatedWebsocketSupport: true,
CredentialsValidator: &APICredentialsValidatorConfig{
RequiresKey: true,
RequiresSecret: true,
RequiresClientID: true,
},
Credentials: APICredentialsConfig{
Key: "asdf123",
Secret: "secretp4ssw0rd",
ClientID: "1337",
OTPSecret: "otp",
PEMKey: "aaa",
},
},
},
{
Name: "test123",
API: APIConfig{
CredentialsValidator: &APICredentialsValidatorConfig{
RequiresKey: true,
},
Credentials: APICredentialsConfig{
Key: "asdf",
Secret: DefaultAPISecret,
},
},
},
}
c.PurgeExchangeAPICredentials()
exchCfg, err := c.GetExchangeConfig(testString)
if err != nil {
t.Error(err)
}
if exchCfg.API.Credentials.Key != DefaultAPIKey &&
exchCfg.API.Credentials.ClientID != DefaultAPIClientID &&
exchCfg.API.Credentials.Secret != DefaultAPISecret &&
exchCfg.API.Credentials.OTPSecret != "" &&
exchCfg.API.Credentials.PEMKey != "" {
t.Error("unexpected values")
}
exchCfg, err = c.GetExchangeConfig("test123")
if err != nil {
t.Error(err)
}
if exchCfg.API.Credentials.Key != "asdf" {
t.Error("unexpected values")
}
}
func TestGetCommunicationsConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
Communications: base.CommunicationsConfig{
SlackConfig: base.SlackConfig{Name: "hellomoto"},
},
}
cCFG := cfg.GetCommunicationsConfig()
if cCFG.SlackConfig.Name != cfg.Communications.SlackConfig.Name {
t.Error("failed to retrieve config")
}
}
func TestUpdateCommunicationsConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
Communications: base.CommunicationsConfig{
SlackConfig: base.SlackConfig{Name: "hellomoto"},
},
}
cfg.UpdateCommunicationsConfig(&base.CommunicationsConfig{SlackConfig: base.SlackConfig{Name: testString}})
if cfg.Communications.SlackConfig.Name != testString {
t.Error("UpdateCommunicationsConfig LoadConfig error")
}
}
func TestGetCryptocurrencyProviderConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
Currency: currency.Config{
CryptocurrencyProvider: currency.Provider{
Name: "hellomoto",
},
},
}
cCFG := cfg.GetCryptocurrencyProviderConfig()
if cCFG.Name != cfg.Currency.CryptocurrencyProvider.Name {
t.Error("failed to retrieve config")
}
}
func TestUpdateCryptocurrencyProviderConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
Currency: currency.Config{
CryptocurrencyProvider: currency.Provider{
Name: "hellomoto",
},
},
}
cfg.UpdateCryptocurrencyProviderConfig(currency.Provider{Name: "SERIOUS TESTING PROCEDURE!"})
if cfg.Currency.CryptocurrencyProvider.Name != "SERIOUS TESTING PROCEDURE!" {
t.Error("UpdateCurrencyProviderConfig LoadConfig error")
}
}
func TestCheckCommunicationsConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
Communications: base.CommunicationsConfig{},
}
cfg.CheckCommunicationsConfig()
if cfg.Communications.SlackConfig.Name != "Slack" ||
cfg.Communications.SMSGlobalConfig.Name != "SMSGlobal" ||
cfg.Communications.SMTPConfig.Name != "SMTP" ||
cfg.Communications.TelegramConfig.Name != "Telegram" {
t.Error("CheckCommunicationsConfig unexpected data:",
cfg.Communications)
}
cfg.SMS = &base.SMSGlobalConfig{}
cfg.Communications.SMSGlobalConfig.Name = ""
cfg.CheckCommunicationsConfig()
if cfg.Communications.SMSGlobalConfig.Password != testString {
t.Error("incorrect password")
}
cfg.SMS.Contacts = append(cfg.SMS.Contacts, base.SMSContact{
Name: "Bobby",
Number: "4321",
Enabled: false,
})
cfg.Communications.SMSGlobalConfig.Name = ""
cfg.CheckCommunicationsConfig()
if cfg.Communications.SMSGlobalConfig.Contacts[0].Name != "Bobby" {
t.Error("incorrect name")
}
cfg.Communications.SMSGlobalConfig.From = ""
cfg.CheckCommunicationsConfig()
if cfg.Communications.SMSGlobalConfig.From != cfg.Name {
t.Error("CheckCommunicationsConfig From value should have been set to the config name")
}
cfg.Communications.SMSGlobalConfig.From = "aaaaaaaaaaaaaaaaaaa"
cfg.CheckCommunicationsConfig()
if cfg.Communications.SMSGlobalConfig.From != "aaaaaaaaaaa" {
t.Error("CheckCommunicationsConfig From value should have been trimmed to 11 characters")
}
cfg.SMS = &base.SMSGlobalConfig{}
cfg.CheckCommunicationsConfig()
if cfg.SMS != nil {
t.Error("CheckCommunicationsConfig unexpected data:",
cfg.SMS)
}
cfg.Communications.SlackConfig.Name = "NOT Slack"
cfg.CheckCommunicationsConfig()
cfg.Communications.SlackConfig.Name = "Slack"
cfg.Communications.SlackConfig.Enabled = true
cfg.CheckCommunicationsConfig()
if cfg.Communications.SlackConfig.Enabled {
t.Error("CheckCommunicationsConfig Slack is enabled when it shouldn't be.")
}
cfg.Communications.SlackConfig.Enabled = false
cfg.Communications.SMSGlobalConfig.Enabled = true
cfg.Communications.SMSGlobalConfig.Password = ""
cfg.CheckCommunicationsConfig()
if cfg.Communications.SlackConfig.Enabled {
t.Error("CheckCommunicationsConfig SMSGlobal is enabled when it shouldn't be.")
}
cfg.Communications.SMSGlobalConfig.Enabled = false
cfg.Communications.SMTPConfig.Enabled = true
cfg.Communications.SMTPConfig.AccountPassword = ""
cfg.CheckCommunicationsConfig()
if cfg.Communications.SlackConfig.Enabled {
t.Error("CheckCommunicationsConfig SMTPConfig is enabled when it shouldn't be.")
}
cfg.Communications.SMTPConfig.Enabled = false
cfg.Communications.TelegramConfig.Enabled = true
cfg.Communications.TelegramConfig.VerificationToken = ""
cfg.CheckCommunicationsConfig()
if cfg.Communications.TelegramConfig.Enabled {
t.Error("CheckCommunicationsConfig TelegramConfig is enabled when it shouldn't be.")
}
}
func TestGetExchangeAssetTypes(t *testing.T) {
t.Parallel()
var c Config
_, err := c.GetExchangeAssetTypes("void")
if err == nil {
t.Error("err should have been thrown on a non-existent exchange")
}
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
CurrencyPairs: &currency.PairsManager{
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: new(currency.PairStore),
asset.Futures: new(currency.PairStore),
},
},
},
)
var assets asset.Items
assets, err = c.GetExchangeAssetTypes(testFakeExchangeName)
if err != nil {
t.Error(err)
}
if !assets.Contains(asset.Spot) || !assets.Contains(asset.Futures) {
t.Error("unexpected results")
}
c.Exchanges[0].CurrencyPairs = nil
_, err = c.GetExchangeAssetTypes(testFakeExchangeName)
if err == nil {
t.Error("Expected error from nil currency pair")
}
}
func TestSupportsExchangeAssetType(t *testing.T) {
t.Parallel()
var c Config
err := c.SupportsExchangeAssetType("void", asset.Spot)
if err == nil {
t.Error("Expected error for non-existent exchange")
}
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
CurrencyPairs: &currency.PairsManager{
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: new(currency.PairStore),
},
},
},
)
err = c.SupportsExchangeAssetType(testFakeExchangeName, asset.Spot)
if err != nil {
t.Error(err)
}
err = c.SupportsExchangeAssetType(testFakeExchangeName, asset.Empty)
if err == nil {
t.Error("Expected error from invalid asset item")
}
c.Exchanges[0].CurrencyPairs = nil
err = c.SupportsExchangeAssetType(testFakeExchangeName, asset.Spot)
if err == nil {
t.Error("Expected error from nil pair manager")
}
}
func TestSetPairs(t *testing.T) {
t.Parallel()
var c Config
pairs := currency.Pairs{
currency.NewPair(currency.BTC, currency.USD),
currency.NewPair(currency.BTC, currency.EUR),
}
err := c.SetPairs("asdf", asset.Spot, true, nil)
if err == nil {
t.Error("Expected error from nil pairs")
}
err = c.SetPairs("asdf", asset.Spot, true, pairs)
if err == nil {
t.Error("Expected error from non-existent exchange")
}
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
},
)
err = c.SetPairs(testFakeExchangeName, asset.Index, true, pairs)
if err == nil {
t.Error("Expected error from non initialised pair manager")
}
c.Exchanges[0].CurrencyPairs = &currency.PairsManager{
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: new(currency.PairStore),
},
}
err = c.SetPairs(testFakeExchangeName, asset.Index, true, pairs)
if err == nil {
t.Error("Expected error from non supported asset type")
}
err = c.SetPairs(testFakeExchangeName, asset.Spot, true, pairs)
if err != nil {
t.Error(err)
}
}
func TestGetCurrencyPairConfig(t *testing.T) {
t.Parallel()
var c Config
_, err := c.GetCurrencyPairConfig("asdfg", asset.Spot)
if err == nil {
t.Error("Expected error with non-existent exchange")
}
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
},
)
_, err = c.GetCurrencyPairConfig(testFakeExchangeName, asset.Index)
if err == nil {
t.Error("Expected error with nil currency pair store")
}
pm := &currency.PairsManager{
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: {
RequestFormat: &currency.PairFormat{
Uppercase: false,
Delimiter: "_",
},
ConfigFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "~",
},
},
},
}
c.Exchanges[0].CurrencyPairs = pm
_, err = c.GetCurrencyPairConfig(testFakeExchangeName, asset.Index)
if err == nil {
t.Error("Expected error with unsupported asset")
}
var p *currency.PairStore
p, err = c.GetCurrencyPairConfig(testFakeExchangeName, asset.Spot)
if err != nil {
t.Error(err)
}
if p.RequestFormat.Delimiter != "_" ||
p.RequestFormat.Uppercase ||
!p.ConfigFormat.Uppercase ||
p.ConfigFormat.Delimiter != "~" {
t.Error("unexpected values")
}
}
func TestCheckPairConfigFormats(t *testing.T) {
var c Config
if err := c.CheckPairConfigFormats("non-existent"); err == nil {
t.Error("non-existent exchange should throw an error")
}
// Test nil pair store
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
},
)
if err := c.CheckPairConfigFormats(testFakeExchangeName); err == nil {
t.Error("nil pair store should return an error")
}
c.Exchanges[0].CurrencyPairs = &currency.PairsManager{
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: {},
asset.Futures: {},
},
}
if err := c.CheckPairConfigFormats(testFakeExchangeName); err == nil {
t.Error("error cannot be nil")
}
c.Exchanges[0].CurrencyPairs = &currency.PairsManager{
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: {
RequestFormat: &currency.EMPTYFORMAT,
ConfigFormat: &currency.EMPTYFORMAT,
},
asset.Futures: {
RequestFormat: &currency.EMPTYFORMAT,
ConfigFormat: &currency.EMPTYFORMAT,
},
},
}
if err := c.CheckPairConfigFormats(testFakeExchangeName); err != nil {
t.Error("nil pairs should be okay to continue")
}
avail, err := currency.NewPairDelimiter(testPair, "-")
if err != nil {
t.Fatal(err)
}
enabled, err := currency.NewPairDelimiter("BTC~USD", "~")
if err != nil {
t.Fatal(err)
}
c.Exchanges[0].CurrencyPairs.Pairs = map[asset.Item]*currency.PairStore{
asset.Spot: {
RequestFormat: &currency.PairFormat{
Uppercase: false,
Delimiter: "_",
},
ConfigFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "~",
},
Available: currency.Pairs{
avail,
},
Enabled: currency.Pairs{
enabled,
},
},
}
assert.ErrorContains(t, c.CheckPairConfigFormats(testFakeExchangeName), "does not contain delimiter", "Invalid pair delimiter should throw an error")
}
func TestCheckPairConsistency(t *testing.T) {
t.Parallel()
var c Config
err := c.CheckPairConsistency("asdf")
if !errors.Is(err, ErrExchangeNotFound) {
t.Fatalf("received: '%v' buy expected: '%v'", err, ErrExchangeNotFound)
}
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
},
)
// Test nil pair store
err = c.CheckPairConsistency(testFakeExchangeName)
if !errors.Is(err, errPairsManagerIsNil) {
t.Fatalf("received: '%v' buy expected: '%v'", err, errPairsManagerIsNil)
}
enabled, err := currency.NewPairDelimiter("BTC_USD", "_")
if err != nil {
t.Fatal(err)
}
c.Exchanges[0].CurrencyPairs = &currency.PairsManager{
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: {
RequestFormat: &currency.PairFormat{
Uppercase: false,
Delimiter: "_",
},
ConfigFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "_",
},
Enabled: currency.Pairs{
enabled,
},
},
},
}
// Test for nil avail pairs
err = c.CheckPairConsistency(testFakeExchangeName)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' buy expected: '%v'", err, nil)
}
p1, err := currency.NewPairDelimiter("LTC_USD", "_")
if err != nil {
t.Fatal(err)
}
// Test that enabled pair is not found in the available pairs
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Available = currency.Pairs{
p1,
}
// LTC_USD is only found in the available pairs list and should therefore
// be added to the enabled pairs list due to the atLestOneEnabled code
err = c.CheckPairConsistency(testFakeExchangeName)
if err != nil {
t.Fatal(err)
}
if len(c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled) != 1 {
t.Fatal("there should be at least one pair located in this list")
}
if !c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled[0].Equal(p1) {
t.Fatal("LTC_USD should be contained in the enabled pairs list")
}
p2, err := currency.NewPairDelimiter("BTC_USD", "_")
if err != nil {
t.Fatal(err)
}
// Add the BTC_USD pair and see result
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Available = currency.Pairs{
p1, p2,
}
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Fatal(err)
}
// Test that an empty enabled pair is populated with an available pair
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled = nil
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Error("unexpected result", err)
}
if len(c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled) != 1 {
t.Fatal("should be populated with at least one currency pair")
}
// Test that an invalid enabled pair is removed from the list
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled = currency.Pairs{
p1,
p2,
}
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Error("unexpected result")
}
// Test when no update is required as the available pairs and enabled pairs
// are consistent
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Error("unexpected result")
}
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].AssetEnabled = convert.BoolPtr(true)
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled = currency.Pairs{}
// Test no conflict and at least one on enabled asset type
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Error("unexpected result")
}
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].AssetEnabled = convert.BoolPtr(true)
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled = currency.Pairs{currency.NewPair(currency.DASH, currency.USD)}
// Test with conflict and at least one on enabled asset type
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Error("unexpected result")
}
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].AssetEnabled = convert.BoolPtr(false)
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled = currency.Pairs{}
// Test no conflict and at least one on disabled asset type
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Error("unexpected result")
}
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled = currency.Pairs{
currency.NewPair(currency.DASH, currency.USD),
p1,
p2,
}
// Test with conflict and at least one on disabled asset type
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Error("unexpected result")
}
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].AssetEnabled = nil
// assetType enabled failure check
if err := c.CheckPairConsistency(testFakeExchangeName); err != nil {
t.Error("unexpected result")
}
}
func TestSupportsPair(t *testing.T) {
t.Parallel()
fmt := &currency.EMPTYFORMAT
cfg := &Config{
Exchanges: []Exchange{
{
Name: bfx,
Enabled: true,
CurrencyPairs: &currency.PairsManager{
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: {
AssetEnabled: convert.BoolPtr(true),
Available: []currency.Pair{currency.NewPair(currency.BTC, currency.USD)},
ConfigFormat: fmt,
RequestFormat: fmt,
},
},
},
},
},
}
assetType := asset.Spot
if cfg.SupportsPair("asdf",
currency.NewPair(currency.BTC, currency.USD), assetType) {
t.Error(
"TestSupportsPair. Expected error from Non-existent exchange",
)
}
if !cfg.SupportsPair(bfx, currency.NewPair(currency.BTC, currency.USD), assetType) {
t.Errorf(
"expected true",
)
}
}
func TestGetPairFormat(t *testing.T) {
t.Parallel()
var c Config
_, err := c.GetPairFormat("meow", asset.Spot)
if err == nil {
t.Error("Expected error from non-existent exchange")
}
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
},
)
_, err = c.GetPairFormat(testFakeExchangeName, asset.Spot)
if err == nil {
t.Error("Expected error from nil pair manager")
}
c.Exchanges[0].CurrencyPairs = &currency.PairsManager{
UseGlobalFormat: false,
RequestFormat: &currency.PairFormat{
Uppercase: false,
Delimiter: "_",
},
ConfigFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "_",
},
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: nil,
},
}
_, err = c.GetPairFormat(testFakeExchangeName, asset.Spot)
if err == nil {
t.Error("Expected error from nil pair manager")
}
c.Exchanges[0].CurrencyPairs = &currency.PairsManager{
UseGlobalFormat: true,
RequestFormat: &currency.PairFormat{
Uppercase: false,
Delimiter: "_",
},
ConfigFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "_",
},
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: new(currency.PairStore),
},
}
_, err = c.GetPairFormat(testFakeExchangeName, asset.Empty)
if err == nil {
t.Error("Expected error from non-existent asset item")
}
_, err = c.GetPairFormat(testFakeExchangeName, asset.Futures)
if err == nil {
t.Error("Expected error from valid but non supported asset type")
}
var p currency.PairFormat
p, err = c.GetPairFormat(testFakeExchangeName, asset.Spot)
if err != nil {
t.Error(err)
}
if !p.Uppercase && p.Delimiter != "_" {
t.Error("unexpected results")
}
// Test nil pair store
c.Exchanges[0].CurrencyPairs.UseGlobalFormat = false
_, err = c.GetPairFormat(testFakeExchangeName, asset.Spot)
if err == nil {
t.Error("Expected error")
}
c.Exchanges[0].CurrencyPairs.Pairs = map[asset.Item]*currency.PairStore{
asset.Spot: {
ConfigFormat: &currency.PairFormat{
Uppercase: true,
Delimiter: "~",
},
},
}
p, err = c.GetPairFormat(testFakeExchangeName, asset.Spot)
if err != nil {
t.Error(err)
}
if p.Delimiter != "~" && !p.Uppercase {
t.Error("unexpected results")
}
}
func TestGetAvailablePairs(t *testing.T) {
t.Parallel()
var c Config
_, err := c.GetAvailablePairs("asdf", asset.Spot)
if err == nil {
t.Error("Expected error from non-existent exchange")
}
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
CurrencyPairs: &currency.PairsManager{},
},
)
_, err = c.GetAvailablePairs(testFakeExchangeName, asset.Spot)
if err == nil {
t.Error("Expected error from nil pair manager")
}
c.Exchanges[0].CurrencyPairs.Pairs = map[asset.Item]*currency.PairStore{
asset.Spot: {
ConfigFormat: &currency.PairFormat{
Delimiter: "-",
Uppercase: true,
},
},
}
_, err = c.GetAvailablePairs(testFakeExchangeName, asset.Spot)
if err != nil {
t.Error("Expected error from nil pairs")
}
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Available = currency.Pairs{
currency.NewPair(currency.BTC, currency.USD),
}
_, err = c.GetAvailablePairs(testFakeExchangeName, asset.Spot)
if err != nil {
t.Error(err)
}
}
func TestGetEnabledPairs(t *testing.T) {
t.Parallel()
var c Config
_, err := c.GetEnabledPairs("asdf", asset.Spot)
if err == nil {
t.Error("Expected error from non-existent exchange")
}
c.Exchanges = append(c.Exchanges,
Exchange{
Name: testFakeExchangeName,
CurrencyPairs: &currency.PairsManager{},
},
)
_, err = c.GetEnabledPairs(testFakeExchangeName, asset.Spot)
if err == nil {
t.Error("Expected error from nil pair manager")
}
c.Exchanges[0].CurrencyPairs.Pairs = map[asset.Item]*currency.PairStore{
asset.Spot: {
ConfigFormat: &currency.PairFormat{
Delimiter: "-",
Uppercase: true,
},
},
}
_, err = c.GetEnabledPairs(testFakeExchangeName, asset.Spot)
if err != nil {
t.Error("nil pairs should return a nil error")
}
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled = currency.Pairs{
currency.NewPair(currency.BTC, currency.USD),
}
c.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Available = currency.Pairs{
currency.NewPair(currency.BTC, currency.USD),
}
_, err = c.GetEnabledPairs(testFakeExchangeName, asset.Spot)
if err != nil {
t.Error(err)
}
}
func TestGetEnabledExchanges(t *testing.T) {
t.Parallel()
cfg := &Config{Exchanges: []Exchange{
{
Name: bfx,
Enabled: true,
},
}}
exchanges := cfg.GetEnabledExchanges()
if !slices.Contains(exchanges, bfx) {
t.Error(
"TestGetEnabledExchanges. Expected exchange Bitfinex not found",
)
}
}
func TestGetDisabledExchanges(t *testing.T) {
t.Parallel()
cfg := &Config{Exchanges: []Exchange{
{
Name: bfx,
Enabled: true,
},
}}
exchanges := cfg.GetDisabledExchanges()
if len(exchanges) != 0 {
t.Error(
"TestGetDisabledExchanges. Enabled exchanges value mismatch",
)
}
exchCfg, err := cfg.GetExchangeConfig(bfx)
if err != nil {
t.Errorf(
"TestGetDisabledExchanges. GetExchangeConfig Error: %s", err.Error(),
)
}
exchCfg.Enabled = false
err = cfg.UpdateExchangeConfig(exchCfg)
if err != nil {
t.Errorf(
"TestGetDisabledExchanges. UpdateExchangeConfig Error: %s", err.Error(),
)
}
if len(cfg.GetDisabledExchanges()) != 1 {
t.Error(
"TestGetDisabledExchanges. Enabled exchanges value mismatch",
)
}
}
func TestCountEnabledExchanges(t *testing.T) {
t.Parallel()
cfg := &Config{Exchanges: []Exchange{
{
Enabled: true,
},
}}
enabledExch := cfg.CountEnabledExchanges()
if enabledExch != 1 {
t.Errorf("Expected %v, Received %v", 1, enabledExch)
}
}
func TestGetCurrencyPairDisplayConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
Currency: currency.Config{
CurrencyPairFormat: &currency.PairFormat{
Delimiter: "-",
Uppercase: true,
},
},
}
settings := cfg.GetCurrencyPairDisplayConfig()
if settings.Delimiter != "-" || !settings.Uppercase {
t.Errorf(
"GetCurrencyPairDisplayConfi. Invalid values",
)
}
}
func TestGetAllExchangeConfigs(t *testing.T) {
t.Parallel()
cfg := &Config{
Exchanges: []Exchange{
{},
},
}
if len(cfg.GetAllExchangeConfigs()) != 1 {
t.Error("GetAllExchangeConfigs error")
}
}
func TestGetExchangeConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
Exchanges: []Exchange{
{
Name: bfx,
},
},
}
_, err := cfg.GetExchangeConfig(bfx)
if err != nil {
t.Errorf("GetExchangeConfig.GetExchangeConfig Error: %s",
err.Error())
}
_, err = cfg.GetExchangeConfig("Testy")
if !errors.Is(err, ErrExchangeNotFound) {
t.Errorf("received '%v' expected '%v'", err, ErrExchangeNotFound)
}
}
func TestGetForexProviders(t *testing.T) {
t.Parallel()
fxr := "Fixer"
cfg := &Config{
Currency: currency.Config{
ForexProviders: []currency.FXSettings{
{
Name: fxr,
},
},
},
}
if r := cfg.GetForexProviders(); len(r) != 1 {
t.Error("unexpected length of forex providers")
}
}
func TestGetPrimaryForexProvider(t *testing.T) {
t.Parallel()
fxr := "Fixer" // nolint:ifshort,nolintlint // false positive and triggers only on Windows
cfg := &Config{
Currency: currency.Config{
ForexProviders: []currency.FXSettings{
{
Name: fxr,
PrimaryProvider: true,
},
},
},
}
primary := cfg.GetPrimaryForexProvider()
if primary != fxr {
t.Error("GetPrimaryForexProvider error")
}
for i := range cfg.Currency.ForexProviders {
cfg.Currency.ForexProviders[i].PrimaryProvider = false
}
primary = cfg.GetPrimaryForexProvider()
if primary != "" {
t.Error("GetPrimaryForexProvider error, expected nil got:", primary)
}
}
func TestUpdateExchangeConfig(t *testing.T) {
t.Parallel()
ok := "Okx"
cfg := &Config{
Exchanges: []Exchange{
{
Name: ok,
API: APIConfig{Credentials: APICredentialsConfig{}},
},
},
}
e := &Exchange{}
err := cfg.UpdateExchangeConfig(e)
if err == nil {
t.Error("Expected error from non-existent exchange")
}
e, err = cfg.GetExchangeConfig(ok)
if err != nil {
t.Error(err)
}
e.API.Credentials.Key = "test1234"
err = cfg.UpdateExchangeConfig(e)
if err != nil {
t.Error(err)
}
}
// TestCheckExchangeConfigValues logic test
func TestCheckExchangeConfigValues(t *testing.T) {
var cfg Config
if err := cfg.CheckExchangeConfigValues(); err == nil {
t.Error("nil exchanges should throw an err")
}
err := cfg.LoadConfig(TestFile, true)
if err != nil {
t.Fatal(err)
}
// Test our default test config and report any errors
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Fatal(err)
}
// Test API settings migration
sptr := func(s string) *string { return &s }
cfg.Exchanges[0].APIKey = sptr("awesomeKey")
cfg.Exchanges[0].APISecret = sptr("meowSecret")
cfg.Exchanges[0].ClientID = sptr("clientIDerino")
cfg.Exchanges[0].APIAuthPEMKey = sptr("-----BEGIN EC PRIVATE KEY-----\nASDF\n-----END EC PRIVATE KEY-----\n")
cfg.Exchanges[0].APIAuthPEMKeySupport = convert.BoolPtr(true)
cfg.Exchanges[0].AuthenticatedAPISupport = convert.BoolPtr(true)
cfg.Exchanges[0].AuthenticatedWebsocketAPISupport = convert.BoolPtr(true)
cfg.Exchanges[0].WebsocketURL = sptr("wss://1337")
cfg.Exchanges[0].APIURL = sptr(APIURLNonDefaultMessage)
cfg.Exchanges[0].APIURLSecondary = sptr(APIURLNonDefaultMessage)
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
// Ensure that all of our previous settings are migrated
if cfg.Exchanges[0].API.Credentials.Key != "awesomeKey" ||
cfg.Exchanges[0].API.Credentials.Secret != "meowSecret" ||
cfg.Exchanges[0].API.Credentials.ClientID != "clientIDerino" ||
!strings.Contains(cfg.Exchanges[0].API.Credentials.PEMKey, "ASDF") ||
!cfg.Exchanges[0].API.PEMKeySupport ||
!cfg.Exchanges[0].API.AuthenticatedSupport ||
!cfg.Exchanges[0].API.AuthenticatedWebsocketSupport {
t.Error("unexpected values")
}
if cfg.Exchanges[0].APIKey != nil ||
cfg.Exchanges[0].APISecret != nil ||
cfg.Exchanges[0].ClientID != nil ||
cfg.Exchanges[0].APIAuthPEMKey != nil ||
cfg.Exchanges[0].APIAuthPEMKeySupport != nil ||
cfg.Exchanges[0].AuthenticatedAPISupport != nil ||
cfg.Exchanges[0].AuthenticatedWebsocketAPISupport != nil ||
cfg.Exchanges[0].WebsocketURL != nil ||
cfg.Exchanges[0].APIURL != nil ||
cfg.Exchanges[0].APIURLSecondary != nil {
t.Error("unexpected values")
}
// Test feature and endpoint migrations
cfg.Exchanges[0].Features = nil
cfg.Exchanges[0].SupportsAutoPairUpdates = convert.BoolPtr(true)
cfg.Exchanges[0].Websocket = convert.BoolPtr(true)
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if !cfg.Exchanges[0].Features.Enabled.AutoPairUpdates ||
!cfg.Exchanges[0].Features.Enabled.Websocket ||
!cfg.Exchanges[0].Features.Supports.RESTCapabilities.AutoPairUpdates {
t.Error("unexpected values")
}
// Test AutoPairUpdates
cfg.Exchanges[0].Features.Supports.RESTCapabilities.AutoPairUpdates = false
cfg.Exchanges[0].Features.Supports.WebsocketCapabilities.AutoPairUpdates = false
cfg.Exchanges[0].CurrencyPairs.LastUpdated = 0
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
// Test websocket and HTTP timeout values
cfg.Exchanges[0].WebsocketResponseMaxLimit = 0
cfg.Exchanges[0].WebsocketResponseCheckTimeout = 0
cfg.Exchanges[0].Orderbook.WebsocketBufferLimit = 0
cfg.Exchanges[0].WebsocketTrafficTimeout = 0
cfg.Exchanges[0].HTTPTimeout = 0
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if cfg.Exchanges[0].WebsocketResponseMaxLimit == 0 {
t.Errorf("expected exchange %s to have updated WebsocketResponseMaxLimit value",
cfg.Exchanges[0].Name)
}
if cfg.Exchanges[0].Orderbook.WebsocketBufferLimit == 0 {
t.Errorf("expected exchange %s to have updated WebsocketOrderbookBufferLimit value",
cfg.Exchanges[0].Name)
}
if cfg.Exchanges[0].WebsocketTrafficTimeout == 0 {
t.Errorf("expected exchange %s to have updated WebsocketTrafficTimeout value",
cfg.Exchanges[0].Name)
}
if cfg.Exchanges[0].HTTPTimeout == 0 {
t.Errorf("expected exchange %s to have updated HTTPTimeout value",
cfg.Exchanges[0].Name)
}
v := &APICredentialsValidatorConfig{
RequiresKey: true,
RequiresSecret: true,
}
cfg.Exchanges[0].API.CredentialsValidator = v
cfg.Exchanges[0].API.Credentials.Key = "Key"
cfg.Exchanges[0].API.Credentials.Secret = "Secret"
cfg.Exchanges[0].API.AuthenticatedSupport = true
cfg.Exchanges[0].API.AuthenticatedWebsocketSupport = true
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if cfg.Exchanges[0].API.AuthenticatedSupport ||
cfg.Exchanges[0].API.AuthenticatedWebsocketSupport {
t.Error("Expected authenticated endpoints to be false from invalid API keys")
}
v.RequiresKey = false
v.RequiresClientID = true
cfg.Exchanges[0].API.AuthenticatedSupport = true
cfg.Exchanges[0].API.AuthenticatedWebsocketSupport = true
cfg.Exchanges[0].API.Credentials.ClientID = DefaultAPIClientID
cfg.Exchanges[0].API.Credentials.Secret = "TESTYTEST"
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if cfg.Exchanges[0].API.AuthenticatedSupport ||
cfg.Exchanges[0].API.AuthenticatedWebsocketSupport {
t.Error("Expected AuthenticatedAPISupport to be false from invalid API keys")
}
v.RequiresKey = true
cfg.Exchanges[0].API.AuthenticatedSupport = true
cfg.Exchanges[0].API.AuthenticatedWebsocketSupport = true
cfg.Exchanges[0].API.Credentials.Key = "meow"
cfg.Exchanges[0].API.Credentials.Secret = "test123"
cfg.Exchanges[0].API.Credentials.ClientID = "clientIDerino"
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if !cfg.Exchanges[0].API.AuthenticatedSupport ||
!cfg.Exchanges[0].API.AuthenticatedWebsocketSupport {
t.Error("Expected AuthenticatedAPISupport and AuthenticatedWebsocketAPISupport to be false from invalid API keys")
}
// Make a sneaky copy for bank account testing
//nolint: gocritic
cpy := append(cfg.Exchanges[:0:0], cfg.Exchanges...)
// Test empty exchange name for an enabled exchange
cfg.Exchanges[0].Enabled = true
cfg.Exchanges[0].Name = ""
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if cfg.Exchanges[0].Enabled {
t.Errorf(
"Exchange with no name should be empty",
)
}
// Test no enabled exchanges
cfg.Exchanges = cfg.Exchanges[:1]
cfg.Exchanges[0].Enabled = false
err = cfg.CheckExchangeConfigValues()
if err == nil {
t.Error("Expected error from no enabled exchanges")
}
cfg.Exchanges = cpy
// Check bank account validation for exchange
cfg.Exchanges[0].BankAccounts = []banking.Account{
{
Enabled: true,
},
}
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if cfg.Exchanges[0].BankAccounts[0].Enabled {
t.Fatal("bank aaccount details not provided this should disable")
}
// Test international bank
cfg.Exchanges[0].BankAccounts[0].Enabled = true
cfg.Exchanges[0].BankAccounts[0].BankName = testString
cfg.Exchanges[0].BankAccounts[0].BankAddress = testString
cfg.Exchanges[0].BankAccounts[0].BankPostalCode = testString
cfg.Exchanges[0].BankAccounts[0].BankPostalCity = testString
cfg.Exchanges[0].BankAccounts[0].BankCountry = testString
cfg.Exchanges[0].BankAccounts[0].AccountName = testString
cfg.Exchanges[0].BankAccounts[0].SupportedCurrencies = "monopoly moneys"
cfg.Exchanges[0].BankAccounts[0].IBAN = "some iban"
cfg.Exchanges[0].BankAccounts[0].SWIFTCode = "some swifty"
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if !cfg.Exchanges[0].BankAccounts[0].Enabled {
t.Fatal("bank aaccount details provided this should not disable")
}
// Test aussie bank
cfg.Exchanges[0].BankAccounts[0].Enabled = true
cfg.Exchanges[0].BankAccounts[0].BankName = testString
cfg.Exchanges[0].BankAccounts[0].BankAddress = testString
cfg.Exchanges[0].BankAccounts[0].BankPostalCode = testString
cfg.Exchanges[0].BankAccounts[0].BankPostalCity = testString
cfg.Exchanges[0].BankAccounts[0].BankCountry = testString
cfg.Exchanges[0].BankAccounts[0].AccountName = testString
cfg.Exchanges[0].BankAccounts[0].SupportedCurrencies = "AUD"
cfg.Exchanges[0].BankAccounts[0].BSBNumber = "some BSB nonsense"
cfg.Exchanges[0].BankAccounts[0].IBAN = ""
cfg.Exchanges[0].BankAccounts[0].SWIFTCode = ""
err = cfg.CheckExchangeConfigValues()
if err != nil {
t.Error(err)
}
if !cfg.Exchanges[0].BankAccounts[0].Enabled {
t.Fatal("bank account details provided this should not disable")
}
cfg.Exchanges = nil
cfg.Exchanges = append(cfg.Exchanges, cpy[0])
cfg.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].Enabled = nil
cfg.Exchanges[0].CurrencyPairs.Pairs[asset.Spot].AssetEnabled = convert.BoolPtr(false)
err = cfg.CheckExchangeConfigValues()
require.NoError(t, err)
cfg.Exchanges[0].CurrencyPairs.Pairs = make(map[asset.Item]*currency.PairStore)
err = cfg.CheckExchangeConfigValues()
assert.ErrorIs(t, err, errNoEnabledExchanges, "Exchanges without any pairs should be disabled")
}
func TestReadConfigFromFile(t *testing.T) {
cfg := &Config{}
err := cfg.ReadConfigFromFile(TestFile, true)
if err != nil {
t.Errorf("TestReadConfig %s", err.Error())
}
err = cfg.ReadConfigFromFile("bla", true)
if err == nil {
t.Error("TestReadConfig error cannot be nil")
}
}
func TestReadConfigFromReader(t *testing.T) {
t.Parallel()
c := &Config{}
confString := `{"name":"test"}`
err := c.readConfig(strings.NewReader(confString))
require.NoError(t, err)
assert.Equal(t, "test", c.Name)
err = c.readConfig(strings.NewReader("{}"))
require.NoError(t, err, "Reading a config shorter than encryptionPrefix must not error EOF")
}
func TestLoadConfig(t *testing.T) {
cfg := &Config{}
err := cfg.LoadConfig(TestFile, true)
if err != nil {
t.Error("TestLoadConfig " + err.Error())
}
err = cfg.LoadConfig("testy", true)
if err == nil {
t.Error("TestLoadConfig Expected error")
}
}
func TestSaveConfigToFile(t *testing.T) {
cfg := &Config{}
err := cfg.LoadConfig(TestFile, true)
if err != nil {
t.Errorf("TestSaveConfig.LoadConfig: %s", err.Error())
}
f, err := os.CreateTemp("", "")
if err != nil {
t.Errorf("TestSaveConfig create file: %s", err)
}
f.Close()
defer os.Remove(f.Name())
err2 := cfg.SaveConfigToFile(f.Name())
if err2 != nil {
t.Errorf("TestSaveConfig.SaveConfig, %s", err2.Error())
}
}
func TestCheckConnectionMonitorConfig(t *testing.T) {
t.Parallel()
var c Config
c.CheckConnectionMonitorConfig()
assert.Equal(t, connchecker.DefaultCheckInterval, c.ConnectionMonitor.CheckInterval)
assert.Equal(t, connchecker.DefaultDNSList, c.ConnectionMonitor.DNSList)
assert.Equal(t, connchecker.DefaultDomainList, c.ConnectionMonitor.PublicDomainList)
}
func TestDefaultFilePath(t *testing.T) {
// This is tricky to test because we're dealing with a config file stored
// in a persons default directory and to properly test it, it would
// require causing os.Stat to return !os.IsNotExist and os.IsNotExist (which
// means moving a users config file around), a way of getting around this is
// to pass the datadir as a param line but adds a burden to everyone who
// uses it
t.Parallel()
result := DefaultFilePath()
if !strings.Contains(result, File) &&
!strings.Contains(result, EncryptedFile) {
t.Error("result should have contained config.json or config.dat")
}
}
func TestGetFilePath(t *testing.T) {
t.Parallel()
expected := "blah.json"
result, wasDefault, _ := GetFilePath("blah.json")
if result != "blah.json" {
t.Errorf("TestGetFilePath: expected %s got %s", expected, result)
}
if wasDefault {
t.Errorf("TestGetFilePath: expected non-default")
}
expected = DefaultFilePath()
result, wasDefault, err := GetFilePath("")
if file.Exists(expected) {
if err != nil || result != expected {
t.Errorf("TestGetFilePath: expected %s got %s", expected, result)
}
if !wasDefault {
t.Errorf("TestGetFilePath: expected default file")
}
} else if err == nil {
t.Error("Expected error when default config file does not exist")
}
}
func TestCheckRemoteControlConfig(t *testing.T) {
t.Parallel()
var c Config
c.Webserver = &WebserverConfig{
Enabled: true,
AdminUsername: "satoshi",
AdminPassword: "ultrasecurepassword",
ListenAddress: ":9050",
WebsocketConnectionLimit: 5,
WebsocketMaxAuthFailures: 10,
WebsocketAllowInsecureOrigin: true,
}
c.CheckRemoteControlConfig()
if c.RemoteControl.Username != "satoshi" ||
c.RemoteControl.Password != "ultrasecurepassword" ||
!c.RemoteControl.GRPC.Enabled ||
c.RemoteControl.GRPC.ListenAddress != "localhost:9052" ||
!c.RemoteControl.GRPC.GRPCProxyEnabled ||
c.RemoteControl.GRPC.GRPCProxyListenAddress != "localhost:9053" ||
!c.RemoteControl.DeprecatedRPC.Enabled ||
c.RemoteControl.DeprecatedRPC.ListenAddress != "localhost:9050" ||
!c.RemoteControl.WebsocketRPC.Enabled ||
c.RemoteControl.WebsocketRPC.ListenAddress != "localhost:9051" ||
!c.RemoteControl.WebsocketRPC.AllowInsecureOrigin ||
c.RemoteControl.WebsocketRPC.ConnectionLimit != 5 ||
c.RemoteControl.WebsocketRPC.MaxAuthFailures != 10 {
t.Error("unexpected results")
}
// Now test to ensure the previous settings are flushed
if c.Webserver != nil {
t.Error("old webserver settings should be nil")
}
}
func TestCheckConfig(t *testing.T) {
t.Parallel()
cp1 := currency.NewPair(currency.DOGE, currency.XRP)
cp2 := currency.NewPair(currency.DOGE, currency.USD)
cfg := &Config{
Exchanges: []Exchange{
{
Name: testFakeExchangeName,
Enabled: true,
BaseCurrencies: currency.Currencies{
currency.USD,
},
CurrencyPairs: &currency.PairsManager{
RequestFormat: nil,
ConfigFormat: nil,
UseGlobalFormat: false,
LastUpdated: 0,
Pairs: map[asset.Item]*currency.PairStore{
asset.Spot: {
AssetEnabled: convert.BoolPtr(true),
Available: currency.Pairs{cp1, cp2},
Enabled: currency.Pairs{cp1},
ConfigFormat: &currency.EMPTYFORMAT,
RequestFormat: &currency.EMPTYFORMAT,
},
},
},
},
},
}
if err := cfg.CheckConfig(); err != nil {
t.Fatal(err)
}
}
func TestUpdateConfig(t *testing.T) {
var c Config
require.NoError(t, c.LoadConfig(TestFile, true), "LoadConfig should not error")
newCfg := c
require.NoError(t, c.UpdateConfig(TestFile, &newCfg, true), "UpdateConfig should not error")
if isGCTDocker := os.Getenv("GCT_DOCKER_CI"); isGCTDocker != "true" {
require.Error(t, c.UpdateConfig("//non-existentpath\\", &newCfg, false), "UpdateConfig should error on non-existent path")
}
}
func BenchmarkUpdateConfig(b *testing.B) {
var c Config
err := c.LoadConfig(TestFile, true)
if err != nil {
b.Errorf("Unable to benchmark UpdateConfig(): %s", err)
}
newCfg := c
for i := 0; i < b.N; i++ {
_ = c.UpdateConfig(TestFile, &newCfg, true)
}
}
func TestCheckLoggerConfig(t *testing.T) {
t.Parallel()
var c Config
c.Logging = log.Config{}
err := c.CheckLoggerConfig()
if err != nil {
t.Errorf("Failed to create default logger. Error: %s", err)
}
if !*c.Logging.Enabled {
t.Error("unexpected result")
}
c.Logging.LoggerFileConfig.FileName = ""
c.Logging.LoggerFileConfig.Rotate = nil
c.Logging.LoggerFileConfig.MaxSize = -1
c.Logging.AdvancedSettings.ShowLogSystemName = nil
err = c.CheckLoggerConfig()
if err != nil {
t.Error(err)
}
if c.Logging.LoggerFileConfig.FileName != "log.txt" ||
c.Logging.LoggerFileConfig.Rotate == nil ||
c.Logging.LoggerFileConfig.MaxSize != 100 ||
c.Logging.AdvancedSettings.ShowLogSystemName == nil ||
*c.Logging.AdvancedSettings.ShowLogSystemName {
t.Error("unexpected result")
}
}
func TestDisableNTPCheck(t *testing.T) {
t.Parallel()
var c Config
warn, err := c.SetNTPCheck(strings.NewReader("w\n"))
if err != nil {
t.Fatalf("to create ntpclient failed reason: %v", err)
}
if warn != "Time sync has been set to warn only" {
t.Errorf("failed expected %v got %v", "Time sync has been set to warn only", warn)
}
alert, _ := c.SetNTPCheck(strings.NewReader("a\n"))
if alert != "Time sync has been set to alert" {
t.Errorf("failed expected %v got %v", "Time sync has been set to alert", alert)
}
disable, _ := c.SetNTPCheck(strings.NewReader("d\n"))
if disable != "Future notifications for out of time sync has been disabled" {
t.Errorf("failed expected %v got %v", "Future notifications for out of time sync has been disabled", disable)
}
_, err = c.SetNTPCheck(strings.NewReader(" "))
if err.Error() != "EOF" {
t.Errorf("failed expected EOF got: %v", err)
}
}
func TestCheckGCTScriptConfig(t *testing.T) {
t.Parallel()
var c Config
if err := c.checkGCTScriptConfig(); err != nil {
t.Error(err)
}
if c.GCTScript.ScriptTimeout != gctscript.DefaultTimeoutValue {
t.Fatal("unexpected value return")
}
if c.GCTScript.MaxVirtualMachines != gctscript.DefaultMaxVirtualMachines {
t.Fatal("unexpected value return")
}
}
func TestCheckDatabaseConfig(t *testing.T) {
t.Parallel()
var c Config
if err := c.checkDatabaseConfig(); err != nil {
t.Error(err)
}
if c.Database.Driver != database.DBSQLite3 ||
c.Database.Database != database.DefaultSQLiteDatabase ||
c.Database.Enabled {
t.Error("unexpected results")
}
c.Database.Enabled = true
c.Database.Driver = "mssqlisthebest"
if err := c.checkDatabaseConfig(); err == nil {
t.Error("unexpected result")
}
c.Database.Driver = database.DBSQLite3
c.Database.Enabled = true
if err := c.checkDatabaseConfig(); err != nil {
t.Error(err)
}
}
func TestCheckNTPConfig(t *testing.T) {
t.Parallel()
cfg := &Config{
NTPClient: NTPClientConfig{},
}
cfg.CheckNTPConfig()
if cfg.NTPClient.Pool[0] != "pool.ntp.org:123" {
t.Error("ntpclient with no valid pool should default to pool.ntp.org")
}
if cfg.NTPClient.AllowedDifference == nil {
t.Error("ntpclient with nil alloweddifference should default to sane value")
}
if cfg.NTPClient.AllowedNegativeDifference == nil {
t.Error("ntpclient with nil allowednegativedifference should default to sane value")
}
}
func TestCheckCurrencyConfigValues(t *testing.T) {
t.Parallel()
cfg := &Config{
Currency: currency.Config{},
}
cfg.Currency.ForexProviders = nil
cfg.Currency.CryptocurrencyProvider = currency.Provider{}
err := cfg.CheckCurrencyConfigValues()
if err != nil {
t.Error(err)
}
if cfg.Currency.ForexProviders == nil {
t.Error("Failed to populate c.Currency.ForexProviders")
}
if cfg.Currency.CryptocurrencyProvider.APIKey != DefaultUnsetAPIKey {
t.Error("Failed to set the api key to the default key")
}
if cfg.Currency.CryptocurrencyProvider.Name != "CoinMarketCap" {
t.Error("Failed to set the c.Currency.CryptocurrencyProvider.Name")
}
cfg.Currency.ForexProviders[0].Enabled = true
cfg.Currency.ForexProviders[0].Name = "CurrencyConverter"
cfg.Currency.ForexProviders[0].PrimaryProvider = true
cfg.Cryptocurrencies = nil
cfg.Currency.CurrencyPairFormat = nil
cfg.CurrencyPairFormat = &currency.PairFormat{
Uppercase: true,
}
cfg.Currency.FiatDisplayCurrency = currency.EMPTYCODE
cfg.FiatDisplayCurrency = &currency.BTC
cfg.Currency.CryptocurrencyProvider.Enabled = true
err = cfg.CheckCurrencyConfigValues()
if err != nil {
t.Error(err)
}
if !cfg.Currency.CurrencyPairFormat.Uppercase {
t.Error("Failed to apply c.CurrencyPairFormat format to c.Currency.CurrencyPairFormat")
}
cfg.Currency.CryptocurrencyProvider.Enabled = false
cfg.Currency.CryptocurrencyProvider.APIKey = ""
cfg.Currency.CryptocurrencyProvider.AccountPlan = ""
cfg.FiatDisplayCurrency = &currency.BTC
cfg.Currency.ForexProviders[0].Enabled = true
cfg.Currency.ForexProviders[0].Name = "Name"
cfg.Currency.ForexProviders[0].PrimaryProvider = true
cfg.Cryptocurrencies = &currency.Currencies{}
err = cfg.CheckCurrencyConfigValues()
if err != nil {
t.Error(err)
}
if cfg.FiatDisplayCurrency != nil {
t.Error("Failed to clear c.FiatDisplayCurrency")
}
if cfg.Currency.CryptocurrencyProvider.APIKey != DefaultUnsetAPIKey ||
cfg.Currency.CryptocurrencyProvider.AccountPlan != DefaultUnsetAccountPlan {
t.Error("Failed to set CryptocurrencyProvider.APIkey and AccountPlan")
}
}
func TestPreengineConfigUpgrade(t *testing.T) {
t.Parallel()
err := new(Config).LoadConfig("../testdata/preengine_config.json", false)
require.NoError(t, err)
}
func TestRemoveExchange(t *testing.T) {
t.Parallel()
var c Config
const testExchangeName = "0xBAAAAAAD"
c.Exchanges = append(c.Exchanges, Exchange{
Name: testExchangeName,
})
_, err := c.GetExchangeConfig(testExchangeName)
if err != nil {
t.Fatal(err)
}
if success := c.RemoveExchange(testExchangeName); !success {
t.Fatal("exchange should of been removed")
}
_, err = c.GetExchangeConfig(testExchangeName)
if err == nil {
t.Fatal("non-existent exchange should throw an error")
}
if success := c.RemoveExchange("1D10TH0RS3"); success {
t.Fatal("exchange shouldn't exist")
}
}
func TestGetDataPath(t *testing.T) {
t.Parallel()
tests := []struct {
name string
dir string
elem []string
want string
}{
{
name: "empty",
dir: "",
elem: []string{},
want: common.GetDefaultDataDir(runtime.GOOS),
},
{
name: "empty a b",
dir: "",
elem: []string{"a", "b"},
want: filepath.Join(common.GetDefaultDataDir(runtime.GOOS), "a", "b"),
},
{
name: "target",
dir: "target",
elem: []string{"a", "b"},
want: filepath.Join("target", "a", "b"),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
t.Helper()
c := &Config{
DataDirectory: tt.dir,
}
if got := c.GetDataPath(tt.elem...); got != tt.want {
t.Errorf("Config.GetDataPath() = %v, want %v", got, tt.want)
}
})
}
}
func TestMigrateConfig(t *testing.T) {
type args struct {
configFile string
targetDir string
}
dir := t.TempDir()
tests := []struct {
name string
setup func(t *testing.T)
args args
want string
wantErr error
}{
{
name: "nonexisting",
args: args{
configFile: "not-exists.json",
},
wantErr: os.ErrNotExist,
},
{
name: "source present, no target dir",
setup: func(t *testing.T) {
t.Helper()
test, err := os.Create(filepath.Join(dir, "test.json"))
require.NoError(t, err, "os.Create must not error")
require.NoError(t, test.Close(), "file Close must not error")
},
args: args{
configFile: filepath.Join(dir, "test.json"),
targetDir: filepath.Join(dir, "new"),
},
want: filepath.Join(dir, "new", File),
},
{
name: "source same as target",
setup: func(t *testing.T) {
t.Helper()
err := file.Write(filepath.Join(dir, File), nil)
require.NoError(t, err, "file.Write must not error")
},
args: args{
configFile: filepath.Join(dir, File),
targetDir: dir,
},
want: filepath.Join(dir, File),
},
{
name: "source and target present",
setup: func(t *testing.T) {
t.Helper()
err := file.Write(filepath.Join(dir, File), nil)
require.NoError(t, err, "file.Write must not error")
err = file.Write(filepath.Join(dir, "src", EncryptedFile), nil)
require.NoError(t, err, "file.Write must not error")
},
args: args{
configFile: filepath.Join(dir, "src", EncryptedFile),
targetDir: dir,
},
want: filepath.Join(dir, "src", EncryptedFile),
wantErr: nil, // We only expect warning
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.setup != nil {
tt.setup(t)
}
got, err := migrateConfig(tt.args.configFile, tt.args.targetDir)
if tt.wantErr != nil {
require.ErrorIs(t, err, tt.wantErr, "migrateConfig must error correctly")
} else {
require.NoError(t, err, "migrateConfig must not error")
require.Equal(t, tt.want, got, "migrateConfig must return the correct file")
require.Truef(t, file.Exists(got), "migrateConfig return file `%s` must exist", got)
}
})
}
}
func TestExchangeConfigValidate(t *testing.T) {
err := (*Exchange)(nil).Validate()
if !errors.Is(err, errExchangeConfigIsNil) {
t.Fatalf("received: '%v' but expected: '%v'", err, errExchangeConfigIsNil)
}
err = (&Exchange{}).Validate()
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
}
func TestGetDefaultSyncManagerConfig(t *testing.T) {
t.Parallel()
cfg := GetDefaultSyncManagerConfig()
if cfg == (SyncManagerConfig{}) {
t.Error("expected config")
}
if cfg.TimeoutREST != DefaultSyncerTimeoutREST {
t.Errorf("expected %v, received %v", DefaultSyncerTimeoutREST, cfg.TimeoutREST)
}
}
func TestCheckSyncManagerConfig(t *testing.T) {
t.Parallel()
c := Config{}
if c.SyncManagerConfig != (SyncManagerConfig{}) {
t.Error("expected empty config")
}
c.CheckSyncManagerConfig()
if c.SyncManagerConfig.TimeoutREST != DefaultSyncerTimeoutREST {
t.Error("expected default config")
}
c.SyncManagerConfig.TimeoutWebsocket = -1
c.SyncManagerConfig.PairFormatDisplay = nil
c.SyncManagerConfig.TimeoutREST = -1
c.SyncManagerConfig.NumWorkers = -1
c.CurrencyPairFormat = &currency.PairFormat{
Uppercase: true,
}
c.CheckSyncManagerConfig()
if c.SyncManagerConfig.TimeoutWebsocket != DefaultSyncerTimeoutWebsocket {
t.Errorf("received %v expected %v", c.SyncManagerConfig.TimeoutWebsocket, DefaultSyncerTimeoutWebsocket)
}
if c.SyncManagerConfig.PairFormatDisplay == nil {
t.Errorf("received %v expected %v", c.SyncManagerConfig.PairFormatDisplay, c.CurrencyPairFormat)
}
if c.SyncManagerConfig.TimeoutREST != DefaultSyncerTimeoutREST {
t.Errorf("received %v expected %v", c.SyncManagerConfig.TimeoutREST, DefaultSyncerTimeoutREST)
}
if c.SyncManagerConfig.NumWorkers != DefaultSyncerWorkers {
t.Errorf("received %v expected %v", c.SyncManagerConfig.NumWorkers, DefaultSyncerWorkers)
}
}