# # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # use t::APISIX 'no_plan'; repeat_each(1); no_long_string(); no_root_location(); no_shuffle(); log_level("info"); run_tests; __DATA__ === TEST 1: add plugin metadata --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_PUT, [[{ "skey": "val", "ikey": 1 }]], [[{ "node": { "value": { "skey": "val", "ikey": 1 } }, "action": "set" }]] ) ngx.status = code ngx.say(body) } } --- request GET /t --- response_body passed --- no_error_log [error] === TEST 2: update plugin metadata --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_PUT, [[{ "skey": "val2", "ikey": 2 }]], [[{ "node": { "value": { "skey": "val2", "ikey": 2 } }, "action": "set" }]] ) ngx.status = code ngx.say(body) -- hit again local code, body = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_PUT, [[{ "skey": "val2", "ikey": 2 }]], [[{ "node": { "value": { "skey": "val2", "ikey": 2 } }, "action": "set" }]] ) ngx.say(code) ngx.say(body) } } --- request GET /t --- response_body passed 200 passed --- no_error_log [error] === TEST 3: get plugin metadata --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_GET, nil, [[{ "node": { "value": { "skey": "val2", "ikey": 2 } }, "action": "get" }]] ) ngx.status = code ngx.say(body) } } --- request GET /t --- response_body passed --- no_error_log [error] === TEST 4: delete plugin metadata --- config location /t { content_by_lua_block { ngx.sleep(0.3) local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_DELETE, nil, [[{"action": "delete"}]] ) ngx.status = code ngx.say(body) } } --- request GET /t --- response_body passed --- no_error_log [error] === TEST 5: delete plugin metadata(key: not_found) --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code = t('/apisix/admin/plugin_metadata/not_found', ngx.HTTP_DELETE, nil, [[{ "action": "delete" }]] ) ngx.say("[delete] code: ", code) } } --- request GET /t --- response_body [delete] code: 404 --- no_error_log [error] === TEST 6: missing plugin name --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata', ngx.HTTP_PUT, [[{"k": "v"}]], [[{ "node": { "value": "sdf" }, "action": "set" }]] ) ngx.status = code ngx.print(body) } } --- request GET /t --- error_code: 400 --- response_body {"error_msg":"missing plugin name"} --- no_error_log [error] === TEST 7: invalid plugin name --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/test', ngx.HTTP_PUT, [[{"k": "v"}]], [[{ "node": { "value": "sdf" }, "action": "set" }]] ) ngx.status = code ngx.print(body) } } --- request GET /t --- error_code: 400 --- response_body {"error_msg":"invalid plugin name"} --- no_error_log [error] === TEST 8: verify metadata schema fail --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_PUT, [[{ "skey": "val" }]], [[{ "node": { "value": { "skey": "val", "ikey": 1 } }, "action": "set" }]] ) ngx.status = code ngx.say(body) } } --- request GET /t --- error_code: 400 --- response_body eval qr/\{"error_msg":"invalid configuration: property \\"ikey\\" is required"\}/ --- no_error_log [error] === TEST 9: set plugin interceptors --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/prometheus', ngx.HTTP_PUT, [[{ "interceptors": [ { "name": "ip-restriction", "conf": { "whitelist": ["192.168.1.0/24"] } } ] }]] ) if code >= 300 then ngx.status = code end ngx.say(body) } } --- request GET /t --- response_body passed --- no_error_log [error] === TEST 10: hit prometheus route --- config location /t { content_by_lua_block { ngx.sleep(1) -- wait for data synced local t = require("lib.test_admin").test local code, body = t('/apisix/prometheus/metrics', ngx.HTTP_GET) if code >= 300 then ngx.status = code end ngx.say(body) } } --- request GET /t --- error_code: 403 === TEST 11: set plugin interceptors (allow ip access) --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/prometheus', ngx.HTTP_PUT, [[{ "interceptors": [ { "name": "ip-restriction", "conf": { "whitelist": ["127.0.0.1"] } } ] }]] ) if code >= 300 then ngx.status = code end ngx.say(body) } } --- request GET /t --- response_body passed --- no_error_log [error] === TEST 12: hit prometheus route again --- request GET /apisix/prometheus/metrics --- error_code: 200 === TEST 13: invalid interceptors configure (unknown interceptor) --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/prometheus', ngx.HTTP_PUT, [[{ "interceptors": [ { "name": "unknown", "conf": { "whitelist": ["127.0.0.1"] } } ] }]] ) if code >= 300 then ngx.status = code end ngx.say(body) } } --- request GET /t --- response_body eval qr/\{"error_msg":"invalid configuration: property \\"interceptors\\" validation failed: failed to validate item 1: property \\"name\\" validation failed: matches none of the enum values"\}/ --- error_code: 400 --- no_error_log [error] === TEST 14: invalid interceptors configure (missing conf) --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/prometheus', ngx.HTTP_PUT, [[{ "interceptors": [ { "name": "ip-restriction" } ] }]] ) if code >= 300 then ngx.status = code end ngx.say(body) } } --- request GET /t --- error_code: 400 --- response_body eval qr/\{"error_msg":"invalid configuration: property \\"interceptors\\" validation failed: failed to validate item 1: property \\"conf\\" is required"\}/ --- no_error_log [error] === TEST 15: invalid interceptors configure (invalid interceptor configure) --- config location /t { content_by_lua_block { local t = require("lib.test_admin").test local code, body = t('/apisix/admin/plugin_metadata/prometheus', ngx.HTTP_PUT, [[{ "interceptors": [ { "name": "ip-restriction", "conf": {"aa": "b"} } ] }]] ) if code >= 300 then ngx.status = code end ngx.say(body) } } --- request GET /t --- error_code: 400 --- response_body eval qr/\{"error_msg":"invalid configuration: property \\"interceptors\\" validation failed: failed to validate item 1: failed to validate dependent schema for \\"name\\": value should match only one schema, but matches none"\}/ --- no_error_log [error] === TEST 16: not unwanted data, PUT --- config location /t { content_by_lua_block { local json = require("toolkit.json") local t = require("lib.test_admin").test local code, message, res = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_PUT, [[{ "skey": "val", "ikey": 1 }]] ) if code >= 300 then ngx.status = code ngx.say(message) return end res = json.decode(res) res.node.value.create_time = nil res.node.value.update_time = nil ngx.say(json.encode(res)) } } --- response_body {"action":"set","node":{"key":"/apisix/plugin_metadata/example-plugin","value":{"ikey":1,"skey":"val"}}} --- request GET /t --- no_error_log [error] === TEST 17: not unwanted data, GET --- config location /t { content_by_lua_block { local json = require("toolkit.json") local t = require("lib.test_admin").test local code, message, res = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_GET ) if code >= 300 then ngx.status = code ngx.say(message) return end res = json.decode(res) local value = res.node.value assert(res.count ~= nil) res.count = nil ngx.say(json.encode(res)) } } --- response_body {"action":"get","node":{"key":"/apisix/plugin_metadata/example-plugin","value":{"ikey":1,"skey":"val"}}} --- request GET /t --- no_error_log [error] === TEST 18: not unwanted data, DELETE --- config location /t { content_by_lua_block { local json = require("toolkit.json") local t = require("lib.test_admin").test local code, message, res = t('/apisix/admin/plugin_metadata/example-plugin', ngx.HTTP_DELETE ) if code >= 300 then ngx.status = code ngx.say(message) return end res = json.decode(res) ngx.say(json.encode(res)) } } --- response_body {"action":"delete","deleted":"1","key":"/apisix/plugin_metadata/example-plugin","node":{}} --- request GET /t --- no_error_log [error]