跳到主要内容

单元测试示例

Github StackBlitz

本示例演示了如何使用 stretchr/testify 包为 Go Fiber 应用编写单元测试。

描述​

本项目提供了一个 Go Fiber 应用中单元测试的基本设置。它包含如何组织测试、编写测试用例以及使用 stretchr/testify 包进行断言的示例。

要求​

  • Go 1.18 或更高版本
  • Git

项目结构​

  • main.go: 应用的主入口点。
  • main_test.go: 包含单元测试的测试文件。
  • go.mod: Go 模块文件。

设置​

  1. 克隆仓库

    git clone https://github.com/gofiber/recipes.git
    cd recipes/unit-test

  2. 安装依赖项

    go mod download

运行测试​

要运行测试，请使用以下命令

go test ./...

示例用法​

main.go 文件设置了一个包含单个路由的简单 Fiber 应用。main_test.go 文件包含该应用的单元测试。

main.go​

该文件设置了一个基本的 Fiber 应用，包含一个返回 "OK" 的单个路由。

main_test.go​

该文件包含 Fiber 应用的单元测试。它使用 stretchr/testify 包进行断言。

package main

import (
 "io"
 "net/http"
 "testing"

 "github.com/stretchr/testify/assert"
)

func TestIndexRoute(t *testing.T) {
 tests := []struct {
  description string
  route string
  expectedError bool
  expectedCode int
  expectedBody string
 }{
  {
   description: "index route",
   route: "/",
   expectedError: false,
   expectedCode: 200,
   expectedBody: "OK",
  },
  {
   description: "non existing route",
   route: "/i-dont-exist",
   expectedError: false,
   expectedCode: 404,
   expectedBody: "Cannot GET /i-dont-exist",
  },
 }

 app := Setup()

 for _, test := range tests {
  req, _ := http.NewRequest("GET", test.route, nil)
  res, err := app.Test(req, -1)
  assert.Equalf(t, test.expectedError, err != nil, test.description)
  if test.expectedError {
   continue
  }
  assert.Equalf(t, test.expectedCode, res.StatusCode, test.description)
  body, err := io.ReadAll(res.Body)
  assert.Nilf(t, err, test.description)
  assert.Equalf(t, test.expectedBody, string(body), test.description)
 }
}

单元测试概述​

单元测试是一种软件测试方法，它独立于应用的其余部分测试软件的单个单元或组件。单元测试的目的是验证软件的每个单元是否按预期执行。单元测试通常是自动化的，由开发人员在开发过程中编写。

单元测试的益处​

  • 早期错误检测：单元测试有助于在开发周期的早期识别错误。
  • 文档：单元测试可以作为代码的文档。
  • 重构支持：在重构代码时，单元测试提供了安全网。
  • 设计：编写单元测试可以带来更好的软件设计。

在 Fiber 中进行单元测试​

Fiber 是一个受 Express 启发的 Go Web 框架。在 Fiber 中进行单元测试涉及测试单个路由和处理程序，以确保它们按预期运行。stretchr/testify 包常用于在 Go 测试中编写断言。

在 Fiber 中编写单元测试​

  1. 设置应用：创建一个函数来设置 Fiber 应用。这个函数可以在测试中重复使用。
  2. 定义测试用例：创建一个结构体来定义每个测试用例的输入和预期输出。
  3. 执行请求：使用 app.Test 方法执行 HTTP 请求并捕获响应。
  4. 断言：使用 stretchr/testify 包编写断言并验证响应。

app.Test 方法​

Fiber 中的 app.Test 方法用于模拟对 Fiber 应用的 HTTP 请求并测试响应。这对于单元测试特别有用，因为它可以在不启动实际服务器的情况下测试应用的路由和处理程序。

app.Test 方法的用法​

app.Test 方法接受两个参数

  1. req: 一个 *http.Request 对象，表示要测试的 HTTP 请求。
  2. timeout: 一个 int 值，指定请求允许的最大毫秒数。值为 -1 表示禁用超时。

该方法返回一个 *http.Response 和一个 error。*http.Response 包含应用对模拟请求的响应，error 指示请求处理过程中是否发生了任何错误。

示例​

下面是 app.Test 方法在单元测试中的使用示例

package main

import (
    "io"
    "net/http"
    "testing"

    "github.com/stretchr/testify/assert"
)

func TestIndexRoute(t *testing.T) {
    // Setup the app as it is done in the main function
    app := Setup()

    // Create a new HTTP request
    req, _ := http.NewRequest("GET", "/", nil)

    // Perform the request using app.Test
    res, err := app.Test(req, -1)

    // Verify that no error occurred
    assert.Nil(t, err)

    // Verify the status code
    assert.Equal(t, 200, res.StatusCode)

    // Read the response body
    body, _ := io.ReadAll(res.Body)

    // Verify the response body
    assert.Equal(t, "OK", string(body))
}

在此示例中，向应用的根路由 ("/") 发送一个 GET 请求。验证响应以确保状态码为 200 且响应文本为 "OK"。

结论​

本示例提供了一个 Go Fiber 应用中单元测试的基本设置。它可以进一步扩展和定制，以满足更复杂应用的需求。

参考资料​