Unify usage of file helpers #566

sdvendramini · 2025-01-31T07:42:15Z

Description

Closes #550

The proposal is to unify the use of all functions related to files in a file_handler libray, where the implementation of filesystem-related functions is separated from IO operation.

Proposed Changes

File_helper is created, which is composed of the FilesystemWrapper and FileIO libraries. These contain functions that wrap standard functions and others that perform operations related to files and their directories.

In summary:

The IFileIO interface is created and IFileSystem is moved to file_helper.
Classes implementing these interfaces are created based on previous developments that were scattered in different locations.
Wrappers are added to make the code more testable.
Unnecessary functions are removed.
Tests are added.

Results and Evidence

E2E tests

Inventory - Network

Inventory - RPM Package

Inventory - NPM Package

Inventory - PYPI Package

Inventory - Hardware

Inventory - Process Info
Unit tests

Filesystem tests

FileIO tests
Manual tests for macOS
Inventory - Hardware
- main branch
- PR branch
Inventory - Package
- main branch
- PR branch

Artifacts Affected

Executable files, all platforms.

Configuration Changes

None

Documentation Updates

None

Tests Introduced

Added:

file_io_test

Moved:

filesystem_test

Fixed:

sysInfoPackageLinuxParserRPM_test
sysInfoPackagesNPM_test
sysInfoPackagesPYPI_test

Review Checklist

Code changes reviewed
Relevant evidence provided
Tests cover the new functionality
Configuration changes documented
Developer documentation reflects the changes
Meets requirements and/or definition of done
No unresolved dependencies with other issues
...

src/common/data_provider/CMakeLists.txt

src/common/linuxHelper/include/linuxInfoHelper.h

src/common/file_handler/filesystem/include/filesystem.hpp

src/common/file_handler/filesystem/include/ifilesystem.hpp

src/common/data_provider/src/network/networkLinuxWrapper.h

src/common/data_provider/src/packages/packageLinuxParserRpm.hpp

src/common/data_provider/src/packages/packagesNPM.hpp

src/common/data_provider/tests/sysInfoPackageLinuxParserRpm/CMakeLists.txt

src/common/file_handler/file_io/include/file_io.hpp

The functions is_regular_file and directory_iterator have been moved to the new library `file_handler`. Since the other functions in `fileHelper` were redundant, this file has been removed, and all its usages have been replaced with the new library. Additionally, the moved functions have been added to the. filesystem mock used in the centralized configuration tests.

The function is moved to the new file_handler, renamed to expand_absolute_path, all its usages are replaced, and associated tests are fixed.

The function is moved to the new file_handler, renamed to enumerate_dir, all its usages are replaced.

The class is created to host the method getRpmInfo. This way, it will be possible to mock the filesystem of file_handler and thus remove the use of existsRegular function.

This function has been removed, and its usage has been replaced by functions already present in the library. This results in simpler code. Additionally, the necessary changes have been made to ensure that the tests run successfully.

This class and its readLineByLinea method have been moved to the new library, and the necessary changes have been made to ensure that the tests run successfully.

These functions have been moved to the new FileIO class in file_handler. Their usages have been replaced, and new functions have been documented. Additionally, an interface has been added to allow mocking the functions in future tests.

The implementation and name of this method have been changed to return a vector instead of an iterator. This makes its use in tests and the way the method is mocked much simpler. Its usages have been replaced and tests fixed.

The remaining fileHelper files have been removed. The remaining tests for the expand_absolute_path function have been moved. A call to configure_target has been added in CMakeLists.txt file, which required some changes to avoid warnings and compilation errors.

The enumerate_dir function has been removed and its usages replaced with list_directory. To do so, some checks have been added in the code and the format of the returned values has been changed.

Methods have been added to the ifile_io interface to allow testing of the FileIO class functions. A mock has been added within the test file for internal testing, and the MockFileIO class has been completed for other tests that require it as an external dependency.

Pure abstract base class was missing a = 0 in create_ifstream

…m_wrapper

This class member is added to avoid using std::filesystem in the class implementation.

jr0me

LGTM

cborla · 2025-02-13T13:32:54Z

Good job!
The changes look good, as it affects several modules, I would like to see some examples of inventory tables for the 3 available OS.

sdvendramini self-assigned this Jan 31, 2025

sdvendramini linked an issue Jan 31, 2025 that may be closed by this pull request

Unify usage of file helpers #550

Closed

4 tasks

sdvendramini force-pushed the enhancement/550-unify-usage-of-file-helpers branch from b8fe1c0 to c1b3dde Compare January 31, 2025 09:07

sdvendramini mentioned this pull request Jan 31, 2025

Unify usage of file helpers #550

Closed

4 tasks

sdvendramini force-pushed the enhancement/550-unify-usage-of-file-helpers branch 16 times, most recently from a5480ee to dc7a627 Compare February 6, 2025 12:06

TomasTurina reviewed Feb 7, 2025

View reviewed changes

src/common/data_provider/CMakeLists.txt Outdated Show resolved Hide resolved

TomasTurina reviewed Feb 7, 2025

View reviewed changes

src/common/linuxHelper/include/linuxInfoHelper.h Outdated Show resolved Hide resolved