Golang的REST API的单元测试

用不同的语言、不同的方法和设计模式构建RESTful api一直是一种趋势,就像学习过程中遇到的困难一样。这是因为代码中有很多抽象、启动项目的痛苦以及更多的原因。在此基础上,为实现的服务编写测试用例也是一件麻烦事。

Go为您提供了以非常简单,优雅和简洁的方式编写REST API的特权。除此之外,Go中的单元测试也非常简单,只需一个命令即可运行测试用例。

由于本文只是在Go中编写单元测试用例,我假设您将知道如何在Go中编写REST实现。

为了更深入地了解这个简单的赋值,您可以查看此示例

我已经附加了postman集合以便于导入,sql转储以及附加的自述文件,以便您可以开始使用简单的赋值。

所以让我们开始 -

如果我们考虑一个编写测试用例的例子会更好。假设我们想要一个Online Address Book创建地址簿的应用程序,其中包含以下字段 -

package main

type entry struct {
    ID           int    `json:"id,omitempty"`
    FirstName    string `json:"first_name,omitempty"`
    LastName     string `json:"last_name,omitempty"`
    EmailAddress string `json:"email_address,omitempty"`
    PhoneNumber  string `json:"phone_number,omitempty"`
}

Entry modal

我们将假设我们有端点GetEntriesGetEntryByIDCreateEntryUpdateEntryDeleteEntry

GetEntries -> "/entries" -> Method **GET**

GetEntryByID -> "/entry?id=1234" -> Method **GET**

CreateEntry -> "/entry" -> Method **POST**

UpdateEntry -> "/entry" -> Method **PUT**

DeleteEntry -> "/entry" -> Method **DELETE**


用于Go中的单元测试的包

  1. [testing](https://golang.org/pkg/testing/) - 这是一个内置的Golang包,用于实现和运行单元/自动化测试用例。它旨在使用go test带有可选参数的命令来接受要测试的go文件。
  2. [net/http/httptest](https://golang.org/pkg/net/http/httptest/) - 这也是一个内置的Golang包,它提供了进行HTTP测试的权限。在我们的例子中,我们希望记录来自端点的响应并进行相应的检查。

NOTE:避免使用断言。


写单元测试

在Go中编写单元测试用例可以在同一个包中,也可以在不同的包中。Go testing包有两个标准来标识测试用例。

  • 文件名应以_test。结尾。例如 -endpoints_test.go
  • 测试用例函数应该以Test开头。例如 -
func TestGetEntries(t *testing.T) { 
....
}

编写REST API端点的单元测试用例

让我们逐个测试每个端点,看看如何测试上面指定的示例中的所有端点例子,即GetEntriesGetEntryByIDGetEntryByIDNotFoundCreateEntryEditEntryDeleteEntry

让我们从编写以下测试用例开始 -

GetEntries测试案例 -

func TestGetEntries(t *testing.T) {
    req, err := http.NewRequest("GET", "/entries", nil)
    if err != nil {
        t.Fatal(err)
    }
    rr := httptest.NewRecorder()
    handler := http.HandlerFunc(GetEntries)
    handler.ServeHTTP(rr, req)
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v",
            status, http.StatusOK)
    }

    // Check the response body is what we expect.
    expected := `[{"id":1,"first_name":"Krish","last_name":"Bhanushali","email_address":"krishsb@g.com","phone_number":"0987654321"},{"id":2,"first_name":"xyz","last_name":"pqr","email_address":"xyz@pqr.com","phone_number":"1234567890"},{"id":6,"first_name":"FirstNameSample","last_name":"LastNameSample","email_address":"lr@gmail.com","phone_number":"1111111111"}]`
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v",
            rr.Body.String(), expected)
    }
}

TestGetEntries()

注意:上面指定的Github存储库不包含每个测试用例的单独go文件。我在一个go文件中指定了所有测试用例。

让我们get_entries_test.go一行一行 -

  • 第1-号行。请在此处注明功能名称。它首先Test使testing包识别出测试用例,而用例中的下一个单词也以大写字母开头。该函数有一个参数,它是指向testingT变量的指针,表示它是一个测试用例。
  • 第2行 - 这会向/entries端点创建新请求。
  • 第6行 - 创建一个新的记录器来记录entries端点收到的响应。
  • 8号线 - 用记录仪和请求命中终点。
  • 第9行 - 检查响应是否为200 OK。
  • 第10行 - 将错误标记发送为测试失败。
  • 第15行 - 是端点的预期输出。
  • 第16行 - 检查响应是否等于预期。

GetEntryByID测试用例 -

func TestGetEntryByID(t *testing.T) {

    req, err := http.NewRequest("GET", "/entry", nil)
    if err != nil {
        t.Fatal(err)
    }
    q := req.URL.Query()
    q.Add("id", "1")
    req.URL.RawQuery = q.Encode()
    rr := httptest.NewRecorder()
    handler := http.HandlerFunc(GetEntryByID)
    handler.ServeHTTP(rr, req)
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v",
            status, http.StatusOK)
    }

    // Check the response body is what we expect.
    expected := `{"id":1,"first_name":"Krish","last_name":"Bhanushali","email_address":"krishsb2405@gmail.com","phone_number":"0987654321"}`
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v",
            rr.Body.String(), expected)
    }
}

