cborla
commented
3 months ago Define layout (v1)
Possible directory structure (TBD)
fim_project/
├── CMakeLists.txt
├── src/
│ ├── CMakeLists.txt
│ ├── fim/
│ │ ├── FIM.cpp
│ │ ├── FIM.h
│ │ └── ...
│ ├── dbsync/
│ │ ├── DBsync.cpp
│ │ ├── DBsync.h
│ │ └── ...
│ ├── persistence/
│ │ ├── Persistence.cpp
│ │ ├── Persistence.h
│ │ └── ...
│ └── main.cpp
├── include/
│ ├── fim/
│ │ ├── FIM.h
│ │ └── ...
│ ├── dbsync/
│ │ ├── DBsync.h
│ │ └── ...
│ └── persistence/
│ ├── Persistence.h
│ └── ...
├── tests/
│ ├── CMakeLists.txt
│ ├── test_fim.cpp
│ ├── test_dbsync.cpp
│ └── test_persistence.cpp
└── docs/
├── design.md
└── usage.md
Steps to Define the Layout
- Create the Repository (fim_project).
- Setup CMake.
- Organize Source Code.
- Import and Refactor FIM Module.
- Integrate DBsync and Persistence.
- Main Application Entry Point.
- Add Unit Tests (InitGoogleTest).
- Documentation.
Possible CMake
- Root CMakeLists.txt
cmake_minimum_required(VERSION 3.10)
project(FIM_Project)
set(CMAKE_CXX_STANDARD 17)
# Add subdirectories
add_subdirectory(src)
add_subdirectory(tests)
# Include directories
include_directories(include)
- src/CMakeLists.txt
# Add the FIM library
add_library(fim STATIC
fim/FIM.cpp
fim/FIM.h
# Add other FIM source files if needed
)
# Add the DBsync library
add_library(dbsync STATIC
dbsync/DBsync.cpp
dbsync/DBsync.h
# Add other DBsync source files if needed
)
# Add the Persistence library
add_library(persistence STATIC
persistence/Persistence.cpp
persistence/Persistence.h
# Add other Persistence source files if needed
)
# Add include directories for the libraries
target_include_directories(fim PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/fim)
target_include_directories(dbsync PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/dbsync)
target_include_directories(persistence PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/persistence)
# Create the main executable
add_executable(main main.cpp)
# Link the libraries to the main executable
target_link_libraries(main fim dbsync persistence)
- tests/CMakeLists.txt
# Find the GTest package
find_package(GTest REQUIRED)
include_directories(${GTEST_INCLUDE_DIRS})
# Add test executables
add_executable(test_fim test_fim.cpp)
target_link_libraries(test_fim ${GTEST_LIBRARIES} pthread fim)
add_executable(test_dbsync test_dbsync.cpp)
target_link_libraries(test_dbsync ${GTEST_LIBRARIES} pthread dbsync)
add_executable(test_persistence test_persistence.cpp)
target_link_libraries(test_persistence ${GTEST_LIBRARIES} pthread persistence)
# Enable testing
enable_testing()
# Add tests
add_test(NAME test_fim COMMAND test_fim)
add_test(NAME test_dbsync COMMAND test_dbsync)
add_test(NAME test_persistence COMMAND test_persistence)
Approval Section
The team must review and approve the proposed design, or iterate with changes until the final design is approved.
- [x] Is the design approved by the team? 🔴
- No, we decided to improve it.
LucioDonda
nbertoldo
Parent issue:
Description
In this spike we're going to write a program which will test the persistence model within the agent. We will transform FIM module into a library which will be used to detect file changes.
FIM will ensure the state generated is persisted, across program restarts. On a restart, differences between the saved state and new changes will be calculated locally, generating change events.
We will design how these events will reach the Wazuh servers in:
1
This will give us a vision about the current persistence capabilities as we want expand this model to the rest of the modules.
During this exploration we will investigate how this model could be applied to other modules such as SCA and Syscollector.
The following diagrams present an overall design for the agent, but these will change during the development of the spike.
Component diagram
Data flow
Implementation Restrictions
Plan
Define Layout:
FIM Module Transformation:
Persistence/Storage System:
DBsync Integration:
Proof of Concept (nice-to-have):