第九章完成

zhima1234 · zhima1234 · commit eff077d48cbc · 2017-10-09T19:52:31.000+08:00
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -24,7 +24,7 @@
  - 5.2 math/big — 大数实现
  - 5.3 math/cmplx — 复数基本函数操作
  - 5.4 math/rand — 伪随机数生成器
-* 第六章 [文件系统](chapter06/06.0.md)
+* [第六章 文件系统](chapter06/06.0.md)
  - 6.1 [os — 平台无关的操作系统功能实现](chapter06/06.1.md)
  - 6.2 [path/filepath — 操作路径](chapter06/06.2.md)
 * [第七章 数据持久存储与交换](chapter07/07.0.md)
@@ -40,21 +40,21 @@
  - 8.4 compress/bzip2 — bzip2 压缩
  - 8.5 archive/tar — tar 归档访问
  - 8.6 archive/zip — zip 归档访问
-* 第九章 [测试](chapter09/09.0.md)
+* [第九章 测试](chapter09/09.0.md)
  - 9.1 [testing - 单元测试](chapter09/09.1.md)
  - 9.2 [testing - 基准测试](chapter09/09.2.md)
  - 9.3 [testing - 子测试](chapter09/09.3.md)
  - 9.4 [testing - 运行并验证示例](chapter09/09.4.md)
  - 9.5 [testing - 其他功能](chapter09/09.5.md)
  - 9.6 [httptest - HTTP 测试辅助工具](chapter09/09.6.md)
-* 第十章 [进程、线程与 goroutine](chapter10/10.0.md)
+* [第十章 进程、线程与 goroutine](chapter10/10.0.md)
  - 10.1 [创建进程](chapter10/10.1.md)
  - 10.2 [进程属性和控制](chapter10/10.2.md)
  - 10.3 [线程](chapter10/10.3.md)
  - 10.4 [进程间通信](chapter10/10.4.md)
 * 第十一章 网络通信与互联网 (Internet)
 * 第十二章 email
-* 第十三章 [应用构建 与 debug](chapter13/13.0.md)
+* [第十三章 应用构建 与 debug](chapter13/13.0.md)
  - 13.1 [flag - 命令行参数解析](chapter13/13.1.md)
  - 13.2 [log - 日志记录](chapter13/13.2.md)
  - 13.3 [expvar - 公共变量的标准化接口](chapter13/13.3.md)
diff --git a/chapter09/09.6.md b/chapter09/09.6.md
@@ -1,9 +1,155 @@
 # httptest - HTTP 测试辅助工具 #
 
-httptest 包提供了进行 HTTP 测试所需的设施。
+由于 Go 标准库的强大支持，Go 可以很容易的进行 Web 开发。为此，Go 标准库专门提供了 httptest 包专门用于进行 http Web 开发测试。
 
-## 测试 http.Handler ##
+本节我们通过一个社区帖子的增删改查的例子来学习该包。
 
