Unit test plugins

Lorin_Totah · January 10, 2018, 2:53pm

I would like to make unit test to each plugin we wrote, from what I can see in the Kong project they only doing integration tests including DB use, also i didn’t find any plugin that come with tests.
There is any way to do unit tests and stub NGX?
I tried with busted but I had trouble stubbing all the NGX functionally.

Thanks,
Lorin.

bungle · January 10, 2018, 2:58pm

You can use resty, e.g. that’s what we use:

github.com

Kong/kong/blob/master/bin/busted

#!/usr/bin/env resty

do
  local lines = getmetatable(io.output()).lines

  getmetatable(io.output()).lines = function(self, ...)
    local iter = lines(self, ...)

    return function()
      local ok, ret = pcall(iter)
      if ok then
        return ret
      end
    end
  end
end

if not os.getenv("KONG_BUSTED_RESPAWNED") then
  -- initial run, so go update the environment
  local script = {}

This file has been truncated. show original

Of course some APIs in ngx.*space are not available to timer phase on which resty runs its code, so beware of that.

bungle · January 10, 2018, 3:00pm

Many standard OpenResty libraries use test-nginx, so that is one option as well. You need perl for that: