現在有一個需求那就是，我們需要使用Golang的net/http包中的http.Get(url)方法去向伺服器端請求資料，但是負責服務端的同事並沒有將介面實現（可能是同事太忙，把妹，喝酒，扯淡， XO等等）以至於你只知道返回資料的json格式，然而無法請求到真實的資料，但是你的工作進度並不能因為同事而耽誤，需要測試你的程式碼的正確性，那麼怎麼辦？辦法就是通過單元測試中的httptest，實現http server，並設定好返回值，那麼http.Get(url)的請求就會直接打到單元測試的http server上，同時得到你設定好的返回值，你就可以繼續去處理資料，測試你的程式碼邏輯了。

一、匯入

設定一個場景：

需要向伺服器端去獲取住址為"shanghai"的所有人的資訊，請求函式為：

func GetInfo(api string) ([]Person, error) 

1.向服務端傳送get請求獲取資料

2.將資料序列化person的資訊

3.如果出現錯誤，返回error

需要測試的內容：

1.需要測試返回值是我們設定的值：

var personResponse = []Person{
			  {
				Name : "wahaha",
				Address : "shanghai",
				Age : 20,
			  },
	                  {
				Name : "lebaishi",
				Address : "shanghai",
				Age : 10,
			  },
 			}
 

3.返回狀態碼是否正確。

二、Golang testing基礎

Go提供了一個testing包來寫單元測試。假設我們有個檔案叫person.go，那麼我們的測試檔案就需要明明為person_test.go：

package person

import (
	"testing"
)

func TestPublishUnreachable(t *testing.T) {
	api := "http://localhost:8090"
	_, err := GetInfo(api)
	if err != nil {
		t.Errorf("GetInfo() return an error")
	}
}
 

>測試函式以Test*開頭。

>測試函式將*testing.T作為引數，可以在失敗的情況下使用Errorf()方法。

>在包內使用go test來執行單元測試。

這個單元測試將會失敗，因為我們還沒有實現GetInfo()方法，下面是person.go檔案：

package person

import (
	"net/http"
	"fmt"
)

const (
	ADDRESS = "shanghai"
)

type Person struct {
	Name string `json:"name"`
	Address string `json:"address"`
	Age int `json:"age"`
}

func GetInfo(api string) ([]Person, error) {
	url := fmt.Sprintf("%s/person?addr=%s", api, ADDRESS)
	resp, err := http.Get(url)

	if err != nil {
		return []Person{}, err
	}

	if resp.StatusCode != http.StatusOK {
		return []Person{}, fmt.Errorf("get info didn’t respond 200 OK: %s", resp.Status)
	}

	return nil, nil
}

三、Golang httptest

上面一個例子很有用，但是如何去傳送一個真正的http request而不去真正的啟動一個http server（亦或者請求任意的server）？答案是使用Go 的httptest包，這個包可以非常簡單的建立一個測試的http server，那麼下面我們將展示一下完整的程式碼，並解釋一下整體的測試流程：

person.go：

package person

import (
	"net/http"
	"fmt"
	"io/ioutil"
	"encoding/json"

	"github.com/astaxie/beego/logs"
)

const (
	ADDRESS = "shanghai"
)

type Person struct {
	Name string `json:"name"`
	Address string `json:"address"`
	Age int `json:"age"`
}

func GetInfo(api string) ([]Person, error) {
	url := fmt.Sprintf("%s/person?addr=%s", api, ADDRESS)
	resp, err := http.Get(url)

	defer resp.Body.Close()

	if err != nil {
		return []Person{}, err
	}

	if resp.StatusCode != http.StatusOK {
		return []Person{}, fmt.Errorf("get info didn’t respond 200 OK: %s", resp.Status)
	}

	bodyBytes, _ := ioutil.ReadAll(resp.Body)
	personList := make([]Person,0)
	err = json.Unmarshal(bodyBytes, &personList)
	if err != nil {
		logs.Error("decode data fail")
		return []Person{}, fmt.Errorf("decode data fail")
	}

	return personList, nil
}

person_test.go：

package person

import (
	"testing"
	"net/http/httptest"
	"net/http"
	"fmt"
	"encoding/json"
)

var personResponse = []Person{
			  {
				Name : "wahaha",
				Address : "shanghai",
				Age : 20,
			  },
	                  {
				Name : "lebaishi",
				Address : "shanghai",
				Age : 10,
			  },
 			}

var personResponseBytes, _ = json.Marshal(personResponse)

func TestPublishWrongResponseStatus(t *testing.T) {
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
		w.Write(personResponseBytes)
		if r.Method != "GET"{
			t.Errorf("Expected 'GET' request, got '%s'", r.Method)
		}
		if r.URL.EscapedPath() != "/person" {
			t.Errorf("Expected request to '/person', got '%s'", r.URL.EscapedPath())
		}
		r.ParseForm()
		topic := r.Form.Get("addr")
		if topic != "shanghai" {
			t.Errorf("Expected request to have 'addr=shanghai', got: '%s'", topic)
		}
	}))

	defer ts.Close()
	api := ts.URL
	fmt.Println("url:", api)
	resp, _ := GetInfo(api)

	fmt.Println("reps:", resp)
}

>我們通過httptest.NewServer建立了一個測試的http server

>讀請求設定通過變數r *http.Request，寫變數（也就是返回值）通過w http.ResponseWriter

>通過ts.URL來獲取請求的URL（一般都是<http://ip:port>）

>通過r.Method來獲取請求的方法，來測試判斷我們的請求方法是否正確

>獲取請求路徑：r.URL.EscapedPath()，本例中的請求路徑就是"/person"

>獲取請求引數：r.ParseForm，r.Form.Get("addr")

>設定返回的狀態碼：w.WriteHeader(http.StatusOK)

>設定返回的內容（這就是我們想要的結果）：w.Write(personResponseBytes)，注意w.Write()接收的引數是[]byte，因此需要將object物件列表通過json.Marshal(personResponse)轉換成位元組。

綜上，我們可以通過不傳送httptest來模擬出httpserver和返回值來進行自己程式碼的測試了。

Author：憶之獨秀

Email：[email protected]