Merge pull request #7 from tianxiaoliang/main

add error register

Author: tianxiaoliang

discovery/error.go

@@ -54,7 +54,33 @@ const (
 	ErrUnavailableQuota   int32 = 500101
 )
 
-var errors = map[int32]string{}
+var errorsMap = map[int32]string{
+	ErrInvalidParams:           "Invalid parameter(s)",
+	ErrUnhealthy:               "Server is Unhealthy",
+	ErrServiceAlreadyExists:    "Micro-service already exists",
+	ErrServiceNotExists:        "Micro-service does not exist",
+	ErrServiceVersionNotExists: "Micro-service version does not exist",
+	ErrDeployedInstance:        "Micro-service has deployed instance(s)",
+	ErrDependedOnConsumer:      "Consumer(s) depends on this micro-service",
+	ErrUndefinedSchemaID:       "Undefined schema id",
+	ErrModifySchemaNotAllow:    "Not allowed to modify schema",
+	ErrSchemaNotExists:         "Schema does not exist",
+	ErrInstanceNotExists:       "Instance does not exist",
+	ErrPermissionDeny:          "Access micro-service refused",
+	ErrTagNotExists:            "Tag does not exist",
+	ErrRuleAlreadyExists:       "Rule already exist",
+	ErrBlackAndWhiteRule:       "Can not have both 'BLACK' and 'WHITE'",
+	ErrModifyRuleNotAllow:      "Not allowed to modify the type of the rule",
+	ErrRuleNotExists:           "Rule does not exist",
+	ErrNotEnoughQuota:          "Not enough quota",
+	ErrUnauthorized:            "Request unauthorized",
+	ErrInternal:                "Internal server error",
+	ErrUnavailableBackend:      "Registry service is unavailable",
+	ErrUnavailableQuota:        "Quota service is unavailable",
+	ErrEndpointAlreadyExists:   "Endpoint is already belong to other service",
+	ErrForbidden:               "Forbidden",
+	ErrConflictAccount:         "account name is duplicated",
+}
 
 type Error struct {
 	Code    int32  `json:"errorCode,string"`
@@ -85,11 +111,20 @@ func (e *Error) InternalError() bool {
 func NewError(code int32, detail string) *Error {
 	return &Error{
 		Code:    code,
-		Message: errors[code],
+		Message: errorsMap[code],
 		Detail:  detail,
 	}
 }
 
 func NewErrorf(code int32, format string, args ...interface{}) *Error {
 	return NewError(code, fmt.Sprintf(format, args...))
 }
+func RegisterErrors(errs map[int32]string) {
+	for err, msg := range errs {
+		if err < 400000 || err >= 600000 {
+			fmt.Sprintf("error code[%v] should be between 4xx and 5xx\n", err)
+			continue
+		}
+		errorsMap[err] = msg
+	}
+}

discovery/error_test.go

@@ -0,0 +1,75 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package discovery_test
+
+import (
+	"github.com/go-chassis/cari/discovery"
+	"github.com/stretchr/testify/assert"
+	"net/http"
+	"testing"
+)
+
+func TestError_StatusCode(t *testing.T) {
+	e := discovery.Error{Code: 503999}
+	if e.StatusCode() != http.StatusServiceUnavailable {
+		t.Fatalf("TestError_StatusCode %v failed", e)
+	}
+
+	if !e.InternalError() {
+		t.Fatalf("TestInternalError failed")
+	}
+}
+
+func TestNewError(t *testing.T) {
+	var err error
+	err = discovery.NewError(discovery.ErrInvalidParams, "test1")
+	if err == nil {
+		t.Fatalf("TestNewError failed")
+	}
+	err = discovery.NewErrorf(discovery.ErrInvalidParams, "%s", "test2")
+	if err == nil {
+		t.Fatalf("TestNewErrorf failed")
+	}
+
+	if len(err.Error()) == 0 {
+		t.Fatalf("TestError failed")
+	}
+
+	if len(err.(*discovery.Error).Marshal()) == 0 {
+		t.Fatalf("TestMarshal failed")
+	}
+
+	if err.(*discovery.Error).StatusCode() != http.StatusBadRequest {
+		t.Fatalf("TestStatusCode failed, %d", err.(*discovery.Error).StatusCode())
+	}
+
+	if err.(*discovery.Error).InternalError() {
+		t.Fatalf("TestInternalError failed")
+	}
+
+	err = discovery.NewErrorf(discovery.ErrInvalidParams, "")
+	if len(err.Error()) == 0 {
+		t.Fatalf("TestNewErrorf with empty detial failed")
+	}
+}
+
+func TestRegisterErrors(t *testing.T) {
+	discovery.RegisterErrors(map[int32]string{503999: "test1", 1: "none"})
+
+	e := discovery.NewError(503999, "test2")
+	assert.Equal(t, "test1", e.Message)
+}

go.mod

@@ -2,4 +2,7 @@ module github.com/go-chassis/cari
 
 go 1.13
 
-require github.com/gogo/protobuf v1.3.1
+require (
+	github.com/gogo/protobuf v1.3.1
+	github.com/stretchr/testify v1.6.1
+)