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

@@ -8,6 +8,7 @@ import (
"testing"
"time"
"github.com/stretchr/testify/require"
"github.com/thrasher-corp/gocryptotrader/common"
)
@@ -27,9 +28,7 @@ func TestCheckAndRegister(t *testing.T) {
newLovelyClient := new(http.Client)
err = tracker.checkAndRegister(newLovelyClient)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
require.NoError(t, err)
if !tracker.contains(newLovelyClient) {
t.Fatalf("received: '%v' but expected: '%v'", false, true)
@@ -55,18 +54,14 @@ func TestDeRegister(t *testing.T) {
}
err = tracker.checkAndRegister(newLovelyClient)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
require.NoError(t, err)
if !tracker.contains(newLovelyClient) {
t.Fatalf("received: '%v' but expected: '%v'", false, true)
}
err = tracker.deRegister(newLovelyClient)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
require.NoError(t, err)
if tracker.contains(newLovelyClient) {
t.Fatalf("received: '%v' but expected: '%v'", true, false)
@@ -81,9 +76,7 @@ func TestNewProtectedClient(t *testing.T) {
newLovelyClient := new(http.Client)
protec, err := newProtectedClient(newLovelyClient)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
require.NoError(t, err)
if protec.protected != newLovelyClient {
t.Fatal("unexpected value")
@@ -105,9 +98,7 @@ func TestClientSetProxy(t *testing.T) {
t.Fatalf("received: '%v' but expected: '%v'", err, errTransportNotSet)
}
err = (&client{protected: common.NewHTTPClientWithTimeout(0)}).setProxy(pp)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
require.NoError(t, err)
}
func TestClientSetHTTPClientTimeout(t *testing.T) {
@@ -117,26 +108,20 @@ func TestClientSetHTTPClientTimeout(t *testing.T) {
t.Fatalf("received: '%v' but expected: '%v'", err, errTransportNotSet)
}
err = (&client{protected: common.NewHTTPClientWithTimeout(0)}).setHTTPClientTimeout(time.Second)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
require.NoError(t, err)
}
func TestRelease(t *testing.T) {
t.Parallel()
newLovelyClient, err := newProtectedClient(common.NewHTTPClientWithTimeout(0))
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
require.NoError(t, err)
if !tracker.contains(newLovelyClient.protected) {
t.Fatalf("received: '%v' but expected: '%v'", false, true)
}
err = newLovelyClient.release()
if !errors.Is(err, nil) {
t.Fatalf("received: '%v' but expected: '%v'", err, nil)
}
require.NoError(t, err)
if tracker.contains(newLovelyClient.protected) {
t.Fatalf("received: '%v' but expected: '%v'", true, false)

View File

@@ -548,7 +548,7 @@ func TestEnableDisableRateLimit(t *testing.T) {
err = sendIt() // this should block until a token is refilled
require.NoError(t, err, "sendIt must not error")
elapsed := time.Since(start)
assert.GreaterOrEqual(t, elapsed.Milliseconds(), int64(20), "Expected sendIt to block for at least 20ms, but it returned after %dms", elapsed.Milliseconds())
assert.GreaterOrEqualf(t, elapsed.Milliseconds(), int64(20), "Expected sendIt to block for at least 20ms, but it returned after %dms", elapsed.Milliseconds())
}
func TestSetHTTPClient(t *testing.T) {
@@ -560,9 +560,8 @@ func TestSetHTTPClient(t *testing.T) {
client := new(http.Client)
r = new(Requester)
err = r.SetHTTPClient(client)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v', but expected: '%v'", err, nil)
}
require.NoError(t, err)
err = r.SetHTTPClient(client)
if !errors.Is(err, errCannotReuseHTTPClient) {
t.Fatalf("received: '%v', but expected: '%v'", err, errCannotReuseHTTPClient)
@@ -581,9 +580,7 @@ func TestSetHTTPClientTimeout(t *testing.T) {
t.Fatal(err)
}
err = r.SetHTTPClientTimeout(time.Second)
if !errors.Is(err, nil) {
t.Fatalf("received: '%v', but expected: '%v'", err, nil)
}
require.NoError(t, err)
}
func TestSetHTTPClientUserAgent(t *testing.T) {
@@ -594,9 +591,7 @@ func TestSetHTTPClientUserAgent(t *testing.T) {
}
r = new(Requester)
err = r.SetHTTPClientUserAgent("")
if !errors.Is(err, nil) {
t.Fatalf("received: '%v', but expected: '%v'", err, nil)
}
require.NoError(t, err)
}
func TestGetHTTPClientUserAgent(t *testing.T) {
@@ -607,13 +602,11 @@ func TestGetHTTPClientUserAgent(t *testing.T) {
}
r = new(Requester)
err = r.SetHTTPClientUserAgent("sillyness")
if !errors.Is(err, nil) {
t.Fatalf("received: '%v', but expected: '%v'", err, nil)
}
require.NoError(t, err)
ua, err := r.GetHTTPClientUserAgent()
if !errors.Is(err, nil) {
t.Fatalf("received: '%v', but expected: '%v'", err, nil)
}
require.NoError(t, err)
if ua != "sillyness" {
t.Fatal("unexpected value")
}