apisix/t/admin/plugins-reload.t
罗泽轩 3c857a8a13
fix: ensure the plugin is always reloaded (#4319)
* fix: ensure the plugin is always reloaded

Only trigger a reset from admin when the etcd's data is different
from the one of admin. So there is no need to add check in node side.

Fix #4314

Signed-off-by: spacewander <spacewanderlzx@gmail.com>

* fix reset check

Signed-off-by: spacewander <spacewanderlzx@gmail.com>

* fix error handling

Signed-off-by: spacewander <spacewanderlzx@gmail.com>

* update test

Signed-off-by: spacewander <spacewanderlzx@gmail.com>
2021-05-31 16:37:23 +08:00

386 lines
8.9 KiB
Perl
Vendored

#
# 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");
workers(2);
add_block_preprocessor(sub {
my ($block) = @_;
if (!defined $block->no_error_log) {
$block->set_value("no_error_log", "[error]");
}
$block;
});
run_tests;
__DATA__
=== TEST 1: reload plugins
--- config
location /t {
content_by_lua_block {
local t = require("lib.test_admin").test
-- now the plugin will be loaded twice,
-- one during startup and the other one by reload
local code, _, org_body = t('/apisix/admin/plugins/reload',
ngx.HTTP_PUT)
ngx.status = code
ngx.say(org_body)
ngx.sleep(0.2)
}
}
--- request
GET /t
--- response_body
done
--- grep_error_log eval
qr/sync local conf to etcd/
--- grep_error_log_out
sync local conf to etcd
--- error_log
load plugin times: 2
load plugin times: 2
start to hot reload plugins
start to hot reload plugins
=== TEST 2: reload plugins triggers plugin list sync
--- config
location /t {
content_by_lua_block {
local core = require "apisix.core"
local config_util = require("apisix.core.config_util")
ngx.sleep(0.5) -- make sure the sync happened when admin starts is already finished
local before_reload = true
local plugins_conf, err
plugins_conf, err = core.config.new("/plugins", {
automatic = true,
single_item = true,
filter = function(item)
-- called once before reload for sync data from admin
ngx.log(ngx.WARN, "reload plugins on node ",
before_reload and "before reload" or "after reload")
ngx.log(ngx.WARN, require("toolkit.json").encode(item.value))
end,
})
if not plugins_conf then
error("failed to create etcd instance for fetching /plugins : "
.. err)
end
ngx.sleep(0.5)
local data = [[
apisix:
node_listen: 1984
admin_key: null
plugins:
- jwt-auth
stream_plugins:
- mqtt-proxy
]]
require("lib.test_admin").set_config_yaml(data)
before_reload = false
local t = require("lib.test_admin").test
local code, _, org_body = t('/apisix/admin/plugins/reload',
ngx.HTTP_PUT)
ngx.status = code
ngx.say(org_body)
ngx.sleep(1)
}
}
--- request
GET /t
--- response_body
done
--- grep_error_log eval
qr/reload plugins on node \w+ reload/
--- grep_error_log_out
reload plugins on node before reload
reload plugins on node after reload
--- error_log
filter(): [{"name":"jwt-auth"},{"name":"mqtt-proxy","stream":true}]
=== TEST 3: reload plugins when attributes changed
--- yaml_config
apisix:
node_listen: 1984
admin_key: null
plugins:
- example-plugin
plugin_attr:
example-plugin:
val: 0
--- config
location /t {
content_by_lua_block {
local core = require "apisix.core"
ngx.sleep(0.1)
local data = [[
apisix:
node_listen: 1984
admin_key: null
plugins:
- example-plugin
plugin_attr:
example-plugin:
val: 1
]]
require("lib.test_admin").set_config_yaml(data)
local t = require("lib.test_admin").test
local code, _, org_body = t('/apisix/admin/plugins/reload',
ngx.HTTP_PUT)
ngx.status = code
ngx.say(org_body)
ngx.sleep(0.1)
local data = [[
apisix:
node_listen: 1984
admin_key: null
plugins:
- example-plugin
plugin_attr:
example-plugin:
val: 1
]]
require("lib.test_admin").set_config_yaml(data)
local t = require("lib.test_admin").test
local code, _, org_body = t('/apisix/admin/plugins/reload',
ngx.HTTP_PUT)
ngx.say(org_body)
ngx.sleep(0.1)
}
}
--- request
GET /t
--- response_body
done
done
--- grep_error_log eval
qr/example-plugin get plugin attr val: \d+/
--- grep_error_log_out
example-plugin get plugin attr val: 0
example-plugin get plugin attr val: 0
example-plugin get plugin attr val: 0
example-plugin get plugin attr val: 1
example-plugin get plugin attr val: 1
example-plugin get plugin attr val: 1
example-plugin get plugin attr val: 1
example-plugin get plugin attr val: 1
example-plugin get plugin attr val: 1
=== TEST 4: reload plugins to change prometheus' export uri
--- yaml_config
apisix:
node_listen: 1984
admin_key: null
plugins:
- prometheus
plugin_attr:
prometheus:
export_uri: /metrics
--- config
location /t {
content_by_lua_block {
local core = require "apisix.core"
ngx.sleep(0.1)
local t = require("lib.test_admin").test
local code, _, org_body = t('/apisix/metrics',
ngx.HTTP_GET)
ngx.say(code)
local data = [[
apisix:
node_listen: 1984
admin_key: null
plugins:
- prometheus
plugin_attr:
prometheus:
export_uri: /apisix/metrics
]]
require("lib.test_admin").set_config_yaml(data)
local code, _, org_body = t('/apisix/admin/plugins/reload',
ngx.HTTP_PUT)
ngx.say(org_body)
ngx.sleep(0.1)
local code, _, org_body = t('/apisix/metrics',
ngx.HTTP_GET)
ngx.say(code)
}
}
--- request
GET /t
--- response_body
404
done
200
=== TEST 5: reload plugins to disable skywalking
--- yaml_config
apisix:
node_listen: 1984
admin_key: null
plugins:
- skywalking
plugin_attr:
skywalking:
service_name: APISIX
service_instance_name: "APISIX Instance Name"
endpoint_addr: http://127.0.0.1:12801
report_interval: 1
--- config
location /t {
content_by_lua_block {
local core = require "apisix.core"
ngx.sleep(1.2)
local t = require("lib.test_admin").test
local data = [[
apisix:
node_listen: 1984
admin_key: null
plugins:
- prometheus
]]
require("lib.test_admin").set_config_yaml(data)
local code, _, org_body = t('/apisix/admin/plugins/reload',
ngx.HTTP_PUT)
ngx.say(org_body)
ngx.sleep(2)
}
}
--- request
GET /t
--- response_body
done
--- no_error_log
[alert]
--- grep_error_log eval
qr/Instance report fails/
--- grep_error_log_out
Instance report fails
=== TEST 6: check disabling plugin via etcd
--- config
location /t {
content_by_lua_block {
local t = require("lib.test_admin").test
local code, body = t('/apisix/admin/routes/1',
ngx.HTTP_PUT,
[[{
"plugins": {
"echo": {
"body":"hello upstream\n"
}
},
"upstream": {
"nodes": {
"127.0.0.1:1980": 1
},
"type": "roundrobin"
},
"uri": "/hello"
}]]
)
if code >= 300 then
ngx.status = code
end
ngx.say(body)
}
}
--- request
GET /t
--- response_body
passed
=== TEST 7: hit
--- yaml_config
apisix:
node_listen: 1984
enable_admin: false
--- request
GET /hello
--- response_body
hello upstream
=== TEST 8: hit after disabling echo
--- yaml_config
apisix:
node_listen: 1984
enable_admin: false
--- config
location /t {
content_by_lua_block {
local t = require("lib.test_admin").test
local etcd = require("apisix.core.etcd")
assert(etcd.set("/plugins", {{name = "jwt-auth"}}))
ngx.sleep(0.2)
local http = require "resty.http"
local httpc = http.new()
local uri = "http://127.0.0.1:" .. ngx.var.server_port
.. "/hello"
local res, err = httpc:request_uri(uri)
if not res then
ngx.say(err)
return
end
ngx.print(res.body)
}
}
--- request
GET /t
--- response_body
hello world