refactor core: get rid of DefaultSecdistProvider component

Author: mnink275

clickhouse/functional_tests/basic_chaos/clickhouse_service.cpp

@@ -11,7 +11,6 @@
 #include <userver/server/handlers/http_handler_json_base.hpp>
 #include <userver/storages/clickhouse.hpp>
 #include <userver/storages/secdist/component.hpp>
-#include <userver/storages/secdist/provider_component.hpp>
 #include <userver/utils/boost_uuid4.hpp>
 #include <userver/utils/daemon_run.hpp>
 
@@ -214,7 +213,6 @@ int main(int argc, char* argv[]) {
           .Append<chaos::KeyValue>()
           .Append<chaos::UuidsHandler>()
           .Append<components::Secdist>()
-          .Append<components::DefaultSecdistProvider>()
           .Append<clients::dns::Component>()
           .Append<components::ClickHouse>("clickhouse-database");
 

clickhouse/functional_tests/metrics/service.cpp

@@ -15,7 +15,6 @@
 #include <userver/storages/clickhouse/query.hpp>
 
 #include <userver/storages/secdist/component.hpp>
-#include <userver/storages/secdist/provider_component.hpp>
 
 #include <userver/utils/daemon_run.hpp>
 #include "userver/clients/http/component.hpp"
@@ -116,8 +115,7 @@ int main(int argc, char* argv[]) {
           .Append<components::TestsuiteSupport>()
           .Append<server::handlers::TestsControl>()
           .Append<clients::dns::Component>()
-          .Append<components::Secdist>()
-          .Append<components::DefaultSecdistProvider>();
+          .Append<components::Secdist>();
 
   return utils::DaemonMain(argc, argv, components_list);
 }

core/functional_tests/cache_update/service.cpp

@@ -10,8 +10,6 @@
 #include <userver/dump/common_containers.hpp>
 #include <userver/server/handlers/http_handler_base.hpp>
 #include <userver/server/handlers/ping.hpp>
-#include <userver/storages/secdist/component.hpp>
-#include <userver/storages/secdist/provider_component.hpp>
 #include <userver/tracing/manager_component.hpp>
 #include <userver/utils/daemon_run.hpp>
 

core/functional_tests/https/service.cpp

@@ -1,6 +1,5 @@
 #include <userver/clients/dns/component.hpp>
 #include <userver/storages/secdist/component.hpp>
-#include <userver/storages/secdist/provider_component.hpp>
 #include <userver/testsuite/testsuite_support.hpp>
 
 #include <userver/alerts/handler.hpp>
@@ -20,7 +19,6 @@
 int main(int argc, char* argv[]) {
   const auto component_list = components::MinimalServerComponentList()
                                   .Append<https::HttpServerHandler>()
-                                  .Append<components::DefaultSecdistProvider>()
                                   .Append<components::Secdist>()
                                   .Append<components::LoggingConfigurator>()
                                   .Append<components::HttpClient>()

core/functional_tests/metrics/service.cpp

@@ -8,7 +8,6 @@
 #include <userver/dump/common_containers.hpp>
 #include <userver/server/handlers/ping.hpp>
 #include <userver/storages/secdist/component.hpp>
-#include <userver/storages/secdist/provider_component.hpp>
 #include <userver/tracing/manager_component.hpp>
 #include <userver/utils/daemon_run.hpp>
 
@@ -62,7 +61,6 @@ int main(int argc, const char* const argv[]) {
           .AppendComponentList(components::CommonComponentList())
           .AppendComponentList(components::CommonServerComponentList())
           .Append<components::Secdist>()
-          .Append<components::DefaultSecdistProvider>()
           .Append<functional_tests::CachedTranslations>()
           .Append<functional_tests::LruCachedTranslations>()
           .Append<server::handlers::Ping>();

core/functional_tests/uctl/service.cpp

@@ -8,7 +8,6 @@
 #include <userver/dump/common_containers.hpp>
 #include <userver/server/handlers/ping.hpp>
 #include <userver/storages/secdist/component.hpp>
-#include <userver/storages/secdist/provider_component.hpp>
 #include <userver/tracing/manager_component.hpp>
 #include <userver/utils/daemon_run.hpp>
 
@@ -18,7 +17,6 @@ int main(int argc, const char* const argv[]) {
           .AppendComponentList(components::CommonComponentList())
           .AppendComponentList(components::CommonServerComponentList())
           .Append<components::Secdist>()
-          .Append<components::DefaultSecdistProvider>()
           .Append<server::handlers::Ping>();
   return utils::DaemonMain(argc, argv, component_list);
 }

core/include/userver/storages/secdist/component.hpp

@@ -5,8 +5,7 @@
 
 #include <string>
 
-#include <userver/components/loggable_component_base.hpp>
-#include <userver/storages/secdist/secdist.hpp>
+#include <userver/storages/secdist/component_base.hpp>
 
 USERVER_NAMESPACE_BEGIN
 
@@ -39,24 +38,15 @@ namespace components {
 
 // clang-format on
 
-class Secdist final : public LoggableComponentBase {
+class Secdist final : public SecdistComponentBase {
  public:
   /// @ingroup userver_component_names
   /// @brief The default name of components::Secdist
   static constexpr std::string_view kName = "secdist";
 
   Secdist(const ComponentConfig&, const ComponentContext&);
 
-  const storages::secdist::SecdistConfig& Get() const;
-
-  rcu::ReadablePtr<storages::secdist::SecdistConfig> GetSnapshot() const;
-
-  storages::secdist::Secdist& GetStorage();
-
   static yaml_config::Schema GetStaticConfigSchema();
-
- private:
-  storages::secdist::Secdist secdist_;
 };
 
 template <>

core/include/userver/storages/secdist/component_base.hpp

@@ -0,0 +1,61 @@
+#pragma once
+
+/// @file userver/storages/secdist/component_base.hpp
+/// @brief @copybrief components::SecdistComponentBase
+
+#include <string>
+
+#include <userver/components/loggable_component_base.hpp>
+#include <userver/storages/secdist/secdist.hpp>
+
+USERVER_NAMESPACE_BEGIN
+
+namespace components {
+// clang-format off
+
+/// @ingroup userver_components
+///
+/// @brief Component that stores security related data (keys, passwords, ...).
+///
+/// The component must be configured in service config.
+///
+/// Secdist requires a provider storages::secdist::SecdistProvider
+/// You can implement your own or use components::DefaultSecdistProvider
+///
+/// ## Static configuration example:
+///
+/// @snippet samples/redis_service/static_config.yaml Sample secdist static config
+///
+/// ## Static options:
+/// Name | Description | Default value
+/// ---- | ----------- | -------------
+/// provider | optional secdist provider component name | 'default-secdist-provider'
+/// config | path to the config file with data | ''
+/// format | config format, either `json` or `yaml` | 'json'
+/// missing-ok | do not terminate components load if no file found by the config option | false
+/// environment-secrets-key | name of environment variable from which to load additional data | -
+/// update-period | period between data updates in utils::StringToDuration() suitable format ('0s' for no updates) | 0s
+/// blocking-task-processor | name of task processor for background blocking operations | --
+
+// clang-format on
+
+class SecdistComponentBase : public LoggableComponentBase {
+ public:
+  SecdistComponentBase(const ComponentConfig&, const ComponentContext&,
+          storages::secdist::SecdistConfig::Settings&&);
+
+  const storages::secdist::SecdistConfig& Get() const;
+
+  rcu::ReadablePtr<storages::secdist::SecdistConfig> GetSnapshot() const;
+
+  storages::secdist::Secdist& GetStorage();
+
+  static yaml_config::Schema GetStaticConfigSchema();
+
+ private:
+  storages::secdist::Secdist secdist_;
+};
+
+}  // namespace components
+
+USERVER_NAMESPACE_END

core/include/userver/storages/secdist/default_provider.hpp

@@ -0,0 +1,35 @@
+#pragma once
+
+/// @file userver/storages/secdist/component.hpp
+/// @brief @copybrief components::DefaultSecdistProvider
+
+#include <string>
+
+#include <userver/storages/secdist/provider.hpp>
+#include <userver/storages/secdist/secdist.hpp>
+
+USERVER_NAMESPACE_BEGIN
+
+namespace storages::secdist {
+
+class DefaultProvider final : public storages::secdist::SecdistProvider {
+ public:
+  struct Settings {
+    std::string config_path;
+    SecdistFormat format{SecdistFormat::kJson};
+    bool missing_ok{false};
+    std::optional<std::string> environment_secrets_key;
+    engine::TaskProcessor* blocking_task_processor{nullptr};
+  };
+
+  explicit DefaultProvider(Settings settings);
+
+  formats::json::Value Get() const override;
+
+ private:
+  Settings settings_;
+};
+
+}  // namespace storages::secdist
+
+USERVER_NAMESPACE_END