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

fix(admin): correct the count field of plugin-metadata/global-rule #6155

Merged
merged 8 commits into from
Jan 23, 2022
1 change: 1 addition & 0 deletions apisix/admin/global_rules.lua
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ function _M.get(id)
return 503, {error_msg = err}
end

utils.fix_count(res.body, id)
return res.status, res.body
end

Expand Down
2 changes: 2 additions & 0 deletions apisix/admin/plugin_metadata.lua
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ local error = error
local pcall = pcall
local require = require
local core = require("apisix.core")
local utils = require("apisix.admin.utils")
local api_router = require("apisix.api_router")

local injected_mark = "injected metadata_schema"
Expand Down Expand Up @@ -119,6 +120,7 @@ function _M.get(key)
return 503, {error_msg = err}
end

utils.fix_count(res.body, key)
return res.status, res.body
end

Expand Down
143 changes: 143 additions & 0 deletions t/admin/global-rules2.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
#
# 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");

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

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

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

run_tests;

__DATA__

=== TEST 1: list empty resources
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add some test cases for non-empty resources?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. please see b94a86c.

--- 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/global_rules',
ngx.HTTP_GET
)

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

res = json.decode(res)
ngx.say(json.encode(res))
}
}
--- response_body
{"action":"get","count":0,"node":{"dir":true,"key":"/apisix/global_rules","nodes":{}}}



=== TEST 2: set global rule
--- 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/global_rules/1',
ngx.HTTP_PUT,
[[{
"plugins": {
"proxy-rewrite": {
"uri": "/"
}
}
}]]
)

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/global_rules/1","value":{"id":"1","plugins":{"proxy-rewrite":{"uri":"/"}}}}}



=== TEST 3: list global rules
--- 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/global_rules',
ngx.HTTP_GET
)

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

res = json.decode(res)
ngx.say(json.encode(res))
}
}
--- response_body_like
{"action":"get","count":1,"node":\{"dir":true,"key":"/apisix/global_rules","nodes":.*



=== TEST 4: delete global rules
--- config
location /t {
content_by_lua_block {
local t = require("lib.test_admin").test
local code, message = t('/apisix/admin/global_rules/1',
ngx.HTTP_DELETE,
nil,
[[{
"action": "delete"
}]]
)
ngx.say("[delete] code: ", code, " message: ", message)
}
}
--- response_body
[delete] code: 200 message: passed
63 changes: 63 additions & 0 deletions t/admin/plugin-metadata2.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
#
# 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");

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

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

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

run_tests;

__DATA__

=== TEST 1: list empty resources
--- 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',
ngx.HTTP_GET
)

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

res = json.decode(res)
ngx.say(json.encode(res))
}
}
--- response_body
{"action":"get","count":0,"node":{"dir":true,"key":"/apisix/plugin_metadata","nodes":{}}}