From 09cb4e2be3ab7549b4357d352cd67ca67346ef95 Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Wed, 4 Sep 2024 17:16:09 +0800
Subject: [PATCH 01/13] cmd & pid

---
 spec/details/cmd.lua | 395 +++++++++++++++++++++++++++++++++++++++++++
 spec/details/pid.lua |  70 ++++++++
 2 files changed, 465 insertions(+)
 create mode 100644 spec/details/cmd.lua
 create mode 100644 spec/details/pid.lua

diff --git a/spec/details/cmd.lua b/spec/details/cmd.lua
new file mode 100644
index 000000000000..4315df59351a
--- /dev/null
+++ b/spec/details/cmd.lua
@@ -0,0 +1,395 @@
+local lfs = require("lfs")
+local pl_dir = require("pl.dir")
+local pl_path = require("pl.path")
+local pl_utils = require("pl.utils")
+local constants = require("kong.constants")
+local conf_loader = require("kong.conf_loader")
+local kong_table = require("kong.tools.table")
+local prefix_handler = require("kong.cmd.utils.prefix_handler")
+
+
+local CONSTANTS = require("spec.details.constants")
+local shell = require("spec.details.shell")
+local pid = require("spec.details.pid")
+local DB = require("spec.details.db")
+local dns_mock = require("spec.details.dns")
+
+
+local conf = shell.conf
+local kong_exec = shell.kong_exec
+
+
+local config_yml
+
+
+local function build_go_plugins(path)
+  if pl_path.exists(pl_path.join(path, "go.mod")) then
+    local ok, _, stderr = shell.run(string.format(
+            "cd %s; go mod tidy; go mod download", path), nil, 0)
+    assert(ok, stderr)
+  end
+  for _, go_source in ipairs(pl_dir.getfiles(path, "*.go")) do
+    local ok, _, stderr = shell.run(string.format(
+            "cd %s; go build %s",
+            path, pl_path.basename(go_source)
+    ), nil, 0)
+    assert(ok, stderr)
+  end
+end
+
+
+--- Prepares the Kong environment.
+-- Creates the working directory if it does not exist.
+-- @param prefix (optional) path to the working directory, if omitted the test
+-- configuration will be used
+-- @function prepare_prefix
+local function prepare_prefix(prefix)
+  return pl_dir.makepath(prefix or conf.prefix)
+end
+
+
+--- Cleans the Kong environment.
+-- Deletes the working directory if it exists.
+-- @param prefix (optional) path to the working directory, if omitted the test
+-- configuration will be used
+-- @function clean_prefix
+local function clean_prefix(prefix)
+
+  -- like pl_dir.rmtree, but ignore mount points
+  local function rmtree(fullpath)
+    if pl_path.islink(fullpath) then return false,'will not follow symlink' end
+    for root,dirs,files in pl_dir.walk(fullpath,true) do
+      if pl_path.islink(root) then
+        -- sub dir is a link, remove link, do not follow
+        local res, err = os.remove(root)
+        if not res then
+          return nil, err .. ": " .. root
+        end
+
+      else
+        for i,f in ipairs(files) do
+          f = pl_path.join(root,f)
+          local res, err = os.remove(f)
+          if not res then
+            return nil,err .. ": " .. f
+          end
+        end
+
+        local res, err = pl_path.rmdir(root)
+        -- skip errors when trying to remove mount points
+        if not res and shell.run("findmnt " .. root .. " 2>&1 >/dev/null", nil, 0) == 0 then
+          return nil, err .. ": " .. root
+        end
+      end
+    end
+    return true
+  end
+
+  prefix = prefix or conf.prefix
+  if pl_path.exists(prefix) then
+    local _, err = rmtree(prefix)
+    if err then
+      error(err)
+    end
+  end
+end
+
+
+local function render_fixtures(conf, env, prefix, fixtures)
+
+  if fixtures and (fixtures.http_mock or fixtures.stream_mock) then
+    -- prepare the prefix so we get the full config in the
+    -- hidden `.kong_env` file, including test specified env vars etc
+    assert(kong_exec("prepare --conf " .. conf, env))
+    local render_config = assert(conf_loader(prefix .. "/.kong_env", nil,
+                                             { from_kong_env = true }))
+
+    for _, mocktype in ipairs { "http_mock", "stream_mock" } do
+
+      for filename, contents in pairs(fixtures[mocktype] or {}) do
+        -- render the file using the full configuration
+        contents = assert(prefix_handler.compile_conf(render_config, contents))
+
+        -- write file to prefix
+        filename = prefix .. "/" .. filename .. "." .. mocktype
+        assert(pl_utils.writefile(filename, contents))
+      end
+    end
+  end
+
+  if fixtures and fixtures.dns_mock then
+    -- write the mock records to the prefix
+    assert(getmetatable(fixtures.dns_mock) == dns_mock,
+           "expected dns_mock to be of a helpers.dns_mock class")
+    assert(pl_utils.writefile(prefix .. "/dns_mock_records.json",
+                              tostring(fixtures.dns_mock)))
+
+    -- add the mock resolver to the path to ensure the records are loaded
+    if env.lua_package_path then
+      env.lua_package_path = CONSTANTS.DNS_MOCK_LUA_PATH .. ";" .. env.lua_package_path
+    else
+      env.lua_package_path = CONSTANTS.DNS_MOCK_LUA_PATH
+    end
+  else
+    -- remove any old mocks if they exist
+    os.remove(prefix .. "/dns_mock_records.json")
+  end
+
+  return true
+end
+
+
+--- Return the actual configuration running at the given prefix.
+-- It may differ from the default, as it may have been modified
+-- by the `env` table given to start_kong.
+-- @function get_running_conf
+-- @param prefix (optional) The prefix path where the kong instance is running,
+-- defaults to the prefix in the default config.
+-- @return The conf table of the running instance, or nil + error.
+local function get_running_conf(prefix)
+  local default_conf = conf_loader(nil, {prefix = prefix or conf.prefix})
+  return conf_loader.load_config_file(default_conf.kong_env)
+end
+
+
+--- Clears the logfile. Will overwrite the logfile with an empty file.
+-- @function clean_logfile
+-- @param logfile (optional) filename to clear, defaults to the current
+-- error-log file
+-- @return nothing
+-- @see line
+local function clean_logfile(logfile)
+  logfile = logfile or (get_running_conf() or conf).nginx_err_logs
+
+  assert(type(logfile) == "string", "'logfile' must be a string")
+
+  local fh, err, errno = io.open(logfile, "w+")
+
+  if fh then
+    fh:close()
+    return
+
+  elseif errno == 2 then -- ENOENT
+    return
+  end
+
+  error("failed to truncate logfile: " .. tostring(err))
+end
+
+
+--- Start the Kong instance to test against.
+-- The fixtures passed to this function can be 3 types:
+--
+-- * DNS mocks
+--
+-- * Nginx server blocks to be inserted in the http module
+--
+-- * Nginx server blocks to be inserted in the stream module
+-- @function start_kong
+-- @param env table with Kong configuration parameters (and values)
+-- @param tables list of database tables to truncate before starting
+-- @param preserve_prefix (boolean) if truthy, the prefix will not be cleaned
+-- before starting
+-- @param fixtures tables with fixtures, dns, http and stream mocks.
+-- @return return values from `execute`
+-- @usage
+-- -- example mocks
+-- -- Create a new DNS mock and add some DNS records
+-- local fixtures = {
+--   http_mock = {},
+--   stream_mock = {},
+--   dns_mock = helpers.dns_mock.new()
+-- }
+--
+-- **DEPRECATED**: http_mock fixture is deprecated. Please use `spec.helpers.http_mock` instead.
+--
+-- fixtures.dns_mock:A {
+--   name = "a.my.srv.test.com",
+--   address = "127.0.0.1",
+-- }
+--
+-- -- The blocks below will be rendered by the Kong template renderer, like other
+-- -- custom Kong templates. Hence the `${{xxxx}}` values.
+-- -- Multiple mocks can be added each under their own filename ("my_server_block" below)
+-- fixtures.http_mock.my_server_block = [[
+--      server {
+--          server_name my_server;
+--          listen 10001 ssl;
+--
+--          ssl_certificate ${{SSL_CERT}};
+--          ssl_certificate_key ${{SSL_CERT_KEY}};
+--          ssl_protocols TLSv1.2 TLSv1.3;
+--
+--          location ~ "/echobody" {
+--            content_by_lua_block {
+--              ngx.req.read_body()
+--              local echo = ngx.req.get_body_data()
+--              ngx.status = status
+--              ngx.header["Content-Length"] = #echo + 1
+--              ngx.say(echo)
+--            }
+--          }
+--      }
+--    ]]
+--
+-- fixtures.stream_mock.my_server_block = [[
+--      server {
+--        -- insert stream server config here
+--      }
+--    ]]
+--
+-- assert(helpers.start_kong( {database = "postgres"}, nil, nil, fixtures))
+local function start_kong(env, tables, preserve_prefix, fixtures)
+  if tables ~= nil and type(tables) ~= "table" then
+    error("arg #2 must be a list of tables to truncate")
+  end
+  env = env or {}
+  local prefix = env.prefix or conf.prefix
+
+  -- go plugins are enabled
+  --  compile fixture go plugins if any setting mentions it
+  for _,v in pairs(env) do
+    if type(v) == "string" and v:find(CONSTANTS.GO_PLUGIN_PATH) then
+      build_go_plugins(CONSTANTS.GO_PLUGIN_PATH)
+      break
+    end
+  end
+
+  -- note: set env var "KONG_TEST_DONT_CLEAN" !! the "_TEST" will be dropped
+  if not (preserve_prefix or os.getenv("KONG_DONT_CLEAN")) then
+    clean_prefix(prefix)
+  end
+
+  local ok, err = prepare_prefix(prefix)
+  if not ok then return nil, err end
+
+  DB.truncate_tables(DB.db, tables)
+
+  local nginx_conf = ""
+  local nginx_conf_flags = { "test" }
+  if env.nginx_conf then
+    nginx_conf = " --nginx-conf " .. env.nginx_conf
+  end
+
+  if CONSTANTS.TEST_COVERAGE_MODE == "true" then
+    -- render `coverage` blocks in the templates
+    nginx_conf_flags[#nginx_conf_flags + 1] = 'coverage'
+  end
+
+  if next(nginx_conf_flags) then
+    nginx_conf_flags = " --nginx-conf-flags " .. table.concat(nginx_conf_flags, ",")
+  else
+    nginx_conf_flags = ""
+  end
+
+  local dcbp = DB.get_dcbp()
+  if dcbp and not env.declarative_config and not env.declarative_config_string then
+    if not config_yml then
+      config_yml = prefix .. "/config.yml"
+      local cfg = dcbp.done()
+      local declarative = require "kong.db.declarative"
+      local ok, err = declarative.to_yaml_file(cfg, config_yml)
+      if not ok then
+        return nil, err
+      end
+    end
+    env = kong_table.cycle_aware_deep_copy(env)
+    env.declarative_config = config_yml
+  end
+
+  assert(render_fixtures(CONSTANTS.TEST_CONF_PATH .. nginx_conf, env, prefix, fixtures))
+  return kong_exec("start --conf " .. CONSTANTS.TEST_CONF_PATH .. nginx_conf .. nginx_conf_flags, env)
+end
+
+
+-- Cleanup after kong test instance, should be called if start_kong was invoked with the nowait flag
+-- @function cleanup_kong
+-- @param prefix (optional) the prefix where the test instance runs, defaults to the test configuration.
+-- @param preserve_prefix (boolean) if truthy, the prefix will not be deleted after stopping
+-- @param preserve_dc ???
+local function cleanup_kong(prefix, preserve_prefix, preserve_dc)
+  -- remove socket files to ensure `pl.dir.rmtree()` ok
+  prefix = prefix or conf.prefix
+  local socket_path = pl_path.join(prefix, constants.SOCKET_DIRECTORY)
+  for child in lfs.dir(socket_path) do
+    local path = pl_path.join(socket_path, child)
+    if lfs.attributes(path, "mode") == "socket" then
+      os.remove(path)
+    end
+  end
+
+  -- note: set env var "KONG_TEST_DONT_CLEAN" !! the "_TEST" will be dropped
+  if not (preserve_prefix or os.getenv("KONG_DONT_CLEAN")) then
+    clean_prefix(prefix)
+  end
+
+  if not preserve_dc then
+    config_yml = nil
+  end
+  ngx.ctx.workspace = nil
+end
+
+
+-- Stop the Kong test instance.
+-- @function stop_kong
+-- @param prefix (optional) the prefix where the test instance runs, defaults to the test configuration.
+-- @param preserve_prefix (boolean) if truthy, the prefix will not be deleted after stopping
+-- @param preserve_dc ???
+-- @param signal (optional string) signal name to send to kong, defaults to TERM
+-- @param nowait (optional) if truthy, don't wait for kong to terminate.  caller needs to wait and call cleanup_kong
+-- @return true or nil+err
+local function stop_kong(prefix, preserve_prefix, preserve_dc, signal, nowait)
+  prefix = prefix or conf.prefix
+  signal = signal or "TERM"
+
+  local running_conf, err = get_running_conf(prefix)
+  if not running_conf then
+    return nil, err
+  end
+
+  local pid, err = pid.get_pid_from_file(running_conf.nginx_pid)
+  if not pid then
+    return nil, err
+  end
+
+  local ok, _, err = shell.run(string.format("kill -%s %d", signal, pid), nil, 0)
+  if not ok then
+    return nil, err
+  end
+
+  if nowait then
+    return running_conf.nginx_pid
+  end
+
+  pid.wait_pid(running_conf.nginx_pid)
+
+  cleanup_kong(prefix, preserve_prefix, preserve_dc)
+
+  return true
+end
+
+--- Restart Kong. Reusing declarative config when using `database=off`.
+-- @function restart_kong
+-- @param env see `start_kong`
+-- @param tables see `start_kong`
+-- @param fixtures see `start_kong`
+-- @return true or nil+err
+local function restart_kong(env, tables, fixtures)
+  stop_kong(env.prefix, true, true)
+  return start_kong(env, tables, true, fixtures)
+end
+
+
+return {
+  start_kong = start_kong,
+  cleanup_kong = cleanup_kong,
+  stop_kong = stop_kong,
+  restart_kong = restart_kong,
+
+  prepare_prefix = prepare_prefix,
+  clean_prefix = clean_prefix,
+
+  get_running_conf = get_running_conf,
+  clean_logfile = clean_logfile,
+}
+
diff --git a/spec/details/pid.lua b/spec/details/pid.lua
new file mode 100644
index 000000000000..3da8ca7bad30
--- /dev/null
+++ b/spec/details/pid.lua
@@ -0,0 +1,70 @@
+local shell = require("resty.shell")
+
+
+local CONSTANTS = require("spec.details.constants")
+
+
+-- Reads the pid from a pid file and returns it, or nil + err
+local function get_pid_from_file(pid_path)
+  local pid
+  local fd, err = io.open(pid_path)
+  if not fd then
+    return nil, err
+  end
+
+  pid = fd:read("*l")
+  fd:close()
+
+  return pid
+end
+
+
+local function pid_dead(pid, timeout)
+  local max_time = ngx.now() + (timeout or 10)
+
+  repeat
+    if not shell.run("ps -p " .. pid .. " >/dev/null 2>&1", nil, 0) then
+      return true
+    end
+    -- still running, wait some more
+    ngx.sleep(0.05)
+  until ngx.now() >= max_time
+
+  return false
+end
+
+
+-- Waits for the termination of a pid.
+-- @param pid_path Filename of the pid file.
+-- @param timeout (optional) in seconds, defaults to 10.
+local function wait_pid(pid_path, timeout, is_retry)
+  local pid = get_pid_from_file(pid_path)
+
+  if CONSTANTS.TEST_COVERAGE_MODE == "true" then
+    timeout = CONSTANTS.TEST_COVERAGE_TIMEOUT
+  end
+
+  if pid then
+    if pid_dead(pid, timeout) then
+      return
+    end
+
+    if is_retry then
+      return
+    end
+
+    -- Timeout reached: kill with SIGKILL
+    shell.run("kill -9 " .. pid .. " >/dev/null 2>&1", nil, 0)
+
+    -- Sanity check: check pid again, but don't loop.
+    wait_pid(pid_path, timeout, true)
+  end
+end
+
+
+return {
+  get_pid_from_file = get_pid_from_file,
+  pid_dead = pid_dead,
+  wait_pid = wait_pid,
+}
+

From 3c1335f4bf8bcdc608df543b058974cb2d599cbe Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Thu, 5 Sep 2024 15:41:01 +0800
Subject: [PATCH 02/13] get_version

---
 spec/details/cmd.lua | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/spec/details/cmd.lua b/spec/details/cmd.lua
index 4315df59351a..5e28653dfce2 100644
--- a/spec/details/cmd.lua
+++ b/spec/details/cmd.lua
@@ -1,4 +1,5 @@
 local lfs = require("lfs")
+local version = require("version")
 local pl_dir = require("pl.dir")
 local pl_path = require("pl.path")
 local pl_utils = require("pl.utils")
@@ -22,6 +23,21 @@ local kong_exec = shell.kong_exec
 local config_yml
 
 
+--- Return the actual Kong version the tests are running against.
+-- See [version.lua](https://github.com/kong/version.lua) for the format. This
+-- is mostly useful for testing plugins that should work with multiple Kong versions.
+-- @function get_version
+-- @return a `version` object
+-- @usage
+-- local version = require 'version'
+-- if helpers.get_version() < version("0.15.0") then
+--   -- do something
+-- end
+local function get_version()
+  return version(select(3, assert(kong_exec("version"))))
+end
+
+
 local function build_go_plugins(path)
   if pl_path.exists(pl_path.join(path, "go.mod")) then
     local ok, _, stderr = shell.run(string.format(
@@ -380,7 +396,14 @@ local function restart_kong(env, tables, fixtures)
 end
 
 
+-- TODO
+-- get_kong_workers
+-- reload_kong
+
+
 return {
+  get_version = get_version,
+
   start_kong = start_kong,
   cleanup_kong = cleanup_kong,
   stop_kong = stop_kong,

From e4cb0229668be86c70768ab484397c396681b813 Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Fri, 6 Sep 2024 08:58:33 +0800
Subject: [PATCH 03/13] clean

---
 spec/details/cmd.lua | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/spec/details/cmd.lua b/spec/details/cmd.lua
index 5e28653dfce2..e0ae6d265b48 100644
--- a/spec/details/cmd.lua
+++ b/spec/details/cmd.lua
@@ -10,16 +10,13 @@ local prefix_handler = require("kong.cmd.utils.prefix_handler")
 
 
 local CONSTANTS = require("spec.details.constants")
+local conf = require("spec.details.conf")
 local shell = require("spec.details.shell")
 local pid = require("spec.details.pid")
 local DB = require("spec.details.db")
 local dns_mock = require("spec.details.dns")
 
 
-local conf = shell.conf
-local kong_exec = shell.kong_exec
-
-
 local config_yml
 
 
@@ -34,7 +31,7 @@ local config_yml
 --   -- do something
 -- end
 local function get_version()
-  return version(select(3, assert(kong_exec("version"))))
+  return version(select(3, assert(shell.kong_exec("version"))))
 end
 
 
@@ -116,7 +113,7 @@ local function render_fixtures(conf, env, prefix, fixtures)
   if fixtures and (fixtures.http_mock or fixtures.stream_mock) then
     -- prepare the prefix so we get the full config in the
     -- hidden `.kong_env` file, including test specified env vars etc
-    assert(kong_exec("prepare --conf " .. conf, env))
+    assert(shell.kong_exec("prepare --conf " .. conf, env))
     local render_config = assert(conf_loader(prefix .. "/.kong_env", nil,
                                              { from_kong_env = true }))
 
@@ -314,7 +311,7 @@ local function start_kong(env, tables, preserve_prefix, fixtures)
   end
 
   assert(render_fixtures(CONSTANTS.TEST_CONF_PATH .. nginx_conf, env, prefix, fixtures))
-  return kong_exec("start --conf " .. CONSTANTS.TEST_CONF_PATH .. nginx_conf .. nginx_conf_flags, env)
+  return shell.kong_exec("start --conf " .. CONSTANTS.TEST_CONF_PATH .. nginx_conf .. nginx_conf_flags, env)
 end
 
 
@@ -384,6 +381,7 @@ local function stop_kong(prefix, preserve_prefix, preserve_dc, signal, nowait)
   return true
 end
 
+
 --- Restart Kong. Reusing declarative config when using `database=off`.
 -- @function restart_kong
 -- @param env see `start_kong`

From 5186af91e82f8cc07de7663f0015b032f899e8bf Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Fri, 6 Sep 2024 11:34:13 +0800
Subject: [PATCH 04/13] comments

---
 spec/details/cmd.lua | 1 +
 1 file changed, 1 insertion(+)

diff --git a/spec/details/cmd.lua b/spec/details/cmd.lua
index e0ae6d265b48..1a2828996713 100644
--- a/spec/details/cmd.lua
+++ b/spec/details/cmd.lua
@@ -17,6 +17,7 @@ local DB = require("spec.details.db")
 local dns_mock = require("spec.details.dns")
 
 
+-- initialized in start_kong()
 local config_yml
 
 

From 0b857479e0dfca86d1e3662d1d7728fabcb379e1 Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Mon, 9 Sep 2024 10:44:26 +0800
Subject: [PATCH 05/13] ldoc support

---
 spec/details/cmd.lua | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/spec/details/cmd.lua b/spec/details/cmd.lua
index 1a2828996713..1a2234801782 100644
--- a/spec/details/cmd.lua
+++ b/spec/details/cmd.lua
@@ -1,3 +1,11 @@
+------------------------------------------------------------------
+-- Collection of utilities to help testing Kong features and plugins.
+--
+-- @copyright Copyright 2016-2022 Kong Inc. All rights reserved.
+-- @license [Apache 2.0](https://opensource.org/licenses/Apache-2.0)
+-- @module spec.helpers
+
+
 local lfs = require("lfs")
 local version = require("version")
 local pl_dir = require("pl.dir")

From c4d62f58a1c1239de49cbd1509c79a753599f066 Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Mon, 9 Sep 2024 19:25:10 +0800
Subject: [PATCH 06/13] signal funcs

---
 spec/details/cmd.lua | 55 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/spec/details/cmd.lua b/spec/details/cmd.lua
index 1a2234801782..470f53a3e70d 100644
--- a/spec/details/cmd.lua
+++ b/spec/details/cmd.lua
@@ -14,6 +14,7 @@ local pl_utils = require("pl.utils")
 local constants = require("kong.constants")
 local conf_loader = require("kong.conf_loader")
 local kong_table = require("kong.tools.table")
+local kill = require("kong.cmd.utils.kill")
 local prefix_handler = require("kong.cmd.utils.prefix_handler")
 
 
@@ -403,6 +404,56 @@ local function restart_kong(env, tables, fixtures)
 end
 
 
+-- Only use in CLI tests from spec/02-integration/01-cmd
+local function kill_all(prefix, timeout)
+  local running_conf = get_running_conf(prefix)
+  if not running_conf then return end
+
+  -- kill kong_tests.conf service
+  local pid_path = running_conf.nginx_pid
+  if pl_path.exists(pid_path) then
+    kill.kill(pid_path, "-TERM")
+    pid.wait_pid(pid_path, timeout)
+  end
+end
+
+
+local function signal(prefix, signal, pid_path)
+  if not pid_path then
+    local running_conf = get_running_conf(prefix)
+    if not running_conf then
+      error("no config file found at prefix: " .. prefix)
+    end
+
+    pid_path = running_conf.nginx_pid
+  end
+
+  return kill.kill(pid_path, signal)
+end
+
+
+-- send signal to all Nginx workers, not including the master
+local function signal_workers(prefix, signal, pid_path)
+  if not pid_path then
+    local running_conf = get_running_conf(prefix)
+    if not running_conf then
+      error("no config file found at prefix: " .. prefix)
+    end
+
+    pid_path = running_conf.nginx_pid
+  end
+
+  local cmd = string.format("pkill %s -P `cat %s`", signal, pid_path)
+  local _, _, _, _, code = shell.run(cmd)
+
+  if not pid.pid_dead(pid_path) then
+    return false
+  end
+
+  return code
+end
+
+
 -- TODO
 -- get_kong_workers
 -- reload_kong
@@ -421,5 +472,9 @@ return {
 
   get_running_conf = get_running_conf,
   clean_logfile = clean_logfile,
+
+  kill_all = kill_all,
+  signal = signal,
+  signal_workers = signal_workers,
 }
 

From 39d5a3d5e381c46a1b4555099babf56989a07d64 Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Wed, 11 Sep 2024 16:05:44 +0800
Subject: [PATCH 07/13] clean helpers.lua

---
 spec/helpers.lua | 509 ++---------------------------------------------
 1 file changed, 16 insertions(+), 493 deletions(-)

diff --git a/spec/helpers.lua b/spec/helpers.lua
index af0f11741473..4dfef1017efb 100644
--- a/spec/helpers.lua
+++ b/spec/helpers.lua
@@ -6,14 +6,10 @@
 -- @module spec.helpers
 
 
-local prefix_handler = require "kong.cmd.utils.prefix_handler"
-local conf_loader = require "kong.conf_loader"
-local constants = require "kong.constants"
 local pl_tablex = require "pl.tablex"
 local pl_utils = require "pl.utils"
 local pl_path = require "pl.path"
 local pl_file = require "pl.file"
-local version = require "version"
 local pl_dir = require "pl.dir"
 local cjson = require "cjson.safe"
 local kong_table = require "kong.tools.table"
@@ -45,6 +41,8 @@ local grpc = reload_module("spec.details.grpc")
 local dns_mock = reload_module("spec.details.dns")
 local asserts = reload_module("spec.details.asserts") -- luacheck: ignore
 local server = reload_module("spec.details.server")
+local pid = require("spec.details.pid")
+local cmd = reload_module("spec.details.cmd")
 
 
 local exec = shell.exec
@@ -79,11 +77,6 @@ do
 end
 
 
----------------
--- Conf and DAO
----------------
-local config_yml
-
 -----------------
 -- Custom helpers
 -----------------
@@ -1367,435 +1360,6 @@ do
 end
 
 
---- Prepares the Kong environment.
--- Creates the working directory if it does not exist.
--- @param prefix (optional) path to the working directory, if omitted the test
--- configuration will be used
--- @function prepare_prefix
-local function prepare_prefix(prefix)
-  return pl_dir.makepath(prefix or conf.prefix)
-end
-
-
---- Cleans the Kong environment.
--- Deletes the working directory if it exists.
--- @param prefix (optional) path to the working directory, if omitted the test
--- configuration will be used
--- @function clean_prefix
-local function clean_prefix(prefix)
-
-  -- like pl_dir.rmtree, but ignore mount points
-  local function rmtree(fullpath)
-    if pl_path.islink(fullpath) then return false,'will not follow symlink' end
-    for root,dirs,files in pl_dir.walk(fullpath,true) do
-      if pl_path.islink(root) then
-        -- sub dir is a link, remove link, do not follow
-        local res, err = os.remove(root)
-        if not res then
-          return nil, err .. ": " .. root
-        end
-
-      else
-        for i,f in ipairs(files) do
-          f = pl_path.join(root,f)
-          local res, err = os.remove(f)
-          if not res then
-            return nil,err .. ": " .. f
-          end
-        end
-
-        local res, err = pl_path.rmdir(root)
-        -- skip errors when trying to remove mount points
-        if not res and shell.run("findmnt " .. root .. " 2>&1 >/dev/null", nil, 0) == 0 then
-          return nil, err .. ": " .. root
-        end
-      end
-    end
-    return true
-  end
-
-  prefix = prefix or conf.prefix
-  if pl_path.exists(prefix) then
-    local _, err = rmtree(prefix)
-    if err then
-      error(err)
-    end
-  end
-end
-
-
--- Reads the pid from a pid file and returns it, or nil + err
-local function get_pid_from_file(pid_path)
-  local pid
-  local fd, err = io.open(pid_path)
-  if not fd then
-    return nil, err
-  end
-
-  pid = fd:read("*l")
-  fd:close()
-
-  return pid
-end
-
-
-local function pid_dead(pid, timeout)
-  local max_time = ngx.now() + (timeout or 10)
-
-  repeat
-    if not shell.run("ps -p " .. pid .. " >/dev/null 2>&1", nil, 0) then
-      return true
-    end
-    -- still running, wait some more
-    ngx.sleep(0.05)
-  until ngx.now() >= max_time
-
-  return false
-end
-
--- Waits for the termination of a pid.
--- @param pid_path Filename of the pid file.
--- @param timeout (optional) in seconds, defaults to 10.
-local function wait_pid(pid_path, timeout, is_retry)
-  local pid = get_pid_from_file(pid_path)
-
-  if CONSTANTS.TEST_COVERAGE_MODE == "true" then
-    timeout = CONSTANTS.TEST_COVERAGE_TIMEOUT
-  end
-
-  if pid then
-    if pid_dead(pid, timeout) then
-      return
-    end
-
-    if is_retry then
-      return
-    end
-
-    -- Timeout reached: kill with SIGKILL
-    shell.run("kill -9 " .. pid .. " >/dev/null 2>&1", nil, 0)
-
-    -- Sanity check: check pid again, but don't loop.
-    wait_pid(pid_path, timeout, true)
-  end
-end
-
-
---- Return the actual configuration running at the given prefix.
--- It may differ from the default, as it may have been modified
--- by the `env` table given to start_kong.
--- @function get_running_conf
--- @param prefix (optional) The prefix path where the kong instance is running,
--- defaults to the prefix in the default config.
--- @return The conf table of the running instance, or nil + error.
-local function get_running_conf(prefix)
-  local default_conf = conf_loader(nil, {prefix = prefix or conf.prefix})
-  return conf_loader.load_config_file(default_conf.kong_env)
-end
-
-
---- Clears the logfile. Will overwrite the logfile with an empty file.
--- @function clean_logfile
--- @param logfile (optional) filename to clear, defaults to the current
--- error-log file
--- @return nothing
--- @see line
-local function clean_logfile(logfile)
-  logfile = logfile or (get_running_conf() or conf).nginx_err_logs
-
-  assert(type(logfile) == "string", "'logfile' must be a string")
-
-  local fh, err, errno = io.open(logfile, "w+")
-
-  if fh then
-    fh:close()
-    return
-
-  elseif errno == 2 then -- ENOENT
-    return
-  end
-
-  error("failed to truncate logfile: " .. tostring(err))
-end
-
-
---- Return the actual Kong version the tests are running against.
--- See [version.lua](https://github.com/kong/version.lua) for the format. This
--- is mostly useful for testing plugins that should work with multiple Kong versions.
--- @function get_version
--- @return a `version` object
--- @usage
--- local version = require 'version'
--- if helpers.get_version() < version("0.15.0") then
---   -- do something
--- end
-local function get_version()
-  return version(select(3, assert(kong_exec("version"))))
-end
-
-
-local function render_fixtures(conf, env, prefix, fixtures)
-
-  if fixtures and (fixtures.http_mock or fixtures.stream_mock) then
-    -- prepare the prefix so we get the full config in the
-    -- hidden `.kong_env` file, including test specified env vars etc
-    assert(kong_exec("prepare --conf " .. conf, env))
-    local render_config = assert(conf_loader(prefix .. "/.kong_env", nil,
-                                             { from_kong_env = true }))
-
-    for _, mocktype in ipairs { "http_mock", "stream_mock" } do
-
-      for filename, contents in pairs(fixtures[mocktype] or {}) do
-        -- render the file using the full configuration
-        contents = assert(prefix_handler.compile_conf(render_config, contents))
-
-        -- write file to prefix
-        filename = prefix .. "/" .. filename .. "." .. mocktype
-        assert(pl_utils.writefile(filename, contents))
-      end
-    end
-  end
-
-  if fixtures and fixtures.dns_mock then
-    -- write the mock records to the prefix
-    assert(getmetatable(fixtures.dns_mock) == dns_mock,
-           "expected dns_mock to be of a helpers.dns_mock class")
-    assert(pl_utils.writefile(prefix .. "/dns_mock_records.json",
-                              tostring(fixtures.dns_mock)))
-
-    -- add the mock resolver to the path to ensure the records are loaded
-    if env.lua_package_path then
-      env.lua_package_path = CONSTANTS.DNS_MOCK_LUA_PATH .. ";" .. env.lua_package_path
-    else
-      env.lua_package_path = CONSTANTS.DNS_MOCK_LUA_PATH
-    end
-  else
-    -- remove any old mocks if they exist
-    os.remove(prefix .. "/dns_mock_records.json")
-  end
-
-  return true
-end
-
-
-local function build_go_plugins(path)
-  if pl_path.exists(pl_path.join(path, "go.mod")) then
-    local ok, _, stderr = shell.run(string.format(
-            "cd %s; go mod tidy; go mod download", path), nil, 0)
-    assert(ok, stderr)
-  end
-  for _, go_source in ipairs(pl_dir.getfiles(path, "*.go")) do
-    local ok, _, stderr = shell.run(string.format(
-            "cd %s; go build %s",
-            path, pl_path.basename(go_source)
-    ), nil, 0)
-    assert(ok, stderr)
-  end
-end
-
---- Start the Kong instance to test against.
--- The fixtures passed to this function can be 3 types:
---
--- * DNS mocks
---
--- * Nginx server blocks to be inserted in the http module
---
--- * Nginx server blocks to be inserted in the stream module
--- @function start_kong
--- @param env table with Kong configuration parameters (and values)
--- @param tables list of database tables to truncate before starting
--- @param preserve_prefix (boolean) if truthy, the prefix will not be cleaned
--- before starting
--- @param fixtures tables with fixtures, dns, http and stream mocks.
--- @return return values from `execute`
--- @usage
--- -- example mocks
--- -- Create a new DNS mock and add some DNS records
--- local fixtures = {
---   http_mock = {},
---   stream_mock = {},
---   dns_mock = helpers.dns_mock.new()
--- }
---
--- **DEPRECATED**: http_mock fixture is deprecated. Please use `spec.helpers.http_mock` instead.
---
--- fixtures.dns_mock:A {
---   name = "a.my.srv.test.com",
---   address = "127.0.0.1",
--- }
---
--- -- The blocks below will be rendered by the Kong template renderer, like other
--- -- custom Kong templates. Hence the `${{xxxx}}` values.
--- -- Multiple mocks can be added each under their own filename ("my_server_block" below)
--- fixtures.http_mock.my_server_block = [[
---      server {
---          server_name my_server;
---          listen 10001 ssl;
---
---          ssl_certificate ${{SSL_CERT}};
---          ssl_certificate_key ${{SSL_CERT_KEY}};
---          ssl_protocols TLSv1.2 TLSv1.3;
---
---          location ~ "/echobody" {
---            content_by_lua_block {
---              ngx.req.read_body()
---              local echo = ngx.req.get_body_data()
---              ngx.status = status
---              ngx.header["Content-Length"] = #echo + 1
---              ngx.say(echo)
---            }
---          }
---      }
---    ]]
---
--- fixtures.stream_mock.my_server_block = [[
---      server {
---        -- insert stream server config here
---      }
---    ]]
---
--- assert(helpers.start_kong( {database = "postgres"}, nil, nil, fixtures))
-local function start_kong(env, tables, preserve_prefix, fixtures)
-  if tables ~= nil and type(tables) ~= "table" then
-    error("arg #2 must be a list of tables to truncate")
-  end
-  env = env or {}
-  local prefix = env.prefix or conf.prefix
-
-  -- go plugins are enabled
-  --  compile fixture go plugins if any setting mentions it
-  for _,v in pairs(env) do
-    if type(v) == "string" and v:find(CONSTANTS.GO_PLUGIN_PATH) then
-      build_go_plugins(CONSTANTS.GO_PLUGIN_PATH)
-      break
-    end
-  end
-
-  -- note: set env var "KONG_TEST_DONT_CLEAN" !! the "_TEST" will be dropped
-  if not (preserve_prefix or os.getenv("KONG_DONT_CLEAN")) then
-    clean_prefix(prefix)
-  end
-
-  local ok, err = prepare_prefix(prefix)
-  if not ok then return nil, err end
-
-  DB.truncate_tables(DB.db, tables)
-
-  local nginx_conf = ""
-  local nginx_conf_flags = { "test" }
-  if env.nginx_conf then
-    nginx_conf = " --nginx-conf " .. env.nginx_conf
-  end
-
-  if CONSTANTS.TEST_COVERAGE_MODE == "true" then
-    -- render `coverage` blocks in the templates
-    nginx_conf_flags[#nginx_conf_flags + 1] = 'coverage'
-  end
-
-  if next(nginx_conf_flags) then
-    nginx_conf_flags = " --nginx-conf-flags " .. table.concat(nginx_conf_flags, ",")
-  else
-    nginx_conf_flags = ""
-  end
-
-  local dcbp = DB.get_dcbp()
-  if dcbp and not env.declarative_config and not env.declarative_config_string then
-    if not config_yml then
-      config_yml = prefix .. "/config.yml"
-      local cfg = dcbp.done()
-      local declarative = require "kong.db.declarative"
-      local ok, err = declarative.to_yaml_file(cfg, config_yml)
-      if not ok then
-        return nil, err
-      end
-    end
-    env = kong_table.cycle_aware_deep_copy(env)
-    env.declarative_config = config_yml
-  end
-
-  assert(render_fixtures(CONSTANTS.TEST_CONF_PATH .. nginx_conf, env, prefix, fixtures))
-  return kong_exec("start --conf " .. CONSTANTS.TEST_CONF_PATH .. nginx_conf .. nginx_conf_flags, env)
-end
-
-
--- Cleanup after kong test instance, should be called if start_kong was invoked with the nowait flag
--- @function cleanup_kong
--- @param prefix (optional) the prefix where the test instance runs, defaults to the test configuration.
--- @param preserve_prefix (boolean) if truthy, the prefix will not be deleted after stopping
--- @param preserve_dc ???
-local function cleanup_kong(prefix, preserve_prefix, preserve_dc)
-  -- remove socket files to ensure `pl.dir.rmtree()` ok
-  prefix = prefix or conf.prefix
-  local socket_path = pl_path.join(prefix, constants.SOCKET_DIRECTORY)
-  for child in lfs.dir(socket_path) do
-    local path = pl_path.join(socket_path, child)
-    if lfs.attributes(path, "mode") == "socket" then
-      os.remove(path)
-    end
-  end
-
-  -- note: set env var "KONG_TEST_DONT_CLEAN" !! the "_TEST" will be dropped
-  if not (preserve_prefix or os.getenv("KONG_DONT_CLEAN")) then
-    clean_prefix(prefix)
-  end
-
-  if not preserve_dc then
-    config_yml = nil
-  end
-  ngx.ctx.workspace = nil
-end
-
-
--- Stop the Kong test instance.
--- @function stop_kong
--- @param prefix (optional) the prefix where the test instance runs, defaults to the test configuration.
--- @param preserve_prefix (boolean) if truthy, the prefix will not be deleted after stopping
--- @param preserve_dc ???
--- @param signal (optional string) signal name to send to kong, defaults to TERM
--- @param nowait (optional) if truthy, don't wait for kong to terminate.  caller needs to wait and call cleanup_kong
--- @return true or nil+err
-local function stop_kong(prefix, preserve_prefix, preserve_dc, signal, nowait)
-  prefix = prefix or conf.prefix
-  signal = signal or "TERM"
-
-  local running_conf, err = get_running_conf(prefix)
-  if not running_conf then
-    return nil, err
-  end
-
-  local pid, err = get_pid_from_file(running_conf.nginx_pid)
-  if not pid then
-    return nil, err
-  end
-
-  local ok, _, err = shell.run(string.format("kill -%s %d", signal, pid), nil, 0)
-  if not ok then
-    return nil, err
-  end
-
-  if nowait then
-    return running_conf.nginx_pid
-  end
-
-  wait_pid(running_conf.nginx_pid)
-
-  cleanup_kong(prefix, preserve_prefix, preserve_dc)
-
-  return true
-end
-
---- Restart Kong. Reusing declarative config when using `database=off`.
--- @function restart_kong
--- @param env see `start_kong`
--- @param tables see `start_kong`
--- @param fixtures see `start_kong`
--- @return true or nil+err
-local function restart_kong(env, tables, fixtures)
-  stop_kong(env.prefix, true, true)
-  return start_kong(env, tables, true, fixtures)
-end
-
-
 local function wait_until_no_common_workers(workers, expected_total, strategy)
   wait_until(function()
     local pok, admin_client = pcall(admin_client)
@@ -1962,7 +1526,7 @@ do
   end
 
   function echo_server_reset()
-    stop_kong(prefix_dir)
+    cmd.stop_kong(prefix_dir)
     msg_id = -1
   end
 end
@@ -2210,15 +1774,15 @@ end
   execute = exec,
   dns_mock = dns_mock,
   kong_exec = kong_exec,
-  get_version = get_version,
-  get_running_conf = get_running_conf,
+  get_version = cmd.get_version,
+  get_running_conf = cmd.get_running_conf,
   http_client = http_client,
   grpc_client = grpc_client,
   http2_client = http2_client,
   make_synchronized_clients = make_synchronized_clients,
   wait_until = wait_until,
   pwait_until = pwait_until,
-  wait_pid = wait_pid,
+  wait_pid = pid.wait_pid,
   wait_timer = wait_timer,
   wait_for_all_config_update = wait_for_all_config_update,
   wait_for_file = wait_for_file,
@@ -2242,9 +1806,9 @@ end
   proxy_ssl_client = proxy_ssl_client,
   admin_ssl_client = admin_ssl_client,
   admin_gui_ssl_client = admin_gui_ssl_client,
-  prepare_prefix = prepare_prefix,
-  clean_prefix = clean_prefix,
-  clean_logfile = clean_logfile,
+  prepare_prefix = cmd.prepare_prefix,
+  clean_prefix = cmd.clean_prefix,
+  clean_logfile = cmd.clean_logfile,
   wait_for_invalidation = wait_for_invalidation,
   each_strategy = DB.each_strategy,
   all_strategies = DB.all_strategies,
@@ -2264,10 +1828,10 @@ end
   generate_keys = misc.generate_keys,
 
   -- launching Kong subprocesses
-  start_kong = start_kong,
-  stop_kong = stop_kong,
-  cleanup_kong = cleanup_kong,
-  restart_kong = restart_kong,
+  start_kong = cmd.start_kong,
+  stop_kong = cmd.stop_kong,
+  cleanup_kong = cmd.cleanup_kong,
+  restart_kong = cmd.restart_kong,
   reload_kong = reload_kong,
   get_kong_workers = get_kong_workers,
   wait_until_no_common_workers = wait_until_no_common_workers,
@@ -2280,19 +1844,7 @@ end
   use_old_plugin = use_old_plugin,
 
   -- Only use in CLI tests from spec/02-integration/01-cmd
-  kill_all = function(prefix, timeout)
-    local kill = require "kong.cmd.utils.kill"
-
-    local running_conf = get_running_conf(prefix)
-    if not running_conf then return end
-
-    -- kill kong_tests.conf service
-    local pid_path = running_conf.nginx_pid
-    if pl_path.exists(pid_path) then
-      kill.kill(pid_path, "-TERM")
-      wait_pid(pid_path, timeout)
-    end
-  end,
+  kill_all = cmd.kill_all,
 
   with_current_ws = function(ws,fn, db)
     local old_ws = ngx.ctx.workspace
@@ -2304,40 +1856,11 @@ end
     return res
   end,
 
-  signal = function(prefix, signal, pid_path)
-    local kill = require "kong.cmd.utils.kill"
+  signal = cmd.signal,
 
-    if not pid_path then
-      local running_conf = get_running_conf(prefix)
-      if not running_conf then
-        error("no config file found at prefix: " .. prefix)
-      end
-
-      pid_path = running_conf.nginx_pid
-    end
-
-    return kill.kill(pid_path, signal)
-  end,
   -- send signal to all Nginx workers, not including the master
-  signal_workers = function(prefix, signal, pid_path)
-    if not pid_path then
-      local running_conf = get_running_conf(prefix)
-      if not running_conf then
-        error("no config file found at prefix: " .. prefix)
-      end
-
-      pid_path = running_conf.nginx_pid
-    end
+  signal_workers = cmd.signal_workers,
 
-    local cmd = string.format("pkill %s -P `cat %s`", signal, pid_path)
-    local _, _, _, _, code = shell.run(cmd)
-
-    if not pid_dead(pid_path) then
-      return false
-    end
-
-    return code
-  end,
   -- returns the plugins and version list that is used by Hybrid mode tests
   get_plugins_list = function()
     local PLUGINS_LIST = DB.get_plugins_list()

From 83a083c3d2b56fa71124b8f53f470645d4828277 Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Wed, 11 Sep 2024 16:13:07 +0800
Subject: [PATCH 08/13] ldoc for pid

---
 spec/details/pid.lua | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/spec/details/pid.lua b/spec/details/pid.lua
index 3da8ca7bad30..29fecfd2977c 100644
--- a/spec/details/pid.lua
+++ b/spec/details/pid.lua
@@ -1,3 +1,11 @@
+------------------------------------------------------------------
+-- Collection of utilities to help testing Kong features and plugins.
+--
+-- @copyright Copyright 2016-2022 Kong Inc. All rights reserved.
+-- @license [Apache 2.0](https://opensource.org/licenses/Apache-2.0)
+-- @module spec.helpers
+
+
 local shell = require("resty.shell")
 
 

From ffa4d9ff9c18c380967ac0c20ecdd10d2119f061 Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Wed, 11 Sep 2024 16:29:41 +0800
Subject: [PATCH 09/13] fix pid require

---
 spec/details/cmd.lua | 2 +-
 spec/helpers.lua     | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/spec/details/cmd.lua b/spec/details/cmd.lua
index 470f53a3e70d..f635416872db 100644
--- a/spec/details/cmd.lua
+++ b/spec/details/cmd.lua
@@ -21,8 +21,8 @@ local prefix_handler = require("kong.cmd.utils.prefix_handler")
 local CONSTANTS = require("spec.details.constants")
 local conf = require("spec.details.conf")
 local shell = require("spec.details.shell")
-local pid = require("spec.details.pid")
 local DB = require("spec.details.db")
+local pid = require("spec.details.pid")
 local dns_mock = require("spec.details.dns")
 
 
diff --git a/spec/helpers.lua b/spec/helpers.lua
index 4dfef1017efb..2ba63b2b8930 100644
--- a/spec/helpers.lua
+++ b/spec/helpers.lua
@@ -41,7 +41,7 @@ local grpc = reload_module("spec.details.grpc")
 local dns_mock = reload_module("spec.details.dns")
 local asserts = reload_module("spec.details.asserts") -- luacheck: ignore
 local server = reload_module("spec.details.server")
-local pid = require("spec.details.pid")
+local pid = reload_module("spec.details.pid")
 local cmd = reload_module("spec.details.cmd")
 
 

From a6a48a3817325b7d204054c7e6e0762dd0a0aafa Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Wed, 11 Sep 2024 17:08:03 +0800
Subject: [PATCH 10/13] fix shadowd `pid`

---
 spec/details/cmd.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/spec/details/cmd.lua b/spec/details/cmd.lua
index f635416872db..2d7b2b1d6a61 100644
--- a/spec/details/cmd.lua
+++ b/spec/details/cmd.lua
@@ -370,12 +370,12 @@ local function stop_kong(prefix, preserve_prefix, preserve_dc, signal, nowait)
     return nil, err
   end
 
-  local pid, err = pid.get_pid_from_file(running_conf.nginx_pid)
-  if not pid then
+  local id, err = pid.get_pid_from_file(running_conf.nginx_pid)
+  if not id then
     return nil, err
   end
 
-  local ok, _, err = shell.run(string.format("kill -%s %d", signal, pid), nil, 0)
+  local ok, _, err = shell.run(string.format("kill -%s %d", signal, id), nil, 0)
   if not ok then
     return nil, err
   end

From 78e0aaa3a925d54011f636d9d2c303d102c7152d Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Wed, 11 Sep 2024 17:43:02 +0800
Subject: [PATCH 11/13] echo_server

---
 spec/details/server.lua | 94 +++++++++++++++++++++++++++++++++++++++++
 spec/helpers.lua        | 92 ++--------------------------------------
 2 files changed, 97 insertions(+), 89 deletions(-)

diff --git a/spec/details/server.lua b/spec/details/server.lua
index 1e2c6908be58..d9ba00f434d5 100644
--- a/spec/details/server.lua
+++ b/spec/details/server.lua
@@ -403,6 +403,96 @@ local function udp_server(port, n, timeout)
 end
 
 
+local is_echo_server_ready, get_echo_server_received_data, echo_server_reset
+do
+  local cmd = require("spec.details.cmd")
+  local shell = require("spec.details.shell")
+
+  -- Message id is maintained within echo server context and not
+  -- needed for echo server user.
+  -- This id is extracted from the number in nginx error.log at each
+  -- line of log. i.e.:
+  --  2023/12/15 14:10:12 [info] 718291#0: *303 stream [lua] content_by_lua ...
+  -- in above case, the id is 303.
+  local msg_id = -1
+  local prefix_dir = "servroot"
+
+  --- Check if echo server is ready.
+  --
+  -- @function is_echo_server_ready
+  -- @return boolean
+  function is_echo_server_ready()
+    -- ensure server is ready.
+    local sock = ngx.socket.tcp()
+    sock:settimeout(0.1)
+    local retry = 0
+    local test_port = 8188
+
+    while true do
+      if sock:connect("localhost", test_port) then
+        sock:send("START\n")
+        local ok = sock:receive()
+        sock:close()
+        if ok == "START" then
+          return true
+        end
+      else
+        retry = retry + 1
+        if retry > 10 then
+          return false
+        end
+      end
+    end
+  end
+
+  --- Get the echo server's received data.
+  -- This function check the part of expected data with a timeout.
+  --
+  -- @function get_echo_server_received_data
+  -- @param expected part of the data expected.
+  -- @param timeout (optional) timeout in seconds, default is 0.5.
+  -- @return  the data the echo server received. If timeouts, return "timeout".
+  function get_echo_server_received_data(expected, timeout)
+    if timeout == nil then
+      timeout = 0.5
+    end
+
+    local extract_cmd = "grep content_by_lua "..prefix_dir.."/logs/error.log | tail -1"
+    local _, _, log = assert(shell.exec(extract_cmd))
+    local pattern = "%*(%d+)%s.*received data: (.*)"
+    local cur_msg_id, data = string.match(log, pattern)
+
+    -- unit is second.
+    local t = 0.1
+    local time_acc = 0
+
+    -- retry it when data is not available. because sometime,
+    -- the error.log has not been flushed yet.
+    while string.find(data, expected) == nil or cur_msg_id == msg_id  do
+      ngx.sleep(t)
+      time_acc = time_acc + t
+      if time_acc >= timeout then
+        return "timeout"
+      end
+
+      _, _, log = assert(shell.exec(extract_cmd))
+      cur_msg_id, data = string.match(log, pattern)
+    end
+
+    -- update the msg_id, it persists during a cycle from echo server
+    -- start to stop.
+    msg_id = cur_msg_id
+
+    return data
+  end
+
+  function echo_server_reset()
+    cmd.stop_kong(prefix_dir)
+    msg_id = -1
+  end
+end
+
+
 return {
   tcp_server = tcp_server,
   kill_tcp_server = kill_tcp_server,
@@ -410,4 +500,8 @@ return {
   http_mock = http_mock,
 
   udp_server = udp_server,
+
+  is_echo_server_ready = is_echo_server_ready,
+  echo_server_reset = echo_server_reset,
+  get_echo_server_received_data = get_echo_server_received_data,
 }
diff --git a/spec/helpers.lua b/spec/helpers.lua
index 2ba63b2b8930..02f5027a273b 100644
--- a/spec/helpers.lua
+++ b/spec/helpers.lua
@@ -1445,92 +1445,6 @@ local function reload_kong(strategy, ...)
   return ok, err
 end
 
-local is_echo_server_ready, get_echo_server_received_data, echo_server_reset
-do
-  -- Message id is maintained within echo server context and not
-  -- needed for echo server user.
-  -- This id is extracted from the number in nginx error.log at each
-  -- line of log. i.e.:
-  --  2023/12/15 14:10:12 [info] 718291#0: *303 stream [lua] content_by_lua ...
-  -- in above case, the id is 303.
-  local msg_id = -1
-  local prefix_dir = "servroot"
-
-  --- Check if echo server is ready.
-  --
-  -- @function is_echo_server_ready
-  -- @return boolean
-  function is_echo_server_ready()
-    -- ensure server is ready.
-    local sock = ngx.socket.tcp()
-    sock:settimeout(0.1)
-    local retry = 0
-    local test_port = 8188
-
-    while true do
-      if sock:connect("localhost", test_port) then
-        sock:send("START\n")
-        local ok = sock:receive()
-        sock:close()
-        if ok == "START" then
-          return true
-        end
-      else
-        retry = retry + 1
-        if retry > 10 then
-          return false
-        end
-      end
-    end
-  end
-
-  --- Get the echo server's received data.
-  -- This function check the part of expected data with a timeout.
-  --
-  -- @function get_echo_server_received_data
-  -- @param expected part of the data expected.
-  -- @param timeout (optional) timeout in seconds, default is 0.5.
-  -- @return  the data the echo server received. If timeouts, return "timeout".
-  function get_echo_server_received_data(expected, timeout)
-    if timeout == nil then
-      timeout = 0.5
-    end
-
-    local extract_cmd = "grep content_by_lua "..prefix_dir.."/logs/error.log | tail -1"
-    local _, _, log = assert(exec(extract_cmd))
-    local pattern = "%*(%d+)%s.*received data: (.*)"
-    local cur_msg_id, data = string.match(log, pattern)
-
-    -- unit is second.
-    local t = 0.1
-    local time_acc = 0
-
-    -- retry it when data is not available. because sometime,
-    -- the error.log has not been flushed yet.
-    while string.find(data, expected) == nil or cur_msg_id == msg_id  do
-      ngx.sleep(t)
-      time_acc = time_acc + t
-      if time_acc >= timeout then
-        return "timeout"
-      end
-
-      _, _, log = assert(exec(extract_cmd))
-      cur_msg_id, data = string.match(log, pattern)
-    end
-
-    -- update the msg_id, it persists during a cycle from echo server
-    -- start to stop.
-    msg_id = cur_msg_id
-
-    return data
-  end
-
-  function echo_server_reset()
-    cmd.stop_kong(prefix_dir)
-    msg_id = -1
-  end
-end
-
 --- Simulate a Hybrid mode DP and connect to the CP specified in `opts`.
 -- @function clustering_client
 -- @param opts Options to use, the `host`, `port`, `cert` and `cert_key` fields
@@ -1790,9 +1704,9 @@ end
   tcp_server = server.tcp_server,
   udp_server = server.udp_server,
   kill_tcp_server = server.kill_tcp_server,
-  is_echo_server_ready = is_echo_server_ready,
-  echo_server_reset = echo_server_reset,
-  get_echo_server_received_data = get_echo_server_received_data,
+  is_echo_server_ready = server.is_echo_server_ready,
+  echo_server_reset = server.echo_server_reset,
+  get_echo_server_received_data = server.get_echo_server_received_data,
   http_mock = server.http_mock,
   get_proxy_ip = get_proxy_ip,
   get_proxy_port = get_proxy_port,

From f26169f39c2719b7004c581a9dd3026522f8a4c8 Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Wed, 11 Sep 2024 17:46:55 +0800
Subject: [PATCH 12/13] style

---
 spec/details/server.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/spec/details/server.lua b/spec/details/server.lua
index d9ba00f434d5..25f7c46e87d5 100644
--- a/spec/details/server.lua
+++ b/spec/details/server.lua
@@ -405,8 +405,8 @@ end
 
 local is_echo_server_ready, get_echo_server_received_data, echo_server_reset
 do
-  local cmd = require("spec.details.cmd")
   local shell = require("spec.details.shell")
+  local cmd = require("spec.details.cmd")
 
   -- Message id is maintained within echo server context and not
   -- needed for echo server user.

From 3bd7ce5b076eee1f3658187864998c3c53f1dafc Mon Sep 17 00:00:00 2001
From: chronolaw <chrono_cpp@me.com>
Date: Thu, 12 Sep 2024 06:21:14 +0800
Subject: [PATCH 13/13] style

---
 spec/helpers.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/spec/helpers.lua b/spec/helpers.lua
index 02f5027a273b..36e447091aad 100644
--- a/spec/helpers.lua
+++ b/spec/helpers.lua
@@ -40,9 +40,9 @@ local DB = reload_module("spec.details.db")
 local grpc = reload_module("spec.details.grpc")
 local dns_mock = reload_module("spec.details.dns")
 local asserts = reload_module("spec.details.asserts") -- luacheck: ignore
-local server = reload_module("spec.details.server")
 local pid = reload_module("spec.details.pid")
 local cmd = reload_module("spec.details.cmd")
+local server = reload_module("spec.details.server")
 
 
 local exec = shell.exec