Refactor TestRecord class and add interop features for test execution context by david-driscoll · Pull Request #2250 · RocketSurgeonsGuild/Testing

david-driscoll · 2026-06-28T23:42:34Z

No description provided.

… context

codacy-production · 2026-06-28T23:44:46Z

Not up to standards ⛔

🔴 Issues 18 critical · 3 medium · 4 minor

Alerts:
⚠ 25 issues (≤ 0 issues of at least minor severity)

Results:
25 new issues

Category Results

Compatibility 1 medium

UnusedCode 1 minor

BestPractice 2 medium

ErrorProne 18 critical

CodeStyle 3 minor

View in Codacy

🟢 Metrics -4 complexity · 0 duplication

Metric Results

Complexity -4

Duplication 0

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

_{TIP This summary will be updated as you push new changes.}

github-actions · 2026-06-28T23:44:56Z

Test Results

0 tests ±0 0 ✅ ±0 0s ⏱️ ±0s
0 suites ±0 0 💤 ±0
0 files ±0 0 ❌ ±0

Results for commit 9af1bd7. ± Comparison against base commit 5640e0d.

codecov · 2026-06-28T23:45:08Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.25%. Comparing base (5640e0d) to head (9af1bd7).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##           main    #2250       +/-   ##
=========================================
+ Coverage      0   58.25%   +58.25%     
=========================================
  Files         0       52       +52     
  Lines         0     3368     +3368     
  Branches      0      221      +221     
=========================================
+ Hits          0     1962     +1962     
- Misses        0     1339     +1339     
- Partials      0       67       +67

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codacy-production

Pull Request Overview

This PR refactors the TestRecord class to use automatic TUnit context resolution and introduces interop delegation features for both TUnit and XUnit3. However, the Codacy analysis indicates the PR is not up to standards due to 25 new issues and a lack of required test coverage.

A critical risk exists in the Scriban template used for XUnit3 delegation: property and indexer setters are currently empty, which will lead to silent failures when writing to delegated members. Additionally, TestRecord lacks safe initialization for TestContext.Current, potentially causing NullReferenceExceptions if accessed outside a test lifecycle. There are also significant documentation copy-paste errors throughout the TUnit implementation referring to 'xUnit'.

About this PR

The source generation templates for XUnit3 delegation do not support writable properties or indexers. Any attempt to set values on these members will fail silently at runtime.
The PR description is empty. Please provide context regarding the new interop features and why the TestRecord refactoring was necessary.

Test suggestions

Verify TestRecord correctly proxies TUnit execution properties (Phase, Result, etc.)
Verify TestRecord correctly proxies TUnit output methods (WriteLine, AttachArtifact)
Verify TestRecord Isolation methods return correctly formatted unique names
Verify XUnitTestContext source-generated members correctly delegate calls to the underlying ITestContext

Prompt proposal for missing tests

Consider implementing these tests if applicable:
1. Verify TestRecord correctly proxies TUnit execution properties (Phase, Result, etc.)
2. Verify TestRecord correctly proxies TUnit output methods (WriteLine, AttachArtifact)
3. Verify TestRecord Isolation methods return correctly formatted unique names
4. Verify XUnitTestContext source-generated members correctly delegate calls to the underlying ITestContext

_{TIP Improve review quality by adding custom instructions}
_{TIP How was this review? Give us feedback}

codacy-production · 2026-06-28T23:45:58Z

+   set
+   {


_{🔴 HIGH RISK}

The indexer setter implementation is empty. Any attempt to set a value via an indexer on the generated classes will be silently ignored. This should delegate to the underlying reference.

codacy-production · 2026-06-28T23:45:58Z

+   }
+{{~end~}}
+{{~if property.have_setter~}}
+   set


_{🔴 HIGH RISK}

The property setter implementation is empty and ignores the 'value' parameter. It should delegate the assignment to the underlying reference to prevent silent failures when setting properties on the context.

codacy-production · 2026-06-28T23:45:58Z

+    /// This property is typically used to retrieve contextual information or perform
+    /// test-specific logging operations.
+    /// </remarks>
+    public TestContext TestContext { get; } = TestContext.Current!;


_{🔴 HIGH RISK}

The TestContext property relies on TestContext.Current, which may be null if accessed outside of a TUnit test execution. Explicitly checking for null and throwing a clear exception is recommended to avoid confusing NullReferenceExceptions.

Suggested change

public TestContext TestContext { get; } = TestContext.Current!;

public TestContext TestContext { get; } = TestContext.Current ?? throw new InvalidOperationException("TUnit TestContext is not available in the current execution context.");

codacy-production · 2026-06-28T23:45:58Z

+    /// var dotPrefix = TestContext.Current!.Isolation.GetIsolatedPrefix("."); // Returns "test.42."
+    /// </code>
+    /// </example>
+    public string GetIsolatedPrefix(string separator = "_") => ( (ITestIsolation)TestContext ).GetIsolatedPrefix(separator);


_{🟡 MEDIUM RISK}

