Skip to content

[Test Improver] Add unit tests for LoggingManager.BuildAsync#8124

Merged
Evangelink merged 2 commits into
mainfrom
test-assist/logging-manager-build-async-tests-2026-05-05-50aebd2f268088a2
May 11, 2026
Merged

[Test Improver] Add unit tests for LoggingManager.BuildAsync#8124
Evangelink merged 2 commits into
mainfrom
test-assist/logging-manager-build-async-tests-2026-05-05-50aebd2f268088a2

Conversation

@Evangelink
Copy link
Copy Markdown
Member

@Evangelink Evangelink commented May 11, 2026

Cover all key behaviors of LoggingManager:

  • AddProvider with null throws ArgumentNullException
  • BuildAsync with no providers returns a non-null factory
  • BuildAsync with no providers returns a functional factory that can create a logger
  • Factory delegate receives the correct LogLevel and IServiceProvider (validated across Trace, Warning, and Critical)
  • Non-IExtension provider is always included
  • IExtension provider enabled -> included; disabled -> excluded
  • IAsyncInitializableExtension + enabled -> InitializeAsync called and provider included
  • IAsyncInitializableExtension + disabled -> InitializeAsync not called
  • Non-extension IAsyncInitializableExtension -> InitializeAsync called and provider included

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Cover all key behaviors of LoggingManager:
- AddProvider with null throws ArgumentNullException
- BuildAsync with no providers returns a non-null factory
- Factory delegate receives the correct LogLevel and IServiceProvider
- Non-IExtension provider is always included
- IExtension provider enabled -> included; disabled -> excluded
- IAsyncInitializableExtension + enabled -> InitializeAsync called
- IAsyncInitializableExtension + disabled -> InitializeAsync not called
- Non-extension IAsyncInitializableExtension -> InitializeAsync called

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 11, 2026 14:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds unit test coverage for Microsoft.Testing.Platform.Logging.LoggingManager.BuildAsync, which is responsible for assembling the platform ILoggerFactory and conditionally including/initializing providers.

Changes:

  • Adds coverage for AddProvider null-guard behavior.
  • Adds coverage for BuildAsync behavior with no providers and correct propagation of LogLevel/IServiceProvider into provider factories.
  • Adds coverage for extension-provider enable/disable filtering and async initialization (IAsyncInitializableExtension) behavior.
Show a summary per file
File Description
test/UnitTests/Microsoft.Testing.Platform.UnitTests/Logging/LoggingManagerTests.cs New unit tests covering provider inclusion/filtering and initialization behaviors in LoggingManager.BuildAsync.

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

Copy link
Copy Markdown
Member Author

@Evangelink Evangelink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

Workflow: PR Nitpick Reviewer 🔍
Date: 2026-05-11
Repository: microsoft/testfx

Key Findings

Good overall structure and naming conventions — the test names are descriptive and follow the MethodName_Condition_ExpectedBehavior pattern consistently. A few minor polish items:

  1. Unused CreateLogger mock setups (lines 109 & 136) — Two tests that focus solely on InitializeAsync also configure CreateLogger on their mock but never invoke factory.CreateLogger(), making those setups dead code.
  2. Unclear lambda parameter x in constructor (line 19) — The single instance of x is inconsistent with the more descriptive parameter names used elsewhere in the file.
  3. Nullable capture variable without intermediate assertion (line 56) — A missing Assert.IsNotNull(capturedServiceProvider) before the AreSame check would produce a clearer failure message if the factory is not invoked.

Positive Highlights

  • The three helper interface declarations (IExtensionLoggerProvider, IInitializableLoggerProvider, IInitializableExtensionLoggerProvider) are a clean approach to composing test-only types for different provider combinations.
  • Clear separation between "inclusion" tests (that call factory.CreateLogger) and "initialization" tests (that only check InitializeAsync was called).

Generated by PR Nitpick Reviewer

🔍 Meticulously inspected by PR Nitpick Reviewer 🔍

Copy link
Copy Markdown
Member Author

@Evangelink Evangelink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

Workflow: Expert Code Reviewer 🧠
Date: 2026-05-11
Repository: microsoft/testfx

Key Findings

