feat(S3): added make to S3Config

ecmwf · Dec 20, 2024 · 3c29ecf · 3c29ecf
1 parent 701fe9e
commit 3c29ecf
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 12 deletions.
diff --git a/src/eckit/io/s3/S3Config.cc b/src/eckit/io/s3/S3Config.cc
@@ -19,7 +19,6 @@
 #include "eckit/config/LocalConfiguration.h"
 #include "eckit/config/Resource.h"
 #include "eckit/config/YAMLConfiguration.h"
-#include "eckit/container/DenseSet.h"
 #include "eckit/exception/Exceptions.h"
 #include "eckit/filesystem/URI.h"
 #include "eckit/log/CodeLocation.h"
@@ -28,9 +27,7 @@
 
 #include <cstdint>
 #include <iostream>
-#include <map>
 #include <ostream>
-#include <set>
 #include <string>
 #include <utility>
 #include <vector>
@@ -43,7 +40,11 @@ namespace {
 
 const std::string defaultConfigFile = "~/.config/eckit/S3Config.yaml";
 
-S3Config fromYAML(const LocalConfiguration& config) {
+}  // namespace
+
+//----------------------------------------------------------------------------------------------------------------------
+
+S3Config S3Config::make(const LocalConfiguration& config) {
     const net::Endpoint endpoint {config.getString("endpoint")};
 
     const auto region = config.getString("region", s3DefaultRegion);
@@ -70,11 +71,7 @@ S3Config fromYAML(const LocalConfiguration& config) {
     return s3config;
 }
 
-}  // namespace
-
-//----------------------------------------------------------------------------------------------------------------------
-
-auto S3Config::fromFile(std::string path) -> std::vector<S3Config> {
+auto S3Config::make(std::string path) -> std::vector<S3Config> {
 
     if (path.empty()) { path = Resource<std::string>("s3ConfigFile;$ECKIT_S3_CONFIG_FILE", defaultConfigFile); }
 
@@ -89,7 +86,7 @@ auto S3Config::fromFile(std::string path) -> std::vector<S3Config> {
 
     std::vector<S3Config> result;
     result.reserve(servers.size());
-    for (const auto& server : servers) { result.emplace_back(fromYAML(server)); }
+    for (const auto& server : servers) { result.emplace_back(make(server)); }
 
     return result;
 }

diff --git a/src/eckit/io/s3/S3Config.h b/src/eckit/io/s3/S3Config.h
@@ -28,6 +28,8 @@
 
 namespace eckit {
 
+class LocalConfiguration;
+
 enum class S3Backend : std::uint8_t { AWS, REST, MINIO };
 
 constexpr auto     s3DefaultHost   = "127.0.0.1";
@@ -60,7 +62,13 @@ constexpr auto     s3DefaultRegion = "default";
 ///
 struct S3Config {
 
-    static auto fromFile(std::string path) -> std::vector<S3Config>;
+    // static methods
+
+    static auto make(const LocalConfiguration& config) -> S3Config;
+
+    static auto make(std::string path) -> std::vector<S3Config>;
+
+    // constructors
 
     S3Config() = default;
 
@@ -70,6 +78,8 @@ struct S3Config {
 
     explicit S3Config(const URI& uri);
 
+    // operators
+
     bool operator==(const S3Config& other) const {
         return backend == other.backend && endpoint == other.endpoint && region == other.region;
     }
@@ -80,6 +90,8 @@ struct S3Config {
 
     friend std::ostream& operator<<(std::ostream& out, const S3Config& config);
 
+    // members
+
     net::Endpoint endpoint {s3DefaultHost, s3DefaultPort};
     std::string   region {s3DefaultRegion};
     S3Backend     backend {S3Backend::AWS};

diff --git a/src/eckit/io/s3/S3Session.cc b/src/eckit/io/s3/S3Session.cc
@@ -76,7 +76,7 @@ void S3Session::clear() {
 // CLIENT
 
 void S3Session::loadClients(const std::string& path) {
-    const auto configs = S3Config::fromFile(path);
+    const auto configs = S3Config::make(path);
     for (const auto& config : configs) { addClient(config); }
 }