feature: restart and health

kong-0.8.2-0.rockspec

@@ -61,9 +61,11 @@ build = {
     ["kong.cmd.start"] = "kong/cmd/start.lua",
     ["kong.cmd.check"] = "kong/cmd/check.lua",
     ["kong.cmd.reload"] = "kong/cmd/reload.lua",
+    ["kong.cmd.restart"] = "kong/cmd/restart.lua",
     ["kong.cmd.cluster"] = "kong/cmd/cluster.lua",
     ["kong.cmd.compile"] = "kong/cmd/compile.lua",
     ["kong.cmd.migrations"] = "kong/cmd/migrations.lua",
+    ["kong.cmd.health"] = "kong/cmd/health.lua",
     ["kong.cmd.version"] = "kong/cmd/version.lua",
     ["kong.cmd.utils.log"] = "kong/cmd/utils/log.lua",
     ["kong.cmd.utils.kill"] = "kong/cmd/utils/kill.lua",

kong/cmd/health.lua

@@ -0,0 +1,54 @@
+local conf_loader = require "kong.conf_loader"
+local log = require "kong.cmd.utils.log"
+local kill = require "kong.cmd.utils.kill"
+local pl_stringx = require "pl.stringx"
+local pl_path = require "pl.path"
+local pl_tablex = require "pl.tablex"
+
+local function is_running(pid_path)
+  if not pl_path.exists(pid_path) then return nil end
+  local code = kill(pid_path, "-0")
+  return code == 0
+end
+
+local function execute(args)
+  local default_conf = assert(conf_loader(args.conf, {
+    prefix = args.prefix
+  }))
+  assert(pl_path.exists(default_conf.prefix),
+    "no such prefix: "..default_conf.prefix)
+
+  local pids = {
+    nginx = default_conf.nginx_pid,
+    serf = default_conf.serf_pid,
+    dnsmasq = default_conf.dnsmasq and default_conf.dnsmasq_pid or nil
+  }
+
+  local count = 0
+  for k, v in pairs(pids) do
+    local running = is_running(v)
+    local msg = pl_stringx.ljust(k, 10, ".")..(running and "running" or "not running")
+    if running then
+      count = count + 1
+      log(msg)
+    else
+      log.warn(msg)
+    end
+  end
+
+  assert(count > 0, "Kong is not running")
+  assert(count == pl_tablex.size(pids), "Some services are not running")
+end
+
+local lapp = [[
+Usage: kong health [OPTIONS]
+
+Options:
+ -c,--conf (optional string) configuration file
+ --prefix  (optional string) override prefix directory
+]]
+
+return {
+  lapp = lapp,
+  execute = execute
+}

kong/cmd/init.lua

@@ -13,6 +13,7 @@ Usage: kong COMMAND [OPTIONS]
 The available commands are:
  start
  stop
+ restart
  reload
  check
  compile
@@ -26,12 +27,14 @@ Options:
 local cmds = {
   start = "start",
   stop = "stop",
+  restart = "restart",
   reload = "reload",
   check = "check",
   compile = "compile",
   migrations = "migrations",
   cluster = "cluster",
   version = "version",
+  health = "health",
   roar = "roar"
 }
 

kong/cmd/restart.lua

@@ -0,0 +1,25 @@
+local conf_loader = require "kong.conf_loader"
+local stop = require "kong.cmd.stop"
+local start = require "kong.cmd.start"
+
+local function execute(args)
+  local conf = assert(conf_loader(args.conf))
+  args.prefix = conf.prefix -- Required for stop
+  args.graceful = nil -- Restart is always not graceful (reload should be used instead)
+
+  pcall(stop.execute, args)
+  start.execute(args)
+end
+
+local lapp = [[
+Usage: kong restart [OPTIONS]
+
+Options:
+ -c,--conf (optional string) configuration file
+ --prefix  (optional string) override prefix directory
+]]
+
+return {
+  lapp = lapp,
+  execute = execute
+}

kong/cmd/stop.lua

@@ -16,19 +16,20 @@ local function execute(args)
 
   -- load <PREFIX>/kong.conf containing running node's config
   local conf = assert(conf_loader(default_conf.kong_conf))
-  assert(nginx_signals.stop(conf))
+  assert(nginx_signals.stop(conf, args.graceful))
   assert(serf_signals.stop(conf, DAOFactory(conf)))
   if conf.dnsmasq then
     assert(dnsmasq_signals.stop(conf))
   end
-  log("Stopped")
+  log("Stopped%s", args.graceful and " gracefully" or "")
 end
 
 local lapp = [[
 Usage: kong stop [OPTIONS]
 
 Options:
  --prefix (optional string) prefix Kong is running at
+ --graceful (optional boolean) graceful shutdown
 ]]
 
 return {

kong/cmd/utils/nginx_signals.lua

@@ -86,8 +86,8 @@ function _M.start(kong_conf)
   return true
 end
 
-function _M.stop(kong_conf)
-  return send_signal(kong_conf.nginx_pid, "QUIT")
+function _M.stop(kong_conf, graceful)
+  return send_signal(kong_conf.nginx_pid, graceful and "QUIT" or "TERM")
 end
 
 function _M.reload(kong_conf)

spec/02-integration/01-cmd/02-start_stop_spec.lua

@@ -1,5 +1,3 @@
-local pl_dir = require "pl.dir"
-local pl_path = require "pl.path"
 local helpers = require "spec.helpers"
 
 describe("kong start/stop", function()
@@ -33,6 +31,10 @@ describe("kong start/stop", function()
     assert(helpers.kong_exec("start --conf "..helpers.test_conf_path))
     assert(helpers.kong_exec("stop --prefix "..helpers.test_conf.prefix))
   end)
+  it("start/stop gracefully", function()
+    assert(helpers.kong_exec("start --conf "..helpers.test_conf_path))
+    assert(helpers.kong_exec("stop --graceful --prefix "..helpers.test_conf.prefix))
+  end)
   it("start with inexistent prefix", function()
     finally(function()
       pcall(helpers.dir.rmtree, "foobar")

spec/02-integration/01-cmd/08-restart_spec.lua

@@ -0,0 +1,28 @@
+local helpers = require "spec.helpers"
+
+describe("kong restart", function()
+  before_each(function()
+    helpers.kill_all()
+  end)
+  teardown(function()
+    helpers.kill_all()
+    helpers.clean_prefix()
+  end)
+
+  it("restarts if not running", function()
+    assert(helpers.kong_exec("restart --conf "..helpers.test_conf_path))
+  end)
+  it("restarts if already running", function()
+    assert(helpers.kong_exec("start --conf "..helpers.test_conf_path, {dnsmasq = true, dns_resolver = ""}))
+
+    local nginx_pid = assert(helpers.file.read(helpers.test_conf.nginx_pid))
+    local serf_pid = assert(helpers.file.read(helpers.test_conf.serf_pid))
+    local dnsmasq_pid = assert(helpers.file.read(helpers.test_conf.dnsmasq_pid))
+
+    assert(helpers.kong_exec("restart --trace --conf "..helpers.test_conf_path, {dnsmasq = true, dns_resolver = ""}))
+
+    assert.is_not.equal(assert(helpers.file.read(helpers.test_conf.nginx_pid)), nginx_pid)
+    assert.is_not.equal(assert(helpers.file.read(helpers.test_conf.serf_pid)), serf_pid)
+    assert.is_not.equal(assert(helpers.file.read(helpers.test_conf.dnsmasq_pid)), dnsmasq_pid)
+  end)
+end)

spec/02-integration/01-cmd/09-health_spec.lua

@@ -0,0 +1,33 @@
+local helpers = require "spec.helpers"
+local prefix_handler = require "kong.cmd.utils.prefix_handler"
+
+describe("kong restart", function()
+  before_each(function()
+    helpers.kill_all()
+  end)
+  teardown(function()
+    helpers.kill_all()
+    helpers.clean_prefix()
+  end)
+
+  it("succeeds when Kong is running", function()
+    assert(helpers.kong_exec("start --conf "..helpers.test_conf_path, {dnsmasq = true, dns_resolver = ""}))
+    assert(helpers.kong_exec("health --conf "..helpers.test_conf_path))
+  end)
+
+  describe("errors", function()
+    it("fails when Kong is not running", function()
+      assert(prefix_handler.prepare_prefix(helpers.test_conf))
+      local ok, stderr = helpers.kong_exec("health --conf "..helpers.test_conf_path)
+      assert.False(ok)
+      assert.matches("Kong is not running", stderr)
+    end)
+    it("fails when a service is not running", function()
+      assert(helpers.kong_exec("start --conf "..helpers.test_conf_path, {dnsmasq = true, dns_resolver = ""}))
+      helpers.execute("pkill serf")
+      local ok, stderr = helpers.kong_exec("health --conf "..helpers.test_conf_path)
+      assert.False(ok)
+      assert.matches("Some services are not running", stderr)
+    end)
+  end)
+end)