Merge pull request #2 from WoSai/hotfix/trigger_ci

补充注释

Author: jacexh

.github/workflows/ci.yml

@@ -8,6 +8,7 @@ on:
     branchs:
     - release/*
     - hotfix/*
+    - master
     tags:
     - v*
 

application/rule.go

@@ -15,12 +15,15 @@ import (
 )
 
 var (
+	// MockApplication 全局的mockApplication对象
 	MockApplication *mockApplication
 
-	ErrRuleNotFound = errors.New("rule not founded")
+	// ErrRuleNotFound 定义的无匹配规则时的错误
+	ErrRuleNotFound = errors.New("rule not found")
 )
 
 type (
+	// AsyncJob 异步的摆渡任务接口定义
 	AsyncJob interface {
 		Period() time.Duration
 		Do() error
@@ -36,6 +39,7 @@ type (
 	}
 )
 
+// BuildMockApplication mockApplication的工厂函数
 func BuildMockApplication(rr domain.RuleRepository, er domain.ExecutorRepository, job AsyncJob) *mockApplication {
 	MockApplication = &mockApplication{rule: rr, executor: er, job: job}
 	go func() {
@@ -140,6 +144,7 @@ func convertRegulationVO(reg *domain.Regulation) *types.RegulationDTO {
 	return r
 }
 
+// CreateRule 创建规则的user case
 func (srv *mockApplication) CreateRule(ctx context.Context, rule *types.RuleDTO) (string, error) {
 	ru := convertRuleDTO(rule)
 	rid, _ := ru.SupplyID()
@@ -156,6 +161,7 @@ func (srv *mockApplication) CreateRule(ctx context.Context, rule *types.RuleDTO)
 	return rid, nil
 }
 
+// GetRule 获取规则的user case
 func (srv *mockApplication) GetRule(ctx context.Context, rid string) (*types.RuleDTO, error) {
 	re, err := srv.rule.GetRuleByID(ctx, rid)
 	if err != nil {
@@ -170,6 +176,7 @@ func (srv *mockApplication) GetRule(ctx context.Context, rid string) (*types.Rul
 	return rule, nil
 }
 
+// DeleteRule 删除规则的user case
 func (srv *mockApplication) DeleteRule(ctx context.Context, rid string) error {
 	if err := srv.rule.DeleteRule(ctx, rid); err != nil {
 		misc.Logger.Error("failed to delete rule entity", zap.String("rule_id", rid), zap.Error(err))
@@ -178,6 +185,7 @@ func (srv *mockApplication) DeleteRule(ctx context.Context, rid string) error {
 	return nil
 }
 
+// PutRule 全量更新规则的user case
 func (srv *mockApplication) PutRule(ctx context.Context, rule *types.RuleDTO) error {
 	or, err := srv.rule.GetRuleByID(ctx, rule.ID)
 	if err != nil {
@@ -198,6 +206,7 @@ func (srv *mockApplication) PutRule(ctx context.Context, rule *types.RuleDTO) er
 	return nil
 }
 
+// PatchRule 部分更新规则的user case
 func (srv *mockApplication) PatchRule(ctx context.Context, rule *types.RuleDTO) error {
 	or, err := srv.rule.GetRuleByID(ctx, rule.ID)
 	if err != nil {
@@ -218,6 +227,7 @@ func (srv *mockApplication) PatchRule(ctx context.Context, rule *types.RuleDTO)
 	return nil
 }
 
+// Export 导出的user case
 func (srv *mockApplication) Export(ctx context.Context) ([]*types.RuleDTO, error) {
 	res, err := srv.rule.Export(ctx)
 	if err != nil {
@@ -236,6 +246,7 @@ func (srv *mockApplication) Export(ctx context.Context) ([]*types.RuleDTO, error
 	return rules, nil
 }
 
+// Import 导入规则的user case
 func (srv *mockApplication) Import(ctx context.Context, rules ...*types.RuleDTO) error {
 	res := make([]*domain.Rule, len(rules))
 	for index, rule := range rules {
@@ -255,6 +266,7 @@ func (srv *mockApplication) Import(ctx context.Context, rules ...*types.RuleDTO)
 	return nil
 }
 
+// MockAPI Mock接口的user case
 func (srv *mockApplication) MockAPI(ctx *fasthttp.RequestCtx) error {
 	index := atomic.AddUint64(&srv.counter, 1)
 	misc.Logger.Info("received request", zap.Uint64("index", index), zap.ByteString("path", ctx.Request.URI().Path()), zap.ByteString("method", ctx.Request.Header.Method()))

client/client.go

@@ -8,26 +8,31 @@ import (
 )
 
 type (
+	// DeepMockClient Client对象
 	DeepMockClient struct {
 		url    string
 		client *requests.Session
 	}
 
+	// DeepMockError client error结构体
 	DeepMockError struct {
 		code int
 		err  string
 	}
 
+	// Response client通用的返回响应
 	Response struct {
 		Code         int    `json:"code"`
 		ErrorMessage string `json:"err_msg,omitempty"`
 	}
 
+	// RuleResponse 单规则接口返回报文
 	RuleResponse struct {
 		Response
 		Data *types.RuleDO `json:"data,omitempty"`
 	}
 
+	// RulesResponse 多规则接口返回报文
 	RulesResponse struct {
 		Response
 		Data []*types.RuleDO `json:"data,omitempty"`
@@ -41,17 +46,20 @@ const (
 	returnCodeOK = 200
 )
 
+// NewDeepMockError client error工厂函数
 func NewDeepMockError(res Response) *DeepMockError {
 	return &DeepMockError{
 		code: res.Code,
 		err:  res.ErrorMessage,
 	}
 }
 
+// Error error的实现
 func (e *DeepMockError) Error() string {
 	return fmt.Sprintf("[%d]: %s", e.code, e.err)
 }
 
+// NewDeepMockClient client的工厂函数
 func NewDeepMockClient(url string) *DeepMockClient {
 	session := requests.NewSession(requests.Option{Name: "DeepMock Go Client"})
 	return &DeepMockClient{
@@ -60,6 +68,7 @@ func NewDeepMockClient(url string) *DeepMockClient {
 	}
 }
 
+// CreateMockRule 创建规则接口
 func (c *DeepMockClient) CreateMockRule(rule *types.RuleDO) (*types.RuleDO, error) {
 	res := new(RuleResponse)
 	_, _, err := c.client.Post(c.url+entrypointRule, requests.Params{Json: rule}, requests.UnmarshalJSONResponse(res))
@@ -72,6 +81,7 @@ func (c *DeepMockClient) CreateMockRule(rule *types.RuleDO) (*types.RuleDO, erro
 	return res.Data, nil
 }
 
+// DeleteMockRule 删除规则接口
 func (c *DeepMockClient) DeleteMockRule(rid string) error {
 	res := new(RuleResponse)
 	_, _, err := c.client.Delete(c.url+entrypointRule, requests.Params{Json: requests.Any{"id": rid}}, requests.UnmarshalJSONResponse(res))
@@ -84,6 +94,7 @@ func (c *DeepMockClient) DeleteMockRule(rid string) error {
 	return nil
 }
 
+// GetMockRule 获取规则接口
 func (c *DeepMockClient) GetMockRule(rid string) (*types.RuleDO, error) {
 	res := new(RuleResponse)
 	_, _, err := c.client.Get(c.url+entrypointRule+"/"+rid, requests.Params{}, requests.UnmarshalJSONResponse(res))
@@ -96,6 +107,7 @@ func (c *DeepMockClient) GetMockRule(rid string) (*types.RuleDO, error) {
 	return res.Data, nil
 }
 
+// PutMockRule 全量更新规则接口
 func (c *DeepMockClient) PutMockRule(rule *types.RuleDO) (*types.RuleDO, error) {
 	res := new(RuleResponse)
 	_, _, err := c.client.Put(c.url+entrypointRule, requests.Params{Json: rule}, requests.UnmarshalJSONResponse(res))
@@ -108,6 +120,7 @@ func (c *DeepMockClient) PutMockRule(rule *types.RuleDO) (*types.RuleDO, error)
 	return res.Data, nil
 }
 
+// PatchMockRule 部分更新规则接口
 func (c *DeepMockClient) PatchMockRule(rule *types.RuleDO) (*types.RuleDO, error) {
 	res := new(RuleResponse)
 	_, _, err := c.client.Patch(c.url+entrypointRule, requests.Params{Json: rule}, requests.UnmarshalJSONResponse(res))
@@ -120,6 +133,7 @@ func (c *DeepMockClient) PatchMockRule(rule *types.RuleDO) (*types.RuleDO, error
 	return res.Data, nil
 }
 
+// ExportRules 导出所有规则
 func (c *DeepMockClient) ExportRules() ([]*types.RuleDO, error) {
 	res := new(RulesResponse)
 	_, _, err := c.client.Get(c.url+entrypointRules, requests.Params{}, requests.UnmarshalJSONResponse(res))
@@ -132,6 +146,7 @@ func (c *DeepMockClient) ExportRules() ([]*types.RuleDO, error) {
 	return res.Data, nil
 }
 
+// ImportRules 导入规则
 func (c *DeepMockClient) ImportRules(rules ...*types.RuleDO) error {
 	res := new(RulesResponse)
 	_, _, err := c.client.Post(c.url+entrypointRules, requests.Params{Json: rules}, requests.UnmarshalJSONResponse(res))

domain/executor.go

@@ -24,6 +24,7 @@ const (
 	// FilterModeRegular 正则表达式模式
 	FilterModeRegular FilterMode = "regular"
 
+	// ModeField 筛选模式的字段名称
 	ModeField = "mode"
 )
 
@@ -32,8 +33,10 @@ var (
 )
 
 type (
+	// FilterMode 筛选模式定义
 	FilterMode = string
 
+	// Executor 规则执行器
 	Executor struct {
 		ID          string
 		Method      []byte
@@ -44,20 +47,24 @@ type (
 		Version     int
 	}
 
+	// WeightPicker 权重随机值选择器
 	WeightPicker map[string]*WeightDice
 
+	// WeightDice 权重随机值对象
 	WeightDice struct {
 		total        int
 		distribution []string
 		factor       map[string]uint
 	}
 
+	// RegulationExecutor 报文规则执行器
 	RegulationExecutor struct {
 		IsDefault bool
 		Filter    *FilterExecutor
 		Template  *TemplateExecutor
 	}
 
+	// TemplateExecutor 响应报文模板执行器
 	TemplateExecutor struct {
 		IsGolangTemplate bool
 		IsBinData        bool
@@ -66,6 +73,7 @@ type (
 		body             []byte
 	}
 
+	// RenderContext 动态渲染的上下文
 	RenderContext struct {
 		Variable map[string]interface{}
 		Weight   map[string]string
@@ -75,31 +83,36 @@ type (
 		Json     map[string]interface{}
 	}
 
+	// FilterExecutor 筛选执行器
 	FilterExecutor struct {
 		Query  *QueryFilterExecutor
 		Header *HeaderFilterExecutor
 		Body   *BodyFilterExecutor
 	}
 
+	// BodyFilterExecutor Body报文筛选执行器
 	BodyFilterExecutor struct {
 		mode    FilterMode
 		regular *regexp.Regexp
 		keyword []byte
 	}
 
+	// HeaderFilterExecutor 请求头筛选执行器
 	HeaderFilterExecutor struct {
 		params   map[string][]byte
 		mode     FilterMode
 		regulars map[string]*regexp.Regexp
 	}
 
+	// QueryFilterExecutor Query参数筛选执行器
 	QueryFilterExecutor struct {
 		params   map[string][]byte
 		mode     FilterMode
 		regulars map[string]*regexp.Regexp
 	}
 )
 
+// DiceAll 返回所有权重因子的值
 func (wp WeightPicker) DiceAll() map[string]string {
 	ret := make(map[string]string)
 	for k, v := range wp {
@@ -108,6 +121,7 @@ func (wp WeightPicker) DiceAll() map[string]string {
 	return ret
 }
 
+// Dice 更具权重值随机返回某个值
 func (wd *WeightDice) Dice() string {
 	return wd.distribution[rand.Intn(wd.total)]
 }
@@ -139,6 +153,7 @@ func (hfe *HeaderFilterExecutor) filterByRegular(header *fasthttp.RequestHeader)
 	return true
 }
 
+// Filter 筛选函数
 func (hfe *HeaderFilterExecutor) Filter(header *fasthttp.RequestHeader) bool {
 	if hfe == nil {
 		return true
@@ -189,6 +204,7 @@ func (qfe *QueryFilterExecutor) filterByRegular(args *fasthttp.Args) bool {
 	return true
 }
 
+// Filter 筛选函数
 func (qfe *QueryFilterExecutor) Filter(args *fasthttp.Args) bool {
 	if qfe == nil {
 		return true
@@ -212,6 +228,7 @@ func (qfe *QueryFilterExecutor) Filter(args *fasthttp.Args) bool {
 	}
 }
 
+// Filter 筛选函数
 func (bfe *BodyFilterExecutor) Filter(body []byte) bool {
 	if bfe == nil {
 		return true
@@ -232,6 +249,7 @@ func (bfe *BodyFilterExecutor) Filter(body []byte) bool {
 	}
 }
 
+// Filter 筛选函数
 func (fe *FilterExecutor) Filter(request *fasthttp.Request) bool {
 	if fe == nil {
 		return true
@@ -249,6 +267,7 @@ func (fe *FilterExecutor) Filter(request *fasthttp.Request) bool {
 	return true
 }
 
+// Render 渲染函数
 func (te *TemplateExecutor) Render(ctx *fasthttp.RequestCtx, v map[string]interface{}, weight map[string]string) error {
 	te.header.CopyTo(&ctx.Response.Header)
 	if !te.IsGolangTemplate {
@@ -271,22 +290,20 @@ func (te *TemplateExecutor) Render(ctx *fasthttp.RequestCtx, v map[string]interf
 	return te.template.Execute(ctx.Response.BodyWriter(), rc)
 }
 
+// Render 渲染函数
 func (re *RegulationExecutor) Render(ctx *fasthttp.RequestCtx, v map[string]interface{}, w map[string]string) error {
 	return re.Template.Render(ctx, v, w)
 }
 
-// todo:
-func NewExecutor() (*Executor, error) {
-	return nil, nil
-}
-
+// Match 请求匹配函数
 func (exe *Executor) Match(path, method []byte) bool {
 	if bytes.Compare(method, exe.Method) != 0 {
 		return false
 	}
 	return exe.Path.Match(path)
 }
 
+// FindRegulationExecutor 查找符合的报文规则执行器
 func (exe *Executor) FindRegulationExecutor(request *fasthttp.Request) *RegulationExecutor {
 	var reg *RegulationExecutor
 

domain/repository.go

@@ -3,6 +3,7 @@ package domain
 import "context"
 
 type (
+	// RuleRepository 规则存储库接口定义
 	RuleRepository interface {
 		CreateRule(context.Context, *Rule) error
 		UpdateRule(context.Context, *Rule) error
@@ -12,9 +13,9 @@ type (
 		Import(context.Context, ...*Rule) error
 	}
 
+	// ExecutorRepository 执行器接口定义
 	ExecutorRepository interface {
 		FindExecutor(context.Context, []byte, []byte) (*Executor, bool)
 		ImportAll(context.Context, ...*Executor)
-		Purge(context.Context)
 	}
 )