TestGetEntryByID()

GetEntryByIDNotFound测试用例 -

func TestGetEntryByIDNotFound(t *testing.T) {
    req, err := http.NewRequest("GET", "/entry", nil)
    if err != nil {
        t.Fatal(err)
    }
    q := req.URL.Query()
    q.Add("id", "123")
    req.URL.RawQuery = q.Encode()
    rr := httptest.NewRecorder()
    handler := http.HandlerFunc(GetEntryByID)
    handler.ServeHTTP(rr, req)
    if status := rr.Code; status == http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v",
            status, http.StatusBadRequest)
    }
}

TestGetEntryByIDNotFound()

CreateEntry测试用例 -

func TestCreateEntry(t *testing.T) {

    var jsonStr = []byte(`{"id":4,"first_name":"xyz","last_name":"pqr","email_address":"xyz@pqr.com","phone_number":"1234567890"}`)

    req, err := http.NewRequest("POST", "/entry", bytes.NewBuffer(jsonStr))
    if err != nil {
        t.Fatal(err)
    }
    req.Header.Set("Content-Type", "application/json")
    rr := httptest.NewRecorder()
    handler := http.HandlerFunc(CreateEntry)
    handler.ServeHTTP(rr, req)
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v",
            status, http.StatusOK)
    }
    expected := `{"id":4,"first_name":"xyz","last_name":"pqr","email_address":"xyz@pqr.com","phone_number":"1234567890"}`
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v",
            rr.Body.String(), expected)
    }
}

TestCreateEntry()

让我们create_entry_test.go一行一行地进行 -

第1-8行与上面的描述相同,其中输入是jsonStr条目对象的JSON字符串,我们使用新方法创建新请求POST

第9行 - 设置标题为Content-Typetoapplication/json

第9-22行 - 同样,发出请求并将响应与预期进行比较的情况相同。如果发出的请求不是200 OK或实际响应不等于预期响应,则测试用例失败。

EditEntry测试案例 -

func TestEditEntry(t *testing.T) {

    var jsonStr = []byte(`{"id":4,"first_name":"xyz change","last_name":"pqr","email_address":"xyz@pqr.com","phone_number":"1234567890"}`)

    req, err := http.NewRequest("PUT", "/entry", bytes.NewBuffer(jsonStr))
    if err != nil {
        t.Fatal(err)
    }
    req.Header.Set("Content-Type", "application/json")
    rr := httptest.NewRecorder()
    handler := http.HandlerFunc(UpdateEntry)
    handler.ServeHTTP(rr, req)
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v",
            status, http.StatusOK)
    }
    expected := `{"id":4,"first_name":"xyz change","last_name":"pqr","email_address":"xyz@pqr.com","phone_number":"1234567890"}`
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v",
            rr.Body.String(), expected)
    }
}

TestEditEntry()

EditEntry测试用例是相同的CreateEntry测试情况下,除了所述请求的方法是PUTEditEntry

DeleteEntry测试用例 -

func TestDeleteEntry(t *testing.T) {
    req, err := http.NewRequest("DELETE", "/entry", nil)
    if err != nil {
        t.Fatal(err)
    }
    q := req.URL.Query()
    q.Add("id", "4")
    req.URL.RawQuery = q.Encode()
    rr := httptest.NewRecorder()
    handler := http.HandlerFunc(DeleteEntry)
    handler.ServeHTTP(rr, req)
    if status := rr.Code; status != http.StatusOK {
        t.Errorf("handler returned wrong status code: got %v want %v",
            status, http.StatusOK)
    }
    expected := `{"id":4,"first_name":"xyz change","last_name":"pqr","email_address":"xyz@pqr.com","phone_number":"1234567890"}`
    if rr.Body.String() != expected {
        t.Errorf("handler returned unexpected body: got %v want %v",
            rr.Body.String(), expected)
    }
}

TestDeleteEntry()

DeleteEntry测试用例再次是相同的GetEntryByID测试情况下,除了所述请求的方法是DELETEDeleteEntry


运行测试用例

让我们首先启动服务器,以便我们的测试用例通过go run api.go entry.go考虑指定的示例来到达端点。

要在测试套件中运行所有测试用例,您可以执行以下操作 -

go test -v


运行测试套件

要运行一个测试用例,您只需使用以下操作 -

go test -v -run <Test Function Name>

运行一个测试用例,如:TestGetEntries

因此,我们可以在此得出结论,我们现在知道如何在Go中为RESTful API编写单元测试用例。

希望这可以帮助。

转:https://codeburst.io/unit-testing-for-rest-apis-in-go-86c70dada52d

推荐阅读更多精彩内容