Do you use logging fakes #9565

tomek-i · 2024-11-07T23:13:58Z

What triggered this change? (PBI link, Email Subject, conversation + reason, etc)

✏️BizCover Client Work
SSWConsulting/SSW.SAW.General#8

What was changed?

✏️ Added new rule

Did you do pair or mob programming (list names)?

✏️ 🥷🏻

tiagov8 · 2024-11-08T17:08:16Z

rules/do-you-use-logging-fakes/rule.md

+guid: dc76970f-deea-4e92-9d55-731e83bee7b5
+---
+
+Unit tests are an essential part of ensuring that your .NET applications work correctly. However, when it comes to testing logging, things can get tricky. You don't want to rely on actual logging infrastructure like file writes or external logging systems during tests, as this could lead to unnecessary complexity and slow down your test suite.


Suggested change

Unit tests are an essential part of ensuring that your .NET applications work correctly. However, when it comes to testing logging, things can get tricky. You don't want to rely on actual logging infrastructure like file writes or external logging systems during tests, as this could lead to unnecessary complexity and slow down your test suite.

Unit tests are an essential part of ensuring .NET applications work correctly. However, when it comes to testing logging, things can get tricky. You don't want to rely on actual logging infrastructure like file writes or external logging systems during tests, as this could lead to unnecessary complexity and slow down your test suite.

tiagov8 · 2024-11-08T17:08:51Z

rules/do-you-use-logging-fakes/rule.md

+
+Microsoft provides a simple solution with `FakeLogger`. This logger allows you to capture and verify logging calls in unit tests without needing to integrate with a real logging framework.
+
+By incorporating `FakeLogger` into your tests, you can ensure that your logging functionality is correct and meets your application's needs, all while maintaining fast and isolated tests.


Suggested change

By incorporating `FakeLogger` into your tests, you can ensure that your logging functionality is correct and meets your application's needs, all while maintaining fast and isolated tests.

By incorporating `FakeLogger` into tests, you can ensure that the logging functionality is correct and meets your application's needs, all while maintaining fast and isolated tests.

tiagov8 · 2024-11-08T17:09:22Z

rules/do-you-use-logging-fakes/rule.md

+
+The FakeLogger is a mock logger provided by Microsoft for unit testing. It is part of the Microsoft.Extensions.Logging namespace and is used primarily in tests to verify that logging actions occur during the execution of the application, without sending log output to external destinations like the console or log files. Instead, it "fakes" the log output, allowing assertions to be made on the log entries.
+
+The advantage of using `FakeLogger` is that it behaves like a real `ILogger<T>`, but it stores the logs in memory, making them available for examination during your tests.


Suggested change

The advantage of using `FakeLogger` is that it behaves like a real `ILogger<T>`, but it stores the logs in memory, making them available for examination during your tests.

The advantage of using `FakeLogger` is that it behaves like a real `ILogger<T>`, but it stores the logs in memory, making them available for examination during tests.

tiagov8 · 2024-11-08T17:09:35Z

rules/do-you-use-logging-fakes/rule.md

+
+## Benefits of using FakeLogger
+
+- **No External Dependencies**: Since `FakeLogger` does not actually write logs anywhere (such as to disk or a remote server), it keeps your unit tests isolated and fast.


Suggested change

- **No External Dependencies**: Since `FakeLogger` does not actually write logs anywhere (such as to disk or a remote server), it keeps your unit tests isolated and fast.

- **No External Dependencies** - Since `FakeLogger` does not actually write logs anywhere (such as to disk or a remote server), it keeps unit tests isolated and fast

tiagov8 · 2024-11-08T17:09:50Z

rules/do-you-use-logging-fakes/rule.md

+## Benefits of using FakeLogger
+
+- **No External Dependencies**: Since `FakeLogger` does not actually write logs anywhere (such as to disk or a remote server), it keeps your unit tests isolated and fast.
+- **Verify Log Entries**: You can assert that certain log messages were generated during the execution of specific methods, helping to verify that your logging statements are firing correctly.


Suggested change

- **Verify Log Entries**: You can assert that certain log messages were generated during the execution of specific methods, helping to verify that your logging statements are firing correctly.

- **Verify Log Entries** - You can assert that certain log messages were generated during the execution of specific methods, helping to verify that logging statements are firing correctly

tiagov8 · 2024-11-08T17:11:07Z

rules/do-you-use-logging-fakes/rule.md

+
+## How to use FakeLogger
+
+To get started with `FakeLogger`, you need to install the necessary package:


Suggested change

To get started with `FakeLogger`, you need to install the necessary package:

To get started with `FakeLogger`, you need to install the necessary package.

tiagov8 · 2024-11-08T17:11:29Z

rules/do-you-use-logging-fakes/rule.md

+
+To get started with `FakeLogger`, you need to install the necessary package:
+
+Once you have the package installed, you can begin using the FakeLogger in your unit tests. Here's how to use it:


Suggested change

Once you have the package installed, you can begin using the FakeLogger in your unit tests. Here's how to use it:

Then you can begin using the FakeLogger in unit tests. Here's how to use it:

tiagov8 · 2024-11-08T17:12:15Z

rules/do-you-use-logging-fakes/rule.md

+
+While the basic usage of FakeLogger is straightforward, you can also use it to verify log levels, event IDs, and other log-related data.
+
+#### Verifying Log Levels


Suggested change

#### Verifying Log Levels

### Verifying Log Levels

tiagov8 · 2024-11-08T17:12:26Z

rules/do-you-use-logging-fakes/rule.md

