Files
gocryptotrader/engine/websocketroutine_manager_test.go
Adrian Gallagher a5b638bfb7 GHA: Add additional checks for common issues (#1922)
* GHA, tests: Add additional checks for common issues

These checks include:
- Ensuring that all testify funcs use their formatted variants (e.g., `assert.Equalf(t, expected, actual)` instead of `assert.Equal(t, expected, actual)`).
- Replacing `%s` with %q
- Enforcing consistent usage of should/must wording for testify assert/require messages

* Add support for checking backticked string format specifiers and fix issues

* tests: Fix error comparisons

* tests: Replace errors.Is(err, nil) usage with testify and automate check

* refactor: Rename ExtractPort to ExtractPortOrDefault

* tests: Replace assert with require for error handling in multiple test files

* tests: Replace assert with require for error handling and improve assertions in data tests

* tests: Fix typo in assertion message for StreamVol test

* OKX: Fix GetOpenInterestAndVolumeStrike test with instrument selection and improved assertions

* OKX: Revert intentional error check

* Improve error message for expiry time check in GetOpenInterestAndVolumeStrike test
2025-05-28 12:26:51 +10:00

336 lines
8.7 KiB
Go

package engine
import (
"errors"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/thrasher-corp/gocryptotrader/config"
"github.com/thrasher-corp/gocryptotrader/currency"
"github.com/thrasher-corp/gocryptotrader/exchange/websocket"
"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
"github.com/thrasher-corp/gocryptotrader/exchanges/order"
"github.com/thrasher-corp/gocryptotrader/exchanges/orderbook"
"github.com/thrasher-corp/gocryptotrader/exchanges/ticker"
)
func TestWebsocketRoutineManagerSetup(t *testing.T) {
_, err := setupWebsocketRoutineManager(nil, nil, nil, nil, false)
if !errors.Is(err, errNilExchangeManager) {
t.Errorf("error '%v', expected '%v'", err, errNilExchangeManager)
}
_, err = setupWebsocketRoutineManager(NewExchangeManager(), (*OrderManager)(nil), nil, nil, false)
if !errors.Is(err, errNilCurrencyPairSyncer) {
t.Errorf("error '%v', expected '%v'", err, errNilCurrencyPairSyncer)
}
_, err = setupWebsocketRoutineManager(NewExchangeManager(), &OrderManager{}, &SyncManager{}, nil, false)
if !errors.Is(err, errNilCurrencyConfig) {
t.Errorf("error '%v', expected '%v'", err, errNilCurrencyConfig)
}
_, err = setupWebsocketRoutineManager(NewExchangeManager(), &OrderManager{}, &SyncManager{}, &currency.Config{}, true)
if !errors.Is(err, errNilCurrencyPairFormat) {
t.Errorf("error '%v', expected '%v'", err, errNilCurrencyPairFormat)
}
m, err := setupWebsocketRoutineManager(NewExchangeManager(), &OrderManager{}, &SyncManager{}, &currency.Config{CurrencyPairFormat: &currency.PairFormat{}}, false)
assert.NoError(t, err)
if m == nil {
t.Error("expecting manager")
}
}
func TestWebsocketRoutineManagerStart(t *testing.T) {
var m *WebsocketRoutineManager
err := m.Start()
if !errors.Is(err, ErrNilSubsystem) {
t.Errorf("error '%v', expected '%v'", err, ErrNilSubsystem)
}
cfg := &currency.Config{CurrencyPairFormat: &currency.PairFormat{
Uppercase: false,
Delimiter: "-",
}}
m, err = setupWebsocketRoutineManager(NewExchangeManager(), &OrderManager{}, &SyncManager{}, cfg, true)
assert.NoError(t, err)
err = m.Start()
assert.NoError(t, err)
err = m.Start()
if !errors.Is(err, ErrSubSystemAlreadyStarted) {
t.Errorf("error '%v', expected '%v'", err, ErrSubSystemAlreadyStarted)
}
}
func TestWebsocketRoutineManagerIsRunning(t *testing.T) {
var m *WebsocketRoutineManager
if m.IsRunning() {
t.Error("expected false")
}
m, err := setupWebsocketRoutineManager(NewExchangeManager(), &OrderManager{}, &SyncManager{}, &currency.Config{CurrencyPairFormat: &currency.PairFormat{}}, false)
assert.NoError(t, err)
if m.IsRunning() {
t.Error("expected false")
}
err = m.Start()
assert.NoError(t, err)
for atomic.LoadInt32(&m.state) == startingState {
<-time.After(time.Second / 100)
}
if !m.IsRunning() {
t.Error("expected true")
}
}
func TestWebsocketRoutineManagerStop(t *testing.T) {
var m *WebsocketRoutineManager
err := m.Stop()
if !errors.Is(err, ErrNilSubsystem) {
t.Errorf("error '%v', expected '%v'", err, ErrNilSubsystem)
}
m, err = setupWebsocketRoutineManager(NewExchangeManager(), &OrderManager{}, &SyncManager{}, &currency.Config{CurrencyPairFormat: &currency.PairFormat{}}, false)
assert.NoError(t, err)
err = m.Stop()
if !errors.Is(err, ErrSubSystemNotStarted) {
t.Errorf("error '%v', expected '%v'", err, ErrSubSystemNotStarted)
}
err = m.Start()
assert.NoError(t, err)
err = m.Stop()
assert.NoError(t, err)
}
func TestWebsocketRoutineManagerHandleData(t *testing.T) {
exchName := "Bitstamp"
var wg sync.WaitGroup
em := NewExchangeManager()
exch, err := em.NewExchangeByName(exchName)
require.NoError(t, err)
exch.SetDefaults()
err = em.Add(exch)
require.NoError(t, err)
om, err := SetupOrderManager(em, &CommunicationManager{}, &wg, &config.OrderManager{})
assert.NoError(t, err)
err = om.Start()
assert.NoError(t, err)
cfg := &currency.Config{CurrencyPairFormat: &currency.PairFormat{
Uppercase: false,
Delimiter: "-",
}}
m, err := setupWebsocketRoutineManager(em, om, &SyncManager{}, cfg, true)
assert.NoError(t, err)
err = m.Start()
assert.NoError(t, err)
orderID := "1337"
err = m.websocketDataHandler(exchName, errors.New("error"))
if err == nil {
t.Error("Error not handled correctly")
}
err = m.websocketDataHandler(exchName, websocket.FundingData{})
if err != nil {
t.Error(err)
}
err = m.websocketDataHandler(exchName, &ticker.Price{
ExchangeName: exchName,
Pair: currency.NewPair(currency.BTC, currency.USDC),
AssetType: asset.Spot,
})
assert.NoError(t, err)
err = m.websocketDataHandler(exchName, websocket.KlineData{})
if err != nil {
t.Error(err)
}
origOrder := &order.Detail{
Exchange: exchName,
OrderID: orderID,
Amount: 1337,
Price: 1337,
}
err = m.websocketDataHandler(exchName, origOrder)
if err != nil {
t.Error(err)
}
// Send it again since it exists now
err = m.websocketDataHandler(exchName, &order.Detail{
Exchange: exchName,
OrderID: orderID,
Amount: 1338,
})
if err != nil {
t.Error(err)
}
updated, err := m.orderManager.GetByExchangeAndID(origOrder.Exchange, origOrder.OrderID)
if err != nil {
t.Error(err)
}
if updated.Amount != 1338 {
t.Error("Bad pipeline")
}
err = m.websocketDataHandler(exchName, &order.Detail{
Exchange: "Bitstamp",
OrderID: orderID,
Status: order.Active,
})
if err != nil {
t.Error(err)
}
updated, err = m.orderManager.GetByExchangeAndID(origOrder.Exchange, origOrder.OrderID)
if err != nil {
t.Error(err)
}
if updated.Status != order.Active {
t.Error("Expected order to be modified to Active")
}
// Send some gibberish
err = m.websocketDataHandler(exchName, order.Stop)
if err != nil {
t.Error(err)
}
err = m.websocketDataHandler(exchName, websocket.UnhandledMessageWarning{
Message: "there's an issue here's a tissue",
})
if err != nil {
t.Error(err)
}
classificationError := order.ClassificationError{
Exchange: "test",
OrderID: "one",
Err: errors.New("lol"),
}
err = m.websocketDataHandler(exchName, classificationError)
if err == nil {
t.Error("Expected error")
}
if !errors.Is(err, classificationError.Err) {
t.Errorf("error '%v', expected '%v'", err, classificationError.Err)
}
err = m.websocketDataHandler(exchName, &orderbook.Base{
Exchange: "Bitstamp",
Pair: currency.NewBTCUSD(),
})
if err != nil {
t.Error(err)
}
err = m.websocketDataHandler(exchName, "this is a test string")
if err != nil {
t.Error(err)
}
}
func TestRegisterWebsocketDataHandlerWithFunctionality(t *testing.T) {
t.Parallel()
var m *WebsocketRoutineManager
err := m.registerWebsocketDataHandler(nil, false)
if !errors.Is(err, ErrNilSubsystem) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrNilSubsystem)
}
m = new(WebsocketRoutineManager)
m.shutdown = make(chan struct{})
err = m.registerWebsocketDataHandler(nil, false)
if !errors.Is(err, errNilWebsocketDataHandlerFunction) {
t.Fatalf("received: '%v' but expected: '%v'", err, errNilWebsocketDataHandlerFunction)
}
// externally defined capture device
dataChan := make(chan any)
fn := func(_ string, data any) error {
switch data.(type) {
case string:
dataChan <- data
default:
}
return nil
}
err = m.registerWebsocketDataHandler(fn, true)
require.NoError(t, err)
if len(m.dataHandlers) != 1 {
t.Fatal("unexpected data handlers registered")
}
mock := websocket.NewManager()
mock.ToRoutine = make(chan any)
m.state = readyState
err = m.websocketDataReceiver(mock)
if err != nil {
t.Fatal(err)
}
mock.ToRoutine <- nil
mock.ToRoutine <- 1336
mock.ToRoutine <- "intercepted"
if r := <-dataChan; r != "intercepted" {
t.Fatal("unexpected value received")
}
close(m.shutdown)
m.wg.Wait()
}
func TestSetWebsocketDataHandler(t *testing.T) {
t.Parallel()
var m *WebsocketRoutineManager
err := m.setWebsocketDataHandler(nil)
if !errors.Is(err, ErrNilSubsystem) {
t.Fatalf("received: '%v' but expected: '%v'", err, ErrNilSubsystem)
}
m = new(WebsocketRoutineManager)
m.shutdown = make(chan struct{})
err = m.setWebsocketDataHandler(nil)
if !errors.Is(err, errNilWebsocketDataHandlerFunction) {
t.Fatalf("received: '%v' but expected: '%v'", err, errNilWebsocketDataHandlerFunction)
}
err = m.registerWebsocketDataHandler(m.websocketDataHandler, false)
require.NoError(t, err)
err = m.registerWebsocketDataHandler(m.websocketDataHandler, false)
require.NoError(t, err)
err = m.registerWebsocketDataHandler(m.websocketDataHandler, false)
require.NoError(t, err)
if len(m.dataHandlers) != 3 {
t.Fatal("unexpected data handler count")
}
err = m.setWebsocketDataHandler(m.websocketDataHandler)
require.NoError(t, err)
if len(m.dataHandlers) != 1 {
t.Fatal("unexpected data handler count")
}
}