chore(tests): add tests for DAO methods

(cherry picked from commit 85f2f1d)

Author: nowNick

kong/db/dao/init.lua

@@ -503,6 +503,8 @@ local function check_update(self, key, entity, options, name)
     return nil, nil, tostring(err_t), err_t
   end
 
+  options = options or {}
+  options.expand_shorthands = false
   local rbw_entity
   local err, err_t
   if name then

spec/02-integration/03-db/14-dao_spec.lua

@@ -1,11 +1,12 @@
 local helpers = require "spec.helpers"
+local utils = require "kong.tools.utils"
 local declarative = require "kong.db.declarative"
 
 -- Note: include "off" strategy here as well
 for _, strategy in helpers.all_strategies() do
   describe("db.dao #" .. strategy, function()
     local bp, db
-    local consumer, service, plugin, acl
+    local consumer, service, service2, plugin, plugin2, acl
     local group = "The A Team"
 
     lazy_setup(function()
@@ -26,7 +27,12 @@ for _, strategy in helpers.all_strategies() do
         name = "abc",
         url = "http://localhost",
       }
-  
+
+      service2 = bp.services:insert {
+        name = "def",
+        url = "http://2-localhost",
+      }
+
       plugin = bp.plugins:insert {
         enabled = true,
         name = "acl",
@@ -35,6 +41,20 @@ for _, strategy in helpers.all_strategies() do
           allow = { "*" },
         },
       }
+
+      plugin2 = bp.plugins:insert {
+        enabled = true,
+        name = "rate-limiting",
+        instance_name = 'rate-limiting-instance-1',
+        service = service,
+        config = {
+          minute = 100,
+          policy = "redis",
+          redis = {
+            host = "localhost"
+          }
+        },
+      }
       -- Note: bp in off strategy returns service=id instead of a table
       plugin.service = {
         id = service.id
@@ -81,7 +101,7 @@ for _, strategy in helpers.all_strategies() do
 
     it("select_by_cache_key()", function()
       local cache_key = kong.db.acls:cache_key(consumer.id, group)
-      
+
       local read_acl, err = kong.db.acls:select_by_cache_key(cache_key)
       assert.is_nil(err)
       assert.same(acl, read_acl)
@@ -91,6 +111,78 @@ for _, strategy in helpers.all_strategies() do
       local read_plugin, err = kong.db.plugins:select_by_cache_key(cache_key)
       assert.is_nil(err)
       assert.same(plugin, read_plugin)
+
+      cache_key = kong.db.plugins:cache_key("rate-limiting", nil, service.id, nil)
+      read_plugin, err = kong.db.plugins:select_by_cache_key(cache_key)
+      assert.is_nil(err)
+      assert.same(plugin2, read_plugin)
+    end)
+
+    it("page_for_route", function()
+      local plugins_for_service, err = kong.db.plugins:page_for_service(service)
+      assert.is_nil(err)
+      assert.equal(2, #plugins_for_service)
+      for _, read_plugin in ipairs(plugins_for_service) do
+        if read_plugin.name == 'acl' then
+          assert.same(plugin, read_plugin)
+        elseif read_plugin.name == 'rate-limiting' then
+          assert.same(plugin2, read_plugin)
+        end
+      end
+    end)
+
+    it("select_by_instance_name", function()
+      local read_plugin, err = kong.db.plugins:select_by_instance_name(plugin2.instance_name)
+      assert.is_nil(err)
+      assert.same(plugin2, read_plugin)
+    end)
+
+    it("update_by_instance_name", function()
+      local newhost = "newhost"
+      local updated_plugin = utils.cycle_aware_deep_copy(plugin2)
+      updated_plugin.config.redis.host = newhost
+      updated_plugin.config.redis_host = newhost
+
+      local read_plugin, err = kong.db.plugins:update_by_instance_name(plugin2.instance_name, updated_plugin)
+      assert.is_nil(err)
+      assert.same(updated_plugin, read_plugin)
+    end)
+
+    it("upsert_by_instance_name", function()
+      -- existing plugin upsert (update part of upsert)
+      local newhost = "newhost"
+      local updated_plugin = utils.cycle_aware_deep_copy(plugin2)
+      updated_plugin.config.redis.host = newhost
+      updated_plugin.config.redis_host = newhost
+
+      local read_plugin, err = kong.db.plugins:upsert_by_instance_name(plugin2.instance_name, updated_plugin)
+      assert.is_nil(err)
+      assert.same(updated_plugin, read_plugin)
+
+      -- new plugin upsert (insert part of upsert)
+      local new_plugin_config = {
+        id = utils.uuid(),
+        enabled = true,
+        name = "rate-limiting",
+        instance_name = 'rate-limiting-instance-2',
+        service = service2,
+        config = {
+          minute = 200,
+          policy = "redis",
+          redis = {
+            host = "new-host-2"
+          }
+        },
+      }
+
+      local read_plugin, err = kong.db.plugins:upsert_by_instance_name(new_plugin_config.instance_name, new_plugin_config)
+      assert.is_nil(err)
+      assert.same(new_plugin_config.id, read_plugin.id)
+      assert.same(new_plugin_config.instance_name, read_plugin.instance_name)
+      assert.same(new_plugin_config.service.id, read_plugin.service.id)
+      assert.same(new_plugin_config.config.minute, read_plugin.config.minute)
+      assert.same(new_plugin_config.config.redis.host, read_plugin.config.redis.host)
+      assert.same(new_plugin_config.config.redis.host, read_plugin.config.redis_host) -- legacy field is included
     end)
   end)
 end