单元测试

本文原文链接：https://docs.konghq.com/1.1.x/plugin-development/tests/

介绍

如果你认真对待你写的插件，你可能想为它编写一些测试。Lua的单元测试很简单，并且可以使用许多测试框架。但是，您可能还想编写集成测试。Kong可以再次为您提供支援。

编写集成测试

Kong的首选测试框架是busted，它与resty-cli解释器一起运行，但如果您愿意，可以自由使用另一个。在Kong存储库中，可以在bin/busted找到 busted 的可执行文件。

Kong为您提供了一个帮助程序，可以在测试套件中从Lua启动和停止它：spec.helpers。此助手还提供了在运行测试之前在数据存储区中插入fixtures的方法，以及删除，以及各种其他helper。

如果您在自己的存储库中编写插件，则需要复制以下文件，直到Kong测试框架发布：

  • bin/busted： 与resty-cli解释器一起运行的 busted 的可执行文件
  • spec/helpers.lua：Kong的helper函数 可以从busted中 启动/关闭kong
  • spec/kong_tests.conf：使用helpers模块运行的Kong实例的配置文件

假设您的LUA_PATH中有spec.helpers模块，您可以使用以下Lua代码来启动和停止Kong：

  1. local helpers = require "spec.helpers"
  3. for _, strategy in helpers.each_strategy() do
  4.   describe("my plugin", function()
  6.     local bp = helpers.get_db_utils(strategy)
  8.     setup(function()
  9.       local service = bp.services:insert {
  10.         name = "test-service",
  11.         host = "httpbin.org"
  12.       }
  14.       bp.routes:insert({
  15.         hosts = { "test.com" },
  16.         service = { id = service.id }
  17.       })
  19.       -- start Kong with your testing Kong configuration (defined in "spec.helpers")
  20.       assert(helpers.start_kong( { plugins = "bundled,my-plugin" }))
  22.       admin_client = helpers.admin_client()
  23.     end)
  25.     teardown(function()
  26.       if admin_client then
  27.         admin_client:close()
  28.       endhttps://github.com/Kong/kong/tree/master/spec/03-plugins/09-key-auth
  30.       helpers.stop_kong()
  31.     end)
  33.     before_each(function()
  34.       proxy_client = helpers.proxy_client()
  35.     end)
  37.     after_each(function()
  38.       if proxy_client then
  39.         proxy_client:close()
  40.       end
  41.     end)
  43.     describe("thing", function()
  44.       it("should do thing", function()
  45.         -- send requests through Kong
  46.         local res = proxy_client:get("/get", {
  47.           headers = {
  48.             ["Host"] = "test.com"
  49.           }
  50.         })
  52.         local body = assert.res_status(200, res)
  54.         -- body is a string containing the response
  55.       end)
  56.     end)
  57.   end)
  58. end

提醒：通过test Kong配置文件，Kong运行在代理监听端口9000(HTTP),9443 (HTTPS)和端口9001上的Admin API。

如果想看一下真实的例子，可以来这里看一看 Key-Auth plugin specs