engine: Adds shutdown method to exchange manager and unload all exchanges when engine is stopped (#1112)

* engine: shutdown and unload exchange when engine is stopped

* linter: fixes

* engine/exchMan: add nil check

* engine/exchanges: add shutdown method to exchanges, rm len check lock not needed, expanded code coverage, address some nits

* exchMan: report all failed shutdowns across exchanges, implement timer and monitoring routines.

* exchMan: improve shutdown sequence and aloc.

* further improvement

* exchman: log from warn to error

* websockconnection: Suppress error return when closure is caused by library

* linter: fix

* fix racies

* add note on why not parallel tests

* glorious: nits

* spelling kween

* thrasher: nits

* engine: change print of setting using reflection, I keep forgetting to implement this so program around forgetfulness

* engine/exchange_management: remove wait group and just rely on intermediary lock

* glorious: nits

* Update common/common.go

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>

* Update main.go

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>

---------

Co-authored-by: Ryan O'Hara-Reid <ryan.oharareid@thrasher.io>
Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>
This commit is contained in:
Ryan O'Hara-Reid
2023-04-05 13:07:35 +10:00
committed by GitHub
parent 4a50a72e4a
commit d23898e63a
35 changed files with 803 additions and 356 deletions

View File

@@ -11,9 +11,15 @@ import (
"github.com/thrasher-corp/gocryptotrader/exchanges/sharedtestvalues"
)
func TestSetupExchangeManager(t *testing.T) {
type broken struct {
bitfinex.Bitfinex
}
func (b *broken) Shutdown() error { return errExpectedTestError }
func TestNewExchangeManager(t *testing.T) {
t.Parallel()
m := SetupExchangeManager()
m := NewExchangeManager()
if m == nil { //nolint:staticcheck,nolintlint // SA5011 Ignore the nil warnings
t.Fatalf("unexpected response")
}
@@ -24,10 +30,27 @@ func TestSetupExchangeManager(t *testing.T) {
func TestExchangeManagerAdd(t *testing.T) {
t.Parallel()
m := SetupExchangeManager()
var m *ExchangeManager
err := m.Add(nil)
if !errors.Is(err, ErrNilSubsystem) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrNilSubsystem)
}
m = NewExchangeManager()
err = m.Add(nil)
if !errors.Is(err, errExchangeIsNil) {
t.Fatalf("received: '%v' but expected: '%v'", err, errExchangeIsNil)
}
b := new(bitfinex.Bitfinex)
b.SetDefaults()
m.Add(b)
err = m.Add(b)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
err = m.Add(b)
if !errors.Is(err, errExchangeAlreadyLoaded) {
t.Fatalf("received: '%v' but expected: '%v'", err, errExchangeAlreadyLoaded)
}
exchanges, err := m.GetExchanges()
if err != nil {
t.Error("no exchange manager found")
@@ -39,7 +62,13 @@ func TestExchangeManagerAdd(t *testing.T) {
func TestExchangeManagerGetExchanges(t *testing.T) {
t.Parallel()
m := SetupExchangeManager()
var m *ExchangeManager
_, err := m.GetExchanges()
if !errors.Is(err, ErrNilSubsystem) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrNilSubsystem)
}
m = NewExchangeManager()
exchanges, err := m.GetExchanges()
if err != nil {
t.Error("no exchange manager found")
@@ -49,7 +78,10 @@ func TestExchangeManagerGetExchanges(t *testing.T) {
}
b := new(bitfinex.Bitfinex)
b.SetDefaults()
m.Add(b)
err = m.Add(b)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
exchanges, err = m.GetExchanges()
if err != nil {
t.Error("no exchange manager found")
@@ -61,30 +93,76 @@ func TestExchangeManagerGetExchanges(t *testing.T) {
func TestExchangeManagerRemoveExchange(t *testing.T) {
t.Parallel()
m := SetupExchangeManager()
if err := m.RemoveExchange("Bitfinex"); err != ErrNoExchangesLoaded {
t.Error("no exchanges should be loaded")
var m *ExchangeManager
err := m.RemoveExchange("")
if !errors.Is(err, ErrNilSubsystem) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrNilSubsystem)
}
m = NewExchangeManager()
err = m.RemoveExchange("")
if !errors.Is(err, ErrExchangeNameIsEmpty) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrExchangeNameIsEmpty)
}
err = m.RemoveExchange("Bitfinex")
if !errors.Is(err, ErrExchangeNotFound) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrExchangeNotFound)
}
b := new(bitfinex.Bitfinex)
b.SetDefaults()
m.Add(b)
err := m.RemoveExchange("Bitstamp")
err = m.Add(b)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
err = m.RemoveExchange("Bitstamp")
if !errors.Is(err, ErrExchangeNotFound) {
t.Errorf("received: %v but expected: %v", err, ErrExchangeNotFound)
}
if err := m.RemoveExchange("BiTFiNeX"); err != nil {
t.Error("exchange should have been removed")
err = m.RemoveExchange("BiTFiNeX")
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
if m.Len() != 0 {
if len(m.exchanges) != 0 {
t.Error("exchange manager len should be 0")
}
brokenExch := &broken{}
brokenExch.SetDefaults()
err = m.Add(brokenExch)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
err = m.RemoveExchange("BiTFiNeX")
if !errors.Is(err, errExpectedTestError) {
t.Fatalf("received: '%v' but expected: '%v'", err, errExpectedTestError)
}
}
func TestNewExchangeByName(t *testing.T) {
m := SetupExchangeManager()
var m *ExchangeManager
_, err := m.NewExchangeByName("")
if !errors.Is(err, ErrNilSubsystem) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrNilSubsystem)
}
m = NewExchangeManager()
_, err = m.NewExchangeByName("")
if !errors.Is(err, ErrExchangeNameIsEmpty) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrExchangeNameIsEmpty)
}
exchanges := []string{"binanceus", "binance", "bitfinex", "bitflyer", "bithumb", "bitmex", "bitstamp", "bittrex", "btc markets", "btse", "bybit", "coinut", "exmo", "coinbasepro", "gateio", "gemini", "hitbtc", "huobi", "itbit", "kraken", "lbank", "okcoin international", "okx", "poloniex", "yobit", "zb", "fake"}
for i := range exchanges {
exch, err := m.NewExchangeByName(exchanges[i])
var exch exchange.IBotExchange
exch, err = m.NewExchangeByName(exchanges[i])
if err != nil && exchanges[i] != "fake" {
t.Fatal(err)
}
@@ -95,6 +173,19 @@ func TestNewExchangeByName(t *testing.T) {
}
}
}
load := &bitfinex.Bitfinex{}
load.SetDefaults()
err = m.Add(load)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
_, err = m.NewExchangeByName("bitfinex")
if !errors.Is(err, ErrExchangeAlreadyLoaded) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrExchangeAlreadyLoaded)
}
}
type ExchangeBuilder struct{}
@@ -113,7 +204,7 @@ func (n ExchangeBuilder) NewExchangeByName(name string) (exchange.IBotExchange,
}
func TestNewCustomExchangeByName(t *testing.T) {
m := SetupExchangeManager()
m := NewExchangeManager()
m.Builder = ExchangeBuilder{}
name := "customex"
exch, err := m.NewExchangeByName(name)
@@ -127,3 +218,31 @@ func TestNewCustomExchangeByName(t *testing.T) {
}
}
}
func TestExchangeManagerShutdown(t *testing.T) {
t.Parallel()
var m *ExchangeManager
err := m.Shutdown(-1)
if !errors.Is(err, ErrNilSubsystem) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrNilSubsystem)
}
m = NewExchangeManager()
err = m.Shutdown(-1)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
brokenExch := &broken{}
brokenExch.SetDefaults()
err = m.Add(brokenExch)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
err = m.Shutdown(-1)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
}