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
This commit is contained in:
Adrian Gallagher
2025-05-28 12:26:51 +10:00
committed by GitHub
parent 1e5739dffa
commit a5b638bfb7
165 changed files with 2565 additions and 4626 deletions

View File

@@ -6,6 +6,7 @@ import (
"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"
@@ -31,9 +32,8 @@ func TestAddRun(t *testing.T) {
bt := &BackTest{}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if bt.MetaData.ID.IsNil() {
t.Errorf("received '%v' expected '%v'", bt.MetaData.ID, "a random ID")
}
@@ -60,9 +60,8 @@ func TestGetSummary(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
id, err := uuid.NewV4()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
_, err = rm.GetSummary(id)
if !errors.Is(err, errTaskNotFound) {
t.Errorf("received '%v' expected '%v'", err, errTaskNotFound)
@@ -73,14 +72,11 @@ func TestGetSummary(t *testing.T) {
Statistic: &statistics.Statistic{},
}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
sum, err := rm.GetSummary(bt.MetaData.ID)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if sum.MetaData.ID != bt.MetaData.ID {
t.Errorf("received '%v' expected '%v'", sum.MetaData.ID, bt.MetaData.ID)
}
@@ -96,9 +92,8 @@ func TestList(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
list, err := rm.List()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
@@ -108,14 +103,11 @@ func TestList(t *testing.T) {
Statistic: &statistics.Statistic{},
}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
list, err = rm.List()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(list) != 1 {
t.Errorf("received '%v' expected '%v'", len(list), 1)
}
@@ -131,17 +123,15 @@ func TestStopRun(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
list, err := rm.List()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
id, err := uuid.NewV4()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
err = rm.StopTask(id)
if !errors.Is(err, errTaskNotFound) {
t.Errorf("received '%v' expected '%v'", err, errTaskNotFound)
@@ -154,9 +144,7 @@ func TestStopRun(t *testing.T) {
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
err = rm.StopTask(bt.MetaData.ID)
if !errors.Is(err, errTaskHasNotRan) {
@@ -167,9 +155,7 @@ func TestStopRun(t *testing.T) {
bt.MetaData.DateStarted = time.Now()
bt.m.Unlock()
err = rm.StopTask(bt.MetaData.ID)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
err = rm.StopTask(bt.MetaData.ID)
if !errors.Is(err, errAlreadyRan) {
@@ -187,9 +173,8 @@ func TestStopAllRuns(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
stoppedRuns, err := rm.StopAllTasks()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(stoppedRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(stoppedRuns), 0)
}
@@ -201,16 +186,14 @@ func TestStopAllRuns(t *testing.T) {
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
bt.m.Lock()
bt.MetaData.DateStarted = time.Now()
bt.m.Unlock()
stoppedRuns, err = rm.StopAllTasks()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(stoppedRuns) != 1 {
t.Errorf("received '%v' expected '%v'", len(stoppedRuns), 1)
}
@@ -226,17 +209,15 @@ func TestStartRun(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
list, err := rm.List()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
id, err := uuid.NewV4()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
err = rm.StartTask(id)
if !errors.Is(err, errTaskNotFound) {
t.Errorf("received '%v' expected '%v'", err, errTaskNotFound)
@@ -250,13 +231,10 @@ func TestStartRun(t *testing.T) {
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
err = rm.StartTask(bt.MetaData.ID)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
err = rm.StartTask(bt.MetaData.ID)
if !errors.Is(err, errTaskIsRunning) {
@@ -284,9 +262,8 @@ func TestStartAllRuns(t *testing.T) {
t.Parallel()
rm := NewTaskManager()
startedRuns, err := rm.StartAllTasks()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(startedRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(startedRuns), 0)
}
@@ -299,13 +276,11 @@ func TestStartAllRuns(t *testing.T) {
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
startedRuns, err = rm.StartAllTasks()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(startedRuns) != 1 {
t.Errorf("received '%v' expected '%v'", len(startedRuns), 1)
}
@@ -322,9 +297,8 @@ func TestClearRun(t *testing.T) {
rm := NewTaskManager()
id, err := uuid.NewV4()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
err = rm.ClearTask(id)
if !errors.Is(err, errTaskNotFound) {
t.Errorf("received '%v' expected '%v'", err, errTaskNotFound)
@@ -338,9 +312,7 @@ func TestClearRun(t *testing.T) {
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
bt.m.Lock()
bt.MetaData.DateStarted = time.Now()
@@ -354,13 +326,11 @@ func TestClearRun(t *testing.T) {
bt.MetaData.DateStarted = time.Time{}
bt.m.Unlock()
err = rm.ClearTask(bt.MetaData.ID)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
list, err := rm.List()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}
@@ -383,9 +353,7 @@ func TestClearAllRuns(t *testing.T) {
if len(remainingRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(remainingRuns), 0)
}
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
bt := &BackTest{
Strategy: &binancecashandcarry.Strategy{},
@@ -395,9 +363,7 @@ func TestClearAllRuns(t *testing.T) {
shutdown: make(chan struct{}),
}
err = rm.AddTask(bt)
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
bt.m.Lock()
bt.MetaData.DateStarted = time.Now()
@@ -409,9 +375,7 @@ func TestClearAllRuns(t *testing.T) {
if len(remainingRuns) != 1 {
t.Errorf("received '%v' expected '%v'", len(remainingRuns), 1)
}
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
bt.m.Lock()
bt.MetaData.DateStarted = time.Time{}
@@ -423,13 +387,11 @@ func TestClearAllRuns(t *testing.T) {
if len(remainingRuns) != 0 {
t.Errorf("received '%v' expected '%v'", len(remainingRuns), 0)
}
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
list, err := rm.List()
if !errors.Is(err, nil) {
t.Errorf("received '%v' expected '%v'", err, nil)
}
assert.NoError(t, err)
if len(list) != 0 {
t.Errorf("received '%v' expected '%v'", len(list), 0)
}