meziantou / meziantou.fluentassertionsanalyzers

Meziantou.FluentAssertionsAnalyzers

Meziantou.FluentAssertionsAnalyzers is a Roslyn analyzer to help migrate from Xunit or NUnit assertions to Fluent Assertions.

Installation

Install the NuGet package: Meziantou.FluentAssertionsAnalyzers

Configuration

You can exclude assertion methods using the .editorconfig file:

[*.cs]
mfa_excluded_methods=M:NUnit.Framework.Assert.Fail;M:NUnit.Framework.Assert.Fail(System.String)

meziantou.fluentassertionsanalyzers's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

• Update all (Meziantou.DotNet.CodingStandard, Microsoft.NET.Test.Sdk, System.Reflection.Metadata, actions/checkout, actions/download-artifact, actions/setup-dotnet, actions/upload-artifact, dotnet-sdk, xunit, xunit.runner.visualstudio)

Detected dependencies

github-actions

.github/workflows/publish.yml

• actions/checkout v3
• actions/setup-dotnet v3
• actions/upload-artifact v3
• actions/checkout v3
• actions/setup-dotnet v3
• actions/upload-artifact v3
• actions/download-artifact v3
• actions/setup-dotnet v3

nuget

Directory.Build.props

• Meziantou.DotNet.CodingStandard 1.0.96

Meziantou.FluentAssertionsAnalyzers.Tests/Meziantou.FluentAssertionsAnalyzers.Tests.csproj

• xunit.runner.visualstudio 2.4.5
• xunit 2.4.2
• System.Reflection.Metadata 7.0.0
• Microsoft.NET.Test.Sdk 17.4.0

Meziantou.FluentAssertionsAnalyzers/Meziantou.FluentAssertionsAnalyzers.csproj

global.json

• dotnet-sdk 8.0.100

---

• Check this box to trigger a request for Renovate to run again on this repository

Simplify pattern nullableValue.HasValue.Should().BeTrue();

I have assertion:

nullableValue.HasValue.Should().BeTrue();

it can be replaced with:

nullableValue.Should().HaveValue();

Add quickfix that swaps actual and expected value

For example:

"video1234_1234_test".Should().Be(result);

should be replaced with:

result.Should().Be("video1234_1234_test");

Add quickfix for pattern Assert.That(() => method()), Throws.InstanceOf<Exception>());

I have a code:

Assert.That(() => Api.Users.Get(userIds), Throws.InstanceOf<ArgumentNullException>());

Can be replaced with:

FluentActions.Invoking(() => Api.Users.Get(userIds)).Should().ThrowExactly<ArgumentNullException>();

Simplify pattern booleanValue.Should().Be(true);

I have assertion:

actual.Should().Be(true);
actual.Should().Be(false);

Can be replaced with:

actual.Should().BeTrue();
actual.Should().BeFalse();

Simplify pattern actual.Should().Be(string.Empty);

I have next Assertion:

user.Site.Should().Be(string.Empty);

Can be simplified with:

user.Site.Should().Be(string.Empty);

NullReferenceException in AssertAnalyzer

Thanks for this project, I've converted all our unit test projects to use FluentAssertions. I've left the analyzers in the projects to prevent Assert being used.

There are multiple unit test projects with the analyzer enabled but only one of them gives this error.

I tried creating a VSIX project and debugging the analyzer but I couldn't getting it going.

Any ideas why this null reference happens? or how to debug it locally?

##[warning]CSC(0,0): Warning AD0001: Analyzer 'Meziantou.FluentAssertionsAnalyzers.AssertAnalyzer' threw 
an exception of type 'System.NullReferenceException' with message 'Object reference not set to an instance of an object.'.
CSC : warning AD0001: Analyzer 'Meziantou.FluentAssertionsAnalyzers.AssertAnalyzer' threw 
an exception of type 'System.NullReferenceException' with message 'Object reference not set to an instance of an object.'. [D:\a\1\s\OurApp\OurApp.Web.UnitTest\OurApp.Web.UnitTest.csproj]

Unit test project is .NET 4.8 and some referenced projects are .NET standard 2.0

Add Assert.NotStrictEqual migration

GeoLocation result = new GeoLocation
				{
					Latitude = 1.456789123,
					Longitude = 1.987654123
				};
Assert.NotStrictEqual(new GeoLocation
				{
					Latitude = 1.456789123,
					Longitude = 1.987654123
				}, result);

Can be replaced with:

result.Should()	.BeEquivalentTo(new GeoLocation
				{
					Latitude = 1.456789123,
					Longitude = 1.987654123
				}, options => options.WithoutStrictOrdering());

Add Assert.Equal migration with comparer

Assert.Equal(expected, actual, _comparer);

Can be replaced with next code:

actual.Should().BeEquivalentTo(expected, x => x.Using(_comparer));

Provide a fix for Assert.That(str1, Is.EqualTo(str2).IgnoreCase)

Apply fix in bulk (to the whole file/project/solution)

It would be amazing if the fix could be applied to the whole file/project/solution:

Currently, it's sadly not possible:

For context, I'd love to migrate our whole solution from native NUnit assertions to Fluent Assertions, but doing it one by one is not an option, as we have a gazillion of usages.

I wonder if that's hard, then maybe just a standalone console app for a one-go migration could be an option? Happy to give it a try myself if you think that would be easier.

Btw, I'm a big fan of your work. Big fan! ;) :)

Simplify result.Count

Assertion:

Assert.That(result.Count, Is.EqualTo(2));

can be replaced with:

result.Should().HaveCount(2);

now it replaced with:

result.Count.Should().Be(2);

Various bugs running on large codebase

Description

When running this analyzer on the codebase at https://github.com/SteeltoeOSS/Steeltoe, the fixers produce code that doesn't compile in several cases. After fixing them manually, various tests start to fail.

Repro steps

• Clone the repo at https://github.com/SteeltoeOSS/Steeltoe
• Add the following to /shared-test.props:

  <ItemGroup>
    <PackageReference Include="Meziantou.FluentAssertionsAnalyzers" Version="1.0.10" PrivateAssets="All" />
  </ItemGroup>
  <ItemGroup>
    <Using Include="FluentAssertions" />
    <Using Include="Xunit" />
  </ItemGroup>

• Set all analyzer rules of this package to Warning severity in Steeltoe.Debug.ruleset: Open src/Steeltoe.All in Visual Studio, expand the Dependencies/Analyzers/FluentAssertions.Analyzers node in project Common/Steeltoe.Common.Expression.Test, select all rules, and right-click > Set severity > Warning.
• Rebuild the Steeltoe.Common.Expression.Test project and use the fixers to update existing Xunit tests to FluentAssertions.

Expected behavior:

No broken code and no failing tests.

Actual behavior:

Some fixers don't actually change code; others produce code that doesn't compile. Some result in test failures.

Versions

• Which version of FluentAssertionsAnalyzers are you using? v1.0.10 with FA v6.8.0
• Which .NET runtime and version are you targeting? .NET 6

Additional Information

I only tried running on the Steeltoe.Common.Expression.Test project. Running on the complete solution may surface additional issues.

I noticed that the fixers add a namespace import for FluentAssertions at the top of the file, which is unneeded because it's already in the .props file. I'm not bothered by that, as it's easy to fix. Just wanted to point it out for awareness.

Bug: Assert.That(groups[0].NullableBoolean, Is.True); does not convert

I have assertion:

Assert.That(groups[0].IsMember, Is.True);

Where the property IsMember is declared as nullable boolean

can be convert to:

groups[0].IsMember.Should().BeTrue();

but convertion does not work