Switch logging framework from NLog to Serilog #853
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated project to remove NLog references and integrate Serilog. Added flexible logging options in the configuration.
Codecov Report❌ Patch coverage is
@@ Coverage Diff @@
## main #853 +/- ##
=======================================
+ Coverage 67.7% 68.0% +0.3%
=======================================
Files 106 112 +6
Lines 4224 4267 +43
Branches 951 956 +5
=======================================
+ Hits 2860 2901 +41
Misses 1038 1038
- Partials 326 328 +2
🚀 New features to boost your workflow:
|
|
axunonb
added a commit
that referenced
this pull request
Aug 13, 2025
* Add logging infrastructure
`Ical.Net`:
* Added package `Microsoft.Extensions.Logging.Abstractions` to `Ical.Net`
* Introduced `LoggingProvider` to support global logger factory configuration.
* `NullLoggerFactory` is the default factory
`Ical.Net.Tests`:
* Added ``TestLoggingProvider`
**Target:**
- The `TestLoggingProvider` is designed for use in testing scenarios within the iCal.NET project.
- It enables logging operations by configuring log targets, which can be either in-memory (`MemoryTarget`) or file-based (`FileTarget`).
- The target (where logs are stored) is set during construction, allowing flexibility for different test requirements.
**Usage:**
- Instantiate `TestLoggingProvider` in unit or integration tests to capture and inspect log output generated by iCal.NET components.
- You can specify logging options (like minimum/maximum log levels and logger name patterns) to control which log messages are recorded.
- Retrieve log entries via the `Logs` property, which returns the most recent logs up to a configurable maximum count (`Options.MaxLogsCount`).
- Useful for verifying that expected log messages are produced during test execution, or for debugging test failures by examining log output.
- Logging can be disabled in case no debugger is attached (`Options.DebugModeOnly`)
---
**Example Usage:**
```csharp
// Create a provider with in-memory logging
var provider = new TestLoggingProvider();
// Use provider.LoggerFactory to create loggers in your tests
var logger = provider.LoggerFactory.CreateLogger("TestLogger");
// Log something
logger.LogInformation("Test message");
// Retrieve logs for assertions
var logs = provider.Logs.ToList();
```
* Refactor logging framework and update tests (#852)
## Ical.Net
- Removed dependency `Microsoft.Extensions.Logging.Abstraction`
- Introduced new logging classes and interfaces (`ILogger`, `ILoggerFactory`, `NullLogger`, `NullLoggerFactory` et al) in namespace `Ical.Net.Logging`
- Refactored `LoggingProvider` to utilize `AsyncLocal<ILoggerFactory?>` for better async context management.
- Added extension methods for simplified logging calls.
## Ical.Net.Tests
- Added `Microsoft.Extensions.Logging` package
- Enhanced `LoggingProviderUnitTests` with new tests for logger factory initialization and multi-threaded logging behavior.
- Modified `TestLoggingProviderBase` to correctly use `NullTarget`.
- Updated `LogLevel` mappings for compatibility with `Ical.Net.Logging` implementation.
* Remove unused `ILoggerT`, implement `IDisposable` pattern for `NullLoggerFactory`
* Switch logging framework from NLog to Serilog (#853)
Updated project to remove NLog references and integrate Serilog.
Added flexible logging options in the configuration.
* Remove obsolete TestLoggingManager CTOR overloads
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated project to remove NLog references and integrate Serilog.
Added flexible logging options in the configuration.