Merge pull request #496 from wazuh/enhancement/122-unify-sqlite-manager

Use a unique database manager and integrate it with the queue
wazuh · Jan 15, 2025 · e3e7b5f · e3e7b5f
2 parents ec649d1 + bd22198
commit e3e7b5f
Show file tree

Hide file tree

Showing 38 changed files with 2,035 additions and 1,902 deletions.
diff --git a/src/agent/CMakeLists.txt b/src/agent/CMakeLists.txt
@@ -8,16 +8,16 @@ project(Agent)
 include(../cmake/CommonSettings.cmake)
 set_common_settings()
 
-add_subdirectory(task_manager)
 add_subdirectory(agent_info)
 add_subdirectory(centralized_configuration)
 add_subdirectory(command_handler)
+add_subdirectory(command_store)
 add_subdirectory(communicator)
 add_subdirectory(configuration_parser)
 add_subdirectory(module_command)
 add_subdirectory(multitype_queue)
-add_subdirectory(sqlite_manager)
-add_subdirectory(command_store)
+add_subdirectory(persistence)
+add_subdirectory(task_manager)
 
 find_package(OpenSSL REQUIRED)
 find_package(Boost REQUIRED COMPONENTS asio beast system program_options)

diff --git a/src/agent/agent_info/CMakeLists.txt b/src/agent/agent_info/CMakeLists.txt
@@ -15,7 +15,7 @@ add_library(AgentInfo src/agent_info.cpp src/agent_info_persistance.cpp)
 target_include_directories(AgentInfo PUBLIC
     ${CMAKE_CURRENT_SOURCE_DIR}/include
     ${CMAKE_CURRENT_SOURCE_DIR}/src)
-target_link_libraries(AgentInfo PUBLIC nlohmann_json::nlohmann_json Config PRIVATE SQLiteManager Boost::uuid Logger)
+target_link_libraries(AgentInfo PUBLIC nlohmann_json::nlohmann_json Config PRIVATE Persistence Boost::uuid Logger)
 
 if(MSVC)
     target_link_libraries(AgentInfo PRIVATE bcrypt)

diff --git a/src/agent/agent_info/include/agent_info.hpp b/src/agent/agent_info/include/agent_info.hpp
@@ -21,7 +21,7 @@ class AgentInfo
     /// information retrieval functions. It also generates a UUID for the agent if one
     /// does not already exist, and loads endpoint, metadata, and header information.
     ///
