exchanges: Remove self-explanatory comments from test functions (#2004)

* Initial plan

* Remove self-explanatory comments from websocket test functions

Co-authored-by: thrasher- <4685270+thrasher-@users.noreply.github.com>

* Remove remaining self-explanatory comments from test functions

Co-authored-by: thrasher- <4685270+thrasher-@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: thrasher- <4685270+thrasher-@users.noreply.github.com>
This commit is contained in:
Copilot
2025-08-19 12:01:04 +10:00
committed by GitHub
parent 9774c22f6a
commit 7879633c4a
17 changed files with 0 additions and 70 deletions

View File

@@ -1285,7 +1285,6 @@ func TestAllOrders(t *testing.T) {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
t.Parallel()

View File

@@ -807,7 +807,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := setFeeBuilder()
_, err := e.GetFeeByType(t.Context(), feeBuilder)
@@ -1116,7 +1115,6 @@ func TestGetDepositAddress(t *testing.T) {
}
}
// TestWSAuth dials websocket, sends login request.
func TestWSAuth(t *testing.T) {
if !e.Websocket.IsEnabled() {
t.Skip(websocket.ErrWebsocketNotEnabled.Error())

View File

@@ -156,7 +156,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := setFeeBuilder()
_, err := e.GetFeeByType(t.Context(), feeBuilder)

View File

@@ -263,7 +263,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
t.Parallel()
feeBuilder := setFeeBuilder()

View File

@@ -463,7 +463,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
t.Parallel()
feeBuilder := setFeeBuilder()
@@ -718,7 +717,6 @@ func TestGetDepositAddress(t *testing.T) {
}
}
// TestWsAuth dials websocket, sends login request.
func TestWsAuth(t *testing.T) {
t.Parallel()
if !e.Websocket.IsEnabled() && !e.API.AuthenticatedWebsocketSupport || !sharedtestvalues.AreAPICredentialsSet(e) {

View File

@@ -44,7 +44,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
t.Parallel()

View File

@@ -325,7 +325,6 @@ func TestFormatWithdrawPermissions(t *testing.T) {
assert.Equal(t, exchange.NoAPIWithdrawalMethodsText, e.FormatWithdrawPermissions(), "FormatWithdrawPermissions should return correct format")
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := &exchange.FeeBuilder{
FeeType: exchange.CryptocurrencyTradeFee,

View File

@@ -243,7 +243,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := setFeeBuilder()
_, err := e.GetFeeByType(t.Context(), feeBuilder)
@@ -673,7 +672,6 @@ func TestGetDepositAddress(t *testing.T) {
}
}
// TestWsAuth dials websocket, sends login request.
func TestWsAuth(t *testing.T) {
if !e.Websocket.IsEnabled() && !e.API.AuthenticatedWebsocketSupport || !sharedtestvalues.AreAPICredentialsSet(e) {
t.Skip(websocket.ErrWebsocketNotEnabled.Error())

View File

@@ -113,7 +113,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := setFeeBuilder()
_, err := e.GetFeeByType(t.Context(), feeBuilder)
@@ -422,7 +421,6 @@ func TestGetDepositAddress(t *testing.T) {
}
}
// TestWsAuthGetAccountBalance dials websocket, retrieves account balance
func TestWsAuthGetAccountBalance(t *testing.T) {
setupWSTestAuth(t)
if _, err := e.wsGetAccountBalance(t.Context()); err != nil {
@@ -430,7 +428,6 @@ func TestWsAuthGetAccountBalance(t *testing.T) {
}
}
// TestWsAuthSubmitOrder dials websocket, submit order
func TestWsAuthSubmitOrder(t *testing.T) {
setupWSTestAuth(t)
if !canManipulateRealOrders {
@@ -448,7 +445,6 @@ func TestWsAuthSubmitOrder(t *testing.T) {
}
}
// TestWsAuthSubmitOrders dials websocket, submit orders
func TestWsAuthSubmitOrders(t *testing.T) {
setupWSTestAuth(t)
if !canManipulateRealOrders {
@@ -474,8 +470,6 @@ func TestWsAuthSubmitOrders(t *testing.T) {
}
}
// TestWsAuthCancelOrders dials websocket, cancels orders
// doesn't care about if the order cancellations fail
func TestWsAuthCancelOrders(t *testing.T) {
setupWSTestAuth(t)
if !canManipulateRealOrders {
@@ -498,8 +492,6 @@ func TestWsAuthCancelOrders(t *testing.T) {
}
}
// TestWsAuthCancelOrdersWrapper dials websocket, cancels orders
// Checks that the wrapper oversight works
func TestWsAuthCancelOrdersWrapper(t *testing.T) {
setupWSTestAuth(t)
if !canManipulateRealOrders {
@@ -514,7 +506,6 @@ func TestWsAuthCancelOrdersWrapper(t *testing.T) {
}
}
// TestWsAuthCancelOrder dials websocket, cancels order
func TestWsAuthCancelOrder(t *testing.T) {
setupWSTestAuth(t)
if !canManipulateRealOrders {
@@ -533,7 +524,6 @@ func TestWsAuthCancelOrder(t *testing.T) {
}
}
// TestWsAuthGetOpenOrders dials websocket, retrieves open orders
func TestWsAuthGetOpenOrders(t *testing.T) {
setupWSTestAuth(t)
_, err := e.wsGetOpenOrders(t.Context(), currency.NewPair(currency.LTC, currency.BTC).String())

View File

@@ -407,7 +407,6 @@ func TestSetAPICredentialDefaults(t *testing.T) {
}
}
// TestGetAuthenticatedAPISupport logic test
func TestGetAuthenticatedAPISupport(t *testing.T) {
t.Parallel()

View File

@@ -110,7 +110,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := setFeeBuilder()
_, err := e.GetFeeByType(t.Context(), feeBuilder)

View File

@@ -238,7 +238,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
t.Parallel()
feeBuilder := setFeeBuilder()
@@ -549,7 +548,6 @@ func TestGetDepositAddress(t *testing.T) {
}
}
// TestWsAuth dials websocket, sends login request.
func TestWsAuth(t *testing.T) {
t.Parallel()
err := e.API.Endpoints.SetRunningURL(exchange.WebsocketSpot.String(), geminiWebsocketSandboxEndpoint)

View File

@@ -110,7 +110,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := setFeeBuilder()
_, err := e.GetFeeByType(t.Context(), feeBuilder)
@@ -453,7 +452,6 @@ func setupWsAuth(t *testing.T) {
wsSetupRan = true
}
// TestWsCancelOrder dials websocket, sends cancel request.
func TestWsCancelOrder(t *testing.T) {
setupWsAuth(t)
if !canManipulateRealOrders {
@@ -465,7 +463,6 @@ func TestWsCancelOrder(t *testing.T) {
}
}
// TestWsPlaceOrder dials websocket, sends order submission.
func TestWsPlaceOrder(t *testing.T) {
setupWsAuth(t)
if !canManipulateRealOrders {
@@ -477,7 +474,6 @@ func TestWsPlaceOrder(t *testing.T) {
}
}
// TestWsReplaceOrder dials websocket, sends replace order request.
func TestWsReplaceOrder(t *testing.T) {
setupWsAuth(t)
if !canManipulateRealOrders {
@@ -489,7 +485,6 @@ func TestWsReplaceOrder(t *testing.T) {
}
}
// TestWsGetActiveOrders dials websocket, sends get active orders request.
func TestWsGetActiveOrders(t *testing.T) {
setupWsAuth(t)
if _, err := e.wsGetActiveOrders(t.Context()); err != nil {
@@ -497,7 +492,6 @@ func TestWsGetActiveOrders(t *testing.T) {
}
}
// TestWsGetTradingBalance dials websocket, sends get trading balance request.
func TestWsGetTradingBalance(t *testing.T) {
setupWsAuth(t)
if _, err := e.wsGetTradingBalance(t.Context()); err != nil {
@@ -505,7 +499,6 @@ func TestWsGetTradingBalance(t *testing.T) {
}
}
// TestWsGetTradingBalance dials websocket, sends get trading balance request.
func TestWsGetTrades(t *testing.T) {
setupWsAuth(t)
_, err := e.wsGetTrades(t.Context(), currency.NewPair(currency.ETH, currency.BTC), 1000, "ASC", "id")
@@ -514,7 +507,6 @@ func TestWsGetTrades(t *testing.T) {
}
}
// TestWsGetTradingBalance dials websocket, sends get trading balance request.
func TestWsGetSymbols(t *testing.T) {
setupWsAuth(t)
_, err := e.wsGetSymbols(t.Context(), currency.NewPair(currency.ETH, currency.BTC))
@@ -523,7 +515,6 @@ func TestWsGetSymbols(t *testing.T) {
}
}
// TestWsGetCurrencies dials websocket, sends get trading balance request.
func TestWsGetCurrencies(t *testing.T) {
setupWsAuth(t)
_, err := e.wsGetCurrencies(t.Context(), currency.BTC)

View File

@@ -1062,7 +1062,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := setFeeBuilder()
_, err := e.GetFeeByType(t.Context(), feeBuilder)

View File

@@ -306,7 +306,6 @@ func TestGetFuturesTradeHistory(t *testing.T) {
assert.NoError(t, err, "GetFuturesTradeHistory should not error")
}
// TestGetAssets API endpoint test
func TestGetAssets(t *testing.T) {
t.Parallel()
_, err := e.GetAssets(t.Context())
@@ -344,7 +343,6 @@ func TestLookupCurrency(t *testing.T) {
assert.Empty(t, a.LookupCurrency("EUR"), "LookupCurrency should still not return an unseeded key")
}
// TestGetAssetPairs API endpoint test
func TestGetAssetPairs(t *testing.T) {
t.Parallel()
for _, v := range []string{"fees", "leverage", "margin", ""} {
@@ -353,28 +351,24 @@ func TestGetAssetPairs(t *testing.T) {
}
}
// TestGetTicker API endpoint test
func TestGetTicker(t *testing.T) {
t.Parallel()
_, err := e.GetTicker(t.Context(), spotTestPair)
assert.NoError(t, err, "GetTicker should not error")
}
// TestGetTickers API endpoint test
func TestGetTickers(t *testing.T) {
t.Parallel()
_, err := e.GetTickers(t.Context(), "LTCUSD,ETCUSD")
assert.NoError(t, err, "GetTickers should not error")
}
// TestGetOHLC API endpoint test
func TestGetOHLC(t *testing.T) {
t.Parallel()
_, err := e.GetOHLC(t.Context(), currency.NewPairWithDelimiter("XXBT", "ZUSD", ""), "1440")
assert.NoError(t, err, "GetOHLC should not error")
}
// TestGetDepth API endpoint test
func TestGetDepth(t *testing.T) {
t.Parallel()
_, err := e.GetDepth(t.Context(), spotTestPair)
@@ -401,7 +395,6 @@ func TestGetSpread(t *testing.T) {
assert.NotEmpty(t, v, "GetSpread should return some spread data for the given pair")
}
// TestGetBalance API endpoint test
func TestGetBalance(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -416,7 +409,6 @@ func TestGetDepositMethods(t *testing.T) {
assert.NoError(t, err, "GetDepositMethods should not error")
}
// TestGetTradeBalance API endpoint test
func TestGetTradeBalance(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -425,7 +417,6 @@ func TestGetTradeBalance(t *testing.T) {
assert.NoError(t, err)
}
// TestGetOpenOrders API endpoint test
func TestGetOpenOrders(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -434,7 +425,6 @@ func TestGetOpenOrders(t *testing.T) {
assert.NoError(t, err)
}
// TestGetClosedOrders API endpoint test
func TestGetClosedOrders(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -443,7 +433,6 @@ func TestGetClosedOrders(t *testing.T) {
assert.NoError(t, err)
}
// TestQueryOrdersInfo API endpoint test
func TestQueryOrdersInfo(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -452,7 +441,6 @@ func TestQueryOrdersInfo(t *testing.T) {
assert.NoError(t, err)
}
// TestGetTradesHistory API endpoint test
func TestGetTradesHistory(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -461,7 +449,6 @@ func TestGetTradesHistory(t *testing.T) {
assert.NoError(t, err)
}
// TestQueryTrades API endpoint test
func TestQueryTrades(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -469,7 +456,6 @@ func TestQueryTrades(t *testing.T) {
assert.NoError(t, err)
}
// TestOpenPositions API endpoint test
func TestOpenPositions(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -477,7 +463,6 @@ func TestOpenPositions(t *testing.T) {
assert.NoError(t, err)
}
// TestGetLedgers API endpoint test
// TODO: Needs a positive test
func TestGetLedgers(t *testing.T) {
t.Parallel()
@@ -488,7 +473,6 @@ func TestGetLedgers(t *testing.T) {
assert.ErrorContains(t, err, "EQuery:Unknown asset pair", "GetLedger should error on imaginary ledgers")
}
// TestQueryLedgers API endpoint test
func TestQueryLedgers(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -496,7 +480,6 @@ func TestQueryLedgers(t *testing.T) {
assert.NoError(t, err)
}
// TestGetTradeVolume API endpoint test
func TestGetTradeVolume(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -526,7 +509,6 @@ func TestOrders(t *testing.T) {
}
}
// TestCancelExistingOrder API endpoint test
func TestCancelExistingOrder(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e, canManipulateRealOrders)
@@ -547,7 +529,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
t.Parallel()
feeBuilder := setFeeBuilder()
@@ -616,7 +597,6 @@ func TestGetFee(t *testing.T) {
assert.NoError(t, err, "InternationalBankWithdrawalFee Basic GetFee should not error")
}
// TestFormatWithdrawPermissions logic test
func TestFormatWithdrawPermissions(t *testing.T) {
t.Parallel()
exp := exchange.AutoWithdrawCryptoWithSetupText + " & " + exchange.WithdrawCryptoWith2FAText + " & " + exchange.AutoWithdrawFiatWithSetupText + " & " + exchange.WithdrawFiatWith2FAText
@@ -624,7 +604,6 @@ func TestFormatWithdrawPermissions(t *testing.T) {
assert.Equal(t, exp, withdrawPermissions, "FormatWithdrawPermissions should return correct value")
}
// TestGetActiveOrders wrapper test
func TestGetActiveOrders(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -640,7 +619,6 @@ func TestGetActiveOrders(t *testing.T) {
assert.NoError(t, err, "GetActiveOrders should not error")
}
// TestGetOrderHistory wrapper test
func TestGetOrderHistory(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCredentialsUnset(t, e)
@@ -666,7 +644,6 @@ func TestGetOrderInfo(t *testing.T) {
// Any tests below this line have the ability to impact your orders on the exchange. Enable canManipulateRealOrders to run them
// ----------------------------------------------------------------------------------------------------------------------------
// TestSubmitOrder wrapper test
func TestSubmitOrder(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCannotManipulateOrders(t, e, canManipulateRealOrders)
@@ -690,7 +667,6 @@ func TestSubmitOrder(t *testing.T) {
}
}
// TestCancelExchangeOrder wrapper test
func TestCancelExchangeOrder(t *testing.T) {
t.Parallel()
@@ -734,7 +710,6 @@ func TestCancelBatchExchangeOrder(t *testing.T) {
}
}
// TestCancelAllExchangeOrders wrapper test
func TestCancelAllExchangeOrders(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCannotManipulateOrders(t, e, canManipulateRealOrders)
@@ -765,7 +740,6 @@ func TestUpdateAccountInfo(t *testing.T) {
}
}
// TestModifyOrder wrapper test
func TestModifyOrder(t *testing.T) {
t.Parallel()
@@ -773,7 +747,6 @@ func TestModifyOrder(t *testing.T) {
assert.ErrorIs(t, err, common.ErrFunctionNotSupported, "ModifyOrder should error correctly")
}
// TestWithdraw wrapper test
func TestWithdraw(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCannotManipulateOrders(t, e, canManipulateRealOrders)
@@ -799,7 +772,6 @@ func TestWithdraw(t *testing.T) {
}
}
// TestWithdrawFiat wrapper test
func TestWithdrawFiat(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCannotManipulateOrders(t, e, canManipulateRealOrders)
@@ -820,7 +792,6 @@ func TestWithdrawFiat(t *testing.T) {
}
}
// TestWithdrawInternationalBank wrapper test
func TestWithdrawInternationalBank(t *testing.T) {
t.Parallel()
sharedtestvalues.SkipTestIfCannotManipulateOrders(t, e, canManipulateRealOrders)
@@ -859,7 +830,6 @@ func TestGetCryptoDepositAddress(t *testing.T) {
}
}
// TestGetDepositAddress wrapper test
func TestGetDepositAddress(t *testing.T) {
t.Parallel()
if sharedtestvalues.AreAPICredentialsSet(e) {
@@ -875,7 +845,6 @@ func TestGetDepositAddress(t *testing.T) {
}
}
// TestWithdrawStatus wrapper test
func TestWithdrawStatus(t *testing.T) {
t.Parallel()
if sharedtestvalues.AreAPICredentialsSet(e) {
@@ -891,7 +860,6 @@ func TestWithdrawStatus(t *testing.T) {
}
}
// TestWithdrawCancel wrapper test
func TestWithdrawCancel(t *testing.T) {
t.Parallel()
_, err := e.WithdrawCancel(t.Context(), currency.BTC, "")

View File

@@ -112,7 +112,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
t.Parallel()
@@ -540,7 +539,6 @@ func TestGenerateNewAddress(t *testing.T) {
}
}
// TestWsAuth dials websocket, sends login request.
// Will receive a message only on failure
func TestWsAuth(t *testing.T) {
t.Parallel()

View File

@@ -167,7 +167,6 @@ func setFeeBuilder() *exchange.FeeBuilder {
}
}
// TestGetFeeByTypeOfflineTradeFee logic test
func TestGetFeeByTypeOfflineTradeFee(t *testing.T) {
feeBuilder := setFeeBuilder()
_, err := e.GetFeeByType(t.Context(), feeBuilder)