Skip to content

Clarify TUnit0046 diagnostic message for data source return types #3843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomhurst merged 3 commits into from
Nov 14, 2025
Merged

Clarify TUnit0046 diagnostic message for data source return types #3843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13a403f
Initial plan
Copilot Nov 14, 2025
4158a41
Update TUnit0046 analyzer message to be clearer
Copilot Nov 14, 2025
d1f6647
Update documentation for TUnit0046 to match new message
Copilot Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion TUnit.Analyzers/AnalyzerReleases.Shipped.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### New Rules

#### Test Method and Structure Rules

Check warning on line 5 in TUnit.Analyzers/AnalyzerReleases.Shipped.md

View workflow job for this annotation

GitHub Actions / modularpipeline (fr-FR) 

Le fichier de version d'analyseur 'AnalyzerReleases.Shipped.md' a un en-tête de version '#### Test Method and Structure Rules' non valide, ou celui-ci est manquant (https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md)

Check warning on line 5 in TUnit.Analyzers/AnalyzerReleases.Shipped.md

View workflow job for this annotation

GitHub Actions / modularpipeline (pl-PL) 

Brak nagłówka wydania „#### Test Method and Structure Rules” w pliku wydania analizatora „AnalyzerReleases.Shipped.md” lub jest on nieprawidłowy (https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md)

Check warning on line 5 in TUnit.Analyzers/AnalyzerReleases.Shipped.md

View workflow job for this annotation

GitHub Actions / modularpipeline (windows-latest) 

Analyzer release file 'AnalyzerReleases.Shipped.md' has a missing or invalid release header '#### Test Method and Structure Rules' (https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md)

Check warning on line 5 in TUnit.Analyzers/AnalyzerReleases.Shipped.md

View workflow job for this annotation

GitHub Actions / modularpipeline (ubuntu-latest) 

Analyzer release file 'AnalyzerReleases.Shipped.md' has a missing or invalid release header '#### Test Method and Structure Rules' (https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md)

Check warning on line 5 in TUnit.Analyzers/AnalyzerReleases.Shipped.md

View workflow job for this annotation

GitHub Actions / modularpipeline (windows-latest) 

Analyzer release file 'AnalyzerReleases.Shipped.md' has a missing or invalid release header '#### Test Method and Structure Rules' (https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md)

Check warning on line 5 in TUnit.Analyzers/AnalyzerReleases.Shipped.md

View workflow job for this annotation

GitHub Actions / modularpipeline (macos-latest) 

Analyzer release file 'AnalyzerReleases.Shipped.md' has a missing or invalid release header '#### Test Method and Structure Rules' (https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md)
Rule ID | Category | Severity | Notes
--------|----------|----------|------------------------------------------------
TUnit0001 | Usage | Error | Test argument types don't match method parameters
Expand All @@ -28,7 +28,7 @@
TUnit0043 | Usage | Error | Properties with data attributes must use 'required' keyword
TUnit0044 | Usage | Error | Properties with data attributes must have a setter
TUnit0045 | Usage | Error | Property has multiple data source attributes - use only one
TUnit0046 | Usage | Warning | Data source should return Func<T> for lazy evaluation instead of T
TUnit0046 | Usage | Warning | Data source should return Func<T> for reference types to ensure test isolation
TUnit0049 | Usage | Error | [Matrix] parameters require [MatrixDataSource] attribute on the test method
TUnit0050 | Usage | Error | Too many test arguments provided
TUnit0056 | Usage | Error | Instance data source methods must use [InstanceMethodDataSource] attribute
Expand Down
6 changes: 3 additions & 3 deletions TUnit.Analyzers/Resources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,13 +328,13 @@
<value>Too many data attributes</value>
</data>
<data name="TUnit0046Description" xml:space="preserve">
<value>Return a `Func&lt;T&gt;` rather than a `&lt;T&gt;`.</value>
<value>When a data source method provides reference types (other than string) as test parameters, it should return Func&lt;T&gt; to defer object creation until the test runs. This prevents shared state between tests and ensures proper test isolation.</value>
</data>
<data name="TUnit0046MessageFormat" xml:space="preserve">
<value>Return a `Func&lt;T&gt;` rather than a `&lt;T&gt;`.</value>
<value>Data source method should return Func&lt;T&gt; for reference type parameters (other than string) to ensure proper test isolation</value>
</data>
<data name="TUnit0046Title" xml:space="preserve">
<value>Return a `Func&lt;T&gt;` rather than a `&lt;T&gt;`</value>
<value>Data source should return Func&lt;T&gt; for reference types</value>
</data>
<data name="TUnit0047Description" xml:space="preserve">
<value>For AsyncLocal values set in before hooks, you must call `context.AddAsyncLocalValues` to access them within tests.</value>
Expand Down
Loading