Kong testing framework

bungle · March 19, 2018, 8:16pm

What do you mean?

With this we execute the tests:

Kong/kong/blob/master/bin/busted

#!/usr/bin/env resty

local DEFAULT_RESTY_FLAGS="-c 4096"

if not os.getenv("KONG_BUSTED_RESPAWNED") then
  -- initial run, so go update the environment
  local script = {}
  for line in io.popen("set"):lines() do
    local ktvar, val = line:match("^KONG_TEST_([^=]*)=(.*)")
    if ktvar then
      -- reinserted KONG_TEST_xxx as KONG_xxx; append
      table.insert(script, "export KONG_" .. ktvar .. "=" ..val)
    end

    local var = line:match("^(KONG_[^=]*)")
    local var_for_spec = line:match("^(KONG_SPEC_[^=]*)")
    if var and not var_for_spec then
      -- remove existing KONG_xxx and KONG_TEST_xxx variables; prepend
      table.insert(script, 1, "unset " .. var)
    end

This file has been truncated. show original

Here is tests:

There’s the helper:

github.com

Kong/kong/blob/master/spec/helpers.lua

------------------------------------------------------------------
-- Collection of utilities to help testing Kong features and plugins.
--
-- @copyright Copyright 2016-2020 Kong Inc. All rights reserved.
-- @license [Apache 2.0](https://opensource.org/licenses/Apache-2.0)
-- @module spec.helpers

local BIN_PATH = "bin/kong"
local TEST_CONF_PATH = os.getenv("KONG_SPEC_TEST_CONF_PATH") or "spec/kong_tests.conf"
local CUSTOM_PLUGIN_PATH = "./spec/fixtures/custom_plugins/?.lua"
local DNS_MOCK_LUA_PATH = "./spec/fixtures/mocks/lua-resty-dns/?.lua"
local GO_PLUGIN_PATH = "./spec/fixtures/go"
local MOCK_UPSTREAM_PROTOCOL = "http"
local MOCK_UPSTREAM_SSL_PROTOCOL = "https"
local MOCK_UPSTREAM_HOST = "127.0.0.1"
local MOCK_UPSTREAM_HOSTNAME = "localhost"
local MOCK_UPSTREAM_PORT = 15555
local MOCK_UPSTREAM_SSL_PORT = 15556
local MOCK_UPSTREAM_STREAM_PORT = 15557
local MOCK_UPSTREAM_STREAM_SSL_PORT = 15558

This file has been truncated. show original

Here’s mock endpoint:

github.com

Kong/kong/blob/master/spec/fixtures/custom_nginx.template#L238-L375


            proxy_set_header      X-Forwarded-For   $upstream_x_forwarded_for;
            proxy_set_header      X-Forwarded-Proto $upstream_x_forwarded_proto;
            proxy_set_header      X-Forwarded-Host  $upstream_x_forwarded_host;
            proxy_set_header      X-Forwarded-Port  $upstream_x_forwarded_port;
            proxy_set_header      X-Real-IP         $remote_addr;
            proxy_pass_header     Server;
            proxy_pass_header     Date;
            proxy_ssl_name        $upstream_host;
            proxy_ssl_server_name on;
> if client_ssl then
            proxy_ssl_certificate ${{CLIENT_SSL_CERT}};
            proxy_ssl_certificate_key ${{CLIENT_SSL_CERT_KEY}};
> end
            proxy_pass            $upstream_scheme://kong_upstream$upstream_uri;
        }

        location = /kong_error_handler {
            internal;
            default_type                 '';

This file has been truncated. show original

Please check tests inside spec how they are implemented.

Yes, we are looking forward for better testing tools, but right now that is what we use. We also have other tests, such as migrations tests:

Topic		Replies	Views
[SOLVED]I want to run kong's spec Questions	3	1137	March 26, 2019
How to mock kong variable using Busted Questions	3	2349	June 11, 2019
Setup for developing/testing kong plugins	2	605	April 14, 2024
Test custom plugins without cloning full Kong repository Questions	1	521	October 26, 2018
Cant' run tests, ./kong/pdk/init.lua:209: in main chunk Questions	2	1659	October 14, 2019

Kong testing framework

Related topics