LOGR: Provide UT stub and improve encapsulation

[ivanovkirilg]

Fixes #12 by adding a std::cerr-logging stub implementation for use in unit-tests.

Encapsulation is improved by extracting the Logger details (private members) into LoggerImpl.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The changes primarily refactor the logging mechanism in the project by replacing the existing `Logger` class with an interface-based approach using `ILogger`. New implementations, such as `LoggerImpl`, are introduced to provide flexible and thread-safe logging capabilities. The modifications enhance testability and modularity, particularly with the inclusion of stub implementations for unit testing. Overall, these updates aim to improve the robustness and maintainability of the logging system. ## Changes | File(s) | Change Summary | |-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| | CTRL/test/UT_Controller.cpp | Introduced logging functionality in tests, enhancing observability of actions in `Controller`. | | LOGR/CMakeLists.txt | Renamed logging header and source files to `ILogger.hpp` and `ILogger.cpp`; added `LoggerImpl.cpp`. | | LOGR/inc/LoggerImpl.hpp | Added new `LoggerImpl` class for asynchronous logging with thread safety features. | | LOGR/include/LOGR/ILogger.hpp | Introduced `ILogger` interface with methods for logging and exceptions for logging errors. | | LOGR/include/LOGR/Trace.hpp | Updated `Trace` class to use the new `ILogger` interface for logging. | | LOGR/include/LOGR/Warning.hpp | Refactored to utilize `ILogger` for logging instead of the previous concrete `Logger`. | | LOGR/src/Exception.cpp | Modified to use `LoggerImpl` for logging messages in exception handling. | | LOGR/src/ILogger.cpp | Implemented `ILogger` interface and created a singleton logger pattern. | | LOGR/src/LoggerImpl.cpp | Refactored from `Logger` to `LoggerImpl`, updating method definitions and member variables. | | MAIN/src/main.cpp | Updated the main function to use `ILogger` for logging initialization, improving flexibility and modularity. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Main participant ILogger participant LoggerImpl Main->>ILogger: create("MAIN") ILogger->>LoggerImpl: initialize logger LoggerImpl-->>ILogger: return instance Main-->>ILogger: use logger instance ``` ## Assessment against linked issues | Objective | Addressed | Explanation | |------------------------------------------------------------|-----------|-------------------------------------------------------| | Implement LOGR stub classes for use in unit-tests. (12) | ✅ | | | Provide a logging mechanism that supports unit testing. (12)| ✅ | | | Enhance modularity of logging system. (12) | ✅ | |

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.