Skip to content

api/admin: Cleanup SuccessResponseTests #2644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2024
Merged

api/admin: Cleanup SuccessResponseTests #2644

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bb96e1
`api/admin`: Cleanup `SuccessResponseTests`
dhrubabasu Jan 22, 2024
d41a113
Merge branch 'master' into cleanup-api-admin-tests
dhrubabasu Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 53 additions & 68 deletions api/admin/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,23 @@ import (
"github.com/ava-labs/avalanchego/utils/rpc"
)

var errTest = errors.New("non-nil error")
var (
errTest = errors.New("non-nil error")

// SuccessResponseTest defines the expected result of an API call that returns SuccessResponse
type SuccessResponseTest struct {
Err error
}

// GetSuccessResponseTests returns a list of possible SuccessResponseTests
func GetSuccessResponseTests() []SuccessResponseTest {
return []SuccessResponseTest{
SuccessResponseTests = []struct {
name string
expectedErr error
}{
{
Err: nil,
name: "no error",
expectedErr: nil,
},
{
Err: errTest,
name: "error",
expectedErr: errTest,
},
}
}
)

type mockClient struct {
response interface{}
Expand Down Expand Up @@ -76,74 +75,62 @@ func (mc *mockClient) SendRequest(_ context.Context, _ string, _ interface{}, re
}

func TestStartCPUProfiler(t *testing.T) {
require := require.New(t)

tests := GetSuccessResponseTests()

for _, test := range tests {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.Err)}
err := mockClient.StartCPUProfiler(context.Background())
require.ErrorIs(err, test.Err)
for _, test := range SuccessResponseTests {
t.Run(test.name, func(t *testing.T) {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.expectedErr)}
err := mockClient.StartCPUProfiler(context.Background())
require.ErrorIs(t, err, test.expectedErr)
})
}
}

func TestStopCPUProfiler(t *testing.T) {
require := require.New(t)

tests := GetSuccessResponseTests()

for _, test := range tests {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.Err)}
err := mockClient.StopCPUProfiler(context.Background())
require.ErrorIs(err, test.Err)
for _, test := range SuccessResponseTests {
t.Run(test.name, func(t *testing.T) {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.expectedErr)}
err := mockClient.StopCPUProfiler(context.Background())
require.ErrorIs(t, err, test.expectedErr)
})
}
}

func TestMemoryProfile(t *testing.T) {
require := require.New(t)

tests := GetSuccessResponseTests()

for _, test := range tests {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.Err)}
err := mockClient.MemoryProfile(context.Background())
require.ErrorIs(err, test.Err)
for _, test := range SuccessResponseTests {
t.Run(test.name, func(t *testing.T) {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.expectedErr)}
err := mockClient.MemoryProfile(context.Background())
require.ErrorIs(t, err, test.expectedErr)
})
}
}

func TestLockProfile(t *testing.T) {
require := require.New(t)

tests := GetSuccessResponseTests()

for _, test := range tests {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.Err)}
err := mockClient.LockProfile(context.Background())
require.ErrorIs(err, test.Err)
for _, test := range SuccessResponseTests {
t.Run(test.name, func(t *testing.T) {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.expectedErr)}
err := mockClient.LockProfile(context.Background())
require.ErrorIs(t, err, test.expectedErr)
})
}
}

func TestAlias(t *testing.T) {
require := require.New(t)

tests := GetSuccessResponseTests()

for _, test := range tests {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.Err)}
err := mockClient.Alias(context.Background(), "alias", "alias2")
require.ErrorIs(err, test.Err)
for _, test := range SuccessResponseTests {
t.Run(test.name, func(t *testing.T) {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.expectedErr)}
err := mockClient.Alias(context.Background(), "alias", "alias2")
require.ErrorIs(t, err, test.expectedErr)
})
}
}

func TestAliasChain(t *testing.T) {
require := require.New(t)

tests := GetSuccessResponseTests()

for _, test := range tests {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.Err)}
err := mockClient.AliasChain(context.Background(), "chain", "chain-alias")
require.ErrorIs(err, test.Err)
for _, test := range SuccessResponseTests {
t.Run(test.name, func(t *testing.T) {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.expectedErr)}
err := mockClient.AliasChain(context.Background(), "chain", "chain-alias")
require.ErrorIs(t, err, test.expectedErr)
})
}
}

Expand All @@ -169,14 +156,12 @@ func TestGetChainAliases(t *testing.T) {
}

func TestStacktrace(t *testing.T) {
require := require.New(t)

tests := GetSuccessResponseTests()

for _, test := range tests {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.Err)}
err := mockClient.Stacktrace(context.Background())
require.ErrorIs(err, test.Err)
for _, test := range SuccessResponseTests {
t.Run(test.name, func(t *testing.T) {
mockClient := client{requester: NewMockClient(&api.EmptyReply{}, test.expectedErr)}
err := mockClient.Stacktrace(context.Background())
require.ErrorIs(t, err, test.expectedErr)
})
}
}

Expand Down