补充API Root 测试用例

Author: yumaojun03

exception/base.go

@@ -9,6 +9,7 @@ type APIException interface {
 	Meta() interface{}
 	Is(code int) bool
 	Namespace() string
+	Reason() string
 }
 
 // WithAPIException 携带元信息的异常
@@ -62,13 +63,6 @@ func (e *exception) Namespace() string {
 	return e.namespace.String()
 }
 
-// NewAPIException 创建一个API异常
-// 用于其他模块自定义异常
-func NewAPIException(code int, reason, format string, a ...interface{}) WithAPIException {
-	// 0表示正常状态, 但是要排除变量的零值
-	if code == 0 {
-		code = -1
-	}
-
-	return newException(usedNamespace, code, reason, format, a...)
+func (e *exception) Reason() string {
+	return e.reason
 }

exception/exception.go

@@ -1,5 +1,16 @@
 package exception
 
+// NewAPIException 创建一个API异常
+// 用于其他模块自定义异常
+func NewAPIException(namespace string, code int, reason, format string, a ...interface{}) WithAPIException {
+	// 0表示正常状态, 但是要排除变量的零值
+	if code == 0 {
+		code = -1
+	}
+
+	return newException(Namespace(namespace), code, reason, format, a...)
+}
+
 // NewUnauthorized 未认证
 func NewUnauthorized(format string, a ...interface{}) APIException {
 	return newException(usedNamespace, Unauthorized, codeReason(Unauthorized), format, a...)
@@ -37,5 +48,5 @@ func IsNotFoundError(err error) bool {
 		return false
 	}
 
-	return e.ErrorCode() == NotFound
+	return e.ErrorCode() == NotFound && e.Namespace() == GlobalNamespace.String()
 }

exception/namespace.go

@@ -14,11 +14,4 @@ func (ns Namespace) String() string {
 const (
 	// GlobalNamespace 所有服务公用的一些异常
 	GlobalNamespace = Namespace("global")
-	// Keyauth 权限系统, 每个子系统有自己的异常空间
-	Keyauth = Namespace("keyauth")
 )
-
-// ChangeNameSapce 切换异常空间
-func ChangeNameSapce(ns Namespace) {
-	usedNamespace = ns
-}

http/request/request.go

@@ -10,7 +10,7 @@ import (
 )
 
 var (
-	// BodyMaxContenxLength body 最大大小 默认 64M
+	// BodyMaxContenxLength body最大大小 默认64M
 	BodyMaxContenxLength int64 = 1 << 26
 )
 

http/response/data.go

@@ -0,0 +1,29 @@
+package response
+
+import "github.com/infraboard/mcube/http/request"
+
+// Data to be used by controllers.
+type Data struct {
+	Code      *int        `json:"code"`                // 自定义返回码  0:表示正常
+	Type      string      `json:"type,omitempty"`      // 数据类型, 可以缺省
+	Namespace string      `json:"namespace,omitempty"` // 异常的范围
+	Reason    string      `json:"reason,omitempty"`    // 异常原因
+	Message   string      `json:"message,omitempty"`   // 关于这次响应的说明信息
+	Data      interface{} `json:"data,omitempty"`      // 返回的具体数据
+}
+
+// PageData 数据分页数据
+type PageData struct {
+	*request.PageRequest
+	TotalCount uint        `json:"total"` // 总共多少条
+	List       interface{} `json:"list"`  // 页面数据
+}
+
+// NewData new实例
+func NewData(data interface{}) *Data {
+	code := -1
+	return &Data{
+		Code: &code,
+		Data: data,
+	}
+}

http/response/receive.go

@@ -1 +1,35 @@
 package response
+
+import (
+	"encoding/json"
+	"errors"
+	"io"
+	"io/ioutil"
+
+	"github.com/infraboard/mcube/exception"
+)
+
+// GetDataFromBody 获取body中的数据
+func GetDataFromBody(body io.ReadCloser, v interface{}) error {
+	defer body.Close()
+
+	bytesB, err := ioutil.ReadAll(body)
+	if err != nil {
+		return err
+	}
+	data := NewData(v)
+
+	if err := json.Unmarshal(bytesB, data); err != nil {
+		return err
+	}
+
+	if data.Code == nil {
+		return errors.New("reponse code is nil")
+	}
+
+	if *data.Code != 0 {
+		return exception.NewAPIException(data.Namespace, *data.Code, data.Reason, data.Message)
+	}
+
+	return nil
+}

http/response/send.go

@@ -6,35 +6,22 @@ import (
 	"net/http"
 
 	"github.com/infraboard/mcube/exception"
-	"github.com/infraboard/mcube/http/request"
 )
 
-// Data to be used by controllers.
-type Data struct {
-	Code    *int        `json:"code"`              // 自定义返回码  0:表示正常
-	Type    string      `json:"type,omitempty"`    // 数据类型, 可以缺省
-	Message string      `json:"message,omitempty"` // 关于这次响应的说明信息
-	Data    interface{} `json:"data,omitempty"`    // 返回的具体数据
-}
-
-// PageData 数据分页数据
-type PageData struct {
-	*request.PageRequest
-
-	TotalCount uint        `json:"total"` // 总共多少条
-	List       interface{} `json:"list"`  // 页面数据
-}
-
 // Failed use to response error messge
 func Failed(w http.ResponseWriter, err error) {
 	var (
 		errCode  int
 		httpCode int
+		ns       string
+		reason   string
 	)
 
 	switch t := err.(type) {
 	case exception.APIException:
 		errCode = t.ErrorCode()
+		reason = t.Reason()
+		ns = t.Namespace()
 	default:
 		errCode = exception.UnKnownException
 	}
@@ -48,8 +35,10 @@ func Failed(w http.ResponseWriter, err error) {
 	}
 
 	resp := Data{
-		Code:    &errCode,
-		Message: err.Error(),
+		Code:      &errCode,
+		Namespace: ns,
+		Reason:    reason,
+		Message:   err.Error(),
 	}
 
 	// set response heanders

http/router/entry.go

@@ -0,0 +1,38 @@
+package router
+
+// Entry 路由条目
+type Entry struct {
+	Path         string            `json:"path,omitempty"`
+	Method       string            `json:"method,omitempty"`
+	FunctionName string            `json:"function_name,omitempty"`
+	Resource     string            `json:"resource,omitempty"`
+	Protected    bool              `json:"protected"`
+	Labels       map[string]string `json:"labels,omitempty"`
+}
+
+// NewEntrySet 实例
+func NewEntrySet() *EntrySet {
+	return &EntrySet{}
+}
+
+// EntrySet 路由条目集
+type EntrySet struct {
+	Items []*Entry
+}
+
+// AddEntry 添加Entry
+func (s *EntrySet) AddEntry(e Entry) {
+	s.Items = append(s.Items, &e)
+}
+
+// GetEntry 获取条目
+func (s *EntrySet) GetEntry(path, mothod string) *Entry {
+	for i := range s.Items {
+		item := s.Items[i]
+		if item.Path == path && item.Method == mothod {
+			return item
+		}
+	}
+
+	return nil
+}

http/router/httprouter/entriy.go

@@ -40,13 +40,13 @@ func (s *entrySet) AddEntry(es ...*entry) error {
 }
 
 // ShowEntries 显示理由条目
-func (s *entrySet) ShowEntries() []router.Entry {
-	entries := make([]router.Entry, 0, len(s.items))
+func (s *entrySet) EntrieSet() *router.EntrySet {
+	es := router.NewEntrySet()
 	for _, v := range s.items {
-		entries = append(entries, *v.Entry)
+		es.AddEntry(*v.Entry)
 	}
 
-	return entries
+	return es
 }
 
 // FindEntry 通过函数地址找到对于的路由条目

http/router/httprouter/httprouter.go

@@ -100,16 +100,16 @@ func (r *httpRouter) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 	r.r.ServeHTTP(response.NewResponse(w), req)
 }
 
-func (r *httpRouter) GetEndpoints() []router.Entry {
-	return r.entrySet.ShowEntries()
+func (r *httpRouter) GetEndpoints() *router.EntrySet {
+	return r.entrySet.EntrieSet()
 }
 
 func (r *httpRouter) EnableAPIRoot() {
 	r.AddPublict("GET", "/", r.apiRoot)
 }
 
 func (r *httpRouter) apiRoot(w http.ResponseWriter, req *http.Request) {
-	response.Success(w, r.entrySet.ShowEntries())
+	response.Success(w, r.entrySet.EntrieSet())
 	return
 }