[app,config,database] Move migration config into a separate struct

Signed-off-by: Mykola Kobets <mykola_kobets@epam.com>

Author: mykola-kobets-epam

src/app/app.cpp

@@ -9,7 +9,6 @@
 #include <execinfo.h>
 #include <iostream>
 
-#include <Poco/Path.h>
 #include <Poco/SignalHandler.h>
 #include <Poco/Util/HelpFormatter.h>
 #include <systemd/sd-daemon.h>
@@ -142,8 +141,7 @@ void App::initialize(Application& self)
     auto config = ParseConfig(mConfigFile.empty() ? cDefaultConfigFile : mConfigFile);
     AOS_ERROR_CHECK_AND_THROW("can't parse config", config.mError);
 
-    err = mDatabase.Init(Poco::Path(config.mValue.mWorkingDir, cDBFileName).toString(), config.mValue.mMigrationPath,
-        config.mValue.mMergedMigrationPath);
+    err = mDatabase.Init(config.mValue.mWorkingDir, config.mValue.mMigration);
     AOS_ERROR_CHECK_AND_THROW("can't initialize database", err);
 
     err = mNodeInfoProvider.Init(config.mValue.mNodeInfo);

src/app/app.hpp

@@ -36,7 +36,6 @@ class App : public Poco::Util::ServerApplication {
 
 private:
     static constexpr auto cSDNotifyReady     = "READY=1";
-    static constexpr auto cDBFileName        = "iamanager.db";
     static constexpr auto cDefaultConfigFile = "aos_iamanager.cfg";
     static constexpr auto cPKCS11CertModule  = "pkcs11module";
 

src/config/config.cpp

@@ -101,6 +101,16 @@ static NodeInfoConfig ParseNodeInfoConfig(const aos::common::utils::CaseInsensit
     return nodeInfoConfig;
 }
 
+static MigrationConfig ParseMigrationConfig(const aos::common::utils::CaseInsensitiveObjectWrapper& migration)
+{
+    MigrationConfig config {};
+
+    config.mMigrationPath       = migration.GetValue<std::string>("migrationPath");
+    config.mMergedMigrationPath = migration.GetValue<std::string>("mergedMigrationPath");
+
+    return config;
+}
+
 /***********************************************************************************************************************
  * Public functions
  **********************************************************************************************************************/
@@ -130,11 +140,7 @@ aos::RetWithError<Config> ParseConfig(const std::string& filename)
         config.mCertStorage              = object.GetValue<std::string>("certStorage");
         config.mWorkingDir               = object.GetValue<std::string>("workingDir");
         config.mEnablePermissionsHandler = object.GetValue<bool>("enablePermissionsHandler");
-
-        auto migration = object.GetObject("migration");
-
-        config.mMigrationPath       = migration.GetValue<std::string>("migrationPath");
-        config.mMergedMigrationPath = migration.GetValue<std::string>("mergedMigrationPath");
+        config.mMigration                = ParseMigrationConfig(object.GetObject("migration"));
 
         config.mStartProvisioningCmdArgs = aos::common::utils::GetArrayValue<std::string>(object,
             "startProvisioningCmdArgs", [](const Poco::Dynamic::Var& value) { return value.convert<std::string>(); });

src/config/config.hpp

@@ -94,6 +94,14 @@ struct NodeInfoConfig {
     std::vector<PartitionInfoConfig>             mPartitions;
 };
 
+/**
+ * Migration configuration.
+ */
+struct MigrationConfig {
+    std::string mMigrationPath;
+    std::string mMergedMigrationPath;
+};
+
 /*
  * Config instance.
  */
@@ -107,8 +115,7 @@ struct Config {
     std::string                  mCACert;
     std::string                  mCertStorage;
     std::string                  mWorkingDir;
-    std::string                  mMigrationPath;
-    std::string                  mMergedMigrationPath;
+    MigrationConfig              mMigration;
     std::vector<ModuleConfig>    mCertModules;
     std::vector<std::string>     mStartProvisioningCmdArgs;
     std::vector<std::string>     mDiskEncryptionCmdArgs;

src/database/database.cpp

@@ -9,6 +9,7 @@
 #include <Poco/Data/SQLite/Connector.h>
 #include <Poco/JSON/Parser.h>
 #include <Poco/JSON/Stringifier.h>
+#include <Poco/Path.h>
 #include <filesystem>
 
 #include "database.hpp"
@@ -38,24 +39,24 @@ Database::Database()
     Poco::Data::SQLite::Connector::registerConnector();
 }
 
-aos::Error Database::Init(
-    const std::string& dbPath, const std::string& migrationPath, const std::string& mergedMigrationPath)
+aos::Error Database::Init(const std::string& workDir, const MigrationConfig& migration)
 {
     if (mSession && mSession->isConnected()) {
         return aos::ErrorEnum::eNone;
     }
 
     try {
-        auto dirPath = std::filesystem::path(dbPath).parent_path();
+        auto dirPath = std::filesystem::path(workDir);
         if (!std::filesystem::exists(dirPath)) {
             std::filesystem::create_directories(dirPath);
         }
 
-        mSession = std::make_unique<Poco::Data::Session>("SQLite", dbPath);
+        const auto dbPath = Poco::Path(workDir, cDBFileName);
+        mSession          = std::make_unique<Poco::Data::Session>("SQLite", dbPath.toString());
         CreateTables();
 
-        mMigration.emplace(*mSession, migrationPath, mergedMigrationPath);
-        mMigration->MigrateToVersion(mVersion);
+        mMigration.emplace(*mSession, migration.mMigrationPath, migration.mMergedMigrationPath);
+        mMigration->MigrateToVersion(cVersion);
     } catch (const std::exception& e) {
         LOG_ERR() << "Failed to initialize database: " << e.what();
 

src/database/database.hpp

@@ -17,6 +17,7 @@
 
 #include <aos/iam/certmodules/certmodule.hpp>
 #include <aos/iam/nodemanager.hpp>
+#include <config/config.hpp>
 #include <migration/migration.hpp>
 
 class Database : public aos::iam::certhandler::StorageItf, public aos::iam::nodemanager::NodeInfoStorageItf {
@@ -29,13 +30,11 @@ class Database : public aos::iam::certhandler::StorageItf, public aos::iam::node
     /**
      * Initializes certificate info storage.
      *
-     * @param dbPath path to the database file.
-     * @param migrationPath path to the migration scripts.
-     * @param mergedMigrationPath path to the merged migration scripts.
+     * @param workDir working directory.
+     * @param migrationConf migration configuration.
      * @return Error.
      */
-    aos::Error Init(
-        const std::string& dbPath, const std::string& migrationPath, const std::string& mergedMigrationPath);
+    aos::Error Init(const std::string& workDir, const MigrationConfig& migrationConf);
 
     //
     // certhandler::StorageItf interface
@@ -134,7 +133,8 @@ class Database : public aos::iam::certhandler::StorageItf, public aos::iam::node
     enum CertColumns { eType = 0, eIssuer, eSerial, eCertURL, eKeyURL, eNotAfter };
     using CertInfo = Poco::Tuple<std::string, Poco::Data::BLOB, Poco::Data::BLOB, std::string, std::string, uint64_t>;
 
-    constexpr static int mVersion = 0;
+    constexpr static int  cVersion    = 0;
+    constexpr static auto cDBFileName = "iamanager.db";
 
     void     CreateTables();
     CertInfo ToAosCertInfo(const aos::String& certType, const aos::iam::certhandler::CertInfo& certInfo);

tests/config/config_test.cpp

@@ -164,8 +164,8 @@ TEST_F(ConfigTest, ParseConfig)
     EXPECT_EQ(config.mCACert, "/etc/ssl/certs/rootCA.crt");
     EXPECT_EQ(config.mCertStorage, "/var/aos/crypt/iam/");
     EXPECT_EQ(config.mWorkingDir, "/var/aos/iamanager");
-    EXPECT_EQ(config.mMigrationPath, "/usr/share/aos/iam/migration");
-    EXPECT_EQ(config.mMergedMigrationPath, "/var/aos/workdirs/iam/migration");
+    EXPECT_EQ(config.mMigration.mMigrationPath, "/usr/share/aos/iam/migration");
+    EXPECT_EQ(config.mMigration.mMergedMigrationPath, "/var/aos/workdirs/iam/migration");
     EXPECT_EQ(config.mEnablePermissionsHandler, true);
 
     EXPECT_EQ(config.mFinishProvisioningCmdArgs, std::vector<std::string> {"/var/aos/finish.sh"});

tests/database/database_test.cpp

@@ -83,20 +83,28 @@ static aos::NodeInfo DefaultNodeInfo(const char* id = "node0")
 
 class DatabaseTest : public Test {
 protected:
-    void SetUp() override { std::filesystem::create_directories(mMigrationPath); }
+    void SetUp() override
+    {
+        mMigrationConfig.mMigrationPath       = cMigrationPath;
+        mMigrationConfig.mMergedMigrationPath = cMergedMigrationPath;
+
+        std::filesystem::create_directories(cMigrationPath);
+    }
 
-    void TearDown() override { std::filesystem::remove_all("database"); }
+    void TearDown() override { std::filesystem::remove_all(cWorkingDir); }
 
     const aos::Array<uint8_t> StringToDN(const char* str)
     {
         return aos::Array<uint8_t>(reinterpret_cast<const uint8_t*>(str), strlen(str) + 1);
     }
 
 protected:
-    std::string mFileName            = "database/test/test.db";
-    std::string mMigrationPath       = "database/test/migration";
-    std::string mMergedMigrationPath = "database/test/merged-migration";
-    Database    mDB;
+    static constexpr auto cWorkingDir          = "database";
+    static constexpr auto cMigrationPath       = "database/migration";
+    static constexpr auto cMergedMigrationPath = "database/merged-migration";
+
+    MigrationConfig mMigrationConfig;
+    Database        mDB;
 };
 
 /***********************************************************************************************************************
@@ -113,7 +121,7 @@ TEST_F(DatabaseTest, AddCertInfo)
     certInfo.mKeyURL   = "keyURL";
     certInfo.mNotAfter = aos::Time::Now();
 
-    EXPECT_EQ(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath), aos::ErrorEnum::eNone);
+    EXPECT_EQ(mDB.Init(cWorkingDir, mMigrationConfig), aos::ErrorEnum::eNone);
 
     EXPECT_EQ(mDB.AddCertInfo("type", certInfo), aos::ErrorEnum::eNone);
     EXPECT_EQ(mDB.AddCertInfo("type", certInfo), aos::ErrorEnum::eFailed);
@@ -128,7 +136,7 @@ TEST_F(DatabaseTest, AddCertInfo)
 
 TEST_F(DatabaseTest, RemoveCertInfo)
 {
-    EXPECT_EQ(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath), aos::ErrorEnum::eNone);
+    EXPECT_EQ(mDB.Init(cWorkingDir, mMigrationConfig), aos::ErrorEnum::eNone);
 
     aos::iam::certhandler::CertInfo certInfo;
 
@@ -145,7 +153,7 @@ TEST_F(DatabaseTest, RemoveCertInfo)
 
 TEST_F(DatabaseTest, RemoveAllCertsInfo)
 {
-    EXPECT_EQ(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath), aos::ErrorEnum::eNone);
+    EXPECT_EQ(mDB.Init(cWorkingDir, mMigrationConfig), aos::ErrorEnum::eNone);
 
     aos::iam::certhandler::CertInfo certInfo;
 
@@ -169,7 +177,7 @@ TEST_F(DatabaseTest, RemoveAllCertsInfo)
 
 TEST_F(DatabaseTest, GetCertInfo)
 {
-    EXPECT_EQ(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath), aos::ErrorEnum::eNone);
+    EXPECT_EQ(mDB.Init(cWorkingDir, mMigrationConfig), aos::ErrorEnum::eNone);
 
     aos::iam::certhandler::CertInfo certInfo {};
 
@@ -204,7 +212,7 @@ TEST_F(DatabaseTest, GetCertInfo)
 
 TEST_F(DatabaseTest, GetCertsInfo)
 {
-    EXPECT_EQ(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath), aos::ErrorEnum::eNone);
+    EXPECT_EQ(mDB.Init(cWorkingDir, mMigrationConfig), aos::ErrorEnum::eNone);
 
     aos::StaticArray<aos::iam::certhandler::CertInfo, 2> certsInfo;
 
@@ -252,7 +260,7 @@ TEST_F(DatabaseTest, GetNodeInfo)
 {
     const auto& nodeInfo = DefaultNodeInfo();
 
-    ASSERT_TRUE(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath).IsNone());
+    ASSERT_TRUE(mDB.Init(cWorkingDir, mMigrationConfig).IsNone());
 
     ASSERT_TRUE(mDB.SetNodeInfo(nodeInfo).IsNone());
 
@@ -267,7 +275,7 @@ TEST_F(DatabaseTest, GetAllNodeIds)
     const auto& node1 = DefaultNodeInfo("node1");
     const auto& node2 = DefaultNodeInfo("node2");
 
-    ASSERT_TRUE(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath).IsNone());
+    ASSERT_TRUE(mDB.Init(cWorkingDir, mMigrationConfig).IsNone());
 
     ASSERT_TRUE(mDB.SetNodeInfo(node0).IsNone());
     ASSERT_TRUE(mDB.SetNodeInfo(node1).IsNone());
@@ -286,7 +294,7 @@ TEST_F(DatabaseTest, GetAllNodeIdsNotEnoughMemory)
     const auto& node1 = DefaultNodeInfo("node1");
     const auto& node2 = DefaultNodeInfo("node2");
 
-    ASSERT_TRUE(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath).IsNone());
+    ASSERT_TRUE(mDB.Init(cWorkingDir, mMigrationConfig).IsNone());
 
     ASSERT_TRUE(mDB.SetNodeInfo(node0).IsNone());
     ASSERT_TRUE(mDB.SetNodeInfo(node1).IsNone());
@@ -303,7 +311,7 @@ TEST_F(DatabaseTest, RemoveNodeInfo)
     const auto& node1 = DefaultNodeInfo("node1");
     const auto& node2 = DefaultNodeInfo("node2");
 
-    ASSERT_TRUE(mDB.Init(mFileName, mMigrationPath, mMergedMigrationPath).IsNone());
+    ASSERT_TRUE(mDB.Init(cWorkingDir, mMigrationConfig).IsNone());
 
     ASSERT_TRUE(mDB.SetNodeInfo(node0).IsNone());
     ASSERT_TRUE(mDB.SetNodeInfo(node1).IsNone());