You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/01/24 14:55:25 UTC
[GitHub] [apisix] starsz commented on a change in pull request #5940: feat: mocking plugin
starsz commented on a change in pull request #5940:
URL: https://github.com/apache/apisix/pull/5940#discussion_r790814817
##########
File path: apisix/plugins/mocking.lua
##########
@@ -0,0 +1,211 @@
+--
+-- 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 xml2lua = require("xml2lua")
+local string = string
+local type = type
+local table = table
+local math = math
+local pairs = pairs
+
+local schema = {
+ type = "object",
+ properties = {
+ -- specify response delay time,default 0ms
+ delay = { type = "integer", default = 0 },
+ -- specify response status,default 200
+ response_status = { type = "integer", default = 200, minimum = 1 },
Review comment:
```suggestion
response_status = { type = "integer", default = 200, minimum = 100 },
```
##########
File path: apisix/plugins/mocking.lua
##########
@@ -0,0 +1,211 @@
+--
+-- 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 xml2lua = require("xml2lua")
+local string = string
+local type = type
+local table = table
+local math = math
+local pairs = pairs
+
+local schema = {
+ type = "object",
+ properties = {
+ -- specify response delay time,default 0ms
+ delay = { type = "integer", default = 0 },
+ -- specify response status,default 200
+ response_status = { type = "integer", default = 200, minimum = 1 },
+ -- specify response content type, support application/xml, text/plain
+ -- and application/json, default application/json
+ content_type = { type = "string", default = "application/json" },
+ -- specify response body.
+ response_example = { type = "string" },
+ -- specify response json schema, if response_example is not nil, this conf will be ignore.
+ -- generate random response by json schema.
+ response_schema = { type = "object" },
+ with_mock_header = { type = "boolean", default = true }
+ },
+ anyOf = {
+ { required = { "response_example" } },
+ { required = { "response_schema" } }
+ }
+}
+
+local _M = {
+ version = 0.1,
+ priority = 9900,
+ name = "mocking",
+ schema = schema,
+}
+
+local function parse_content_type(content_type)
+ if not content_type then
+ return "", ""
+ end
+ local sep_idx = string.find(content_type, ";")
+ local typ, charset
+ if sep_idx then
+ typ = string.sub(content_type, 1, sep_idx - 1)
+ charset = string.sub(content_type, sep_idx + 1)
+ else
+ typ = content_type
+ end
+ return typ, charset
+end
+
+function _M.check_schema(conf)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ if conf.content_type == "" then
+ conf.content_type = "application/json;charset=utf8"
Review comment:
You can put this to schema define.
##########
File path: apisix/plugins/mocking.lua
##########
@@ -0,0 +1,211 @@
+--
+-- 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 xml2lua = require("xml2lua")
+local string = string
+local type = type
+local table = table
+local math = math
+local pairs = pairs
+
+local schema = {
+ type = "object",
+ properties = {
+ -- specify response delay time,default 0ms
+ delay = { type = "integer", default = 0 },
+ -- specify response status,default 200
+ response_status = { type = "integer", default = 200, minimum = 1 },
+ -- specify response content type, support application/xml, text/plain
+ -- and application/json, default application/json
+ content_type = { type = "string", default = "application/json" },
+ -- specify response body.
+ response_example = { type = "string" },
+ -- specify response json schema, if response_example is not nil, this conf will be ignore.
+ -- generate random response by json schema.
+ response_schema = { type = "object" },
+ with_mock_header = { type = "boolean", default = true }
+ },
+ anyOf = {
+ { required = { "response_example" } },
+ { required = { "response_schema" } }
+ }
+}
+
+local _M = {
+ version = 0.1,
+ priority = 9900,
+ name = "mocking",
+ schema = schema,
+}
+
+local function parse_content_type(content_type)
+ if not content_type then
+ return "", ""
+ end
+ local sep_idx = string.find(content_type, ";")
+ local typ, charset
+ if sep_idx then
+ typ = string.sub(content_type, 1, sep_idx - 1)
+ charset = string.sub(content_type, sep_idx + 1)
+ else
+ typ = content_type
+ end
+ return typ, charset
+end
+
+function _M.check_schema(conf)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ if conf.content_type == "" then
+ conf.content_type = "application/json;charset=utf8"
+ end
+ local typ, _ = parse_content_type(conf.content_type)
+ if typ ~= "application/xml" and
+ typ ~= "application/json" and
+ typ ~= "text/plain" and
+ typ ~= "text/html" and
+ typ ~= "text/xml" then
Review comment:
Define a table like this would be better.
```
local support_content_type = {
["application/xml"] = true,
...
}
```
##########
File path: apisix/plugins/mocking.lua
##########
@@ -0,0 +1,211 @@
+--
+-- 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 xml2lua = require("xml2lua")
+local string = string
+local type = type
+local table = table
+local math = math
+local pairs = pairs
+
+local schema = {
+ type = "object",
+ properties = {
+ -- specify response delay time,default 0ms
+ delay = { type = "integer", default = 0 },
+ -- specify response status,default 200
+ response_status = { type = "integer", default = 200, minimum = 1 },
+ -- specify response content type, support application/xml, text/plain
+ -- and application/json, default application/json
+ content_type = { type = "string", default = "application/json" },
Review comment:
Better to use `enum` to define the support type.
##########
File path: apisix/plugins/mocking.lua
##########
@@ -0,0 +1,211 @@
+--
+-- 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 xml2lua = require("xml2lua")
+local string = string
+local type = type
+local table = table
+local math = math
+local pairs = pairs
+
+local schema = {
+ type = "object",
+ properties = {
+ -- specify response delay time,default 0ms
+ delay = { type = "integer", default = 0 },
+ -- specify response status,default 200
+ response_status = { type = "integer", default = 200, minimum = 1 },
+ -- specify response content type, support application/xml, text/plain
+ -- and application/json, default application/json
+ content_type = { type = "string", default = "application/json" },
+ -- specify response body.
+ response_example = { type = "string" },
+ -- specify response json schema, if response_example is not nil, this conf will be ignore.
+ -- generate random response by json schema.
+ response_schema = { type = "object" },
+ with_mock_header = { type = "boolean", default = true }
+ },
+ anyOf = {
+ { required = { "response_example" } },
+ { required = { "response_schema" } }
+ }
+}
+
+local _M = {
+ version = 0.1,
+ priority = 9900,
+ name = "mocking",
+ schema = schema,
+}
+
+local function parse_content_type(content_type)
+ if not content_type then
+ return "", ""
+ end
+ local sep_idx = string.find(content_type, ";")
+ local typ, charset
+ if sep_idx then
+ typ = string.sub(content_type, 1, sep_idx - 1)
+ charset = string.sub(content_type, sep_idx + 1)
+ else
+ typ = content_type
+ end
+ return typ, charset
+end
+
+function _M.check_schema(conf)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ if conf.content_type == "" then
+ conf.content_type = "application/json;charset=utf8"
+ end
+ local typ, _ = parse_content_type(conf.content_type)
Review comment:
```suggestion
local typ = parse_content_type(conf.content_type)
```
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org