fix(ext-plugin): missing schema check (#4359)

Signed-off-by: spacewander <spacewanderlzx@gmail.com>
apache · Jun 3, 2021 · 62ceab5 · 62ceab5
1 parent 0637d79
commit 62ceab5
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 1 deletion.
diff --git a/apisix/plugins/ext-plugin-post-req.lua b/apisix/plugins/ext-plugin-post-req.lua
@@ -14,6 +14,7 @@
 -- See the License for the specific language governing permissions and
 -- limitations under the License.
 --
+local core = require("apisix.core")
 local ext = require("apisix.plugins.ext-plugin.init")
 
 
@@ -25,6 +26,11 @@ local _M = {
 }
 
 
+function _M.check_schema(conf)
+    return core.schema.check(_M.schema, conf)
+end
+
+
 function _M.access(conf, ctx)
     return ext.communicate(conf, ctx)
 end

diff --git a/apisix/plugins/ext-plugin-pre-req.lua b/apisix/plugins/ext-plugin-pre-req.lua
@@ -14,6 +14,7 @@
 -- See the License for the specific language governing permissions and
 -- limitations under the License.
 --
+local core = require("apisix.core")
 local ext = require("apisix.plugins.ext-plugin.init")
 
 
@@ -25,6 +26,11 @@ local _M = {
 }
 
 
+function _M.check_schema(conf)
+    return core.schema.check(_M.schema, conf)
+end
+
+
 function _M.rewrite(conf, ctx)
     return ext.communicate(conf, ctx)
 end

diff --git a/apisix/plugins/ext-plugin/init.lua b/apisix/plugins/ext-plugin/init.lua
@@ -79,7 +79,8 @@ local schema = {
                     value = {
                         type = "string",
                     },
-                }
+                },
+                required = {"name", "value"}
             },
             minItems = 1,
         },

diff --git a/t/plugin/ext-plugin/sanity.t b/t/plugin/ext-plugin/sanity.t
@@ -382,3 +382,66 @@ env MY_ENV_VAR=foo;
     }
 --- error_log
 MY_ENV_VAR foo
+
+
+
+=== TEST 14: bad conf
+--- config
+    location /t {
+        content_by_lua_block {
+            local json = require("toolkit.json")
+            local t = require("lib.test_admin")
+
+            local code, message, res = t.test('/apisix/admin/routes/1',
+                ngx.HTTP_PUT,
+                 [[{
+                    "uri": "/hello",
+                    "plugins": {
+                        "ext-plugin-pre-req": {
+                            "conf": [
+                                {"value":"bar"}
+                            ]
+                        }
+                    },
+                    "upstream": {
+                        "nodes": {
+                            "127.0.0.1:1980": 1
+                        },
+                        "type": "roundrobin"
+                    }
+                }]]
+            )
+
+            if code >= 300 then
+                ngx.say(message)
+            end
+
+            local code, message, res = t.test('/apisix/admin/routes/1',
+                ngx.HTTP_PUT,
+                 [[{
+                    "uri": "/hello",
+                    "plugins": {
+                        "ext-plugin-post-req": {
+                            "conf": [
+                                {"name":"bar"}
+                            ]
+                        }
+                    },
+                    "upstream": {
+                        "nodes": {
+                            "127.0.0.1:1980": 1
+                        },
+                        "type": "roundrobin"
+                    }
+                }]]
+            )
+
+            if code >= 300 then
+                ngx.print(message)
+            end
+        }
+    }
+--- response_body
+{"error_msg":"failed to check the configuration of plugin ext-plugin-pre-req err: property \"conf\" validation failed: failed to validate item 1: property \"name\" is required"}
+
+{"error_msg":"failed to check the configuration of plugin ext-plugin-post-req err: property \"conf\" validation failed: failed to validate item 1: property \"value\" is required"}