feat core: support #file option in YamlConfig #561

goyambokkaboy · 2024-05-02T16:44:36Z

Fixes: #548

github-actions · 2024-05-02T16:44:50Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

apolukhin · 2024-05-03T15:55:19Z

universal/src/yaml_config/yaml_config.cpp

@@ -128,6 +153,12 @@ YamlConfig YamlConfig::operator[](std::string_view key) const {
      // Strip substitutions off to disallow nested substitutions
      return YamlConfig{std::move(*env_value), {}, Mode::kSecure};
    }
+
+    auto file_value = GetFromFileByKey(key, yaml_);


Looks good!

Please also update the docs and examples at

userver/universal/include/userver/yaml_config/yaml_config.hpp

Lines 31 to 60 in 0d821cf

/// If YAML has value that starts with an `$`, then such value is treated as

/// a variable from `config_vars`. For example if `config_vars` contains

/// `variable: 42` and the YAML is following:

/// @snippet universal/src/yaml_config/yaml_config_test.cpp sample vars

/// Then the result of `yaml["some_element"]["some"].As<int>()` is `42`.

///

/// If YAML key ends on '#env' and the mode is YamlConfig::Mode::kEnvAllowed,

/// then the value of the key is searched in

/// environment variables of the process and returned as a value. For example:

/// @snippet universal/src/yaml_config/yaml_config_test.cpp sample env

///

/// If YAML key ends on '#fallback', then the value of the key is used as a

/// fallback for environment and `$` variables. For example for the following

/// YAML with YamlConfig::Mode::kEnvAllowed:

/// @snippet universal/src/yaml_config/yaml_config_test.cpp sample multiple

/// The result of `yaml["some_element"]["some"].As<int>()` is the value of

/// `variable` from `config_vars` if it exists; otherwise the value is the

/// contents of the environment variable `SOME_ENV_VARIABLE` if it exists;

/// otherwise the value if `100500`, from the fallback.

///

/// Another example:

/// @snippet universal/src/yaml_config/yaml_config_test.cpp sample env fallback

/// With YamlConfig::Mode::kEnvAllowed the result of

/// `yaml["some_element"]["value"].As<int>()` is the value of `ENV_NAME`

/// environment variable if it exists; otherwise it is `5`.

///

/// @warning YamlConfig::Mode::kEnvAllowed should be used only on configs that

/// come from trusted environments. Otherwise, an attacker could create a

/// config with `#env` and read any of your environment variables, including

/// variables that contain passwords and other sensitive data.

Thanks for a review!
I have added a bit of documentation, could you please look one more time?

goyambokkaboy · 2024-05-06T17:16:36Z

Apologies, closing the pull request, apparently I'm legally not allowed to contribute to the open source project owned/backed by Yandex.

apolukhin · 2024-05-08T07:23:48Z

Ok

I'll implement the issue #548 by myself from scratch, to make sure that the code from this PR is not taken by any contributor

feat core: support #file option in YamlConfig

d672933

apolukhin requested changes May 3, 2024

View reviewed changes

Add documentation.

a1d0ead

goyambokkaboy requested a review from apolukhin May 4, 2024 21:16

goyambokkaboy closed this May 6, 2024

github-actions bot locked and limited conversation to collaborators May 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat core: support #file option in YamlConfig #561

feat core: support #file option in YamlConfig #561

goyambokkaboy commented May 2, 2024 •

edited

github-actions bot commented May 2, 2024 •

edited

apolukhin May 3, 2024

goyambokkaboy May 4, 2024

goyambokkaboy commented May 6, 2024

apolukhin commented May 8, 2024

	/// If YAML has value that starts with an `$`, then such value is treated as
	/// a variable from `config_vars`. For example if `config_vars` contains
	/// `variable: 42` and the YAML is following:
	/// @snippet universal/src/yaml_config/yaml_config_test.cpp sample vars
	/// Then the result of `yaml["some_element"]["some"].As<int>()` is `42`.
	///
	/// If YAML key ends on '#env' and the mode is YamlConfig::Mode::kEnvAllowed,
	/// then the value of the key is searched in
	/// environment variables of the process and returned as a value. For example:
	/// @snippet universal/src/yaml_config/yaml_config_test.cpp sample env
	///
	/// If YAML key ends on '#fallback', then the value of the key is used as a
	/// fallback for environment and `$` variables. For example for the following
	/// YAML with YamlConfig::Mode::kEnvAllowed:
	/// @snippet universal/src/yaml_config/yaml_config_test.cpp sample multiple
	/// The result of `yaml["some_element"]["some"].As<int>()` is the value of
	/// `variable` from `config_vars` if it exists; otherwise the value is the
	/// contents of the environment variable `SOME_ENV_VARIABLE` if it exists;
	/// otherwise the value if `100500`, from the fallback.
	///
	/// Another example:
	/// @snippet universal/src/yaml_config/yaml_config_test.cpp sample env fallback
	/// With YamlConfig::Mode::kEnvAllowed the result of
	/// `yaml["some_element"]["value"].As<int>()` is the value of `ENV_NAME`
	/// environment variable if it exists; otherwise it is `5`.
	///
	/// @warning YamlConfig::Mode::kEnvAllowed should be used only on configs that
	/// come from trusted environments. Otherwise, an attacker could create a
	/// config with `#env` and read any of your environment variables, including
	/// variables that contain passwords and other sensitive data.

feat core: support #file option in YamlConfig #561

feat core: support #file option in YamlConfig #561

Conversation

goyambokkaboy commented May 2, 2024 • edited

github-actions bot commented May 2, 2024 • edited

apolukhin May 3, 2024

Choose a reason for hiding this comment

goyambokkaboy May 4, 2024

Choose a reason for hiding this comment

goyambokkaboy commented May 6, 2024

apolukhin commented May 8, 2024

goyambokkaboy commented May 2, 2024 •

edited

github-actions bot commented May 2, 2024 •

edited