-    /// @param dbFolderPath Path to the SQLite database folder.
+    /// @param dbFolderPath Path to the database folder.
     /// @param getOSInfo Function to retrieve OS information in JSON format.
     /// @param getNetworksInfo Function to retrieve network information in JSON format.
     AgentInfo(std::string dbFolderPath = config::DEFAULT_DATA_PATH,

diff --git a/src/agent/agent_info/src/agent_info_persistance.cpp b/src/agent/agent_info/src/agent_info_persistance.cpp
@@ -2,13 +2,27 @@
 
 #include <logger.hpp>
 
-using namespace sqlite_manager;
+#include <column.hpp>
+#include <persistence.hpp>
+#include <persistence_factory.hpp>
+
+using namespace column;
 
 namespace
 {
+    // database
+    const std::string AGENT_INFO_DB_NAME = "agent_info.db";
+
+    // agent_info table
     const std::string AGENT_INFO_TABLE_NAME = "agent_info";
+    const std::string AGENT_INFO_NAME_COLUMN_NAME = "name";
+    const std::string AGENT_INFO_KEY_COLUMN_NAME = "key";
+    const std::string AGENT_INFO_UUID_COLUMN_NAME = "uuid";
+
+    // agent_group table
     const std::string AGENT_GROUP_TABLE_NAME = "agent_group";
-    const std::string AGENT_INFO_DB_NAME = "agent_info.db";
+    const std::string AGENT_GROUP_ID_COLUMN_NAME = "id";
+    const std::string AGENT_GROUP_NAME_COLUMN_NAME = "name";
 } // namespace
 
 AgentInfoPersistance::AgentInfoPersistance(const std::string& dbFolderPath)
@@ -17,7 +31,7 @@ AgentInfoPersistance::AgentInfoPersistance(const std::string& dbFolderPath)
 
     try
     {
-        m_db = std::make_unique<SQLiteManager>(dbFilePath);
+        m_db = PersistenceFactory::CreatePersistence(PersistenceFactory::PersistenceType::SQLITE3, dbFilePath);
 
         if (!m_db->TableExists(AGENT_INFO_TABLE_NAME))
         {
@@ -60,30 +74,33 @@ void AgentInfoPersistance::CreateAgentInfoTable()
 {
     try
     {
-        const std::vector<Column> columns = {Column("name", ColumnType::TEXT, true, false),
-                                             Column("key", ColumnType::TEXT, true, false),
-                                             Column("uuid", ColumnType::TEXT, true, false, true)};
+        const Keys columns = {ColumnKey(AGENT_INFO_NAME_COLUMN_NAME, ColumnType::TEXT, NOT_NULL),
+                              ColumnKey(AGENT_INFO_KEY_COLUMN_NAME, ColumnType::TEXT, NOT_NULL),
+                              ColumnKey(AGENT_INFO_UUID_COLUMN_NAME, ColumnType::TEXT, NOT_NULL | PRIMARY_KEY)};
 
         m_db->CreateTable(AGENT_INFO_TABLE_NAME, columns);
     }
     catch (const std::exception& e)
     {
         LogError("Error creating table: {}.", e.what());
+        throw;
     }
 }
 
 void AgentInfoPersistance::CreateAgentGroupTable()
 {
     try
     {
-        const std::vector<Column> columns = {Column("id", ColumnType::INTEGER, true, true, true),
-                                             Column("name", ColumnType::TEXT, true, false)};
+        const Keys columns = {
+            ColumnKey(AGENT_GROUP_ID_COLUMN_NAME, ColumnType::INTEGER, NOT_NULL | PRIMARY_KEY | AUTO_INCREMENT),
+            ColumnKey(AGENT_GROUP_NAME_COLUMN_NAME, ColumnType::TEXT, NOT_NULL)};
 
         m_db->CreateTable(AGENT_GROUP_TABLE_NAME, columns);
     }
     catch (const std::exception& e)
     {
         LogError("Error creating table: {}.", e.what());
+        throw;
     }
 }
 
@@ -95,24 +112,25 @@ void AgentInfoPersistance::InsertDefaultAgentInfo()
 
         if (count == 0)
         {
-            const std::vector<Column> columns = {Column("name", ColumnType::TEXT, ""),
-                                                 Column("key", ColumnType::TEXT, ""),
-                                                 Column("uuid", ColumnType::TEXT, "")};
+            const Row columns = {ColumnValue(AGENT_INFO_NAME_COLUMN_NAME, ColumnType::TEXT, ""),
+                                 ColumnValue(AGENT_INFO_KEY_COLUMN_NAME, ColumnType::TEXT, ""),
+                                 ColumnValue(AGENT_INFO_UUID_COLUMN_NAME, ColumnType::TEXT, "")};
 
             m_db->Insert(AGENT_INFO_TABLE_NAME, columns);
         }
     }
     catch (const std::exception& e)
     {
         LogError("Error inserting default agent info: {}.", e.what());
+        throw;
     }
 }
 
 void AgentInfoPersistance::SetAgentInfoValue(const std::string& column, const std::string& value)
 {
     try
     {
-        const std::vector<Column> columns = {Column(column, ColumnType::TEXT, value)};
+        const Row columns = {ColumnValue(column, ColumnType::TEXT, value)};
         m_db->Update(AGENT_INFO_TABLE_NAME, columns);
     }
     catch (const std::exception& e)
@@ -127,7 +145,7 @@ std::string AgentInfoPersistance::GetAgentInfoValue(const std::string& column) c
 
     try
     {
-        const std::vector<Column> columns = {Column(column, ColumnType::TEXT, "")};
+        const Names columns = {ColumnName(column, ColumnType::TEXT)};
         const std::vector<Row> results = m_db->Select(AGENT_INFO_TABLE_NAME, columns);
 
         if (!results.empty() && !results[0].empty())
@@ -145,17 +163,17 @@ std::string AgentInfoPersistance::GetAgentInfoValue(const std::string& column) c
 
 std::string AgentInfoPersistance::GetName() const
 {
-    return GetAgentInfoValue("name");
+    return GetAgentInfoValue(AGENT_INFO_NAME_COLUMN_NAME);
 }
 
 std::string AgentInfoPersistance::GetKey() const
 {
-    return GetAgentInfoValue("key");
+    return GetAgentInfoValue(AGENT_INFO_KEY_COLUMN_NAME);
 }
 
 std::string AgentInfoPersistance::GetUUID() const
 {
-    return GetAgentInfoValue("uuid");
+    return GetAgentInfoValue(AGENT_INFO_UUID_COLUMN_NAME);
 }
 
 std::vector<std::string> AgentInfoPersistance::GetGroups() const
@@ -164,7 +182,7 @@ std::vector<std::string> AgentInfoPersistance::GetGroups() const
 
     try
     {
-        const std::vector<Column> columns = {Column("name", ColumnType::TEXT, "")};
+        const Names columns = {ColumnName(AGENT_GROUP_NAME_COLUMN_NAME, ColumnType::TEXT)};
         const std::vector<Row> results = m_db->Select(AGENT_GROUP_TABLE_NAME, columns);
 
         for (const auto& row : results)
@@ -185,17 +203,17 @@ std::vector<std::string> AgentInfoPersistance::GetGroups() const
 
 void AgentInfoPersistance::SetName(const std::string& name)
 {
-    SetAgentInfoValue("name", name);
+    SetAgentInfoValue(AGENT_INFO_NAME_COLUMN_NAME, name);
 }
 
 void AgentInfoPersistance::SetKey(const std::string& key)
 {
-    SetAgentInfoValue("key", key);
+    SetAgentInfoValue(AGENT_INFO_KEY_COLUMN_NAME, key);
 }
 
 void AgentInfoPersistance::SetUUID(const std::string& uuid)
 {
-    SetAgentInfoValue("uuid", uuid);
+    SetAgentInfoValue(AGENT_INFO_UUID_COLUMN_NAME, uuid);
 }
 
 bool AgentInfoPersistance::SetGroups(const std::vector<std::string>& groupList)
@@ -208,7 +226,7 @@ bool AgentInfoPersistance::SetGroups(const std::vector<std::string>& groupList)
 
         for (const auto& group : groupList)
         {
-            const std::vector<Column> columns = {Column("name", ColumnType::TEXT, group)};
+            const Row columns = {ColumnValue(AGENT_GROUP_NAME_COLUMN_NAME, ColumnType::TEXT, group)};
             m_db->Insert(AGENT_GROUP_TABLE_NAME, columns);
         }
 

diff --git a/src/agent/agent_info/src/agent_info_persistance.hpp b/src/agent/agent_info/src/agent_info_persistance.hpp
@@ -1,17 +1,17 @@
 #pragma once
 
-#include <sqlite_manager.hpp>
-
 #include <memory>
 #include <string>
 #include <vector>
 
-/// @brief Manages persistence of agent information and groups in a SQLite database.
+class Persistence;
+
+/// @brief Manages persistence of agent information and groups in a database.
 class AgentInfoPersistance
 {
 public:
     /// @brief Constructs the persistence manager for agent info, initializing the database and tables if necessary.
-    /// @param dbFolderPath Path to the SQLite database folder.
+    /// @param dbFolderPath Path to the database folder.
     explicit AgentInfoPersistance(const std::string& dbFolderPath);
 
     /// @brief Destructor for AgentInfoPersistance.
@@ -89,6 +89,6 @@ class AgentInfoPersistance
     /// @return The value from the specified column as a string.
     std::string GetAgentInfoValue(const std::string& column) const;
 
-    /// @brief Unique pointer to the SQLite database manager instance.
-    std::unique_ptr<sqlite_manager::SQLiteManager> m_db;
+    /// @brief Unique pointer to the persistence instance.
+    std::unique_ptr<Persistence> m_db;
 };
diff --git a/src/agent/agent_info/tests/CMakeLists.txt b/src/agent/agent_info/tests/CMakeLists.txt
@@ -3,11 +3,11 @@ find_package(GTest CONFIG REQUIRED)
 add_executable(agent_info_test agent_info_test.cpp)
 configure_target(agent_info_test)
 target_include_directories(agent_info_test PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../src)
-target_link_libraries(agent_info_test PRIVATE AgentInfo SQLiteManager GTest::gtest)
+target_link_libraries(agent_info_test PRIVATE AgentInfo Persistence GTest::gtest)
 add_test(NAME AgentInfoTest COMMAND agent_info_test)
 
 add_executable(agent_info_persistance_test agent_info_persistance_test.cpp)
 configure_target(agent_info_persistance_test)
 target_include_directories(agent_info_persistance_test PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../src)
-target_link_libraries(agent_info_persistance_test PRIVATE AgentInfo SQLiteManager GTest::gtest)
+target_link_libraries(agent_info_persistance_test PRIVATE AgentInfo Persistence GTest::gtest)
 add_test(NAME AgentInfoPersistanceTest COMMAND agent_info_persistance_test)
diff --git a/src/agent/command_store/CMakeLists.txt b/src/agent/command_store/CMakeLists.txt
@@ -14,7 +14,7 @@ include(../../cmake/ConfigureTarget.cmake)
 configure_target(CommandStore)
 
 target_include_directories(CommandStore PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
-target_link_libraries(CommandStore PUBLIC SQLiteManager ModuleCommand PRIVATE Logger)
+target_link_libraries(CommandStore PUBLIC ModuleCommand PRIVATE Persistence Logger)
 
 if(BUILD_TESTS)
     enable_testing()

diff --git a/src/agent/command_store/include/command_store.hpp b/src/agent/command_store/include/command_store.hpp
@@ -1,27 +1,25 @@
 #pragma once
 
 #include <module_command/command_entry.hpp>
-#include <sqlite_manager.hpp>
 
 #include <memory>
 #include <optional>
 #include <string>
 
+class Persistence;
+
 namespace command_store
 {
-    const std::string COMMANDSTORE_DB_NAME = "command_store.db";
-    const std::string COMMANDSTORE_TABLE_NAME = "COMMAND";
-
     /// @brief CommandStore class
     ///
     /// This class provides methods for storing, retrieving, and deleting commands
-    /// in the command store database. It uses a SQLite database to store the
+    /// in the command store database. It uses a database to store the
     /// commands.
     class CommandStore
     {
     private:
-        /// @brief The SQLite database object
-        std::unique_ptr<sqlite_manager::SQLiteManager> m_dataBase;
+        /// @brief Unique pointer to the persistence instance.
+        std::unique_ptr<Persistence> m_dataBase;
 
         /// @brief Gets the current timestamp in seconds
         /// @return The current timestamp in seconds
@@ -37,6 +35,9 @@ namespace command_store
         /// @param dbFolderPath The path to the database folder
         CommandStore(const std::string& dbFolderPath);
 
+        /// @brief CommandStore destructor
+        ~CommandStore();
+
         /// @brief Clears all commands from the database
         /// @return True if successful, false otherwise
         bool Clear();