spacewander commented on a change in pull request #5940: URL: https://github.com/apache/apisix/pull/5940#discussion_r775770634
########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,148 @@ +-- +-- 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 ngx = ngx +local plugin_name = "mocking" + +local schema = { + type = "object", + properties = { + response_schema = { type = "object" } + }, + required = { "response_schema" } +} + +local _M = { + version = 0.1, + priority = 9900, + name = plugin_name, + schema = schema, +} + +function _M.check_schema(conf) + local ok, err = core.schema.check(schema, conf) + if not ok then + return false, err + end + + return true, nil +end + Review comment: Better to use 2 blank lines between functions ########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,148 @@ +-- +-- 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 ngx = ngx +local plugin_name = "mocking" + +local schema = { + type = "object", + properties = { + response_schema = { type = "object" } + }, + required = { "response_schema" } +} + +local _M = { + version = 0.1, + priority = 9900, + name = plugin_name, + schema = schema, +} + +function _M.check_schema(conf) + local ok, err = core.schema.check(schema, conf) Review comment: ```suggestion return core.schema.check(schema, conf) ``` is enough ########## File path: docs/zh/latest/plugins/mocking.md ########## @@ -0,0 +1,196 @@ +--- +title: limit-req Review comment: Bad title ########## File path: docs/zh/latest/plugins/mocking.md ########## @@ -0,0 +1,196 @@ +--- +title: limit-req +--- + +<!-- +# +# 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. +# +--> + +## 目录 + + - [简介](#简介) + - [属性](#属性) + - [示例](#示例) Review comment: Please follow the structure of other plugin doc, like https://raw.githubusercontent.com/apache/apisix/master/docs/zh/latest/plugins/gzip.md ########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,148 @@ +-- +-- 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 ngx = ngx +local plugin_name = "mocking" + +local schema = { + type = "object", + properties = { + response_schema = { type = "object" } + }, + required = { "response_schema" } +} + +local _M = { + version = 0.1, + priority = 9900, + name = plugin_name, + schema = schema, +} + +function _M.check_schema(conf) + local ok, err = core.schema.check(schema, conf) + if not ok then + return false, err + end + + return true, nil +end + +function _M.access(conf) + local output = gen_object(conf.response_schema) + ngx.header["Content-Type"] = "application/json" + return 200, core.utils.resolve_var(core.json.encode(output)) +end + +function gen_object(property) + local output = {} + if property.properties == nil then + return output + end + for k, v in pairs(property.properties) do + local type = string.lower(v.type) + if type == "array" then + output[k] = gen_array(v) + elseif type == "object" then + output[k] = gen_object(v) + else + output[k] = get_base(v) + end + end + return output +end + +function gen_array(property) + local output = {} + if property.items == nil then + return nil + end + local v = property.items + local n = math.random(1, 3) + local type = string.lower(v.type) + for i = 1, n do + if type == "array" then + table.insert(output, gen_array(v)) + elseif type == "object" then + table.insert(output, gen_object(v)) + else + table.insert(output, get_base(v)) + end + end + return output +end + +function get_base(property) + local type = string.lower(property.type) + local example = property.example + if type == "string" then + return gen_string(example) + elseif type == "number" then + return gen_number(example) + elseif type == "integer" then + return gen_integer(example) + elseif type == "boolean" then + return gen_boolean(example) + end + return nil +end + +function gen_string(example) + if example ~= nil and type(example) == "string" then + return example + end + local n = math.random(1, 10) + local list = {} + for i = 1, n do + table.insert(list, string.char(math.random(97, 122))) + end + return table.concat(list) +end + +function gen_number(example) + if example ~= nil and type(example) == "number" then + return example + end + return math.random() * 10000 +end + +function gen_integer(example) + if example ~= nil and type(example) == "number" then + return math.floor(example) + end + return math.random(1, 10000) +end + +function gen_boolean(example) + if example ~= nil and type(example) == "boolean" then + return example + end + local r = math.random(0, 2) Review comment: The range ([0, 2]) is incorrect? ########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,148 @@ +-- +-- 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 ngx = ngx +local plugin_name = "mocking" Review comment: Let's move plugin_name down to _M -- 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]
