chore: generalize error msg to error.go (#1637)

api/internal/handler/authentication/authentication.go

@@ -17,7 +17,6 @@
 package authentication
 
 import (
-	"fmt"
 	"reflect"
 	"time"
 
@@ -29,6 +28,7 @@ import (
 
 	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/handler"
+	"github.com/apisix/manager-api/internal/utils/consts"
 )
 
 type Handler struct {
@@ -89,7 +89,7 @@ func (h *Handler) userLogin(c droplet.Context) (interface{}, error) {
 
 	user := conf.UserList[username]
 	if username != user.Username || password != user.Password {
-		return nil, fmt.Errorf("username or password error")
+		return nil, consts.ErrUsernamePassword
 	}
 
 	// create JWT for session

api/internal/handler/consumer/consumer.go

@@ -17,7 +17,6 @@
 package consumer
 
 import (
-	"fmt"
 	"net/http"
 	"reflect"
 	"strings"
@@ -32,6 +31,7 @@ import (
 	"github.com/apisix/manager-api/internal/core/store"
 	"github.com/apisix/manager-api/internal/handler"
 	"github.com/apisix/manager-api/internal/utils"
+	"github.com/apisix/manager-api/internal/utils/consts"
 )
 
 type Handler struct {
@@ -139,7 +139,7 @@ func (h *Handler) Set(c droplet.Context) (interface{}, error) {
 	input := c.Input().(*SetInput)
 	if input.ID != nil && utils.InterfaceToString(input.ID) != input.Username {
 		return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest},
-			fmt.Errorf("consumer's id and username must be a same value")
+			consts.ErrIDUsername
 	}
 	if input.Username != "" {
 		input.Consumer.Username = input.Username

api/internal/handler/data_loader/route_export.go

@@ -36,6 +36,7 @@ import (
 	"github.com/apisix/manager-api/internal/handler"
 	"github.com/apisix/manager-api/internal/log"
 	"github.com/apisix/manager-api/internal/utils"
+	"github.com/apisix/manager-api/internal/utils/consts"
 )
 
 type Handler struct {
@@ -69,7 +70,7 @@ func (h *Handler) ExportRoutes(c droplet.Context) (interface{}, error) {
 	input := c.Input().(*ExportInput)
 
 	if input.IDs == "" {
-		return nil, fmt.Errorf("Parameter IDs cannot be empty")
+		return nil, consts.ErrParameterID
 	}
 
 	ids := strings.Split(input.IDs, ",")
@@ -79,7 +80,7 @@ func (h *Handler) ExportRoutes(c droplet.Context) (interface{}, error) {
 		route, err := h.routeStore.Get(c.Context(), id)
 		if err != nil {
 			if err == data.ErrNotFound {
-				return nil, fmt.Errorf("route id: %s not found", id)
+				return nil, fmt.Errorf(consts.IDNotFound, "upstream", id)
 			}
 			return nil, err
 		}
@@ -113,7 +114,7 @@ func (h *Handler) ExportAllRoutes(c droplet.Context) (interface{}, error) {
 	routelist, err := h.routeStore.List(c.Context(), store.ListInput{})
 
 	if len(routelist.Rows) < 1 {
-		return nil, fmt.Errorf("Route data is empty, cannot be exported")
+		return nil, consts.ErrRouteData
 	}
 
 	if err != nil {
@@ -158,7 +159,7 @@ func (h *Handler) RouteToOpenAPI3(c droplet.Context, routes []*entity.Route) (*o
 			service, err = h.serviceStore.Get(c.Context(), serviceID)
 			if err != nil {
 				if err == data.ErrNotFound {
-					return nil, fmt.Errorf("service id: %s not found", route.ServiceID)
+					return nil, fmt.Errorf(consts.IDNotFound, "service", route.ServiceID)
 				}
 				return nil, err
 			}
@@ -463,7 +464,7 @@ func (h *Handler) ParseRouteUpstream(c droplet.Context, route *entity.Route) (in
 		upstream, err := h.upstreamStore.Get(c.Context(), upstreamID)
 		if err != nil {
 			if err == data.ErrNotFound {
-				return nil, fmt.Errorf("upstream id: %s not found", route.UpstreamID)
+				return nil, fmt.Errorf(consts.IDNotFound, "upstream", route.UpstreamID)
 			}
 			return nil, err
 		}
@@ -477,7 +478,7 @@ func (h *Handler) ParseRouteUpstream(c droplet.Context, route *entity.Route) (in
 			upstream, err := h.upstreamStore.Get(c.Context(), upstreamID)
 			if err != nil {
 				if err == data.ErrNotFound {
-					return nil, fmt.Errorf("upstream id: %s not found", _service.UpstreamID)
+					return nil, fmt.Errorf(consts.IDNotFound, "upstream", _service.UpstreamID)
 				}
 				return nil, err
 			}

api/internal/handler/data_loader/route_import.go

@@ -20,7 +20,6 @@ import (
 	"bytes"
 	"context"
 	"encoding/json"
-	"errors"
 	"fmt"
 	"net/http"
 	"path"
@@ -95,7 +94,7 @@ func (h *ImportHandler) Import(c droplet.Context) (interface{}, error) {
 
 	if len(swagger.Paths) < 1 {
 		return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest},
-			errors.New("empty or invalid imported file")
+			consts.ErrImportFile
 	}
 
 	routes, err := OpenAPI3ToRoute(swagger)
@@ -116,7 +115,7 @@ func (h *ImportHandler) Import(c droplet.Context) (interface{}, error) {
 			if err != nil {
 				if err == data.ErrNotFound {
 					return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest},
-						fmt.Errorf("service id: %s not found", route.ServiceID)
+						fmt.Errorf(consts.IDNotFound, "service", route.ServiceID)
 				}
 				return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest}, err
 			}
@@ -126,7 +125,7 @@ func (h *ImportHandler) Import(c droplet.Context) (interface{}, error) {
 			if err != nil {
 				if err == data.ErrNotFound {
 					return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest},
-						fmt.Errorf("upstream id: %s not found", route.UpstreamID)
+						fmt.Errorf(consts.IDNotFound, "upstream", route.UpstreamID)
 				}
 				return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest}, err
 			}

api/internal/handler/route/route.go

@@ -314,7 +314,7 @@ func (h *Handler) Create(c droplet.Context) (interface{}, error) {
 		if err != nil {
 			if err == data.ErrNotFound {
 				return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest},
-					fmt.Errorf("service id: %s not found", input.ServiceID)
+					fmt.Errorf(consts.IDNotFound, "service", input.ServiceID)
 			}
 			return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest}, err
 		}
@@ -419,7 +419,7 @@ func (h *Handler) Update(c droplet.Context) (interface{}, error) {
 		if err != nil {
 			if err == data.ErrNotFound {
 				return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest},
-					fmt.Errorf("service id: %s not found", input.ServiceID)
+					fmt.Errorf(consts.IDNotFound, "service", input.ServiceID)
 			}
 			return &data.SpecCodeResponse{StatusCode: http.StatusBadRequest}, err
 		}

api/internal/handler/ssl/ssl.go

@@ -21,7 +21,6 @@ import (
 	"crypto/x509"
 	"encoding/json"
 	"encoding/pem"
-	"errors"
 	"fmt"
 	"net/http"
 	"reflect"
@@ -330,23 +329,23 @@ func (h *Handler) BatchDelete(c droplet.Context) (interface{}, error) {
 
 func ParseCert(crt, key string) (*entity.SSL, error) {
 	if crt == "" || key == "" {
-		return nil, errors.New("invalid certificate")
+		return nil, consts.ErrSSLCertificate
 	}
 
 	certDERBlock, _ := pem.Decode([]byte(crt))
 	if certDERBlock == nil {
-		return nil, errors.New("Certificate resolution failed")
+		return nil, consts.ErrSSLCertificateResolution
 	}
 	// match
 	_, err := tls.X509KeyPair([]byte(crt), []byte(key))
 	if err != nil {
-		return nil, errors.New("key and cert don't match")
+		return nil, consts.ErrSSLKeyAndCert
 	}
 
 	x509Cert, err := x509.ParseCertificate(certDERBlock.Bytes)
 
 	if err != nil {
-		return nil, errors.New("Certificate resolution failed")
+		return nil, consts.ErrSSLCertificateResolution
 	}
 
 	ssl := entity.SSL{}

api/internal/utils/consts/error.go

@@ -16,13 +16,41 @@
  */
 package consts
 
-import "github.com/shiningrush/droplet/data"
+import (
+	"errors"
+
+	"github.com/shiningrush/droplet/data"
+)
 
 const (
 	ErrBadRequest = 20001
 	ErrForbidden  = 20002
 )
 
+const (
+	// IDNotFound is the string use for can't find the cache by the id
+	IDNotFound = "%s id: %s not found"
+)
+
+var (
+	// ErrorUsernamePassword is the error means username or password is not correct
+	ErrUsernamePassword = errors.New("username or password error")
+	// ErrorIDUsername is the error use for the input's id and username is different
+	ErrIDUsername = errors.New("consumer's id and username must be a same value")
+	// ErrorParameterID is the error use for parameter ID is empty
+	ErrParameterID = errors.New("Parameter IDs cannot be empty")
+	// ErrorRouteData is the error that the route data is empty
+	ErrRouteData = errors.New("Route data is empty, cannot be exported")
+	// ErrorImportFile is the error that use for import a empty file
+	ErrImportFile = errors.New("empty or invalid imported file")
+	// ErrorImportFile means the certificate is invalid
+	ErrSSLCertificate = errors.New("invalid certificate")
+	// ErrorSSLCertificateResolution means the SSL certificate decode failed
+	ErrSSLCertificateResolution = errors.New("Certificate resolution failed")
+	// ErrorSSLKeyAndCert means the SSL key and SSL certificate don't match
+	ErrSSLKeyAndCert = errors.New("key and cert don't match")
+)
+
 var (
 	// base error please refer to github.com/shiningrush/droplet/data, such as data.ErrNotFound, data.ErrConflicted
 	ErrInvalidRequest       = data.BaseError{Code: ErrBadRequest, Message: "invalid request"}