Files
gocryptotrader/backtester/data/data_test.go
Scott f929b4d51e backtester: Futures handling & FTX Cash and Carry example strategy (#930)
* implements futures functions and GRPC functions on new branch

* lint and test fixes

* Fix uneven split pnl. Adds collateral weight test. docs. New clear func

* Test protection if someone has zero collateral

* Uses string instead of double for accuracy

* Fixes old code panic

* context, match, docs

* Addresses Shazniterinos, var names, expanded tests

* Returns subaccount name, provides USD values when offlinecalc

* Fixes oopsie

* Fixes cool bug which allowed made up subaccount results

* Subaccount override on FTX, subaccount results for collateral

* Strenghten collateral account info checks. Improve FTX test

* English is my first language

* Fixes oopsies

* Adds some conceptual futures order details to track PNL

* Initial design of future order processing in the backtester

* Introduces futures concept for collateral and spot/futures config diffs

* Fixes most tests

* Simple designs for collateral funding pair concept

* Expands interface use so much it hurts

* Implements more collateral interfaces

* Adds liquidation, adds strategy, struggles with Binance

* Attempts at getting FTX to work

* Adds calculatePNL as a wrapper function and adds an `IsFutures` asset check

* Successfully loads backtester with collateral currency

* Fails to really get much going for supporting futures

* Merges master changes

* Fleshes out how FTX processes collateral

* Further FTX collateral workings

* hooks up more ftx collateral and pnl calculations

* more funcs to flesh out handling

* Adds more links, just can't fit the pieces together :(

* Greatly expands futures order processing

* Fleshes out position tracker to also handle asset and exchange +testing

* RM linkedOrderID. rn positioncontroller, unexport

* Successfully tracks futures order positions

* Fails to calculate PNL

* Calculates pnl from orders accurately with exception to flipping orders

* Calculates PNL from orders

* Adds another controller layer to make it ez from orderstore

* Backtester now compiles. Adds test coverage

* labels things add scaling collateral test

* Calculates pnl in line with fees

* Mostly accurate PNL, with exception to appending with diff prices

* Adds locks, adds rpc function

* grpc implementations

* Gracefully handles rpc function

* beautiful tests!

* rejiggles tests to polish

* Finishes FTX testing, adds comments

* Exposes collateral calculations to rpc

* Adds commands and testing for rpcserver.go functions

* Increase testing and fix up backtester code

* Returns cool changes to original branch

* end of day fixes

* Fixing some tests

* Fixing tests 🎉

* Fixes all the tests

* Splits the backtester setup and running into different files

* Merge, minor fixes

* Messing with some strategy updates

* Failed understanding at collateral usage

* Begins the creation of cash and carry strategy

* Adds underlying pair, adds filldependentevent for futures

* Completes fill prerequsite event implementation. Can't short though

* Some bug fixes

* investigating funds

* CAN NOW CREATE A SHORT ORDER

* Minor change in short size

* Fixes for unrealised PNL & collateral rendering

* Fixes lint and tests

* Adds some verbosity

* Updates to pnl calc

* Tracks pnl for short orders, minor update to strategy

* Close and open event based on conditions

* Adds pnl data for currency statistics

* Working through PNL calculation automatically. Now panics

* Adds tracking, is blocked from design

* Work to flesh out closing a position

* vain attempts at tracking zeroing out bugs

* woww, super fun new subloggers 🎉

* Begins attempt at automatically handling contracts and collateral based on direction

* Merge master + fixes

* Investigating issues with pnl and holdings

* Minor pnl fixes

* Fixes future position sizing, needs contract sizing

* Can render pnl results, focussing on funding statistics

* tracking candles for futures, but why not btc

* Improves funding statistics

* Colours and stats

* Fixes collateral and snapshot bugs

* Completes test

* Fixes totals bug

* Fix double buy, expand stats, fixes usd totals, introduce interface

* Begins report formatting and calculations

* Appends pnl to receiving curr. Fixes map[time]. accurate USD

* Improves report output rendering

* PNL stats in report. New tests for futures

* Fixes existing tests before adding new coverage

* Test coverage

* Completes portfolio coverage

* Increase coverage exchange, portfolio. fix size bug. NEW CHART

* WHAT IS GOING ON WITH PNL

* Fixes PNL calculation. Adds ability to skip om futures tracking

* minor commit before merge

* Adds basic liquidation to backtester

* Changes liquidation to order based

* Liquidationnnnnn

* Further fleshes out liquidations

* Completes liquidations in a honorable manner. Adds AppendReasonf

* Beginnings of spot futures gap chart. Needs to link currencies to render difference

* Removes fake liquidation. Adds cool new chart

* Fixes somet tests,allows for zero fee value v nil distinction,New tests

* Some annoying test fixes that took too long

* portfolio coverage

* holding coverage, privatisation funding

* Testwork

* boring tests

* engine coverage

* More backtesting coverage

* Funding, strategy, report test coverage

* Completes coverage of report package

* Documentation, fixes some assumptions on asset errors

* Changes before master merge

* Lint and Tests

* defaults to non-coloured rendering

* Chart rendering

* Fixes surprise non-local-lints

* Niterinos to the extremeos

* Fixes merge problems

* The linter splintered across the glinting plinths

* Many nits addressed. Now sells spot position on final candle

* Adds forgotten coverage

* Adds ability to size futures contracts to match spot positions.

* fixes order sell sizing

* Adds tests to sizing. Fixes charting issue

* clint splintered the linters with flint

* Improves stats, stat rendering

* minifix

* Fixes tests and fee bug

* Merge fixeroos

* Microfixes

* Updates orderPNL on first Correctly utilises fees. Adds committed funds

* New base funcs. New order summary

* Fun test updates

* Fix logo colouring

* Fixes niteroonies

* Fix report

* BAD COMMIT

* Fixes funding issues.Updates default fee rates.Combines cashcarry case

* doc regen

* Now returns err

* Fixes sizing bug issue introduced in PR

* Fixes fun fee/total US value bug

* Fix chart bug. Show log charts with disclaimer

* sellside fee

* fixes fee and slippage view

* Fixed slippage price issue

* Fixes calculation and removes rendering

* Fixes stats and some rendering

* Merge fix

* Fixes merge issues

* go mod tidy, lint updates

* New linter attempt

* Version bump in appveyor and makefile

* Regex filename, config fixes, template h2 fixes

* Removes bad stats.

* neatens config builder. Moves filename generator

* Fixes issue where linter wants to fix my spelling

* Fixes pointers and starts
2022-06-30 15:43:41 +10:00

255 lines
5.6 KiB
Go

package data
import (
"errors"
"testing"
"time"
"github.com/shopspring/decimal"
"github.com/thrasher-corp/gocryptotrader/backtester/common"
"github.com/thrasher-corp/gocryptotrader/backtester/eventtypes/event"
"github.com/thrasher-corp/gocryptotrader/backtester/eventtypes/order"
"github.com/thrasher-corp/gocryptotrader/currency"
"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
"github.com/thrasher-corp/gocryptotrader/exchanges/kline"
)
const testExchange = "binance"
type fakeDataHandler struct {
time int
}
func TestLatest(t *testing.T) {
t.Parallel()
var d Base
d.AppendStream(&fakeDataHandler{time: 1})
if latest := d.Latest(); latest != d.stream[d.offset] {
t.Error("expected latest to match offset")
}
}
func TestBaseDataFunctions(t *testing.T) {
t.Parallel()
var d Base
d.Next()
o := d.Offset()
if o != 0 {
t.Error("expected 0")
}
d.AppendStream(nil)
if d.IsLastEvent() {
t.Error("no")
}
d.AppendStream(nil)
if len(d.stream) != 0 {
t.Error("expected 0")
}
d.AppendStream(&fakeDataHandler{time: 1})
d.AppendStream(&fakeDataHandler{time: 2})
d.AppendStream(&fakeDataHandler{time: 3})
d.AppendStream(&fakeDataHandler{time: 4})
d.Next()
d.Next()
if list := d.List(); len(list) != 2 {
t.Errorf("expected 2 received %v", len(list))
}
d.Next()
d.Next()
if !d.IsLastEvent() {
t.Error("expected last event")
}
o = d.Offset()
if o != 4 {
t.Error("expected 4")
}
if list := d.List(); len(list) != 0 {
t.Error("expected 0")
}
if history := d.History(); len(history) != 4 {
t.Errorf("expected 4 received %v", len(history))
}
d.SetStream(nil)
if st := d.GetStream(); st != nil {
t.Error("expected nil")
}
d.Reset()
d.GetStream()
d.SortStream()
}
func TestSetup(t *testing.T) {
t.Parallel()
d := HandlerPerCurrency{}
d.Setup()
if d.data == nil {
t.Error("expected not nil")
}
}
func TestSetDataForCurrency(t *testing.T) {
t.Parallel()
d := HandlerPerCurrency{}
exch := testExchange
a := asset.Spot
p := currency.NewPair(currency.BTC, currency.USDT)
d.SetDataForCurrency(exch, a, p, nil)
if d.data == nil {
t.Error("expected not nil")
}
if d.data[exch][a][p] != nil {
t.Error("expected nil")
}
}
func TestGetAllData(t *testing.T) {
t.Parallel()
d := HandlerPerCurrency{}
exch := testExchange
a := asset.Spot
p := currency.NewPair(currency.BTC, currency.USDT)
d.SetDataForCurrency(exch, a, p, nil)
d.SetDataForCurrency(exch, a, currency.NewPair(currency.BTC, currency.DOGE), nil)
result := d.GetAllData()
if len(result) != 1 {
t.Error("expected 1")
}
if len(result[exch][a]) != 2 {
t.Error("expected 2")
}
}
func TestGetDataForCurrency(t *testing.T) {
t.Parallel()
d := HandlerPerCurrency{}
a := asset.Spot
p := currency.NewPair(currency.BTC, currency.USDT)
d.SetDataForCurrency(testExchange, a, p, nil)
d.SetDataForCurrency(testExchange, a, currency.NewPair(currency.BTC, currency.DOGE), nil)
ev := &order.Order{Base: &event.Base{
Exchange: testExchange,
AssetType: a,
CurrencyPair: p,
}}
result, err := d.GetDataForCurrency(ev)
if err != nil {
t.Error(err)
}
if result != nil {
t.Error("expected nil")
}
_, err = d.GetDataForCurrency(nil)
if !errors.Is(err, common.ErrNilEvent) {
t.Errorf("received '%v' expected '%v'", err, common.ErrNilEvent)
}
_, err = d.GetDataForCurrency(&order.Order{Base: &event.Base{
Exchange: "lol",
AssetType: asset.USDTMarginedFutures,
CurrencyPair: currency.NewPair(currency.EMB, currency.DOGE),
}})
if !errors.Is(err, ErrHandlerNotFound) {
t.Errorf("received '%v' expected '%v'", err, ErrHandlerNotFound)
}
_, err = d.GetDataForCurrency(&order.Order{Base: &event.Base{
Exchange: testExchange,
AssetType: asset.USDTMarginedFutures,
CurrencyPair: currency.NewPair(currency.EMB, currency.DOGE),
}})
if !errors.Is(err, ErrHandlerNotFound) {
t.Errorf("received '%v' expected '%v'", err, ErrHandlerNotFound)
}
}
func TestReset(t *testing.T) {
t.Parallel()
d := HandlerPerCurrency{}
exch := testExchange
a := asset.Spot
p := currency.NewPair(currency.BTC, currency.USDT)
d.SetDataForCurrency(exch, a, p, nil)
d.SetDataForCurrency(exch, a, currency.NewPair(currency.BTC, currency.DOGE), nil)
d.Reset()
if d.data != nil {
t.Error("expected nil")
}
}
// methods that satisfy the common.DataEventHandler interface
func (f fakeDataHandler) GetOffset() int64 {
return 4
}
func (f fakeDataHandler) SetOffset(int64) {
}
func (f fakeDataHandler) IsEvent() bool {
return false
}
func (f fakeDataHandler) GetTime() time.Time {
return time.Now().Add(time.Hour * time.Duration(f.time))
}
func (f fakeDataHandler) Pair() currency.Pair {
return currency.NewPair(currency.BTC, currency.USD)
}
func (f fakeDataHandler) GetExchange() string {
return "fake"
}
func (f fakeDataHandler) GetInterval() kline.Interval {
return kline.Interval(time.Minute)
}
func (f fakeDataHandler) GetAssetType() asset.Item {
return asset.Spot
}
func (f fakeDataHandler) GetReason() string {
return "fake"
}
func (f fakeDataHandler) AppendReason(string) {
}
func (f fakeDataHandler) GetClosePrice() decimal.Decimal {
return decimal.Zero
}
func (f fakeDataHandler) GetHighPrice() decimal.Decimal {
return decimal.Zero
}
func (f fakeDataHandler) GetLowPrice() decimal.Decimal {
return decimal.Zero
}
func (f fakeDataHandler) GetOpenPrice() decimal.Decimal {
return decimal.Zero
}
func (f fakeDataHandler) GetUnderlyingPair() currency.Pair {
return f.Pair()
}
func (f fakeDataHandler) AppendReasonf(s string, i ...interface{}) {}
func (f fakeDataHandler) GetBase() *event.Base {
return &event.Base{}
}
func (f fakeDataHandler) GetConcatReasons() string {
return ""
}
func (f fakeDataHandler) GetReasons() []string {
return nil
}