Merge pull request #4 from WoSai/release/redirect_template

支持302重定向，Header支持go template渲染

Author: jacexh

.github/workflows/ci.yml

@@ -3,35 +3,51 @@ name: ci
 on:
   pull_request:
     branches:
-    - master
+      - master
   push:
     branchs:
-    - release/*
-    - hotfix/*
-    - master
+      - release/*
+      - hotfix/*
+      - master
     tags:
-    - v*
+      - v*
 
 jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
-    - name: Set up Go 1.x
-      uses: actions/setup-go@v2
-      with:
-        go-version: ^1.14
-      id: go
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v2
-    - name: Test
-      run: go test -race -coverprofile=coverage.txt -covermode=atomic -v ./...
-    - name: Test Coverage Report
-      run: bash <(curl -s https://codecov.io/bash)
-    - uses: docker/build-push-action@v1
-      with:
-        username: ${{ secrets.DOCKERHUB_ORG_USERNAME }}
-        password: ${{ secrets.DOCKERHUB_ORG_ACCESS_TOKEN }}
-        repository: wosai/deepmock
-        tag_with_ref: true
-        tag_with_sha: true
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v2
+        with:
+          go-version: ^1.14
+        id: go
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+      - name: Test
+        run: go test -race -coverprofile=coverage.txt -covermode=atomic -v ./...
+      - name: Test Coverage Report
+        run: bash <(curl -s https://codecov.io/bash)
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: |
+            wosai/deepmock
+          tags: |
+            type=ref, event=branch
+            type=ref, event=pr
+            type=sha
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_ORG_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_ORG_ACCESS_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}

.gitignore

@@ -16,4 +16,5 @@
 
 # vscode
 .vscode
-.env
+.env
+/deepmock.log

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+
+## 0.6.0 - 2021-12-03
+
+### Added
+
+- 新增对于Response.Header使用Go Template的支持
+
+### Changed 
+
+- DTO新增支持字段render_header和header_template
+- Github Action升级docker/build-push-action@v2
+
+### Fixed
+
+- 修复创建规则时，StatusCode设置不生效的问题

README.md

@@ -49,11 +49,13 @@ curl -X POST http://127.0.0.1:16600/api/v1/rule \
     * `exact`: 精确筛选
     * `keyword`: 关键字筛选
     * `regular`: 正则表达式筛选
-- Response可以通过[Go Template](https://golang.org/pkg/text/template/)实现，因此可以支持以下特性
+- Response中的body和header均可以通过[Go Template](https://golang.org/pkg/text/template/)实现，因此可以支持以下特性
     * 可以使用逻辑控制，如: `if`，`range`
     * 可以使用内置函数
     * 可以自定义函数
 - 规则中的`Variable`、`Weight`以及请求中的`Header`、`Query`、`Form`、`Json`同样参与Response模板的渲染
+- Response.body中使用template渲染时，需设置`is_template: true`
+- Response.header可采用Patch形式，使用template渲染部分Header字段，需设置`render_template: true`以及template字符串`header_template`
 
 ### 接口列表：
 
@@ -397,7 +399,54 @@ curl http://127.0.0.1:16600/api/v1/rule/bba079deaa2b97037694a89386616d88
 |`timestamp` | `precision` | `{{timestamp ms}}` | 按指定的精度返回unix时间戳：mcs,ms,sec|
 |`plus`| `v`, `i` | `{{plus v i}}` | 将v的值增加i，实现简单的计算，支持string\int\float类型|
 |`rand_string`| `n` | `{{rand_string n}}`| 生成长度为n的随机字符串 |
+|`html_unescaped`|无|`{{.Variable.str `|`html_unescaped}}`| 防止template渲染时，将部分字符进行html编码，如"&" --> "\&" |
 
+#### Response.Header使用Template渲染示例
+```json
+{
+  "path": "/redirect/baidu",
+  "method": "get",
+  "variable": {
+    "app_id": "app_id",
+    "code": "123456"
+  },
+  "responses": [
+    {
+      "is_default": true,
+      "response": {
+        "is_template": false,
+        "render_header": true,
+        "header": {
+          "Content-Type": "text/html",
+          "User-Agent": "Wechat",
+          "x-env-flag": "test-111",
+          "rand-string": "I'm a {{rand_string}}",
+          "timestamp-sec": "2021-01-01",
+          "uuid": "I'm a {{uuid}}",
+          "location": "https://www.bing.com"
+        },
+        "header_template": "{\"location\": \"{{.Query.redirect_uri | html_unescaped}}&state={{.Query.state}}&app_id={{.Variable.app_id}}&auth_code={{.Variable.code}}\",\"rand-string\":\"{{rand_string 20}}\",\"uuid\":\"{{uuid}}\", \"timestamp-sec\":\"{{timestamp \"sec\"}}\"}",
+        "status_code": 302
+      }
+    }
+  ]
+}
+```
+```
+curl -I --location --request GET 'http://localhost:16600/redirect/baidu?redirect_uri=https%3A%2F%2Fwww.baidu.com%3Fref%3Dhello&appid=appid&state=true'
+
+HTTP/1.1 302 Found
+Server: DeepMock Service
+Date: Fri, 03 Dec 2021 03:49:55 GMT
+Content-Type: text/html
+Content-Length: 0
+Location: https://www.baidu.com?ref=hello&state=true&app_id=app_id&auth_code=123456
+Rand-String: YHYEglVGzYB8FIIKbify
+Timestamp-Sec: 1638503396
+Uuid: 1cb6c914-04d7-40fe-908f-73d202bb63ea
+X-Env-Flag: test-111
+User-Agent: Wechat
+```
 
 ### Benchmark
 

application/rule.go

@@ -90,9 +90,12 @@ func convertRegulationDTO(reg *types.RegulationDTO) *domain.Regulation {
 	if reg.Template != nil {
 		r.Template = &domain.Template{
 			IsTemplate:     reg.Template.IsTemplate,
+			RenderHeader:   reg.Template.RenderHeader,
 			Header:         reg.Template.Header,
+			HeaderTemplate: reg.Template.HeaderTemplate,
 			Body:           reg.Template.Body,
 			B64EncodedBody: reg.Template.B64EncodeBody,
+			StatusCode:     reg.Template.StatusCode, // 默认不传，设置为200
 		}
 		if reg.Template.StatusCode == 0 {
 			r.Template.StatusCode = http.StatusOK
@@ -126,11 +129,13 @@ func convertRegulationVO(reg *domain.Regulation) *types.RegulationDTO {
 	r := &types.RegulationDTO{
 		IsDefault: reg.IsDefault,
 		Template: &types.TemplateDTO{
-			IsTemplate:    reg.Template.IsTemplate,
-			Header:        reg.Template.Header,
-			StatusCode:    reg.Template.StatusCode,
-			Body:          reg.Template.Body,
-			B64EncodeBody: reg.Template.B64EncodedBody,
+			IsTemplate:     reg.Template.IsTemplate,
+			RenderHeader:   reg.Template.RenderHeader,
+			Header:         reg.Template.Header,
+			HeaderTemplate: reg.Template.HeaderTemplate,
+			StatusCode:     reg.Template.StatusCode,
+			Body:           reg.Template.Body,
+			B64EncodeBody:  reg.Template.B64EncodedBody,
 		},
 	}
 

domain/executor.go

@@ -67,8 +67,10 @@ type (
 	// TemplateExecutor 响应报文模板执行器
 	TemplateExecutor struct {
 		IsGolangTemplate bool
+		RenderHeader     bool
 		IsBinData        bool
 		template         *template.Template
+		headerTemplate   *template.Template
 		header           *fasthttp.ResponseHeader
 		body             []byte
 	}
@@ -270,24 +272,58 @@ func (fe *FilterExecutor) Filter(request *fasthttp.Request) bool {
 // Render 渲染函数
 func (te *TemplateExecutor) Render(ctx *fasthttp.RequestCtx, v map[string]interface{}, weight map[string]string) error {
 	te.header.CopyTo(&ctx.Response.Header)
+	rc := &RenderContext{}
+	if te.RenderHeader {
+		// 渲染header template
+		if err := te.handleHeaderTemplate(rc, ctx, v, weight); err != nil {
+			return err
+		}
+	}
 	if !te.IsGolangTemplate {
 		ctx.Response.SetBody(te.body)
 		return nil
 	}
 
-	// 开始渲染模板
-	var rc RenderContext
+	// 开始渲染body模板
+	if rc == nil {
+		rc.parseParams(ctx, v, weight)
+	}
+	return te.template.Execute(ctx.Response.BodyWriter(), rc)
+}
+
+// handleHeaderTemplate 处理header中的template
+func (te *TemplateExecutor) handleHeaderTemplate(rc *RenderContext, ctx *fasthttp.RequestCtx, v map[string]interface{}, weight map[string]string) error {
+	// parse params
+	rc.parseParams(ctx, v, weight)
+	// render template
+	var buf bytes.Buffer
+	if err := te.headerTemplate.Execute(&buf, rc); err != nil {
+		misc.Logger.Error(err.Error())
+		return err
+	}
+	// merge to ctx.response.header
+	headerToBeSet := make(map[string]string)
+	if err := json.Unmarshal(buf.Bytes(), &headerToBeSet); err != nil {
+		misc.Logger.Error(err.Error())
+		return err
+	}
+	for k, v := range headerToBeSet {
+		ctx.Response.Header.Set(k, v)
+	}
+	return nil
+}
+
+// parseParams 解析Request中的参数，供template渲染使用
+func (rc *RenderContext) parseParams(ctx *fasthttp.RequestCtx, v map[string]interface{}, weight map[string]string) {
 	h := extractHeaderAsParams(&ctx.Request)
 	q := extractQueryAsParams(&ctx.Request)
 	f, j := extractBodyAsParams(&ctx.Request)
-
 	rc.Variable = v
 	rc.Weight = weight
 	rc.Header = h
 	rc.Query = q
 	rc.Form = f
 	rc.Json = j
-	return te.template.Execute(ctx.Response.BodyWriter(), rc)
 }
 
 // Render 渲染函数
@@ -376,6 +412,11 @@ func dateDelta(date, layout string, year, month, day int) string {
 	return t.AddDate(year, month, day).Format(layout)
 }
 
+func HTMLUnescaped(x string) interface{} {
+	// do not encode HTML, like "&" --> "&"
+	return template.HTML(x)
+}
+
 func init() {
 	// create build-in template functions
 	defaultTemplateFuncs = make(template.FuncMap)
@@ -385,4 +426,5 @@ func init() {
 	_ = RegisterTemplateFunc("plus", plus)
 	_ = RegisterTemplateFunc("rand_string", misc.GenRandomString)
 	_ = RegisterTemplateFunc("date_delta", dateDelta)
+	_ = RegisterTemplateFunc("html_unescaped", HTMLUnescaped)
 }