+Assert.Contains(logEntries, log => log.LogLevel == LogLevel.Error);
+```
+
+#### Verifying Log Event IDs


Suggested change

#### Verifying Log Event IDs

### Verifying Log Event IDs

tiagov8 · 2024-11-08T17:13:01Z

rules/do-you-use-logging-fakes/rule.md

+seoDescription: Learn how to use Microsoft's `FakeLogger` in unit tests to verify logging behavior in .NET applications. This guide shows you how to capture log entries, check log levels, and ensure your logging works as expected during testing.
+type: rule
+title: Do you use Logging Fakes?
+uri: do-you-use-logging-fakes


Ho @tomek-i

1. Please avoid the "do-you-" on URLs, making it shorter and friendlier

github-actions · 2024-11-09T12:29:39Z

Howzit @tomek-i,

This PR has been here a while.

Did you know you should avoid merge debt?

Please action (e.g. get a review) and merge or close

Thanks!

danielmackay

One comment

danielmackay · 2024-11-11T06:32:55Z

rules/do-you-use-logging-fakes/rule.md

+seoDescription: Learn how to use Microsoft's `FakeLogger` in unit tests to verify logging behavior in .NET applications. This guide shows you how to capture log entries, check log levels, and ensure your logging works as expected during testing.
+type: rule
+title: Do you use Logging Fakes?
+uri: do-you-use-logging-fakes


Rule needs to be linked to one or more categories

tomek-i added 2 commits November 8, 2024 10:12

Create rule.md

3430aac

Update rule.md

7a46568

tomek-i requested a review from danielmackay November 7, 2024 23:13

tomek-i mentioned this pull request Nov 7, 2024

📈 SSW Rules - Logging Fakes SSWConsulting/SSW.SAW.General#8

Open

tiagov8 requested changes Nov 8, 2024

View reviewed changes

github-actions bot added Age: 🍗 - Ancient About 64 hours old 🔥 Merge Debt This PR contains merge debt, see https://www.ssw.com.au/rules/merge-debt/ and removed Age: 🐓 - Old About 32 hours old labels Nov 9, 2024

github-actions bot added Age: 🦖 - Extinct About 128 hours old and removed Age: 🍗 - Ancient About 64 hours old labels Nov 10, 2024

danielmackay requested changes Nov 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do you use logging fakes #9565

Do you use logging fakes #9565

tomek-i commented Nov 7, 2024 •

edited

Loading

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

tiagov8 Nov 8, 2024

github-actions bot commented Nov 9, 2024

danielmackay left a comment

danielmackay Nov 11, 2024

	Unit tests are an essential part of ensuring that your .NET applications work correctly. However, when it comes to testing logging, things can get tricky. You don't want to rely on actual logging infrastructure like file writes or external logging systems during tests, as this could lead to unnecessary complexity and slow down your test suite.
	Unit tests are an essential part of ensuring .NET applications work correctly. However, when it comes to testing logging, things can get tricky. You don't want to rely on actual logging infrastructure like file writes or external logging systems during tests, as this could lead to unnecessary complexity and slow down your test suite.


		Microsoft provides a simple solution with `FakeLogger`. This logger allows you to capture and verify logging calls in unit tests without needing to integrate with a real logging framework.

		By incorporating `FakeLogger` into your tests, you can ensure that your logging functionality is correct and meets your application's needs, all while maintaining fast and isolated tests.

	By incorporating `FakeLogger` into your tests, you can ensure that your logging functionality is correct and meets your application's needs, all while maintaining fast and isolated tests.
	By incorporating `FakeLogger` into tests, you can ensure that the logging functionality is correct and meets your application's needs, all while maintaining fast and isolated tests.


		The FakeLogger is a mock logger provided by Microsoft for unit testing. It is part of the Microsoft.Extensions.Logging namespace and is used primarily in tests to verify that logging actions occur during the execution of the application, without sending log output to external destinations like the console or log files. Instead, it "fakes" the log output, allowing assertions to be made on the log entries.

		The advantage of using `FakeLogger` is that it behaves like a real `ILogger<T>`, but it stores the logs in memory, making them available for examination during your tests.


		## Benefits of using FakeLogger

		- No External Dependencies: Since `FakeLogger` does not actually write logs anywhere (such as to disk or a remote server), it keeps your unit tests isolated and fast.

	- No External Dependencies: Since `FakeLogger` does not actually write logs anywhere (such as to disk or a remote server), it keeps your unit tests isolated and fast.
	- No External Dependencies - Since `FakeLogger` does not actually write logs anywhere (such as to disk or a remote server), it keeps unit tests isolated and fast

	- Verify Log Entries: You can assert that certain log messages were generated during the execution of specific methods, helping to verify that your logging statements are firing correctly.
	- Verify Log Entries - You can assert that certain log messages were generated during the execution of specific methods, helping to verify that logging statements are firing correctly


		## How to use FakeLogger

		To get started with `FakeLogger`, you need to install the necessary package:


		To get started with `FakeLogger`, you need to install the necessary package:

		Once you have the package installed, you can begin using the FakeLogger in your unit tests. Here's how to use it:

	Once you have the package installed, you can begin using the FakeLogger in your unit tests. Here's how to use it:
	Then you can begin using the FakeLogger in unit tests. Here's how to use it:


		While the basic usage of FakeLogger is straightforward, you can also use it to verify log levels, event IDs, and other log-related data.

		#### Verifying Log Levels

Do you use logging fakes #9565

Are you sure you want to change the base?

Do you use logging fakes #9565

Conversation

tomek-i commented Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 9, 2024

danielmackay left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomek-i commented Nov 7, 2024 •

edited

Loading