No actionable issues found across all review categories:

  • Correctness ✅ — All eight test cases accurately reflect the production logic in LoggingManager.BuildAsync. The IExtension filter path (enabled/disabled), the TryInitializeAsync dispatch path (via the IAsyncInitializableExtension extension method), and the non-extension inclusion path are all correctly exercised.
  • Threading ✅ — Test-only code; no thread-safety concerns.
  • Performance ✅ — No hot-path concerns in test helpers.
  • API Compat ✅ — No public API changes. The three helper interfaces (IExtensionLoggerProvider, IInitializableLoggerProvider, IInitializableExtensionLoggerProvider) are internal and scoped to the test file.
  • Resources ✅ — IMonitor.Lock mock correctly returns a disposable; no leaked handles.
  • Security ✅ — No wire-format or IPC-contract changes.

Positive Observations

  • The test-local interface trio precisely models the four combination cases the production code branches on (IExtension × IAsyncInitializableExtension), without leaking test-only abstractions into production code.
  • The IMonitor mock is correctly initialized in the constructor so all async factory tests reuse the same setup.
  • Moq Verify calls are tight (Times.Once / Times.Never) and target the right method on the right mock.

Generated by Expert Code Reviewer 🧠

🧠 Reviewed by Expert Code Reviewer 🧠

Copy link
Copy Markdown
Member Author

@Evangelink Evangelink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

Workflow: Test Expert Reviewer 🧪
Date: 2026-05-11
Repository: microsoft/testfx

Overview

PR #8124 adds a new LoggingManagerTests.cs covering 8 behaviours of LoggingManager.BuildAsync. The tests are well-structured, isolated (all state is per-instance), use the correct assertion library (MSTest Assert APIs), and exercise all the main code paths described in the PR description. No flakiness or isolation bugs were found.

Key Findings

  1. [Coverage] BuildAsync_NoProviders_ReturnsNonNullFactory is a smoke-only test (line 33) — only Assert.IsNotNull is asserted; calling factory.CreateLogger(...) on the empty factory would give stronger confidence.

  2. [DataDriven] BuildAsync_PassesCorrectLogLevelAndServiceProviderToFactory tests a single LogLevel (line 55) — using [DataRow] with a few representative LogLevel values would make the "passthrough" invariant explicit and guard against accidental remapping in future refactors.

  3. [Coverage] BuildAsync_InitializableExtensionProvider_WhenEnabled_CallsInitializeAsync verifies initialization but not inclusion (line 114) — a regression where InitializeAsync() is called but the provider is not added to the factory would go undetected, since the existing inclusion test uses a non-initializable mock.

  4. [Coverage] Same gap in BuildAsync_NonExtensionInitializableProvider_CallsInitializeAsync (line 141) — no test jointly verifies that IAsyncInitializableExtension (non-IExtension) providers are both initialized and included.

What Looks Good

  • All mocks are instance fields; no static mutable state — the class is safe under parallel execution.
  • The three composite test interfaces (IExtensionLoggerProvider, IInitializableLoggerProvider, IInitializableExtensionLoggerProvider) are a clean way to create typed Moq mocks covering the relevant interface combinations.
  • The "disabled provider is excluded" test correctly calls factory.CreateLogger before asserting Times.Never.
  • Assertion methods match the assertion intent throughout (Assert.AreEqual, Assert.AreSame, Assert.ThrowsExactly, Moq .Verify).

Recommendations

  • For tests #3 and #4 above: store the returned factory and add factory.CreateLogger("test") + mockProvider.Verify(p => p.CreateLogger("test"), Times.Once) to jointly validate initialization and inclusion.
  • For test #2: parameterize with [DataRow(LogLevel.Trace)], [DataRow(LogLevel.Warning)], [DataRow(LogLevel.Critical)].

Generated by Test Expert Reviewer

🧪 Test quality reviewed by Test Expert Reviewer 🧪

@Evangelink
Copy link
Copy Markdown
Member Author

@copilot address review comments

Co-authored-by: Evangelink <11340282+Evangelink@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented May 11, 2026

@copilot address review comments

Done in 79fd012 — all actionable review comments on LoggingManagerTests have been addressed and validated with targeted test runs.

@Evangelink Evangelink merged commit 08dcdbe into main May 11, 2026
45 checks passed
@Evangelink Evangelink deleted the test-assist/logging-manager-build-async-tests-2026-05-05-50aebd2f268088a2 branch May 11, 2026 15:59
Evangelink added a commit that referenced this pull request May 12, 2026
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants