NFluent 3.0.2.500

There is a newer version of this package available.
See the version list below for details.
dotnet add package NFluent --version 3.0.2.500                
NuGet\Install-Package NFluent -Version 3.0.2.500                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NFluent" Version="3.0.2.500" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NFluent --version 3.0.2.500                
#r "nuget: NFluent, 3.0.2.500"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NFluent as a Cake Addin
#addin nuget:?package=NFluent&version=3.0.2.500

// Install NFluent as a Cake Tool
#tool nuget:?package=NFluent&version=3.0.2.500                

GitHub stars

NFluent Motto

Stable NuGet NuGet

Beta MyGet MyGet

Chat Gitter

Issues GitHub issues GitHub closed issues

Build Status Build status Codecov AppVeyor tests Mutation testing badge

NFluent is an assertion library which aims to fluent your .NET TDD experience.

Official site: http://www.n-fluent.net/


NFluent will make your tests:

  • fluent to write: with a super-duper-happy auto-completion 'dot' experience. Indeed, just type the Check.That( followed by one of your objects and a dot, and your IDE will show you all the checks available for the type of the given object to verify. No more, no less (i.e. no auto completion flooding).
  • fluent to read: very close to plain English, making it easier for non-technical people to read test code.
  • fluent to troubleshoot: every failing check of the NFluent library throws an Exception with a crystal-clear message status to ease your TDD experience (see examples below). Thus, no need to set a breakpoint and to debug in order to be able to figure out what went wrong.
  • helpful to reverse engineer legacy code: indeed, temporarily write an on-purpose failing assert on a legacy method, so you can understand it and leverage on the "ready-to-be-copied-and-paste-for-arrays-or-collections-initialization-purpose" NFluent assert failure messages.
  • less error-prone: indeed, no more confusion about the order of the "expected" and "actual" values you can find in the classical .NET unit tests frameworks.

NFluent is directly inspired by the awesome Java FEST Fluent check/reflection library and it most famous fork AssertJ library.

NFluent & unit test frameworks

NFluent is not coupled to any .NET unit test framework. It is fully designed to work in collaboration with your favorite one.

Your favorite unit test framework (e.g. NUnit, xUnit, ...) will still handle the test identification, execution & Co. All you have to do is to replace your usage of its Assert or Assert.That() statements, by the Check.That() NFluent statement form. That's all!

Indeed, we decided to use the Check.That() syntax to avoid collisions and name ambiguity with the traditional Assert class you can find in most of your .NET unit test frameworks (therefore, no need to declare an alias in your test fixtures).

In fact, test runners and check libraries are two orthogonal topics and concerns.

As simple as possible

With Nfluent check libraries:

All you've got to remember is: Check.That, 'cause every check is then provided via a super-duper-auto-completion-dot-experience 😉

Usage sample

With NFluent, you can write simple checks like this:

    var integers = new int[] { 1, 2, 3, 4, 5, 666 };
    Check.That(integers).Contains(3, 5, 666);

    integers = new int[] { 1, 2, 3 };
    Check.That(integers).IsOnlyMadeOf(3, 2, 1);

    var guitarHeroes = new[] { "Hendrix", "Paco de Lucia", "Django Reinhardt", "Baden Powell" };
    Check.That(guitarHeroes).ContainsExactly("Hendrix", "Paco de Lucia", "Django Reinhardt", "Baden Powell");

    var camus = new Person() { Name = "Camus" };
    var sartre = new Person() { Name = "Sartre" };
    Check.That(camus).IsNotEqualTo(sartre).And.IsInstanceOf<Person>();

    var heroes = "Batman and Robin";
    Check.That(heroes).Not.Contains("Joker").And.StartsWith("Bat").And.Contains("Robin");

    int? one = 1;
    Check.That(one).HasAValue().Which.IsStrictlyPositive().And.IsEqualTo(1);

    const Nationality FrenchNationality = Nationality.French;
    Check.ThatEnum(FrenchNationality).IsNotEqualTo(Nationality.Korean);

    string motivationalSaying = "Failure is the mother of success.";
    Check.That(motivationalSaying).IsNotInstanceOf<int>();

with NFluent, you can also write checks like this:

	 var persons = new List<Person>
                                 {
                                     new Person { Name = "Thomas", Age = 38 },
                                     new Person { Name = "Achille", Age = 10, Nationality = Nationality.French },
                                     new Person { Name = "Anton", Age = 7, Nationality = Nationality.French },
                                     new Person { Name = "Arjun", Age = 7, Nationality = Nationality.Indian }
                                 };

    Check.That(persons.Extracting(nameof(Person.Name))).ContainsExactly("Thomas", "Achille", "Anton", "Arjun");
    Check.That(persons.Extracting(nameof(Person.Age))).ContainsExactly(38, 10, 7, 7);
    Check.That(persons.Extracting(nameof(Person.Nationality))).ContainsExactly(Nationality.Unknown, Nationality.French, Nationality.French, Nationality.Indian);

    // more fluent than the following classical NUnit way, isn't it?
    // CollectionAssert.AreEquivalent(persons.Properties(nameof(Person.Age)), new[] { 38, 10, 7, 7 });

    // it's maybe even more fluent than the java versions
	// FEST fluent assert v 2.x:
    // assertThat(extractProperty("name" , String.class).from(inn.getItems())).containsExactly("+5 Dexterity Vest", "Aged Brie", "Elixir of the Mongoose", "Sulfuras, Hand of Ragnaros", "Backstage passes to a TAFKAL80ETC concert", "Conjured Mana Cake");
	// FEST fluent assert v 1.x:
	// assertThat(inn.getItems()).onProperty("name").containsExactly("+5 Dexterity Vest", "Aged Brie", "Elixir of the Mongoose", "Sulfuras, Hand of Ragnaros", "Backstage passes to a TAFKAL80ETC concert", "Conjured Mana Cake");

or like this:

	// Works also with lambda for exception checking
	Check.ThatCode(() => { throw new InvalidOperationException(); }).Throws<InvalidOperationException>();

	// or execution duration checking
	Check.ThatCode(() => Thread.Sleep(30)).LastsLessThan(60, TimeUnit.Milliseconds);

Why NFluent, and not another .NET fluent check framework?

  • Because you think like us that writing a lambda expression within a check statement is not really a fluent experience (for reading as well as writing).
  • Because NFluent is completely driven by the super-duper-happy-path principle to fluent your TDD experience. For instance, we consider the 'dot' autocompletion experience as crucial. Thus, it should not be polluted by things not related to the current unit testing context (which occurs with extension methods on classical .NET types - intellisense flooding).
  • Because you think that those other check libraries have not chosen the proper vocabulary (<subjectUnderTest>.Should().... why don't they choose Must instead?!?). And thus, you'd rather rely on a stronger semantic for your checks (i.e. NFluent's Check.That).
  • Because you like killing features and extra bonus, such as the Properties() extension method for IEnumerable for instance (as showed within the usage sample above).
  • And because it's awesome pal. Try it, you will see!

Samples of crystal-clear error messages

ErrorSample1

ErrorSample2

ErrorSample3

Wanna try NFluent?

Can't be more easy: NFluent is available on nuget.org

nuget

Use cases

NFluent use cases are available here.

Newsgroup

For any comment, remark or question about the library, please use the NFluent-Discuss google group.

BackLog

Nfluent backlog is now available as github issues

New feature to be added?

  • If you want to join the project and contribute: check this out before, but be our guest.
  • If you don't want to contribute to the library, but you need a feature not yet implemented, don't hesitate to request it on the NFluent-Discuss google group. In any case: you are welcome!

Other resources

Many thanks


thomas@pierrain.net / September 2016

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net35 is compatible.  net40 was computed.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 is compatible.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (15)

Showing the top 5 NuGet packages that depend on NFluent:

Package Downloads
Krosoft.Extensions.Testing

Package pour faciliter la mise en place de tests.

Seeq.Link.SDK.TestFramework

Framework for performing standard tests of Seeq C# connnectors

Suzianna.Core

A library for writing flexible and easy to maintain acceptance tests

TestableHttpClient.NFluent

NFluent checks for checking HttpResponseMessages.

iago.lib

Iago is a tool to write bdd like tests in kre. use `iago.runner` to execute your tests

GitHub repositories (18)

Showing the top 5 popular GitHub repositories that depend on NFluent:

Repository Stars
ReClassNET/ReClass.NET
More than a ReClass port to the .NET platform.
zzzprojects/System.Linq.Dynamic.Core
The .NET Standard / .NET Core version from the System Linq Dynamic functionality.
WireMock-Net/WireMock.Net
WireMock.Net is a flexible product for stubbing and mocking web HTTP responses using advanced request matching and response templating. Based on the functionality from http://WireMock.org, but extended with more functionality.
MarcosMeli/FileHelpers
The FileHelpers are a free and easy to use .NET library to read/write data from fixed length or delimited records in files, strings or streams
WOA-Project/WoA-Installer-Rpi
This repository was deprecated, use:
Version Downloads Last updated
3.1.0 2,713 11/27/2024
3.0.4 130,788 3/19/2024
3.0.3 39,226 1/12/2024
3.0.3-beta 490 12/13/2023
3.0.2.500 13,166 12/12/2023
3.0.2.327-beta 1,566 10/13/2023
3.0.1.352 98,495 6/9/2023
3.0.0.351 28,792 5/6/2023
3.0.0.277-beta 11,310 3/3/2022
3.0.0.270-beta 749 2/27/2022
3.0.0.269-beta 758 2/27/2022
3.0.0.268-beta 743 2/24/2022
2.8.0 575,810 2/4/2022
2.7.2 270,759 4/8/2021
2.7.1 111,650 12/29/2020
2.7.0 336,035 2/11/2020
2.6.0 219,642 8/19/2019
2.5.0 173,939 3/12/2019
2.4.0 121,238 10/2/2018
2.3.1 94,655 6/12/2018
2.3.0 2,381 6/9/2018
2.2.0 93,608 2/10/2018
2.1.1 29,571 1/5/2018
2.1.0 12,514 12/10/2017
2.0.0 64,979 6/27/2017
2.0.0-alpha-44 2,573 5/10/2017
1.3.1 239,827 7/28/2014
1.2.0 9,345 6/16/2014
1.1.0 5,454 2/14/2014
1.0.0 8,903 12/31/2013
0.11.0 2,440 11/26/2013
0.9.0 2,494 8/6/2013
0.8.0 2,346 7/6/2013
0.7.0 2,178 6/4/2013
0.6.0 2,141 5/19/2013
0.5.0 2,169 4/21/2013