vspd/client/client_test.go
jholdstock 79fd2f7bbe client: Add additional test case for errors.
Tests now check that the correct vspd error code is returned by the
client.
2023-03-15 10:46:13 +00:00

106 lines
2.8 KiB
Go

package client
import (
"context"
"errors"
"net/http"
"net/http/httptest"
"testing"
"github.com/decred/slog"
"github.com/decred/vspd/types"
)
// TestErrorDetails ensures errors returned by client.do contain adequate
// information for debugging (HTTP status and response body).
func TestErrorDetails(t *testing.T) {
tests := map[string]struct {
respHTTPStatus int
respBodyBytes []byte
expectedErr string
vspdError bool
vspdErrCode int64
}{
"500, vspd error (generic bad request)": {
respHTTPStatus: 500,
respBodyBytes: []byte(`{"code": 1, "message": "bad request"}`),
expectedErr: `bad request`,
vspdError: true,
vspdErrCode: 1,
},
"428, vspd error (cannot broadcast fee)": {
respHTTPStatus: 428,
respBodyBytes: []byte(`{"code": 16, "message": "fee transaction could not be broadcast due to unknown outputs"}`),
expectedErr: `fee transaction could not be broadcast due to unknown outputs`,
vspdError: true,
vspdErrCode: 16,
},
"500, no body": {
respHTTPStatus: 500,
respBodyBytes: nil,
expectedErr: `http status 500 (Internal Server Error) with no body`,
vspdError: false,
},
"500, non vspd error": {
respHTTPStatus: 500,
respBodyBytes: []byte(`an error occurred`),
expectedErr: `http status 500 (Internal Server Error) with body "an error occurred"`,
vspdError: false,
},
"500, non vspd error (json)": {
respHTTPStatus: 500,
respBodyBytes: []byte(`{"some": "json"}`),
expectedErr: `http status 500 (Internal Server Error) with body "{\"some\": \"json\"}"`,
vspdError: false,
},
}
for testName, testData := range tests {
t.Run(testName, func(t *testing.T) {
testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
res.WriteHeader(testData.respHTTPStatus)
_, err := res.Write(testData.respBodyBytes)
if err != nil {
t.Fatalf("writing response body failed: %v", err)
}
}))
client := Client{
URL: testServer.URL,
PubKey: []byte("fake pubkey"),
Log: slog.Disabled,
}
var resp interface{}
err := client.do(context.TODO(), http.MethodGet, "", nil, &resp, nil)
testServer.Close()
if err == nil {
t.Fatalf("client.do did not return an error")
}
if err.Error() != testData.expectedErr {
t.Fatalf("client.do returned incorrect error, expected %q, got %q",
testData.expectedErr, err.Error())
}
if testData.vspdError {
// Error should be unwrappable as a vspd error response.
var e types.ErrorResponse
if !errors.As(err, &e) {
t.Fatal("unable to unwrap vspd error")
}
if e.Code != testData.vspdErrCode {
t.Fatalf("incorrect vspd error code, expected %d, got %d",
testData.vspdErrCode, e.Code)
}
}
})
}
}