Files
gocryptotrader/exchanges/okx/ws_requests_test.go
Samuael A. 3f534a15f1 cmd/exchange_template, exchanges: Update templates and propogate to exchanges (#1777)
* Added TimeInForce type and updated related files

* Linter issue fix and minor coinbasepro type update

* Bitrex consts update

* added unit test and minor changes in bittrex

* Unit tests update

* Fix minor linter issues

* Update TestStringToTimeInForce unit test

* Exchange test template change

* A different approach

* fix conflict with gateio timeInForce

* minor exchange template update

* Minor fix to test_files template

* Update order tests

* Complete updating the order unit tests

* Updating exchange wrapper and test template files

* update kucoin and deribit wrapper to match the time in force change

* minor comment update

* fix time-in-force related test errors

* linter issue fix

* ADD_NEW_EXCHANGE documentation update

* time in force constants, functions and unit tests update

* shift tif policies to TimeInForce

* Update time-in-force, related functions, and unit tests

* fix linter issue and time-in-force processing

* added a good till crossing tif value

* order type fix and fix related tim-in-force entries

* update time-in-force unmarshaling and unit test

* consistency guideline added

* fix time-in-force error in gateio

* linter issue fix

* update based on review comments

* add unit test and fix missing issues

* minor fix and added benchmark unit test

* change GTT to GTC for limit

* fix linter issue

* added time-in-force value to place order param

* fix minor issues based on review comment and move tif code to separate files

* update on exchanges linked to time-in-force

* resolve missing review comments

* minor linter issues fix

* added time-in-force handler and update timeInForce parametered endpoint

* minor fixes based on review

* nits fix

* update based on review

* linter fix

* rm getTimeInForce func and minor change to time-in-force

* minor change

* update based on review comments

* wrappers and time-in-force calling approach

* minor change

* update gateio string to timeInForce conversion and unit test

* update exchange template

* update wrapper template file

* policy comments, and template files update

* rename all exchange types name to Exchange

* update on template files and template generation

* templates and generation code and other updates

* linter issue fix

* added subscriptions and websocket templates

* update ADD_NEW_EXCHANGE.md with recent binance functions and implementations

* rename template files and update unit tests

* minor template and unit test fix

* rename templates and fix on unit tests

* update on template files and documentation

* removed unnecessary tag fix and update templates

* fix Add_NEW_EXCHANGE.md doc file

* formatting, comments, and error checks update on template files

* rename exchange receivers to e and ex for consistency

* rename unit test exchange receiver and minor updates

* linter issues fix

* fix deribit issue and minor style update

* fix test issues caused by receiver change

* raname local variables exchange declaration variables

* update templates comments

* update templates and related comments

* renamed ex to e

* update template comments

* toggle WS to false to improve coverage

* template comments update

* added test coverage to Ws enabled and minor changes

---------

Co-authored-by: Samuel Reid <43227667+cranktakular@users.noreply.github.com>
2025-07-17 10:46:36 +10:00

284 lines
8.9 KiB
Go

package okx
import (
"errors"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/thrasher-corp/gocryptotrader/common"
"github.com/thrasher-corp/gocryptotrader/exchanges/order"
"github.com/thrasher-corp/gocryptotrader/exchanges/request"
"github.com/thrasher-corp/gocryptotrader/exchanges/sharedtestvalues"
testexch "github.com/thrasher-corp/gocryptotrader/internal/testing/exchange"
)
func TestWSPlaceOrder(t *testing.T) {
t.Parallel()
_, err := e.WSPlaceOrder(t.Context(), nil)
require.ErrorIs(t, err, common.ErrNilPointer)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
out := &PlaceOrderRequestParam{
InstrumentID: mainPair.String(),
TradeMode: TradeModeIsolated, // depending on portfolio settings this can also be TradeModeCash
Side: "Buy",
OrderType: "post_only",
Amount: 0.0001,
Price: 20000,
Currency: "USDT",
}
got, err := e.WSPlaceOrder(request.WithVerbose(t.Context()), out)
require.NoError(t, err)
require.NotEmpty(t, got)
}
func TestWSPlaceMultipleOrders(t *testing.T) {
t.Parallel()
_, err := e.WSPlaceMultipleOrders(t.Context(), nil)
require.ErrorIs(t, err, order.ErrSubmissionIsNil)
_, err = e.WSPlaceMultipleOrders(t.Context(), []PlaceOrderRequestParam{{}})
require.ErrorIs(t, err, errMissingInstrumentID)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
out := PlaceOrderRequestParam{
InstrumentID: mainPair.String(),
TradeMode: TradeModeIsolated, // depending on portfolio settings this can also be TradeModeCash
Side: "Buy",
OrderType: "post_only",
Amount: 0.0001,
Price: 20000,
Currency: "USDT",
}
got, err := e.WSPlaceMultipleOrders(request.WithVerbose(t.Context()), []PlaceOrderRequestParam{out})
require.NoError(t, err)
require.NotEmpty(t, got)
}
func TestWSCancelOrder(t *testing.T) {
t.Parallel()
_, err := e.WSCancelOrder(t.Context(), nil)
require.ErrorIs(t, err, common.ErrNilPointer)
_, err = e.WSCancelOrder(t.Context(), &CancelOrderRequestParam{})
require.ErrorIs(t, err, errMissingInstrumentID)
_, err = e.WSCancelOrder(t.Context(), &CancelOrderRequestParam{InstrumentID: mainPair.String()})
require.ErrorIs(t, err, order.ErrOrderIDNotSet)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
got, err := e.WSCancelOrder(request.WithVerbose(t.Context()), &CancelOrderRequestParam{InstrumentID: mainPair.String(), OrderID: "2341161427393388544"})
require.NoError(t, err)
require.NotEmpty(t, got)
}
func TestWSCancelMultipleOrders(t *testing.T) {
t.Parallel()
_, err := e.WSCancelMultipleOrders(t.Context(), nil)
require.ErrorIs(t, err, order.ErrSubmissionIsNil)
_, err = e.WSCancelMultipleOrders(t.Context(), []CancelOrderRequestParam{{}})
require.ErrorIs(t, err, errMissingInstrumentID)
_, err = e.WSCancelMultipleOrders(t.Context(), []CancelOrderRequestParam{{InstrumentID: mainPair.String()}})
require.ErrorIs(t, err, order.ErrOrderIDNotSet)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
got, err := e.WSCancelMultipleOrders(request.WithVerbose(t.Context()), []CancelOrderRequestParam{{InstrumentID: mainPair.String(), OrderID: "2341184920998715392"}})
require.NoError(t, err)
require.NotEmpty(t, got)
}
func TestWSAmendOrder(t *testing.T) {
t.Parallel()
_, err := e.WSAmendOrder(t.Context(), nil)
require.ErrorIs(t, err, common.ErrNilPointer)
out := &AmendOrderRequestParams{}
_, err = e.WSAmendOrder(t.Context(), out)
require.ErrorIs(t, err, errMissingInstrumentID)
out.InstrumentID = mainPair.String()
_, err = e.WSAmendOrder(t.Context(), out)
require.ErrorIs(t, err, order.ErrOrderIDNotSet)
out.OrderID = "2341200629875154944"
_, err = e.WSAmendOrder(t.Context(), out)
require.ErrorIs(t, err, errInvalidNewSizeOrPriceInformation)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
out.NewPrice = 21000
got, err := e.WSAmendOrder(request.WithVerbose(t.Context()), out)
require.NoError(t, err)
require.NotEmpty(t, got)
}
func TestWSAmendMultipleOrders(t *testing.T) {
t.Parallel()
_, err := e.WSAmendMultipleOrders(t.Context(), nil)
require.ErrorIs(t, err, order.ErrSubmissionIsNil)
out := AmendOrderRequestParams{}
_, err = e.WSAmendMultipleOrders(t.Context(), []AmendOrderRequestParams{out})
require.ErrorIs(t, err, errMissingInstrumentID)
out.InstrumentID = mainPair.String()
_, err = e.WSAmendMultipleOrders(t.Context(), []AmendOrderRequestParams{out})
require.ErrorIs(t, err, order.ErrOrderIDNotSet)
out.OrderID = "2341200629875154944"
_, err = e.WSAmendMultipleOrders(t.Context(), []AmendOrderRequestParams{out})
require.ErrorIs(t, err, errInvalidNewSizeOrPriceInformation)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
out.NewPrice = 20000
got, err := e.WSAmendMultipleOrders(request.WithVerbose(t.Context()), []AmendOrderRequestParams{out})
require.NoError(t, err)
require.NotEmpty(t, got)
}
func TestWSMassCancelOrders(t *testing.T) {
t.Parallel()
err := e.WSMassCancelOrders(t.Context(), nil)
require.ErrorIs(t, err, order.ErrSubmissionIsNil)
err = e.WSMassCancelOrders(t.Context(), []CancelMassReqParam{{}})
require.ErrorIs(t, err, errInvalidInstrumentType)
err = e.WSMassCancelOrders(t.Context(), []CancelMassReqParam{{InstrumentType: "OPTION"}})
require.ErrorIs(t, err, errInstrumentFamilyRequired)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
err = e.WSMassCancelOrders(request.WithVerbose(t.Context()), []CancelMassReqParam{
{
InstrumentType: "OPTION",
InstrumentFamily: optionsPair.String(),
},
})
require.NoError(t, err)
}
func TestWSPlaceSpreadOrder(t *testing.T) {
t.Parallel()
_, err := e.WSPlaceSpreadOrder(t.Context(), nil)
require.ErrorIs(t, err, common.ErrNilPointer)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
result, err := e.WSPlaceSpreadOrder(request.WithVerbose(t.Context()), &SpreadOrderParam{
SpreadID: spreadPair.String(),
ClientOrderID: "b15",
Side: order.Buy.Lower(),
OrderType: "limit",
Price: 2.15,
Size: 2,
})
require.NoError(t, err)
assert.NotNil(t, result)
}
func TestWSAmendSpreadOrder(t *testing.T) {
t.Parallel()
_, err := e.WSAmendSpreadOrder(t.Context(), nil)
require.ErrorIs(t, err, common.ErrNilPointer)
_, err = e.WSAmendSpreadOrder(t.Context(), &AmendSpreadOrderParam{NewSize: 2})
require.ErrorIs(t, err, order.ErrOrderIDNotSet)
_, err = e.WSAmendSpreadOrder(t.Context(), &AmendSpreadOrderParam{OrderID: "2510789768709120"})
require.ErrorIs(t, err, errSizeOrPriceIsRequired)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
result, err := e.WSAmendSpreadOrder(request.WithVerbose(t.Context()), &AmendSpreadOrderParam{
OrderID: "2510789768709120",
NewSize: 2,
})
require.NoError(t, err)
assert.NotNil(t, result)
}
func TestWSCancelSpreadOrder(t *testing.T) {
t.Parallel()
_, err := e.WSCancelSpreadOrder(t.Context(), "", "")
require.ErrorIs(t, err, order.ErrOrderIDNotSet)
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
result, err := e.WSCancelSpreadOrder(request.WithVerbose(t.Context()), "1234", "")
require.NoError(t, err)
assert.NotNil(t, result)
}
func TestWSCancelAllSpreadOrders(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
testexch.SetupWs(t, e)
err := e.WSCancelAllSpreadOrders(request.WithVerbose(t.Context()), spreadPair.String())
require.NoError(t, err)
}
type mockHasError struct {
err error
}
func (m *mockHasError) Error() error {
return m.err
}
func TestParseWSResponseErrors(t *testing.T) {
t.Parallel()
require.Panics(t, func() { _ = parseWSResponseErrors(123, nil) }, "result must be a pointer")
require.Panics(t, func() { _ = parseWSResponseErrors(&mockHasError{}, nil) }, "result must be a slice")
var emptySlice []*mockHasError
require.NoError(t, parseWSResponseErrors(&emptySlice, nil))
require.ErrorIs(t, parseWSResponseErrors(&emptySlice, errOperationFailed), errOperationFailed)
err1 := errors.New("error 1")
err2 := errors.New("error 2")
mockSlice := []*mockHasError{{err: nil}, {err: err1}, {err: err2}}
err := parseWSResponseErrors(&mockSlice, errPartialSuccess)
require.ErrorIs(t, err, errPartialSuccess)
require.ErrorIs(t, err, err1)
require.ErrorIs(t, err, err2)
}
func TestSingleItem(t *testing.T) {
t.Parallel()
_, err := singleItem([]*any(nil))
require.ErrorIs(t, err, common.ErrNoResponse)
_, err = singleItem([]*mockHasError{{}, {}})
require.ErrorIs(t, err, errMultipleItemsReturned)
got, err := singleItem([]*mockHasError{{}})
require.NoError(t, err)
require.NotNil(t, got)
}