Files
gocryptotrader/backtester/engine/taskmanager_test.go
Adrian Gallagher a5b638bfb7 GHA: Add additional checks for common issues (#1922)
* GHA, tests: Add additional checks for common issues

These checks include:
- Ensuring that all testify funcs use their formatted variants (e.g., `assert.Equalf(t, expected, actual)` instead of `assert.Equal(t, expected, actual)`).
- Replacing `%s` with %q
- Enforcing consistent usage of should/must wording for testify assert/require messages

* Add support for checking backticked string format specifiers and fix issues

* tests: Fix error comparisons

* tests: Replace errors.Is(err, nil) usage with testify and automate check

* refactor: Rename ExtractPort to ExtractPortOrDefault

* tests: Replace assert with require for error handling in multiple test files

* tests: Replace assert with require for error handling and improve assertions in data tests

* tests: Fix typo in assertion message for StreamVol test

* OKX: Fix GetOpenInterestAndVolumeStrike test with instrument selection and improved assertions

* OKX: Revert intentional error check

* Improve error message for expiry time check in GetOpenInterestAndVolumeStrike test
2025-05-28 12:26:51 +10:00

405 lines
9.5 KiB
Go

package engine
import (
"errors"
"testing"
"time"
"github.com/gofrs/uuid"
"github.com/stretchr/testify/assert"
"github.com/thrasher-corp/gocryptotrader/backtester/data"
"github.com/thrasher-corp/gocryptotrader/backtester/eventhandlers/eventholder"
"github.com/thrasher-corp/gocryptotrader/backtester/eventhandlers/statistics"
"github.com/thrasher-corp/gocryptotrader/backtester/eventhandlers/strategies/binancecashandcarry"
gctcommon "github.com/thrasher-corp/gocryptotrader/common"
)
func TestSetupRunManager(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
if rm == nil {
t.Errorf("received '%v' expected '%v'", rm, "&TaskManager{}")
}
}
func TestAddRun(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
err := rm.AddTask(nil)
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
bt := &BackTest{}
err = rm.AddTask(bt)
assert.NoError(t, err)
if bt.MetaData.ID.IsNil() {
t.Errorf("received '%v' expected '%v'", bt.MetaData.ID, "a random ID")
}
if len(rm.tasks) != 1 {
t.Errorf("received '%v' expected '%v'", len(rm.tasks), 1)
}
err = rm.AddTask(bt)
if !errors.Is(err, errTaskAlreadyMonitored) {
t.Errorf("received '%v' expected '%v'", err, errTaskAlreadyMonitored)
}
if len(rm.tasks) != 1 {
t.Errorf("received '%v' expected '%v'", len(rm.tasks), 1)
}
rm = nil
err = rm.AddTask(bt)
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}
func TestGetSummary(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
id, err := uuid.NewV4()
assert.NoError(t, err)
_, err = rm.GetSummary(id)
if !errors.Is(err, errTaskNotFound) {
t.Errorf("received '%v' expected '%v'", err, errTaskNotFound)
}
bt := &BackTest{
Strategy: &binancecashandcarry.Strategy{},
Statistic: &statistics.Statistic{},
}
err = rm.AddTask(bt)
assert.NoError(t, err)
sum, err := rm.GetSummary(bt.MetaData.ID)
assert.NoError(t, err)
if sum.MetaData.ID != bt.MetaData.ID {
t.Errorf("received '%v' expected '%v'", sum.MetaData.ID, bt.MetaData.ID)
}
rm = nil
_, err = rm.GetSummary(id)
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}
func TestList(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
list, err := rm.List()
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
bt := &BackTest{
Strategy: &binancecashandcarry.Strategy{},
Statistic: &statistics.Statistic{},
}
err = rm.AddTask(bt)
assert.NoError(t, err)
list, err = rm.List()
assert.NoError(t, err)
if len(list) != 1 {
t.Errorf("received '%v' expected '%v'", len(list), 1)
}
rm = nil
_, err = rm.List()
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}
func TestStopRun(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
list, err := rm.List()
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
id, err := uuid.NewV4()
assert.NoError(t, err)
err = rm.StopTask(id)
if !errors.Is(err, errTaskNotFound) {
t.Errorf("received '%v' expected '%v'", err, errTaskNotFound)
}
bt := &BackTest{
Strategy: &fakeStrat{},
Statistic: &fakeStats{},
Reports: &fakeReport{},
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
assert.NoError(t, err)
err = rm.StopTask(bt.MetaData.ID)
if !errors.Is(err, errTaskHasNotRan) {
t.Errorf("received '%v' expected '%v'", err, errTaskHasNotRan)
}
bt.m.Lock()
bt.MetaData.DateStarted = time.Now()
bt.m.Unlock()
err = rm.StopTask(bt.MetaData.ID)
assert.NoError(t, err)
err = rm.StopTask(bt.MetaData.ID)
if !errors.Is(err, errAlreadyRan) {
t.Errorf("received '%v' expected '%v'", err, errAlreadyRan)
}
rm = nil
err = rm.StopTask(id)
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}
func TestStopAllRuns(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
stoppedRuns, err := rm.StopAllTasks()
assert.NoError(t, err)
if len(stoppedRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(stoppedRuns), 0)
}
bt := &BackTest{
Strategy: &binancecashandcarry.Strategy{},
Statistic: &fakeStats{},
Reports: &fakeReport{},
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
assert.NoError(t, err)
bt.m.Lock()
bt.MetaData.DateStarted = time.Now()
bt.m.Unlock()
stoppedRuns, err = rm.StopAllTasks()
assert.NoError(t, err)
if len(stoppedRuns) != 1 {
t.Errorf("received '%v' expected '%v'", len(stoppedRuns), 1)
}
rm = nil
_, err = rm.StopAllTasks()
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}
func TestStartRun(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
list, err := rm.List()
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
id, err := uuid.NewV4()
assert.NoError(t, err)
err = rm.StartTask(id)
if !errors.Is(err, errTaskNotFound) {
t.Errorf("received '%v' expected '%v'", err, errTaskNotFound)
}
bt := &BackTest{
Strategy: &binancecashandcarry.Strategy{},
EventQueue: &eventholder.Holder{},
DataHolder: &data.HandlerHolder{},
Statistic: &statistics.Statistic{},
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
assert.NoError(t, err)
err = rm.StartTask(bt.MetaData.ID)
assert.NoError(t, err)
err = rm.StartTask(bt.MetaData.ID)
if !errors.Is(err, errTaskIsRunning) {
t.Errorf("received '%v' expected '%v'", err, errTaskIsRunning)
}
bt.m.Lock()
bt.MetaData.DateEnded = time.Now()
bt.MetaData.Closed = true
bt.shutdown = make(chan struct{})
bt.m.Unlock()
err = rm.StartTask(bt.MetaData.ID)
if !errors.Is(err, errAlreadyRan) {
t.Errorf("received '%v' expected '%v'", err, errAlreadyRan)
}
rm = nil
err = rm.StartTask(id)
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}
func TestStartAllRuns(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
startedRuns, err := rm.StartAllTasks()
assert.NoError(t, err)
if len(startedRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(startedRuns), 0)
}
bt := &BackTest{
Strategy: &binancecashandcarry.Strategy{},
EventQueue: &eventholder.Holder{},
DataHolder: &data.HandlerHolder{},
Statistic: &statistics.Statistic{},
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
assert.NoError(t, err)
startedRuns, err = rm.StartAllTasks()
assert.NoError(t, err)
if len(startedRuns) != 1 {
t.Errorf("received '%v' expected '%v'", len(startedRuns), 1)
}
rm = nil
_, err = rm.StartAllTasks()
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}
func TestClearRun(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
id, err := uuid.NewV4()
assert.NoError(t, err)
err = rm.ClearTask(id)
if !errors.Is(err, errTaskNotFound) {
t.Errorf("received '%v' expected '%v'", err, errTaskNotFound)
}
bt := &BackTest{
Strategy: &binancecashandcarry.Strategy{},
EventQueue: &eventholder.Holder{},
DataHolder: &data.HandlerHolder{},
Statistic: &statistics.Statistic{},
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
assert.NoError(t, err)
bt.m.Lock()
bt.MetaData.DateStarted = time.Now()
bt.m.Unlock()
err = rm.ClearTask(bt.MetaData.ID)
if !errors.Is(err, errCannotClear) {
t.Errorf("received '%v' expected '%v'", err, errCannotClear)
}
bt.m.Lock()
bt.MetaData.DateStarted = time.Time{}
bt.m.Unlock()
err = rm.ClearTask(bt.MetaData.ID)
assert.NoError(t, err)
list, err := rm.List()
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
rm = nil
err = rm.ClearTask(id)
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}
func TestClearAllRuns(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
clearedRuns, remainingRuns, err := rm.ClearAllTasks()
if len(clearedRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(clearedRuns), 0)
}
if len(remainingRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(remainingRuns), 0)
}
assert.NoError(t, err)
bt := &BackTest{
Strategy: &binancecashandcarry.Strategy{},
EventQueue: &eventholder.Holder{},
DataHolder: &data.HandlerHolder{},
Statistic: &statistics.Statistic{},
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
assert.NoError(t, err)
bt.m.Lock()
bt.MetaData.DateStarted = time.Now()
bt.m.Unlock()
clearedRuns, remainingRuns, err = rm.ClearAllTasks()
if len(clearedRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(clearedRuns), 0)
}
if len(remainingRuns) != 1 {
t.Errorf("received '%v' expected '%v'", len(remainingRuns), 1)
}
assert.NoError(t, err)
bt.m.Lock()
bt.MetaData.DateStarted = time.Time{}
bt.m.Unlock()
clearedRuns, remainingRuns, err = rm.ClearAllTasks()
if len(clearedRuns) != 1 {
t.Errorf("received '%v' expected '%v'", len(clearedRuns), 1)
}
if len(remainingRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(remainingRuns), 0)
}
assert.NoError(t, err)
list, err := rm.List()
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
rm = nil
_, _, err = rm.ClearAllTasks()
if !errors.Is(err, gctcommon.ErrNilPointer) {
t.Errorf("received '%v' expected '%v'", err, gctcommon.ErrNilPointer)
}
}