This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

任务

通过任务学习 API Testing 实践。

1: 快速入门
2: gRPC TLS verification
3: gRPC测试用例编写指南
4: Mock Server 功能使用
5: 关于安全

1 - 快速入门

只需几个简单的步骤即可开始使用 API Testing。

本指南将帮助您通过几个简单的步骤开始使用 API Testing。

// TBD

2 - gRPC TLS verification

If you want to enable gRPC TLS, you need to generate your certificates in the workspace, or you can use an absolute path

1. 生成私钥

openssl genrsa -out server.key 2048

2. 生成证书（会提示即可，不必填写）

openssl req -new -x509 -key server.key -out server.crt -days 36500
国家名字
Country Name (2 letter code) [AU]:CN
省份全名
State or Province Name (full name) [Some-State]:GuangDong
城市名
Locality Name (eg, city) []:Meizhou
组织名
Organization Name (eg, company) [Internet Widgits Pty Ltd]:Xuexiangban
组织单位名
Organizational Unit Name (eg, section) []:go
服务器or用户的名字
Common Name (e.g. server FQDN or YOUR name) []:kuangstudy
邮箱地址
Email Address []:24736743@qq.com

3.生成csr

openssl req -new -key server.key -out server.csr

4.配置openssl.cfg

1) 查找openssl在服务器的安装目录并且找到openssl.cnf
2) 编辑[ CA_default ] ，打开 copy_extensions = copy #取消注释
3) 找到[ req ]，打开 req_extensions = v3.req #取消注释
4) 找到[ v3_req ]，添加字段 subjectAltName = @alt_names
5) 添加新的标签在最底部 [ alt_names ]和标签字段
DNS.1 = localhost

5.生成本地私钥test.key

openssl genpkey -algorithm RSA -out test.key

6.根据私钥生成csr请求文件test.csr

openssl req -new -nodes -key test.key -out test.csr -days 3650 \
-subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=www.example.com" \
-config ./openssl.cnf -extensions v3_req

7.生成ca证书 pem

openssl x509 -req -days 365 -in test.csr \
-out test.pem -CA server.crt -CAkey server.key \
-CAcreateserial -extfile ./openssl.cnf -extensions v3_req

3 - gRPC测试用例编写指南

本文档将介绍如何编写api-testing的 gRPC API 的测试用例。

阅读本文档之前，您需要先安装并配置好api-testing，具体操作可以参考安装章节。如果您已经完成了这些步骤，可以继续阅读本文档的后续部分。

创建测试项目

创建一个基于服务反射的 gRPC 测试用例仅需在 yaml 文件的spec路径下加入以下内容：

spec:
  rpc:
    serverReflection: true

rpc字段一共有五个子字段

字段名	类型	是否可选
import	[]string	√
protofile	string	√
protoset	string	√
serverReflection	bool	√

字段`import`和`protofile`

protofile是一个文件路径，指向api-testing查找描述符的.proto文件的位置。

import字段与protc编译器中的--import_path参数类似，用于确定查找proto文件的位置与解析依赖的目录。与protoc一样，您不需要在此处指定某些proto文件的位置（以google.protobuf开头的Protocol Buffers Well-Known Types），它们已经内置在了api-testing中。

字段`protoset`

protoset字段既可以是一个文件路径，也可以是http(s)://开头的网络地址。

当您的proto数量繁多或引用关系复杂，可以尝试使用protoc --descriptor_set_out=set.pb生成proto描述符集合。本质上它是一个使用了wire编码的二进制文件，其中包括了所有需要的描述符。

字段`serverReflection`

若目标服务器支持服务反射，将此项设为true则不再需要提供上述三个字段。

注：api-testing对三种描述符来源的优先级顺序为

serverReflection > protoset > protofile

编写gRPC API测试

与编写HTTP测试用例类型，您需要在根节点的api字段定义服务器的地址。

api: 127.0.0.1:7070

默认情况下api-testing使用不安全的方式连接到目标服务器。若您想配置TLS证书，请参考文档关于安全

编写gRPC API测试的方式与编写HTTP API测试的方式基本相同。

- name: FunctionsQuery
  request:
    api: /server.Runner/FunctionsQuery
    body: |
      {
        "name": "hello"
      }      
  expect:
    body: |
      {
        "data": [
          {
            "key": "hello",
            "value": "func() string"
          }
        ]
      }

api字段的格式为/package.service/method，支持 gRPC 一元调用、客户端流、服务端流和双向流调用。

与api字段同级的body字段是以JSON格式表示的Protocol Buffers消息，代表将要调用的api的入参。特别的，当您需要调用客户端流或双向流 API 时，请使用JSON Array格式编写字段body，如：

body: |
  [
    {
      "name": "hello"
    },
    {
      "name": "title"
    }
  ]

编写返回内容验证

编写gRPC API返回内容验证的方式与HTTP API基本相同。对与gRPC API来说，一切返回值都被视为map类型，被放入api testing特定的返回结构中：

expect:
  body: |
    {
      "data": [
        {
          "key": "hello",
          "value": "func() string"
        }
      ]
    }

api-testing为JSON比对编写了一套对比库，请参考此处compare

请注意，对于服务端流和双向流模式，服务器发送多条消息的情况下，此处的data字段内的填写的目标数组，需同时满足与待验证数组长度相，两个数组同一下标的内容完全相同。

gRPC API的verify功能与HTTP API保持一致，此处不再赘述。

4 - Mock Server 功能使用

Get started

您可以通过执行下面的命令 mock 一个容器仓库服务container registry:

atest mock --prefix / mock/image-registry.yaml

之后，您可以通过使用如下的命令使用 mock 功能。

docker pull localhost:6060/repo/name:tag

5 - 关于安全

通常在不使用 TLS 证书认证时，gRPC 客户端与服务端之间进行的是明文通信，信息易被第三方监听或篡改。所以大多数情况下均推荐使用 SSL/TLS 保护 gRPC 服务。目前atest已实现服务端 TLS，双向 TLS(mTLS) 需等待后续实现。

默认情况下atest不使用任何安全策略，等价于spec.secure.insecure = true。启用 TLS 仅需 yaml 中添加以下内容：

spec:
  secure:
    cert: server.pem
    serverName: atest

字段说明

secure共有以下五个字段：

字段名	类型	是否可选
cert	string	x
ca	string	√
key	string	√
serverName	string	x
insecure	bool	√

cert为客户端需要配置的证书的文件路径，格式为PEM。

serverName为 TLS 所需的服务名，通常为签发证书时使用的 x509 SAN。

ca为 CA 证书的路径，key为与cert对应的私钥，这两项填写后代表启用 mTLS。(mTLS 尚未实现)

当insecure为false时，cert和serverName为必填项。

任务