API 测试

API（Application Programming Interface）测试 的自动化是软件测试最基本的一种类型。从本质上来说，API 测试是用来验证组成软件的那些单个方法的正确性，而不是测试整个系统本身。

API 测试也称为单元测试（Unit Testing）、模块测试（Module Testing）、组件测试（Component Testing）以及元件测试（Element Testing）。从技术上来说，这些术语是有很大的差别的，但是在日常应用中，你可以认为它们是大致相同的意思。它们背后的思想就是，必须确定系统中每个单独的模块工作正常，否则，这个系统作为一个整体不可能是正确的。毫无疑问，API 测试对于任何重要的软件系统来说都是必不可少的。

我们对 API 测试的定位是服务对外输出的 API 接口测试，属于黑盒、偏重业务的测试步骤。

看过上一章内容的朋友还记得 lua-resty-test，我们的 API 测试同样也是需要它来完成。 get_client_tasks 是终端用来获取当前可执行任务清单的 API，我们用它当做例子给大家做个介绍。

nginx conf:

  1. location ~* /api/([\w_]+?)\.json {
  2.     content_by_lua_file lua/$1.lua;
  3. }
  5. location ~* /unit_test/([\w_]+?)\.json {
  6.     lua_check_client_abort on;
  7.     content_by_lua_file test_case_lua/unit/$1.lua;
  8. }

API 测试代码：

  1. -- unit test for /api/get_client_tasks.json
  2. local tb = require("resty.iresty_test")
  3. local json = require("cjson")
  4. local test = tb.new({unit_name="get_client_tasks"})
  6. function tb:init()
  7.     self.mid = string.rep('0',32)
  8. end
  10. function tb:test_0000()
  11.     -- 正常请求
  12.     local res = ngx.location.capture(
  13.         '/api/get_client_tasks.json?mid='..self.mid,
  14.         { method = ngx.HTTP_POST, body=[[{"type":[1600,1700]}]] }
  15.     )
  17.     if 200 ~= res.status then
  18.         error("failed code:" .. res.status)
  19.     end
  20. end
  22. function tb:test_0001()
  23.     -- 缺少body
  24.     local res = ngx.location.capture(
  25.         '/api/get_client_tasks.json?mid='..self.mid,
  26.         { method = ngx.HTTP_POST }
  27.     )
  29.     if 400 ~= res.status then
  30.         error("failed code:" .. res.status)
  31.     end
  32. end
  34. function tb:test_0002()
  35.     -- 错误的json内容
  36.     local res = ngx.location.capture(
  37.         '/api/get_client_tasks.json?mid='..self.mid,
  38.         { method = ngx.HTTP_POST, body=[[{"type":"[1600,1700]}]] }
  39.     )
  41.     if 400 ~= res.status then
  42.         error("failed code:" .. res.status)
  43.     end
  44. end
  46. function tb:test_0003()
  47.     -- 错误的json格式
  48.     local res = ngx.location.capture(
  49.         '/api/get_client_tasks.json?mid='..self.mid,
  50.         { method = ngx.HTTP_POST, body=[[{"type":"[1600,1700]"}]] }
  51.     )
  53.     if 400 ~= res.status then
  54.         error("failed code:" .. res.status)
  55.     end
  56. end
  58. test:run()

Nginx output:

  1. 0.000  [get_client_tasks] unit test start
  2. 0.001    \_[test_0000] PASS
  3. 0.001    \_[test_0001] PASS
  4. 0.001    \_[test_0002] PASS
  5. 0.001    \_[test_0003] PASS
  6. 0.001  [get_client_tasks] unit test complete

使用 ngx.location.capture 来模拟请求，其实是不靠谱的。如果我们要完全 100% 模拟客户请求，这时候就要使用第三方 cosocket 库，例如 lua-resty-http，这样我们才可以完全指定 http 参数。