chore(userspace,falco.yaml,unit_tests): configs_files -> config_files.

Signed-off-by: Federico Di Pierro <nierro92@gmail.com>
This commit is contained in:
Federico Di Pierro 2024-05-20 14:30:37 +02:00 committed by poiana
parent 1b22c4566a
commit a48965a00c
6 changed files with 16 additions and 16 deletions

View File

@ -25,8 +25,8 @@
# #
# (Falco command-line arguments) # (Falco command-line arguments)
# (Falco environment variables) # (Falco environment variables)
# Falco configs files # Falco config files settings
# configs_files [Stable] # config_files [Stable]
# watch_config_files [Stable] # watch_config_files [Stable]
# Falco rules files # Falco rules files
# rules_files [Stable] # rules_files [Stable]
@ -130,11 +130,11 @@
# disabling the automatic artifacts followed by falcoctl. # disabling the automatic artifacts followed by falcoctl.
####################### ###############################
# Falco configs files # # Falco config files settings #
####################### ###############################
# [Stable] `configs_files` # [Stable] `config_files`
# #
# Falco will load additional configs files specified here. # Falco will load additional configs files specified here.
# Their loading is assumed to be made *after* main config file has been processed, # Their loading is assumed to be made *after* main config file has been processed,
@ -143,7 +143,7 @@
# Also, nested include is not allowed, ie: included config files won't be able to include other config files. # Also, nested include is not allowed, ie: included config files won't be able to include other config files.
# #
# Like for 'rules_files', specifying a folder will load all the configs files present in it in a lexicographical order. # Like for 'rules_files', specifying a folder will load all the configs files present in it in a lexicographical order.
configs_files: config_files:
- /etc/falco/config.d - /etc/falco/config.d
# [Stable] `watch_config_files` # [Stable] `watch_config_files`

View File

@ -368,7 +368,7 @@ TEST(Configuration, configuration_config_files_unexistent)
std::filesystem::remove("main.yaml"); std::filesystem::remove("main.yaml");
} }
TEST(Configuration, configuration_config_files_scalar_configs_files) TEST(Configuration, configuration_config_files_scalar_config_files)
{ {
/* Test that a single file can be included as a scalar (thanks to get_sequence_from_node magic) */ /* Test that a single file can be included as a scalar (thanks to get_sequence_from_node magic) */
const std::string main_conf_yaml = const std::string main_conf_yaml =
@ -413,7 +413,7 @@ TEST(Configuration, configuration_config_files_scalar_configs_files)
std::filesystem::remove("conf_2.yaml"); std::filesystem::remove("conf_2.yaml");
} }
TEST(Configuration, configuration_config_files_empty_configs_files) TEST(Configuration, configuration_config_files_empty_config_files)
{ {
/* Test that empty includes list is accepted */ /* Test that empty includes list is accepted */
const std::string main_conf_yaml = const std::string main_conf_yaml =
@ -561,7 +561,7 @@ TEST(Configuration, configuration_config_files_cmdline)
outfile << conf_yaml_2; outfile << conf_yaml_2;
outfile.close(); outfile.close();
// Pass "configs_files=..." cmdline option // Pass "config_files=..." cmdline option
std::vector<std::string> cmdline_config_options; std::vector<std::string> cmdline_config_options;
cmdline_config_options.push_back((yaml_helper::configs_key+"=conf_2.yaml")); cmdline_config_options.push_back((yaml_helper::configs_key+"=conf_2.yaml"));

View File

@ -30,7 +30,7 @@ static falco::app::run_result apply_deprecated_options(const falco::app::state&
falco::app::run_result falco::app::actions::load_config(const falco::app::state& s) falco::app::run_result falco::app::actions::load_config(const falco::app::state& s)
{ {
// List of loaded conf files, ie: s.options.conf_filename // List of loaded conf files, ie: s.options.conf_filename
// plus all the `configs_files` expanded list of configs. // plus all the `config_files` expanded list of configs.
std::vector<std::string> loaded_conf_files; std::vector<std::string> loaded_conf_files;
try try
{ {

View File

@ -99,7 +99,7 @@ void falco_configuration::init_from_file(const std::string& conf_filename, std::
throw e; throw e;
} }
init_cmdline_options(cmdline_options); init_cmdline_options(cmdline_options);
merge_configs_files(conf_filename, loaded_conf_files); merge_config_files(conf_filename, loaded_conf_files);
load_yaml(conf_filename); load_yaml(conf_filename);
} }
@ -108,7 +108,7 @@ std::string falco_configuration::dump()
return config.dump(); return config.dump();
} }
void falco_configuration::merge_configs_files(const std::string& config_name, std::vector<std::string>& loaded_config_files) void falco_configuration::merge_config_files(const std::string& config_name, std::vector<std::string>& loaded_config_files)
{ {
// Load configs files to be included and merge them into current config // Load configs files to be included and merge them into current config
// NOTE: loaded_config_files will resolve to the filepaths list of loaded config. // NOTE: loaded_config_files will resolve to the filepaths list of loaded config.

View File

@ -195,7 +195,7 @@ public:
yaml_helper config; yaml_helper config;
private: private:
void merge_configs_files(const std::string& config_name, std::vector<std::string>& loaded_config_files); void merge_config_files(const std::string& config_name, std::vector<std::string>& loaded_config_files);
void load_yaml(const std::string& config_name); void load_yaml(const std::string& config_name);
void init_logger(); void init_logger();
void load_engine_config(const std::string& config_name); void load_engine_config(const std::string& config_name);

View File

@ -78,7 +78,7 @@ private:
class yaml_helper class yaml_helper
{ {
public: public:
inline static const std::string configs_key = "configs_files"; inline static const std::string configs_key = "config_files";
/** /**
* Load the YAML document represented by the input string. * Load the YAML document represented by the input string.
@ -104,7 +104,7 @@ public:
{ {
/* /*
* To avoid recursion hell, * To avoid recursion hell,
* we don't support `configs_files` directives from included config files * we don't support `config_files` directives from included config files
* (that use load_from_file_int recursively). * (that use load_from_file_int recursively).
*/ */
const auto &key = n.first.Scalar(); const auto &key = n.first.Scalar();