Files
gocryptotrader/exchanges/subscription/fixtures_test.go
Gareth Kirwan c601575c66 subscriptions: Add templating support and integrate with Binance (#1568)
* Subscriptions: Add List.AssetPairs

* Subscriptions: Add Template and QualifiedChannel

These fields separate the concept of what the channel is from the
qualified resource name

* Subscriptions: Add List.SetStates()

* Subscriptions: Add List.QualifiedChannels

* Subscriptions: Rename testsubs.EqualLists

* Binance: Switch to ExpandTemplates

* Binance: Update ConfigTest format

* Subscriptions: Test Coverage improvements

* Subscriptions: Reenterant List.ExpandTemplates

* Subscriptions: Move templates from subscriptions to exchanges

* Binance: Inline subscription template and improvements
2024-07-09 15:53:00 +10:00

97 lines
2.9 KiB
Go

package subscription
import (
"maps"
"strings"
"testing"
"text/template"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/thrasher-corp/gocryptotrader/currency"
"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
)
type mockEx struct {
tpl string
auth bool
errPairs error
errFormat error
}
func (m *mockEx) GetEnabledPairs(_ asset.Item) (currency.Pairs, error) {
return currency.Pairs{btcusdtPair, ethusdcPair}, m.errPairs
}
func (m *mockEx) GetPairFormat(_ asset.Item, _ bool) (currency.PairFormat, error) {
return currency.PairFormat{Uppercase: true}, m.errFormat
}
func (m *mockEx) GetSubscriptionTemplate(_ *Subscription) (*template.Template, error) {
return template.New(m.tpl).
Funcs(template.FuncMap{
"assetName": func(a asset.Item) string {
if a == asset.Futures {
return "future"
}
return a.String()
}}).
ParseFiles("testdata/" + m.tpl)
}
func (m *mockEx) GetAssetTypes(_ bool) asset.Items { return asset.Items{asset.Spot, asset.Futures} }
func (m *mockEx) CanUseAuthenticatedWebsocketEndpoints() bool { return m.auth }
// equalLists is a utility function to compare subscription lists and show a pretty failure message
// It overcomes the verbose depth of assert.ElementsMatch spewConfig
// Duplicate of internal/testing/subscriptions/EqualLists
func equalLists(tb testing.TB, a, b List) bool {
tb.Helper()
for _, sub := range append(a, b...) {
sub.Key = &StrictKey{&ExactKey{sub}}
}
s, err := NewStoreFromList(a)
require.NoError(tb, err, "NewStoreFromList must not error")
added, missing := s.Diff(b)
if len(added) > 0 || len(missing) > 0 {
fail := "Differences:"
if len(added) > 0 {
fail = fail + "\n + " + strings.Join(added.Strings(), "\n + ")
}
if len(missing) > 0 {
fail = fail + "\n - " + strings.Join(missing.Strings(), "\n - ")
}
assert.Fail(tb, fail, "Subscriptions should be equal")
return false
}
return true
}
// StrictKey is key type for subscriptions where all the pairs, QualifiedChannel and Params in a Subscription must match exactly
type StrictKey struct {
*ExactKey
}
var _ MatchableKey = StrictKey{} // Enforce StrictKey must implement MatchableKey
// Match implements MatchableKey
// Returns true if the key fields exactly matches the subscription, including all Pairs, QualifiedChannel and Params
func (k StrictKey) Match(eachKey MatchableKey) bool {
if !k.ExactKey.Match(eachKey) {
return false
}
eachSub := eachKey.GetSubscription()
return eachSub.QualifiedChannel == k.QualifiedChannel &&
maps.Equal(eachSub.Params, k.Params)
}
// String implements Stringer; returns the Asset, Channel and Pairs
// Does not provide concurrency protection on the subscription it points to
func (k StrictKey) String() string {
s := k.Subscription
if s == nil {
return "Uninitialised StrictKey"
}
return s.QualifiedChannel + " " + ExactKey{s}.String()
}