spacewander commented on a change in pull request #6145: URL: https://github.com/apache/apisix/pull/6145#discussion_r789287724
########## File path: t/plugin/public-api.t ########## @@ -0,0 +1,134 @@ +# +# 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(); + +add_block_preprocessor(sub { + my ($block) = @_; + + if ((!defined $block->error_log) && (!defined $block->no_error_log)) { + $block->set_value("no_error_log", "[error]"); + } + + if (!defined $block->request) { + $block->set_value("request", "GET /t"); + } +}); + +run_tests(); + +__DATA__ + +=== TEST 1: sanity +--- config + location /t { + content_by_lua_block { + local test_cases = { + {uri = "/apisix/plugin/jwt/sign"}, + {uri = 3233} + } + local plugin = require("apisix.plugins.public-api") + + for _, case in ipairs(test_cases) do + local ok, err = plugin.check_schema(case) + ngx.say(ok and "done" or err) + end + } + } +--- response_body +done +property "uri" validation failed: wrong type: expected string, got number + + + +=== TEST 2: set route +--- config + location /t { + content_by_lua_block { + local datas = { + { + uri = "/apisix/admin/consumers", + data = [[{ + "username": "alice", + "plugins": { + "jwt-auth": { + "key": "user-key", + "algorithm": "HS256" + } + } + }]] + }, + { + uri = "/apisix/admin/routes/custom-jwt-sign", + data = [[{ + "plugins": { + "public-api": { + "uri": "/apisix/plugin/jwt/sign" + }, + "serverless-pre-function": { + "phase": "rewrite", + "functions": ["return function(conf, ctx) require(\"apisix.core\").log.warn(\"custom-jwt-sign was triggered\"); end"] + } + }, + "uri": "/gen_token" + }]], + }, + { + uri = "/apisix/admin/routes/direct-wolf-rbac-userinfo", + data = [[{ + "plugins": { + "public-api": {}, + "serverless-pre-function": { + "phase": "rewrite", + "functions": ["return function(conf, ctx) require(\"apisix.core\").log.warn(\"direct-wolf-rbac-userinfo was triggered\"); end"] + } + }, + "uri": "/apisix/plugin/wolf-rbac/user_info" + }]], + }, + } + + local t = require("lib.test_admin").test + + for _, data in ipairs(datas) do + local code, body = t(data.uri, ngx.HTTP_PUT, data.data) + ngx.say(code..body) + end + } + } +--- response_body eval +"201passed\n" x 3 + + + +=== TEST 3: hit route (custom-jwt-sign) +--- request +GET /gen_token?key=user-key Review comment: Let's add assertion to make sure the jwt sign is working ########## File path: apisix/plugins/public-api.lua ########## @@ -0,0 +1,58 @@ +-- +-- 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. +-- + +local core = require("apisix.core") +local router = require("apisix.router") + +local schema = { + type = "object", + properties = { + uri = {type = "string"}, + }, +} + + +local _M = { + version = 0.1, + priority = 501, + name = "public-api", + schema = schema, +} + + +function _M.check_schema(conf) + return core.schema.check(schema, conf) +end + + +function _M.access(conf, ctx) + local local_conf = core.config.local_conf() + + -- overwrite the uri in the ctx when the user has set the target uri + ctx.var.uri = conf.uri and conf.uri or ctx.var.uri + local skip = local_conf and local_conf.apisix.global_rule_skip_internal_api Review comment: We don't need to run global rules twice? ########## File path: apisix/plugins/public-api.lua ########## @@ -0,0 +1,58 @@ +-- +-- 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. +-- + +local core = require("apisix.core") +local router = require("apisix.router") + +local schema = { + type = "object", + properties = { + uri = {type = "string"}, + }, +} + + +local _M = { + version = 0.1, + priority = 501, + name = "public-api", + schema = schema, +} + + +function _M.check_schema(conf) + return core.schema.check(schema, conf) +end + + +function _M.access(conf, ctx) + local local_conf = core.config.local_conf() + + -- overwrite the uri in the ctx when the user has set the target uri + ctx.var.uri = conf.uri and conf.uri or ctx.var.uri Review comment: ```suggestion ctx.var.uri = conf.uri or ctx.var.uri ``` ########## File path: t/plugin/public-api.t ########## @@ -0,0 +1,134 @@ +# +# 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(); + +add_block_preprocessor(sub { + my ($block) = @_; + + if ((!defined $block->error_log) && (!defined $block->no_error_log)) { + $block->set_value("no_error_log", "[error]"); + } + + if (!defined $block->request) { + $block->set_value("request", "GET /t"); + } +}); + +run_tests(); + +__DATA__ + +=== TEST 1: sanity +--- config + location /t { + content_by_lua_block { + local test_cases = { + {uri = "/apisix/plugin/jwt/sign"}, + {uri = 3233} + } + local plugin = require("apisix.plugins.public-api") + + for _, case in ipairs(test_cases) do + local ok, err = plugin.check_schema(case) + ngx.say(ok and "done" or err) + end + } + } +--- response_body +done +property "uri" validation failed: wrong type: expected string, got number + + + +=== TEST 2: set route +--- config + location /t { + content_by_lua_block { + local datas = { + { + uri = "/apisix/admin/consumers", + data = [[{ + "username": "alice", + "plugins": { + "jwt-auth": { + "key": "user-key", + "algorithm": "HS256" + } + } + }]] + }, + { + uri = "/apisix/admin/routes/custom-jwt-sign", + data = [[{ + "plugins": { + "public-api": { + "uri": "/apisix/plugin/jwt/sign" + }, + "serverless-pre-function": { + "phase": "rewrite", + "functions": ["return function(conf, ctx) require(\"apisix.core\").log.warn(\"custom-jwt-sign was triggered\"); end"] + } + }, + "uri": "/gen_token" + }]], + }, + { + uri = "/apisix/admin/routes/direct-wolf-rbac-userinfo", + data = [[{ + "plugins": { + "public-api": {}, + "serverless-pre-function": { + "phase": "rewrite", + "functions": ["return function(conf, ctx) require(\"apisix.core\").log.warn(\"direct-wolf-rbac-userinfo was triggered\"); end"] + } + }, + "uri": "/apisix/plugin/wolf-rbac/user_info" + }]], + }, + } + + local t = require("lib.test_admin").test + + for _, data in ipairs(datas) do + local code, body = t(data.uri, ngx.HTTP_PUT, data.data) + ngx.say(code..body) + end + } + } +--- response_body eval +"201passed\n" x 3 + + + +=== TEST 3: hit route (custom-jwt-sign) +--- request +GET /gen_token?key=user-key +--- error_log +direct-wolf-rbac-userinfo was triggered + + + +=== TEST 4: hit route (direct-wolf-rbac-userinfo) +--- request +GET /apisix/plugin/wolf-rbac/user_info +--- error_code: 401 +--- error_log +custom-jwt-sign was triggered Review comment: Let's add more cases: 1. public api not match 2. match without optional uri 3. add auth to protect public api -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
