Golang实现高效HTTP API端到端测试的插件库baloo的使用

baloo是一个基于Go语言开发的HTTP API端到端测试库，构建在gentleman HTTP客户端工具包之上，提供了表达性强且多功能的API测试能力。

特性

• 内置多种断言功能
• 可扩展的自定义断言
• 声明式、表达力强的流畅API
• 响应体匹配和严格相等断言
• 深度JSON比较
• JSON Schema验证
• 基于gentleman的全功能HTTP客户端
• 直观语义化的HTTP客户端DSL
• 易于配置和使用
• 可组合的链式断言
• 与Go的testing包兼容
• 对Go的HTTP原语提供了方便的抽象
• 基于gentleman的中间件层
• 可扩展和可定制的API

安装

go get -u gopkg.in/h2non/baloo.v3

要求

• Go 1.7+

示例

简单的请求测试

package simple

import (
  "testing"

  "gopkg.in/h2non/baloo.v3"
)

// test存储预配置的HTTP测试客户端
var test = baloo.New("http://httpbin.org")

func TestBalooSimple(t *testing.T) {
  test.Get("/get").
    SetHeader("Foo", "Bar").
    Expect(t).
    Status(200).
    Header("Server", "apache").
    Type("json").
    JSON(map[string]string{"bar": "foo"}).
    Done()
}

自定义断言函数

package custom_assertion

import (
  "errors"
  "net/http"
  "testing"

  "gopkg.in/h2non/baloo.v3"
)

// test存储预配置的HTTP测试客户端
var test = baloo.New("http://httpbin.org")

// assert实现了一个带有自定义验证逻辑的断言函数
// 如果断言失败，它应该返回一个错误
func assert(res *http.Response, req *http.Request) error {
  if res.StatusCode >= 400 {
    return errors.New("Invalid server response (> 400)")
  }
  return nil
}

func TestBalooClient(t *testing.T) {
  test.Post("/post").
    SetHeader("Foo", "Bar").
    JSON(map[string]string{"foo": "bar"}).
    Expect(t).
    Status(200).
    Type("json").
    AssertFunc(assert).
    Done()
}

JSON Schema断言

package json_schema

import (
  "testing"

  "gopkg.in/h2non/baloo.v3"
)

const schema = `{
  "title": "Example Schema",
  "type": "object",
  "properties": {
    "origin": {
      "type": "string"
    }
  },
  "required": ["origin"]
}`

// test存储预配置的HTTP测试客户端
var test = baloo.New("http://httpbin.org")

func TestJSONSchema(t *testing.T) {
  test.Get("/ip").
    Expect(t).
    Status(200).
    Type("json").
    JSONSchema(schema).
    Done()
}

通过别名自定义全局断言

package alias_assertion

import (
  "errors"
  "net/http"
  "testing"

  "gopkg.in/h2non/baloo.v3"
)

// test存储预配置的HTTP测试客户端
var test = baloo.New("http://httpbin.org")

func assert(res *http.Response, req *http.Request) error {
  if res.StatusCode >= 400 {
    return errors.New("Invalid server response (> 400)")
  }
  return nil
}

func init() {
  // 在全局级别注册断言函数
  baloo.AddAssertFunc("test", assert)
}

func TestBalooClient(t *testing.T) {
  test.Post("/post").
    SetHeader("Foo", "Bar").
    JSON(map[string]string{"foo": "bar"}).
    Expect(t).
    Status(200).
    Type("json").
    Assert("test").
    Done()
}

HTTP断言方法

Status(code int)

断言响应HTTP状态码是否相等

StatusRange(start, end int)

断言响应HTTP状态码是否在给定的数值范围内

StatusOk()

断言响应HTTP状态码是否为有效的服务器响应(>= 200 && < 400)

StatusError()

断言响应HTTP状态码是否为有效的客户端/服务器错误响应(>= 400 && < 600)

StatusServerError()

断言响应HTTP状态码是否为有效的服务器错误响应(>= 500 && < 600)

StatusClientError()

断言响应HTTP状态码是否为有效的客户端错误响应(>= 400 && < 500)

Type(kind string)

断言Content-Type头。可以使用MIME类型别名作为kind参数。

支持的别名：json、xml、html、form、text和urlencoded

Header(key, value string)

断言响应头字段值是否匹配

可以使用正则表达式作为值来执行特定的断言

HeaderEquals(key, value string)

断言响应头字段是否等于给定值

HeaderNotEquals(key, value string)

断言响应头字段是否不等于给定值

HeaderPresent(key string)

断言响应头字段是否存在

HeaderNotPresent(key string)

断言响应头字段是否不存在

BodyEquals(value string)

使用严格比较断言响应体

可以使用正则表达式作为值来执行特定的断言

BodyMatchString(pattern string)

断言响应体是否匹配字符串表达式

可以使用正则表达式作为值来执行特定的断言

BodyLength(length int)

断言响应体长度

JSON(match interface{})

使用给定的JSON结构断言响应体

JSONSchema(schema string)

根据给定的JSON schema定义断言响应体

data参数可以是包含JSON schema的string，也可以是文件路径或指向JSON schema定义的URL

Assert(alias string)

通过别名名称添加新的断言函数

断言函数必须通过baloo.AddAssertFunc(“alias”, function)预先注册

AssertFunc(func (*http.Response, *http.Request) error)

添加一个新的自定义断言函数，如果断言失败，它应该返回一个详细的错误