Files
gocryptotrader/backtester/report/report_test.go
Eng Zer Jun 21b3d6a6c9 test: use T.TempDir to create temporary test directory (#934)
* test: use `T.TempDir` to create temporary test directory

This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The
directory created by `t.TempDir` is automatically removed when the test
and all its subtests complete.

Prior to this commit, temporary directory created using `ioutil.TempDir`
needs to be removed manually by calling `os.RemoveAll`, which is omitted
in some tests. The error handling boilerplate e.g.
	defer func() {
		if err := os.RemoveAll(dir); err != nil {
			t.Fatal(err)
		}
	}
is also tedious, but `t.TempDir` handles this for us nicely.

Reference: https://pkg.go.dev/testing#T.TempDir
Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>

* test: fix TestEncryptTwiceReusesSaltButNewCipher on Windows

Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>

* test: fix TestCheckConnection on Windows

Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>

* test: fix TestRPCServer_GetTicker_LastUpdatedNanos on Windows

Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>

* test: cleanup TestGenerateReport

Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-04-28 12:01:15 +10:00

454 lines
13 KiB
Go

package report
import (
"errors"
"testing"
"time"
"github.com/shopspring/decimal"
"github.com/thrasher-corp/gocryptotrader/backtester/config"
"github.com/thrasher-corp/gocryptotrader/backtester/eventhandlers/portfolio/compliance"
"github.com/thrasher-corp/gocryptotrader/backtester/eventhandlers/portfolio/holdings"
"github.com/thrasher-corp/gocryptotrader/backtester/eventhandlers/statistics"
"github.com/thrasher-corp/gocryptotrader/backtester/funding"
"github.com/thrasher-corp/gocryptotrader/currency"
"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
gctkline "github.com/thrasher-corp/gocryptotrader/exchanges/kline"
gctorder "github.com/thrasher-corp/gocryptotrader/exchanges/order"
)
const testExchange = "binance"
func TestGenerateReport(t *testing.T) {
t.Parallel()
e := testExchange
a := asset.Spot
p := currency.NewPair(currency.BTC, currency.USDT)
d := Data{
Config: &config.Config{
StrategySettings: config.StrategySettings{
DisableUSDTracking: true,
},
},
OutputPath: t.TempDir(),
TemplatePath: "tpl.gohtml",
OriginalCandles: []*gctkline.Item{
{
Candles: []gctkline.Candle{
{
Time: time.Now(),
Open: 1337,
High: 1337,
Low: 1337,
Close: 1337,
Volume: 1337,
ValidationIssues: "hello world!",
},
},
},
},
EnhancedCandles: []DetailedKline{
{
Exchange: e,
Asset: a,
Pair: p,
Interval: gctkline.OneHour,
Watermark: "Binance - SPOT - BTC-USDT",
Candles: []DetailedCandle{
{
UnixMilli: time.Date(2020, 12, 12, 0, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1337,
High: 1339,
Low: 1336,
Close: 1338,
Volume: 3,
VolumeColour: "rgba(47, 194, 27, 0.8)",
MadeOrder: true,
OrderDirection: gctorder.Buy,
OrderAmount: decimal.NewFromInt(1337),
Shape: "arrowUp",
Text: "hi",
Position: "aboveBar",
Colour: "green",
PurchasePrice: 50,
},
{
UnixMilli: time.Date(2020, 12, 12, 1, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1332,
High: 1332,
Low: 1330,
Close: 1331,
Volume: 2,
MadeOrder: true,
OrderDirection: gctorder.Buy,
OrderAmount: decimal.NewFromInt(1337),
Shape: "arrowUp",
Text: "hi",
Position: "aboveBar",
Colour: "green",
PurchasePrice: 50,
VolumeColour: "rgba(252, 3, 3, 0.8)",
},
{
UnixMilli: time.Date(2020, 12, 12, 2, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1337,
High: 1339,
Low: 1336,
Close: 1338,
Volume: 3,
MadeOrder: true,
OrderDirection: gctorder.Buy,
OrderAmount: decimal.NewFromInt(1337),
Shape: "arrowUp",
Text: "hi",
Position: "aboveBar",
Colour: "green",
PurchasePrice: 50,
VolumeColour: "rgba(47, 194, 27, 0.8)",
},
{
UnixMilli: time.Date(2020, 12, 12, 3, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1337,
High: 1339,
Low: 1336,
Close: 1338,
Volume: 3,
MadeOrder: true,
OrderDirection: gctorder.Buy,
OrderAmount: decimal.NewFromInt(1337),
Shape: "arrowUp",
Text: "hi",
Position: "aboveBar",
Colour: "green",
PurchasePrice: 50,
VolumeColour: "rgba(252, 3, 3, 0.8)",
},
{
UnixMilli: time.Date(2020, 12, 12, 4, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1337,
High: 1339,
Low: 1336,
Close: 1338,
Volume: 3,
VolumeColour: "rgba(47, 194, 27, 0.8)",
},
},
},
{
Exchange: "Bittrex",
Asset: a,
Pair: currency.NewPair(currency.BTC, currency.USD),
Interval: gctkline.OneDay,
Watermark: "BITTREX - SPOT - BTC-USD - 1d",
Candles: []DetailedCandle{
{
UnixMilli: time.Date(2020, 12, 12, 0, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1337,
High: 1339,
Low: 1336,
Close: 1338,
Volume: 3,
MadeOrder: true,
OrderDirection: gctorder.Buy,
OrderAmount: decimal.NewFromInt(1337),
Shape: "arrowUp",
Text: "hi",
Position: "aboveBar",
Colour: "green",
PurchasePrice: 50,
VolumeColour: "rgba(47, 194, 27, 0.8)",
},
{
UnixMilli: time.Date(2020, 12, 12, 1, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1332,
High: 1332,
Low: 1330,
Close: 1331,
Volume: 2,
MadeOrder: true,
OrderDirection: gctorder.Buy,
OrderAmount: decimal.NewFromInt(1337),
Shape: "arrowUp",
Text: "hi",
Position: "aboveBar",
Colour: "green",
PurchasePrice: 50,
VolumeColour: "rgba(252, 3, 3, 0.8)",
},
{
UnixMilli: time.Date(2020, 12, 12, 2, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1337,
High: 1339,
Low: 1336,
Close: 1338,
Volume: 3,
MadeOrder: true,
OrderDirection: gctorder.Buy,
OrderAmount: decimal.NewFromInt(1337),
Shape: "arrowUp",
Text: "hi",
Position: "aboveBar",
Colour: "green",
PurchasePrice: 50,
VolumeColour: "rgba(47, 194, 27, 0.8)",
},
{
UnixMilli: time.Date(2020, 12, 12, 3, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1337,
High: 1339,
Low: 1336,
Close: 1338,
Volume: 3,
MadeOrder: true,
OrderDirection: gctorder.Buy,
OrderAmount: decimal.NewFromInt(1337),
Shape: "arrowUp",
Text: "hi",
Position: "aboveBar",
Colour: "green",
PurchasePrice: 50,
VolumeColour: "rgba(252, 3, 3, 0.8)",
},
{
UnixMilli: time.Date(2020, 12, 12, 4, 0, 0, 0, time.UTC).UnixMilli(),
Open: 1337,
High: 1339,
Low: 1336,
Close: 1338,
Volume: 3,
VolumeColour: "rgba(47, 194, 27, 0.8)",
},
},
},
},
Statistics: &statistics.Statistic{
StrategyName: "testStrat",
RiskFreeRate: decimal.NewFromFloat(0.03),
ExchangeAssetPairStatistics: map[string]map[asset.Item]map[currency.Pair]*statistics.CurrencyPairStatistic{
e: {
a: {
p: &statistics.CurrencyPairStatistic{
MaxDrawdown: statistics.Swing{},
LowestClosePrice: decimal.NewFromInt(100),
HighestClosePrice: decimal.NewFromInt(200),
MarketMovement: decimal.NewFromInt(100),
StrategyMovement: decimal.NewFromInt(100),
CompoundAnnualGrowthRate: decimal.NewFromInt(1),
BuyOrders: 1,
SellOrders: 1,
FinalHoldings: holdings.Holding{},
FinalOrders: compliance.Snapshot{},
ArithmeticRatios: &statistics.Ratios{},
GeometricRatios: &statistics.Ratios{},
},
},
},
},
TotalBuyOrders: 1337,
TotalSellOrders: 1330,
TotalOrders: 200,
BiggestDrawdown: &statistics.FinalResultsHolder{
Exchange: e,
Asset: a,
Pair: p,
MaxDrawdown: statistics.Swing{
Highest: statistics.ValueAtTime{
Time: time.Now(),
Value: decimal.NewFromInt(1337),
},
Lowest: statistics.ValueAtTime{
Time: time.Now(),
Value: decimal.NewFromInt(137),
},
DrawdownPercent: decimal.NewFromInt(100),
},
MarketMovement: decimal.NewFromInt(1377),
StrategyMovement: decimal.NewFromInt(1377),
},
BestStrategyResults: &statistics.FinalResultsHolder{
Exchange: e,
Asset: a,
Pair: p,
MaxDrawdown: statistics.Swing{
Highest: statistics.ValueAtTime{
Time: time.Now(),
Value: decimal.NewFromInt(1337),
},
Lowest: statistics.ValueAtTime{
Time: time.Now(),
Value: decimal.NewFromInt(137),
},
DrawdownPercent: decimal.NewFromInt(100),
},
MarketMovement: decimal.NewFromInt(1337),
StrategyMovement: decimal.NewFromInt(1337),
},
BestMarketMovement: &statistics.FinalResultsHolder{
Exchange: e,
Asset: a,
Pair: p,
MaxDrawdown: statistics.Swing{
Highest: statistics.ValueAtTime{
Time: time.Now(),
Value: decimal.NewFromInt(1337),
},
Lowest: statistics.ValueAtTime{
Time: time.Now(),
Value: decimal.NewFromInt(137),
},
DrawdownPercent: decimal.NewFromInt(100),
},
MarketMovement: decimal.NewFromInt(1337),
StrategyMovement: decimal.NewFromInt(1337),
},
CurrencyPairStatistics: nil,
WasAnyDataMissing: false,
FundingStatistics: &statistics.FundingStatistics{
Report: &funding.Report{
DisableUSDTracking: true,
},
},
},
}
if err := d.GenerateReport(); err != nil {
t.Error(err)
}
}
func TestEnhanceCandles(t *testing.T) {
t.Parallel()
tt := time.Now()
var d Data
err := d.enhanceCandles()
if !errors.Is(err, errNoCandles) {
t.Errorf("received: %v, expected: %v", err, errNoCandles)
}
d.AddKlineItem(&gctkline.Item{})
err = d.enhanceCandles()
if !errors.Is(err, errStatisticsUnset) {
t.Errorf("received: %v, expected: %v", err, errStatisticsUnset)
}
d.Statistics = &statistics.Statistic{}
err = d.enhanceCandles()
if err != nil {
t.Error(err)
}
d.Statistics.ExchangeAssetPairStatistics = make(map[string]map[asset.Item]map[currency.Pair]*statistics.CurrencyPairStatistic)
d.Statistics.ExchangeAssetPairStatistics[testExchange] = make(map[asset.Item]map[currency.Pair]*statistics.CurrencyPairStatistic)
d.Statistics.ExchangeAssetPairStatistics[testExchange][asset.Spot] = make(map[currency.Pair]*statistics.CurrencyPairStatistic)
d.Statistics.ExchangeAssetPairStatistics[testExchange][asset.Spot][currency.NewPair(currency.BTC, currency.USDT)] = &statistics.CurrencyPairStatistic{}
d.AddKlineItem(&gctkline.Item{
Exchange: testExchange,
Pair: currency.NewPair(currency.BTC, currency.USDT),
Asset: asset.Spot,
Interval: gctkline.OneDay,
Candles: []gctkline.Candle{
{
Time: tt,
Open: 1336,
High: 1338,
Low: 1336,
Close: 1337,
Volume: 1337,
},
},
})
err = d.enhanceCandles()
if err != nil {
t.Error(err)
}
d.AddKlineItem(&gctkline.Item{
Exchange: testExchange,
Pair: currency.NewPair(currency.BTC, currency.USDT),
Asset: asset.Spot,
Interval: gctkline.OneDay,
Candles: []gctkline.Candle{
{
Time: tt,
Open: 1336,
High: 1338,
Low: 1336,
Close: 1336,
Volume: 1337,
},
{
Time: tt,
Open: 1336,
High: 1338,
Low: 1336,
Close: 1335,
Volume: 1337,
},
},
})
err = d.enhanceCandles()
if err != nil {
t.Error(err)
}
d.Statistics.ExchangeAssetPairStatistics[testExchange][asset.Spot][currency.NewPair(currency.BTC, currency.USDT)].FinalOrders = compliance.Snapshot{
Orders: []compliance.SnapshotOrder{
{
ClosePrice: decimal.NewFromInt(1335),
VolumeAdjustedPrice: decimal.NewFromInt(1337),
SlippageRate: decimal.NewFromInt(1),
CostBasis: decimal.NewFromInt(1337),
Detail: nil,
},
},
Timestamp: tt,
}
err = d.enhanceCandles()
if err != nil {
t.Error(err)
}
d.Statistics.ExchangeAssetPairStatistics[testExchange][asset.Spot][currency.NewPair(currency.BTC, currency.USDT)].FinalOrders = compliance.Snapshot{
Orders: []compliance.SnapshotOrder{
{
ClosePrice: decimal.NewFromInt(1335),
VolumeAdjustedPrice: decimal.NewFromInt(1337),
SlippageRate: decimal.NewFromInt(1),
CostBasis: decimal.NewFromInt(1337),
Detail: &gctorder.Detail{
Date: tt,
Side: gctorder.Buy,
},
},
},
Timestamp: tt,
}
err = d.enhanceCandles()
if err != nil {
t.Error(err)
}
d.Statistics.ExchangeAssetPairStatistics[testExchange][asset.Spot][currency.NewPair(currency.BTC, currency.USDT)].FinalOrders = compliance.Snapshot{
Orders: []compliance.SnapshotOrder{
{
ClosePrice: decimal.NewFromInt(1335),
VolumeAdjustedPrice: decimal.NewFromInt(1337),
SlippageRate: decimal.NewFromInt(1),
CostBasis: decimal.NewFromInt(1337),
Detail: &gctorder.Detail{
Date: tt,
Side: gctorder.Sell,
},
},
},
Timestamp: tt,
}
err = d.enhanceCandles()
if err != nil {
t.Error(err)
}
if len(d.EnhancedCandles) == 0 {
t.Error("expected enhanced candles")
}
}