# # 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); master_on(); add_block_preprocessor(sub { my ($block) = @_; $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 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 --- error_log load plugin times: 1 load plugin times: 1 start to hot reload plugins start to hot reload plugins load(): plugins not changed load_stream(): plugins not changed load(): plugins not changed load_stream(): plugins not changed === 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() -- called twice, one for readir, another for waitdir ngx.log(ngx.WARN, "reload plugins on node ", before_reload and "before reload" or "after reload") local plugins = {} for _, conf_value in config_util.iterate_values(plugins_conf.values) do core.table.insert_tail(plugins, unpack(conf_value.value)) end ngx.log(ngx.WARN, require("toolkit.json").encode(plugins)) 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) } } --- 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 --- error_log plugin_attr of example-plugin changed plugins not changed === 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