hishamhm · hishamhm · Mar 29, 2019 · Mar 29, 2019 · Mar 29, 2019 · Mar 29, 2019
diff --git a/.travis.yml b/.travis.yml
@@ -33,6 +33,9 @@ env:
     - KONG_TEST_PG_DATABASE=travis
     - KONG_TEST_PG_USER=postgres
     - JOBS=2
+    - TRAVIS_PULL_REQUEST=$TRAVIS_PULL_REQUEST
+    - TRAVIS_BRANCH=$TRAVIS_BRANCH
+    - TRAVIS_PULL_REQUEST_BRANCH=$TRAVIS_PULL_REQUEST_BRANCH
   matrix:
     - KONG_TEST_DATABASE=postgres TEST_SUITE=integration
     - KONG_TEST_DATABASE=cassandra CASSANDRA=2.2 TEST_SUITE=integration

diff --git a/bin/busted b/bin/busted
@@ -35,6 +35,7 @@ if not os.getenv("KONG_BUSTED_RESPAWNED") then
   end
   -- add cli recursion detection
   table.insert(script, "export KONG_BUSTED_RESPAWNED=1")
+  table.insert(script, "export KONG_STRICT_CONF=1")
 
   -- rebuild the invoked commandline, while inserting extra resty-flags
   local resty_flags = DEFAULT_RESTY_FLAGS

diff --git a/kong/conf_loader.lua b/kong/conf_loader.lua
@@ -187,6 +187,29 @@ local CONF_INFERENCES = {
 
   lua_ssl_verify_depth = { typ = "number" },
   lua_socket_pool_size = { typ = "number" },
+
+  -- known keys which require no type inference:
+  prefix = {},
+  pg_user = {},
+  pg_host = {},
+  pg_schema = {},
+  pg_database = {},
+  cassandra_username = {},
+  cassandra_keyspace = {},
+  declarative_config = {},
+  mem_cache_size = {},
+  lua_package_path = {},
+  lua_package_cpath = {},
+  lua_ssl_trusted_certificate = {},
+  ssl_cert = {},
+  ssl_cert_key = {},
+  ssl_ciphers = {},
+  ssl_cipher_suite = {},
+  admin_ssl_cert = {},
+  admin_ssl_cert_key = {},
+  client_ssl_cert = {},
+  client_ssl_cert_key = {},
+  my_new_option = {},
 }
 
 
@@ -221,13 +244,33 @@ local _nop_tostring_mt = {
 }
 
 
+local function is_dynamic_key(k)
+  for _, dyn_key_prefix in pairs(DYNAMIC_KEY_PREFIXES) do
+    if string.match(k, "^(" .. dyn_key_prefix .. ".+)") then
+      return true
+    end
+  end
+  return false
+end
+
+
 -- Validate properties (type/enum/custom) and infer their type.
 -- @param[type=table] conf The configuration table to treat.
-local function check_and_infer(conf)
+-- @param[type=boolean] strict Report unknown fields as errors.
+local function check_and_infer(conf, strict)
   local errors = {}
 
   for k, value in pairs(conf) do
-    local v_schema = CONF_INFERENCES[k] or {}
+    local v_schema = CONF_INFERENCES[k]
+    if not v_schema then
+      if strict then
+        if not is_dynamic_key(k) then
+          errors[#errors + 1] = fmt("unknown key: '%s'", k)
+        end
+      end
+      v_schema = {}
+    end
+
     local typ = v_schema.typ
 
     if type(value) == "string" then
@@ -750,7 +793,7 @@ local function load(path, custom_conf)
   local conf = tablex.pairmap(overrides, defaults, from_file_conf, custom_conf)
 
   -- validation
-  local ok, err, errors = check_and_infer(conf)
+  local ok, err, errors = check_and_infer(conf, os.getenv("KONG_STRICT_CONF"))
   if not ok then
     return nil, err, errors
   end

diff --git a/spec/01-unit/03-conf_loader_spec.lua b/spec/01-unit/03-conf_loader_spec.lua
@@ -1,4 +1,5 @@
 local conf_loader = require "kong.conf_loader"
+local pl_utils = require "pl.utils"
 local helpers = require "spec.helpers"
 local tablex = require "pl.tablex"
 
@@ -965,4 +966,58 @@ describe("Configuration loader", function()
       assert.equal("123456", conf.cassandra_password)
     end)
   end)
+
+  describe("changes", function()
+    local pr = os.getenv("TRAVIS_PULL_REQUEST")
+    local pr_it = pr and it or pending
+
+    pr_it("are reflected in kong.conf.default", function()
+      local base = os.getenv("TRAVIS_BRANCH")
+      print("Travis PR " .. pr .. " (" ..os.getenv("TRAVIS_PULL_REQUEST_BRANCH") .. ") targeting " .. base)
+
+      local cmd = "git diff " .. base .. " --numstat | cut -f3"
+      local ok, _, files, stderr = pl_utils.executeex(cmd)
+      assert(ok, "failed running: " .. cmd .. "\n" .. (stderr or ""))
+      files = "\n" .. files .. "\n"
+
+      if not files:match("\nkong/conf_loader.lua\n") then
+        print("[PASS]: No changes made to conf_loader.")
+        return
+      end
+
+      if files:match("\nkong.conf.default\n") then
+        print("[PASS]: PR includes changes to both kong/conf_loader.lua and kong.conf.default")
+        return
+      end
+
+      -- Some PRs modify conf_loader but do not require changes to kong.conf.default.
+      -- These should be noted with a hashtag in the commit message: #noconfchange
+
+      local log
+      cmd = "git log " .. base .. "..HEAD"
+      ok, _, log, stderr = pl_utils.executeex(cmd)
+      assert(ok, "failed running: " .. cmd .. "\n" .. (stderr or ""))
+
+      if log:match("#noconfchange") then
+        print("[PASS]: PR includes changes to kong/conf_loader.lua and uses #noconfchange hashtag")
+        return
+      end
+
+      print("*************************************************************************")
+      print("[FAIL]: Your pull request modifies kong.conf_loader (possibly modifying")
+      print("or adding directives) but does not include an accompanying change to")
+      print("kong.conf.default. Please document any changes in kong.conf.default")
+      print("and include in this PR.")
+      print()
+      print("If your PR modifies kong.conf_loader but does not require changes to")
+      print("kong.conf.default (i.e. no user-visible changes to the configuration")
+      print("format), please add the hashtag #noconfchange to your commit message")
+      print("to make this test pass.")
+      print("*************************************************************************")
+      print()
+
+      assert(false)
+    end)
+  end)
+
 end)