+## 简单的 Web 应用
+
+我们首先构建一个简单的 Web 应用。
+
+为了简单起见，数据保存在内存，并且没有考虑并发问题。
+
+```go
+// 保存 Topic，没有考虑并发问题
+var TopicCache = make([]*Topic, 0, 16)
+
+type Topic struct {
+	Id        int       `json:"id"`
+	Title     string    `json:"title"`
+	Content   string    `json:"content"`
+	CreatedAt time.Time `json:"created_at"`
+}
+```
+对于 Topic 的增删改查代码很简单，可以查看[完整代码](code/src/chapter09/httptest/data.go)。
+
+接下来，是通过 http 包来实现一个 Web 应用。
+
+```go
+func main() {
+	http.HandleFunc("/topic/", handleRequest)
+	http.ListenAndServe(":2017", nil)
+}
+...
+```
+`/topic/` 开头的请求都交由 `handleRequest` 处理，它根据不同的 `Method` 执行相应的增删改查，详细代码可以查看 [server.go](code/src/chapter09/httptest/server.go)。
+
+准备好 Web 应用后，我们启动它。
+
+> go run server.go data.go
+
+通过 curl 进行简单的测试：
+
+> 增：curl -i -X POST http://localhost:2017/topic/ -H 'content-type: application/json' -d '{"title":"The Go Standard Library","content":"It contains many packages."}'
+
+> 查：curl -i -X GET http://localhost:2017/topic/1
+
+> 改：curl -i -X PUT http://localhost:2017/topic/1 -H 'content-type: application/json' -d '{"title":"The Go Standard Library By Example","content":"It contains many packages, enjoying it."}'
+
+> 删：curl -i -X DELETE http://localhost:2017/topic/1
+
+## 通过 httptest 进行测试
+
+上面，我们通过 curl 对我们的 Web 应用的接口进行了测试。现在，我们通过 httptest 进行测试。
+
+我们先测试创建帖子，也就是测试 `handlePost` 函数。
+
+```go
+func TestHandlePost(t *testing.T) {
+	mux := http.NewServeMux()
+	mux.HandleFunc("/topic/", handleRequest)
+
+	reader := strings.NewReader(`{"title":"The Go Standard Library","content":"It contains many packages."}`)
+	r, _ := http.NewRequest(http.MethodPost, "/topic/", reader)
+
+	w := httptest.NewRecorder()
+
+	mux.ServeHTTP(w, r)
+	
+	resp := w.Result()
+	if resp.StatusCode != http.StatusOK {
+		t.Errorf("Response code is %v", resp.StatusCode)
+	}
+}
+```
+首先跟待测试代码一样，配置上路由，对 `/topic/` 的请求都交由 `handleRequest ` 处理。
+
+```go
+mux := http.NewServeMux()
+mux.HandleFunc("/topic/", handleRequest)
+```
+
+因为 `handlePost` 的签名是 `func handlePost(w http.ResponseWriter, r *http.Request) error`，为了测试它，我们必须创建 `http.ResponseWriter` 和 `http.Request` 的实例。
+
+接下来的代码就是创建一个 `http.Request` 实例 和 一个 `http.ReponseWriter` 的实例。这里的关键是，`httptest` 为我们提供了一个 `http.ReponseWriter` 接口的实现结构：`httptest.ReponseRecorder`，通过它可以得到一个 `http.ReponseWriter`。
+
+```go
+reader := strings.NewReader(`{"title":"The Go Standard Library","content":"It contains many packages."}`)
+r, _ := http.NewRequest(http.MethodPost, "/topic/", reader)
+
+w := httptest.NewRecorder()
+```
+
+准备好之后，可以测试目标函数了。这里，我们没有直接调用 `handlePost(w, r)`，而是调用 `mux.ServeHTTP(w, r)`，实际上这里直接调用 `handlePost(w, r)` 也是可以的，但调用 `mux.ServeHTTP(w, r)` 更完整的测试了整个流程。`mux.ServeHTTP(w, r)` 最终会调用 `handlePost(w, r)`。
+
+最后，通过 `go test -v` 运行测试。
+
+查、改和删帖子的接口测试代码类似，比如，`handleGet` 的测试代码如下：
+
+```go
+func TestHandleGet(t *testing.T) {
+	mux := http.NewServeMux()
+	mux.HandleFunc("/topic/", handleRequest)
+
+	r, _ := http.NewRequest(http.MethodGet, "/topic/1", nil)
+
+	w := httptest.NewRecorder()
+
+	mux.ServeHTTP(w, r)
+	
+	resp := w.Result()
+	if resp.StatusCode != http.StatusOK {
+		t.Errorf("Response code is %v", resp.StatusCode)
+	}
+
+	topic := new(Topic)
+	json.Unmarshal(w.Body.Bytes(), topic)
+	if topic.Id != 1 {
+		t.Errorf("Cannot get topic")
+	}
+}
+```
+
+*注意：因为数据没有落地存储，为了保证后面的测试正常，请将 `TestHandlePost` 放在最前面。*
+
+## 测试代码改进
+
+细心的朋友应该会发现，上面的测试代码有重复，比如：
+
+```go
+mux := http.NewServeMux()
+mux.HandleFunc("/topic/", handleRequest)
+```
+
+还有：`w := httptest.NewRecorder()`。
+
+这正好是前面学习的 `setup` 可以做的事情，因此可以使用 `TestMain` 来做重构。
+
+```go
+var w *httptest.ResponseRecorder
+
+func TestMain(m *testing.M) {
+	http.DefaultServeMux.HandleFunc("/topic/", handleRequest)
+
+	w = httptest.NewRecorder()
+
+	os.Exit(m.Run())
+}
+```
+
+# 导航 #
+
+- 上一节：[testing - 其他功能](09.5.md)
+- [第十章 进程、线程与 goroutine](chapter10/10.0.md)
 
 
-    
diff --git a/code/src/chapter09/httptest/data.go b/code/src/chapter09/httptest/data.go
@@ -0,0 +1,56 @@
+package main
+
+import (
+	"errors"
+	"time"
+)
+
+// 保存 Topic，没有考虑并发问题
+var TopicCache = make([]*Topic, 0, 16)
+
+type Topic struct {
+	Id        int       `json:"id"`
+	Title     string    `json:"title"`
+	Content   string    `json:"content"`
+	CreatedAt time.Time `json:"created_at"`
+}
+
+func FindTopic(id int) (*Topic, error) {
+	if err := checkIndex(id); err != nil {
+		return nil, err
+	}
+
+	return TopicCache[id-1], nil
+}
+
+func (t *Topic) Create() error {
+	t.Id = len(TopicCache) + 1
+	t.CreatedAt = time.Now()
+	TopicCache = append(TopicCache, t)
+	return nil
+}
+
+func (t *Topic) Update() error {
+	if err := checkIndex(t.Id); err != nil {
+		return err
+	}
+	TopicCache[t.Id-1] = t
+	return nil
+}
+
+// 简单的将对应的 slice 位置置为 nil
+func (t *Topic) Delete() error {
+	if err := checkIndex(t.Id); err != nil {
+		return err
+	}
+	TopicCache[t.Id-1] = nil
+	return nil
+}
+
+func checkIndex(id int) error {
+	if id > 0 && len(TopicCache) <= id-1 {
+		return errors.New("The topic is not exists!")
+	}
+
+	return nil
+}
diff --git a/code/src/chapter09/httptest/server.go b/code/src/chapter09/httptest/server.go
@@ -1,18 +1,113 @@
 package main
 
 import (
-	"log"
+	"encoding/json"
 	"net/http"
+	"path"
+	"strconv"
 )
 
 func main() {
-	http.Handle("/httptest", new(MyHandler))
+	http.HandleFunc("/topic/", handleRequest)
 
-	log.Fatal(http.ListenAndServe(":8080", nil))
+	http.ListenAndServe(":2017", nil)
 }
 
