mirror of
https://github.com/retailcrm/api-client-go.git
synced 2025-04-03 13:13:37 +03:00
different improvements for errors
This commit is contained in:
parent
0762aa771a
commit
483092c1fb
4 changed files with 212 additions and 19 deletions
62
error.go
62
error.go
|
|
@ -2,7 +2,9 @@ package retailcrm
|
|||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"regexp"
|
||||
"strings"
|
||||
)
|
||||
|
||||
var missingParameterMatcher = regexp.MustCompile(`^Parameter \'([\w\]\[\_\-]+)\' is missing$`)
|
||||
|
|
@ -30,6 +32,7 @@ type APIErrorsList map[string]string
|
|||
// APIError returns when an API error was occurred.
|
||||
type APIError interface {
|
||||
error
|
||||
fmt.Stringer
|
||||
withWrapped(error) APIError
|
||||
withErrors(APIErrorsList) APIError
|
||||
Unwrap() error
|
||||
|
|
@ -94,7 +97,33 @@ func NewAPIError(message string) APIError {
|
|||
return &apiError{ErrorMsg: message}
|
||||
}
|
||||
|
||||
// asMissingParameterErr returns true if "Parameter {{}} is missing" error message is provided.
|
||||
// AsAPIError returns APIError and true if provided error is an APIError or contains wrapped APIError.
|
||||
// Returns (nil, false) otherwise.
|
||||
func AsAPIError(err error) (APIError, bool) {
|
||||
apiErr := unwrapAPIError(err)
|
||||
return apiErr, apiErr != nil
|
||||
}
|
||||
|
||||
func unwrapAPIError(err error) APIError {
|
||||
if err == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
if apiErr, ok := err.(APIError); ok {
|
||||
return apiErr
|
||||
}
|
||||
|
||||
wrapper, ok := err.(interface {
|
||||
Unwrap() error
|
||||
})
|
||||
if ok {
|
||||
return unwrapAPIError(wrapper.Unwrap())
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// asMissingParameterErr returns true if "Parameter 'name' is missing" error message is provided.
|
||||
func asMissingParameterErr(message string) (string, bool) {
|
||||
matches := missingParameterMatcher.FindAllStringSubmatch(message, -1)
|
||||
if len(matches) == 1 && len(matches[0]) == 2 {
|
||||
|
|
@ -119,6 +148,37 @@ func (e *apiError) Errors() APIErrorsList {
|
|||
return e.ErrorsList
|
||||
}
|
||||
|
||||
// String returns string representation of an APIError
|
||||
func (e *apiError) String() string {
|
||||
var sb strings.Builder
|
||||
sb.Grow(256)
|
||||
sb.WriteString(fmt.Sprintf(`errorMsg: "%s"`, e.Error()))
|
||||
|
||||
if len(e.Errors()) > 0 {
|
||||
i := 0
|
||||
useIndex := true
|
||||
errorList := make([]string, len(e.Errors()))
|
||||
|
||||
for index, errText := range e.Errors() {
|
||||
if i == 0 && index == "0" {
|
||||
useIndex = false
|
||||
}
|
||||
|
||||
if useIndex {
|
||||
errorList[i] = fmt.Sprintf(`%s: "%s"`, index, errText)
|
||||
} else {
|
||||
errorList[i] = errText
|
||||
}
|
||||
|
||||
i++
|
||||
}
|
||||
|
||||
sb.WriteString(", errors: [" + strings.Join(errorList, ", ") + "]")
|
||||
}
|
||||
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
// withError is an ErrorMsg setter.
|
||||
func (e *apiError) withError(message string) APIError {
|
||||
e.ErrorMsg = message
|
||||
|
|
|
|||
157
error_test.go
157
error_test.go
|
|
@ -1,12 +1,20 @@
|
|||
package retailcrm
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/suite"
|
||||
)
|
||||
|
||||
func TestFailure_ApiErrorsSlice(t *testing.T) {
|
||||
type ErrorTest struct {
|
||||
suite.Suite
|
||||
}
|
||||
|
||||
func TestError(t *testing.T) {
|
||||
suite.Run(t, new(ErrorTest))
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_ApiErrorsSlice() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "Failed to activate module",
|
||||
"errors": [
|
||||
|
|
@ -19,17 +27,15 @@ func TestFailure_ApiErrorsSlice(t *testing.T) {
|
|||
}
|
||||
|
||||
e := CreateAPIError(b)
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
if errors.Is(e, ErrGeneric) {
|
||||
if eq := reflect.DeepEqual(expected, e.(APIError).Errors()); eq != true {
|
||||
t.Errorf("%+v", eq)
|
||||
}
|
||||
} else {
|
||||
t.Errorf("Error must be type of ErrGeneric: %v", e)
|
||||
}
|
||||
t.Require().ErrorIs(e, ErrGeneric)
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Assert().Equal(expected, apiErr.Errors())
|
||||
}
|
||||
|
||||
func TestFailure_ApiErrorsMap(t *testing.T) {
|
||||
func (t *ErrorTest) TestFailure_ApiErrorsMap() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "Failed to activate module",
|
||||
"errors": {"id": "ID must be an integer", "test": "Test error"}}`,
|
||||
|
|
@ -40,11 +46,126 @@ func TestFailure_ApiErrorsMap(t *testing.T) {
|
|||
}
|
||||
|
||||
e := CreateAPIError(b)
|
||||
if errors.Is(e, ErrGeneric) {
|
||||
if eq := reflect.DeepEqual(expected, e.(APIError).Errors()); eq != true {
|
||||
t.Errorf("%+v", eq)
|
||||
}
|
||||
} else {
|
||||
t.Errorf("Error must be type of ErrGeneric: %v", e)
|
||||
}
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().ErrorIs(e, ErrGeneric)
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Assert().Equal(expected, apiErr.Errors())
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_APIKeyMissing() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "\"apiKey\" is missing."}`,
|
||||
)
|
||||
|
||||
e := CreateAPIError(b)
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Require().ErrorIs(e, ErrMissingCredentials)
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_APIKeyWrong() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "Wrong \"apiKey\" value."}`,
|
||||
)
|
||||
|
||||
e := CreateAPIError(b)
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Require().ErrorIs(e, ErrInvalidCredentials)
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_AccessDenied() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "Access denied."}`,
|
||||
)
|
||||
|
||||
e := CreateAPIError(b)
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Require().ErrorIs(e, ErrAccessDenied)
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_AccountDoesNotExist() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "Account does not exist."}`,
|
||||
)
|
||||
|
||||
e := CreateAPIError(b)
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Require().ErrorIs(e, ErrAccountDoesNotExist)
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_Validation() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "Errors in the entity format",
|
||||
"errors": {"name": "name must be provided"}}`,
|
||||
)
|
||||
|
||||
e := CreateAPIError(b)
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Require().ErrorIs(e, ErrValidation)
|
||||
t.Assert().Equal("name must be provided", apiErr.Errors()["name"])
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_Validation2() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "Validation error",
|
||||
"errors": {"name": "name must be provided"}}`,
|
||||
)
|
||||
|
||||
e := CreateAPIError(b)
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Require().ErrorIs(e, ErrValidation)
|
||||
t.Assert().Equal("name must be provided", apiErr.Errors()["name"])
|
||||
t.Assert().Equal("errorMsg: \"Validation error\", errors: [name: \"name must be provided\"]", apiErr.String())
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_MissingParameter() {
|
||||
b := []byte(`{"success": false,
|
||||
"errorMsg": "Parameter 'item' is missing"}`,
|
||||
)
|
||||
|
||||
e := CreateAPIError(b)
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Require().ErrorIs(e, ErrMissingParameter)
|
||||
t.Assert().Equal("item", apiErr.Errors()["Name"])
|
||||
}
|
||||
|
||||
func (t *ErrorTest) Test_CreateGenericAPIError() {
|
||||
e := CreateGenericAPIError("generic error message")
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Assert().ErrorIs(apiErr, ErrGeneric)
|
||||
t.Assert().Equal("generic error message", e.Error())
|
||||
}
|
||||
|
||||
func (t *ErrorTest) TestFailure_HTML() {
|
||||
e := CreateAPIError([]byte{'<'})
|
||||
apiErr, ok := AsAPIError(e)
|
||||
|
||||
t.Require().NotNil(apiErr)
|
||||
t.Require().True(ok)
|
||||
t.Assert().ErrorIs(apiErr, ErrAccountDoesNotExist)
|
||||
}
|
||||
|
|
|
|||
1
go.mod
1
go.mod
|
|
@ -5,5 +5,6 @@ go 1.13
|
|||
require (
|
||||
github.com/google/go-querystring v1.1.0
|
||||
github.com/joho/godotenv v1.3.0
|
||||
github.com/stretchr/testify v1.7.0
|
||||
gopkg.in/h2non/gock.v1 v1.1.2
|
||||
)
|
||||
|
|
|
|||
11
go.sum
11
go.sum
|
|
@ -1,3 +1,5 @@
|
|||
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/google/go-cmp v0.5.2 h1:X2ev0eStA3AbceY54o37/0PQ/UWqKEiiO2dKL5OPaFM=
|
||||
github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
|
||||
|
|
@ -8,7 +10,16 @@ github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
|
|||
github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=
|
||||
github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32 h1:W6apQkHrMkS0Muv8G/TipAy/FJl/rCYT0+EuS8+Z0z4=
|
||||
github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
|
||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/h2non/gock.v1 v1.1.2 h1:jBbHXgGBK/AoPVfJh5x4r/WxIrElvbLel8TCZkkZJoY=
|
||||
gopkg.in/h2non/gock.v1 v1.1.2/go.mod h1:n7UGz/ckNChHiK05rDoiC4MYSunEC/lyaUm2WWaDva0=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue