add more document of mock

Author: LinuxSuRen

docs/site/content/zh/about/index.md

@@ -5,7 +5,7 @@ linkTitle: 关于
 
 {{% blocks/cover title="About API Testing" height="auto" %}}
 
-API Testing 是一个接口调试和测试工具的开源项目。
+API Testing （atest）是一个接口调试和测试工具的开源项目。
 
 请继续阅读以了解更多信息，或访问我们的 [文档](/latest/) 开始使用！
 
@@ -20,4 +20,3 @@ API Testing 是一个接口调试和测试工具的开源项目。
 // TBD.
 
 {{% /blocks/section %}}
-

docs/site/content/zh/latest/tasks/mock-server.md

@@ -16,56 +16,120 @@ atest mock --prefix / --port 9090 mock.yaml
 
 在 UI 上可以实现和命令行相同的功能，并可以通过页面编辑的方式修改、加载 Mock 服务配置。
 
+## Mock Docker Registry
+
+您可以通过执行下面的命令 mock 一个容器仓库服务[container registry](https://distribution.github.io/distribution/):
+
+```shell
+atest mock --prefix / mock/image-registry.yaml
+```
+
+之后，您可以通过使用如下的命令使用 mock 功能。
+
+```shell
+docker pull localhost:6060/repo/name:tag
+```
+
 ## 语法
 
 从整体上来看，我们的写法和 HTTP 的名称基本保持一致，用户无需再了解额外的名词。此外，提供两种描述 Mock 服务的方式：
 
-* 针对某个数据对象的 CRUD
-* 任意 HTTP 服务
+* 面向对象的 CRUD
+* 自定义 HTTP 服务
 
-下面是一个具体的例子：
+### 面对对象
 
 ```yaml
 #!api-testing-mock
 # yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-mock-schema.json
 objects:
-  - name: repo
-    fields:
-      - name: name
-        kind: string
-      - name: url
-        kind: string
   - name: projects
     initCount: 3
     sample: |
       {
-        "name": "api-testing",
+        "name": "atest",
         "color": "{{ randEnum "blue" "read" "pink" }}"
       }
+```
+
+上面 `projects` 的配置，会自动提供该对象的 CRUD（创建、查找、更新、删除）的 API，你可以通过 `atest` 或类似工具发出 HTTP 请求。例如：
+
+```shell
+curl http://localhost:6060/mock/projects
+
+curl http://localhost:6060/mock/projects/atest
+
+curl http://localhost:6060/mock/projects -X POST -d '{"name": "new"}'
+
+curl http://localhost:6060/mock/projects -X PUT -d '{"name": "new", "remark": "this is a project"}'
+
+curl http://localhost:6060/mock/projects/atest -X DELETE
+```
+
+> `initCount` 是指按照 `sample` 给定的数据初始化多少个对象；如果没有指定的话，则默认值为 1.
+
+### 自定义
+
+```yaml
+#!api-testing-mock
+# yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-mock-schema.json
 items:
-  - name: base64
-    request:
-      path: /v1/base64
-    response:
-      body: aGVsbG8=
-      encoder: base64
   - name: prList
     request:
       path: /v1/repos/{repo}/prs
-      header:
-        name: rick
     response:
       header:
         server: mock
+        Content-Type: application/json
       body: |
         {
           "count": 1,
           "items": [{
-            "title": "fix: there is a bug on page {{ randEnum "one" }}",
+            "title": "fix: there is a bug on page {{ randEnum "one", "two" }}",
             "number": 123,
             "message": "{{.Response.Header.server}}",
             "author": "someone",
             "status": "success"
           }]
         }
 ```
+
+启动 Mock 服务后，我们就可以发起如下的请求：
+
+```shell
+curl http://localhost:6060/mock/v1/repos/atest/prs -v
+```
+
+另外，为了满足复杂的场景，还可以对 Response Body 做特定的解码，目前支持：`base64`、`url`：
+
+```yaml
+#!api-testing-mock
+# yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-mock-schema.json
+items:
+  - name: base64
+    request:
+      path: /v1/base64
+    response:
+      body: aGVsbG8=
+      encoder: base64
+```
+
+上面 Body 的内容是经过 `base64` 编码的，这可以用于不希望直接明文显示，或者是图片的场景：
+
+```shell
+curl http://localhost:6060/mock/v1/base64
+```
+
+如果你的 Body 内容可以通过另外一个 HTTP 请求（GET）获得，那么你可以这么写：
+
+```
+#!api-testing-mock
+# yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-mock-schema.json
+items:
+  - name: baidu
+    request:
+      path: /v1/baidu
+    response:
+      body: https://baidu.com
+      encoder: url
+```

docs/site/content/zh/latest/tasks/mock.md

@@ -0,0 +1,10 @@
+#!api-testing-mock
+# yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-mock-schema.json
+objects:
+  - name: projects
+    initCount: 3
+    sample: |
+      {
+        "name": "atest",
+        "color": "{{ randEnum "blue" "read" "pink" }}"
+      }

docs/mock/image-registry.yaml renamed to docs/site/content/zh/latest/tasks/mock/image-registry.yaml

@@ -1,17 +1,32 @@
 #!api-testing-mock
 # yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-mock-schema.json
-objects:
-  - name: users
-    initCount: 1
-    sample: |
-      {
-        "username": "sss",
-        "email": "{{randEmail}}",
-        "age": 12
-      }
-  - name: roles
-    sample: |
-      {
-        "name": "admin",
-        "description": "this is a role"
-      }
+items:
+  - name: prList
+    request:
+      path: /v1/repos/{repo}/prs
+    response:
+      header:
+        server: mock
+      body: |
+        {
+          "count": 1,
+          "items": [{
+            "title": "fix: there is a bug on page {{ randEnum "one" }}",
+            "number": 123,
+            "message": "{{.Response.Header.server}}",
+            "author": "someone",
+            "status": "success"
+          }]
+        }
+  - name: base64
+    request:
+      path: /v1/base64
+    response:
+      body: aGVsbG8=
+      encoder: base64
+  - name: baidu
+    request:
+      path: /v1/baidu
+    response:
+      body: https://baidu.com
+      encoder: url

docs/site/content/zh/latest/tasks/mock/object.yaml

@@ -122,43 +122,6 @@ func (s *inMemoryServer) Start(reader Reader, prefix string) (err error) {
 
 func (s *inMemoryServer) startObject(obj Object) {
 	// create a simple CRUD server
-	s.mux.HandleFunc(fmt.Sprintf("/%s/{%s}", obj.Name, obj.Name), func(w http.ResponseWriter, req *http.Request) {
-		fmt.Println("mock server received request", req.URL.Path)
-		method := req.Method
-		w.Header().Set(util.ContentType, util.JSON)
-
-		objName := strings.TrimPrefix(req.URL.Path, s.prefix+"/"+obj.Name+"/")
-
-		switch method {
-		case http.MethodGet:
-			// list all items
-			for _, item := range s.data[obj.Name] {
-				if item["name"] == objName {
-					data, err := json.Marshal(item)
-					writeResponse(w, data, err)
-					return
-				}
-			}
-		case http.MethodDelete:
-			// delete an item
-			for i, item := range s.data[obj.Name] {
-				if item["name"] == objName {
-					if len(s.data[obj.Name]) == i+1 {
-						s.data[obj.Name] = s.data[obj.Name][:i]
-					} else {
-						s.data[obj.Name] = append(s.data[obj.Name][:i], s.data[obj.Name][i+1])
-					}
-
-					writeResponse(w, []byte(`{"msg": "deleted"}`), nil)
-					return
-				}
-			}
-		default:
-			w.WriteHeader(http.StatusMethodNotAllowed)
-			return
-		}
-		writeResponse(w, []byte(`{"msg": "not found"}`), fmt.Errorf("not found"))
-	})
 	s.mux.HandleFunc("/"+obj.Name, func(w http.ResponseWriter, req *http.Request) {
 		fmt.Println("mock server received request", req.URL.Path)
 		method := req.Method
@@ -174,7 +137,7 @@ func (s *inMemoryServer) startObject(obj Object) {
 				exclude := false
 
 				for k, v := range req.URL.Query() {
-					if v == nil || len(v) == 0 {
+					if len(v) == 0 {
 						continue
 					}
 
@@ -238,29 +201,48 @@ func (s *inMemoryServer) startObject(obj Object) {
 		}
 	})
 
-	// get a single object
+	// handle a single object
 	s.mux.HandleFunc(fmt.Sprintf("/%s/{name:[a-z]+}", obj.Name), func(w http.ResponseWriter, req *http.Request) {
-		if req.Method != http.MethodGet {
-			w.WriteHeader(http.StatusMethodNotAllowed)
-			return
-		}
-
 		w.Header().Set(util.ContentType, util.JSON)
 		objects := s.data[obj.Name]
 		if objects != nil {
 			name := mux.Vars(req)["name"]
-
+			var data []byte
 			for _, obj := range objects {
 				if obj["name"] == name {
 
-					data, err := json.Marshal(obj)
-					writeResponse(w, data, err)
-					return
+					data, _ = json.Marshal(obj)
+					break
+				}
+			}
+
+			if len(data) == 0 {
+				w.WriteHeader(http.StatusNotFound)
+				return
+			}
+
+			method := req.Method
+			switch method {
+			case http.MethodGet:
+				writeResponse(w, data, nil)
+			case http.MethodDelete:
+				for i, item := range s.data[obj.Name] {
+					if item["name"] == name {
+						if len(s.data[obj.Name]) == i+1 {
+							s.data[obj.Name] = s.data[obj.Name][:i]
+						} else {
+							s.data[obj.Name] = append(s.data[obj.Name][:i], s.data[obj.Name][i+1])
+						}
+
+						writeResponse(w, []byte(`{"msg": "deleted"}`), nil)
+					}
 				}
+			default:
+				w.WriteHeader(http.StatusMethodNotAllowed)
 			}
+
 		}
 	})
-	return
 }
 
 func (s *inMemoryServer) startItem(item Item) {

docs/site/content/zh/latest/tasks/mock/simple.yaml

@@ -95,10 +95,7 @@ func TestInMemoryServer(t *testing.T) {
 	})
 
 	// delete object
-	delReq, err := http.NewRequest(http.MethodDelete, api+"/team", bytes.NewBufferString(`{
-		"name": "test",
-		"members": []
-	}`))
+	delReq, err := http.NewRequest(http.MethodDelete, api+"/team/test", nil)
 	assert.NoError(t, err)
 	resp, err = http.DefaultClient.Do(delReq)
 	assert.NoError(t, err)
@@ -111,6 +108,11 @@ func TestInMemoryServer(t *testing.T) {
 			assert.NoError(t, err)
 			assert.Equal(t, `[{"name":"someone"}]`, string(data))
 		}
+
+		resp, err = http.Get(api + "/team/test")
+		if assert.NoError(t, err) {
+			assert.Equal(t, http.StatusNotFound, resp.StatusCode)
+		}
 	})
 
 	t.Run("invalid request method", func(t *testing.T) {
@@ -122,7 +124,7 @@ func TestInMemoryServer(t *testing.T) {
 	})
 
 	t.Run("only accept GET method in getting a single object", func(t *testing.T) {
-		wrongMethodReq, err := http.NewRequest(http.MethodPut, api+"/team/test", nil)
+		wrongMethodReq, err := http.NewRequest(http.MethodPut, api+"/team/someone", nil)
 		assert.NoError(t, err)
 		resp, err = http.DefaultClient.Do(wrongMethodReq)
 		assert.NoError(t, err)