-type MyHandler func(http.ResponseWriter, *http.Request)
+// main handler function
+func handleRequest(w http.ResponseWriter, r *http.Request) {
+	var err error
+	switch r.Method {
+	case http.MethodGet:
+		err = handleGet(w, r)
+	case http.MethodPost:
+		err = handlePost(w, r)
+	case http.MethodPut:
+		err = handlePut(w, r)
+	case http.MethodDelete:
+		err = handleDelete(w, r)
+	}
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+}
+
+// 获取一个帖子
+// 如 GET /topic/1
+func handleGet(w http.ResponseWriter, r *http.Request) error {
+	id, err := strconv.Atoi(path.Base(r.URL.Path))
+	if err != nil {
+		return err
+	}
+	topic, err := FindTopic(id)
+	if err != nil {
+		return err
+	}
+	output, err := json.MarshalIndent(&topic, "", "\t\t")
+	if err != nil {
+		return err
+	}
+	w.Header().Set("Content-Type", "application/json")
+	w.Write(output)
+	return nil
+}
+
+// 增加一个帖子
+// POST /topic/
+func handlePost(w http.ResponseWriter, r *http.Request) (err error) {
+	body := make([]byte, r.ContentLength)
+	r.Body.Read(body)
+	var topic = new(Topic)
+	err = json.Unmarshal(body, &topic)
+	if err != nil {
+		return
+	}
+
+	err = topic.Create()
+	if err != nil {
+		return
+	}
+	w.WriteHeader(http.StatusOK)
+	return
+}
+
+// 更新一个帖子
+// PUT /topic/1
+func handlePut(w http.ResponseWriter, r *http.Request) error {
+	id, err := strconv.Atoi(path.Base(r.URL.Path))
+	if err != nil {
+		return err
+	}
+	topic, err := FindTopic(id)
+	if err != nil {
+		return err
+	}
+	body := make([]byte, r.ContentLength)
+	r.Body.Read(body)
+	json.Unmarshal(body, topic)
+	err = topic.Update()
+	if err != nil {
+		return err
+	}
+	w.WriteHeader(http.StatusOK)
+	return nil
+}
 
-func (self MyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
-	self(w, r)
+// 删除一个帖子
+// DELETE /topic/1
+func handleDelete(w http.ResponseWriter, r *http.Request) (err error) {
+	id, err := strconv.Atoi(path.Base(r.URL.Path))
+	if err != nil {
+		return
+	}
+	topic, err := FindTopic(id)
+	if err != nil {
+		return
+	}
+	err = topic.Delete()
+	if err != nil {
+		return
+	}
+	w.WriteHeader(http.StatusOK)
+	return
 }
diff --git a/code/src/chapter09/httptest/server_test.go b/code/src/chapter09/httptest/server_test.go
