static_config_validator.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/components/static_config_validator.hpp
/// @brief Static component configuration validation helpers
 
#include <userver/components/component_config.hpp>
#include <userver/components/raw_component_base.hpp>
#include <userver/yaml_config/impl/validate_static_config.hpp>
#include <userver/yaml_config/schema.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace components {
 
enum class ValidationMode {
    kOnlyTurnedOn,
    kAll,
};
 
ValidationMode Parse(const yaml_config::YamlConfig& value, formats::parse::To<ValidationMode>);
 
namespace impl {
 
[[noreturn]] void WrapInvalidStaticConfigSchemaException(const std::exception&);
 
template <typename Component>
void TryValidateStaticConfig(
    std::string_view component_name,
    const components::ComponentConfig& static_config,
    ValidationMode validation_condition
) {
    if (components::kForceNoValidation<Component>) {
        return;
    }
 
    if (components::kHasValidate<Component> || validation_condition == ValidationMode::kAll) {
        yaml_config::Schema schema;
        try {
            schema = Component::GetStaticConfigSchema();
        } catch (const std::exception& ex) {
            WrapInvalidStaticConfigSchemaException(ex);
        }
        schema.path = component_name;
 
        yaml_config::impl::Validate(static_config, schema);
    }
}
 
template <typename Component>
yaml_config::Schema GetStaticConfigSchema() {
    // TODO: implement for kOnlyTurnedOn
    return Component::GetStaticConfigSchema();
}
 
}  // namespace impl
}  // namespace components
 
USERVER_NAMESPACE_END