Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ext-plugin): support to get request body #5600

Merged
merged 6 commits into from
Nov 29, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion apisix/plugins/ext-plugin/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,11 @@ local function handle_extra_info(ctx, input)
var_req:Init(info.bytes, info.pos)

local var_name = var_req:Name()
res = ctx.var[var_name]
if var_name == "request_body" then
res = core.request.get_body()
else
res = ctx.var[var_name]
end
else
return nil, "unsupported info type: " .. info_type
end
Expand Down
2 changes: 2 additions & 0 deletions t/lib/ext-plugin.lua
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ function _M.go(case)
local entry = call_req:Args(1)
assert(entry:Name() == "x")
assert(entry:Value() == "z")
elseif case.get_request_body then
assert(call_req:Method() == a6_method.POST)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to check the request_body's value?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to validate different content-type, so the value of request body is not fixed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actions.result would check the value in request body?

else
assert(call_req:Method() == a6_method.GET)
end
Expand Down
177 changes: 177 additions & 0 deletions t/plugin/ext-plugin/request-body.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
#
# 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();

add_block_preprocessor(sub {
my ($block) = @_;

$block->set_value("stream_conf_enable", 1);

if (!defined $block->extra_stream_config) {
my $stream_config = <<_EOC_;
server {
listen unix:\$TEST_NGINX_HTML_DIR/nginx.sock;

content_by_lua_block {
local ext = require("lib.ext-plugin")
ext.go({})
}
}

_EOC_
$block->set_value("extra_stream_config", $stream_config);
}

my $unix_socket_path = $ENV{"TEST_NGINX_HTML_DIR"} . "/nginx.sock";
my $cmd = $block->ext_plugin_cmd // "['sleep', '5s']";
my $extra_yaml_config = <<_EOC_;
ext-plugin:
path_for_test: $unix_socket_path
cmd: $cmd
_EOC_

$block->set_value("extra_yaml_config", $extra_yaml_config);

if (!$block->request) {
$block->set_value("request", "GET /t");
}

if (!$block->error_log) {
$block->set_value("no_error_log", "[error]\n[alert]");
}
});

run_tests;

__DATA__

=== TEST 1: add route
--- 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": {
}
},
"upstream": {
"nodes": {
"127.0.0.1:1980": 1
},
"type": "roundrobin"
}
}]]
)

if code >= 300 then
ngx.status = code
ngx.say(message)
return
end

ngx.say(message)
}
}
--- response_body
passed



=== TEST 2: request body(text)
--- request
POST /hello
123
--- extra_stream_config
server {
listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;

content_by_lua_block {
local ext = require("lib.ext-plugin")
local actions = {
{type = "var", name = "request_body", result = "123"},
}
ext.go({extra_info = actions, stop = true, get_request_body = true})
}
}
--- error_code: 405
--- grep_error_log eval
qr/send extra info req successfully/
--- grep_error_log_out
send extra info req successfully



=== TEST 3: request body(x-www-form-urlencoded)
--- request
POST /hello
foo=bar
--- more_headers
Content-Type: application/x-www-form-urlencoded
--- extra_stream_config
server {
listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;

content_by_lua_block {
local ext = require("lib.ext-plugin")
local actions = {
{type = "var", name = "request_body", result = "foo=bar"},
}
ext.go({extra_info = actions, stop = true, get_request_body = true})
}
}
--- error_code: 405
--- grep_error_log eval
qr/send extra info req successfully/
--- grep_error_log_out
send extra info req successfully



=== TEST 4: request body(json)
tzssangglass marked this conversation as resolved.
Show resolved Hide resolved
--- request
POST /hello
{"foo":"bar"}
--- more_headers
Content-Type: application/json
--- extra_stream_config
server {
listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;

content_by_lua_block {
local ext = require("lib.ext-plugin")
local actions = {
{type = "var", name = "request_body", result = "{\"foo\":\"bar\"}"},
}
ext.go({extra_info = actions, stop = true, get_request_body = true})
}
}
--- error_code: 405
--- grep_error_log eval
qr/send extra info req successfully/
--- grep_error_log_out
send extra info req successfully