Optional parameters in public APIs can cause versioning issues. Replacing 'GetIsolatedPrefix' and 'AttachArtifact' optional parameters with method overloads ensures the default values are centralized in the library.

codacy-production · 2026-06-28T23:45:58Z

+    /// </summary>
+    /// <param name="key">The key of the value to get or set.</param>
+    /// <returns>The value associated with the specified key.</returns>
+    public object? this[string key] => ( (ITestStateBag)TestContext )[key];


_{⚪ LOW RISK}

Suggestion: The indexer is missing a setter. Add a setter to maintain parity with the underlying ITestStateBag implementation, allowing users to use indexer assignment syntax.

codacy-production · 2026-06-28T23:45:58Z

@@ -0,0 +1,411 @@
+using TUnit.Core.Enums;


_{⚪ LOW RISK}

Suggestion: Specify CLS compliance for the assembly to ensure interoperability with other .NET languages like F# or VB.NET.

Suggested change

using TUnit.Core.Enums;

[assembly: System.CLSCompliant(true)]

using TUnit.Core.Enums;

codacy-production · 2026-06-28T23:45:58Z

 ///     The xunit test context
 /// </remarks>
-/// <param name="context"></param>
 /// <param name="logEventLevel"></param>
 /// <param name="outputTemplate"></param>
 /// <param name="configureLogger"></param>
 [PublicAPI]
-public abstract class TUnitTestRecord<TContext>(
-    TestContext context,
-    LogEventLevel logEventLevel = LogEventLevel.Verbose,
-    string? outputTemplate = null,
-    Action<TContext, LoggerConfiguration>? configureLogger = null
-    ) : RocketSurgeryTestContext<TContext>(
-    configureLogger,
-    logEventLevel,
-    outputTemplate
-    )
-    where TContext : RocketSurgeryTestContext<TContext>, ILoggingTestContext
+public abstract partial class TestRecord<TContext>
+    (LogEventLevel logEventLevel = LogEventLevel.Verbose, string? outputTemplate = null, Action<TContext, LoggerConfiguration>? configureLogger = null)
+    : RocketSurgeryTestContext<TContext>(configureLogger, logEventLevel, outputTemplate)
+    where TContext : RocketSurgeryTestContext<TContext>
 {
-    private readonly TestContext _context = context;
+    /// <summary>
+    /// Represents the current test context for xUnit tests.


_{⚪ LOW RISK}

Nitpick: The documentation here refers to 'xunit test context', but this class is part of the TUnit implementation. Update all XML summaries and remarks to correctly reflect TUnit.

Refactor TestRecord class and add interop features for test execution…

9af1bd7

… context

github-actions Bot added this to the v10.0.5 milestone Jun 28, 2026

codacy-production Bot reviewed Jun 28, 2026

View reviewed changes

david-driscoll merged commit ae42d6d into main Jun 28, 2026
9 of 10 checks passed

david-driscoll deleted the feature/test-context-wrapping branch June 28, 2026 23:50

github-actions Bot added the ✨ mysterious We forgot to label this label Jun 28, 2026

github-actions Bot modified the milestones: v10.0.5, v10.0.6, v10.0.7 Jun 28, 2026

Navigation Menu

Uh oh!

Refactor TestRecord class and add interop features for test execution context - #2250

Refactor TestRecord class and add interop features for test execution context#2250
david-driscoll merged 1 commit into
mainfrom
feature/test-context-wrapping

david-driscoll commented Jun 28, 2026

Uh oh!

codacy-production Bot commented Jun 28, 2026

Uh oh!

github-actions Bot commented Jun 28, 2026

Uh oh!

codecov Bot commented Jun 28, 2026

Uh oh!

codacy-production Bot left a comment

Uh oh!

codacy-production Bot Jun 28, 2026

Uh oh!

codacy-production Bot Jun 28, 2026

Uh oh!

codacy-production Bot Jun 28, 2026

Uh oh!

codacy-production Bot Jun 28, 2026

Uh oh!

codacy-production Bot Jun 28, 2026

Uh oh!

codacy-production Bot Jun 28, 2026

Uh oh!

codacy-production Bot Jun 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	public TestContext TestContext { get; } = TestContext.Current!;
	public TestContext TestContext { get; } = TestContext.Current ?? throw new InvalidOperationException("TUnit TestContext is not available in the current execution context.");

	using TUnit.Core.Enums;
	[assembly: System.CLSCompliant(true)]
	using TUnit.Core.Enums;

Uh oh!

Conversation

david-driscoll commented Jun 28, 2026

Uh oh!

codacy-production Bot commented Jun 28, 2026

Not up to standards ⛔

Uh oh!

github-actions Bot commented Jun 28, 2026

Test Results

Uh oh!

codecov Bot commented Jun 28, 2026

Codecov Report

Uh oh!

codacy-production Bot left a comment

Choose a reason for hiding this comment

Pull Request Overview

About this PR

Test suggestions

Uh oh!

codacy-production Bot Jun 28, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Jun 28, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Jun 28, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Jun 28, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Jun 28, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Jun 28, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Jun 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant