Skip to content

Commit

Permalink
[Feature] Check for plugin configuration errors on configtest
Browse files Browse the repository at this point in the history
  • Loading branch information
vstakhov committed Aug 7, 2023
1 parent f1e5383 commit 890e7fe
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 3 deletions.
17 changes: 17 additions & 0 deletions lualib/lua_cfg_utils.lua
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ limitations under the License.
-- This module contains utility functions for configuration of Rspamd modules
--]]
local rspamd_logger = require "rspamd_logger"
local exports = {}
--[[[
Expand Down Expand Up @@ -64,4 +65,20 @@ exports.push_config_error = function(module, err)
table.insert(rspamd_plugins_state.config_errors[module], err)
end
exports.check_configuration_errors = function()
local ret = true
if type(rspamd_plugins_state.config_errors) == 'table' then
-- We have some errors found during the configuration, so we need to show them
for m, errs in pairs(rspamd_plugins_state.config_errors) do
for _, err in ipairs(errs) do
rspamd_logger.errx(rspamd_config, 'configuration error: module %s: %s', m, err)
ret = false
end
end
end
return ret
end
return exports
23 changes: 20 additions & 3 deletions src/rspamadm/configtest.c
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/*-
* Copyright 2016 Vsevolod Stakhov
/*
* Copyright 2023 Vsevolod Stakhov
*
* Licensed 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
* 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,
Expand Down Expand Up @@ -150,6 +150,23 @@ rspamadm_configtest(gint argc, gchar **argv, const struct rspamadm_command *cmd)
FALSE)) {
ret = FALSE;
}

if (ret) {
if (rspamd_lua_require_function(cfg->lua_state, "lua_cfg_utils", "check_configuration_errors")) {
GError *err = NULL;

if (!rspamd_lua_universal_pcall(cfg->lua_state, -1, G_STRLOC, 1, "", &err)) {
msg_err_config("call to lua function failed: %s",
lua_tostring(cfg->lua_state, -1));
lua_pop(cfg->lua_state, 2);
ret = FALSE;
}
else {
ret = lua_toboolean(cfg->lua_state, -1);
lua_pop(cfg->lua_state, 2);
}
}
}
}

if (strict && ret) {
Expand Down

0 comments on commit 890e7fe

Please sign in to comment.