knizkar / shouldly

Should testing for .net - the way Asserting *Should* be!

Shouldly

Shouldly is an assertion framework which focuses on giving great error messages when the assertion fails while being simple and terse.

This is the old Assert way:

Assert.That(contestant.Points, Is.EqualTo(1337));

For your troubles, you get this message, when it fails:

Expected 1337 but was 0

How it Should be:

contestant.Points.ShouldBe(1337);

Which is just syntax, so far, but check out the message when it fails:

contestant.Points should be 1337 but was 0

It might be easy to underestimate how useful this is. Another example, side by side:

Assert.That(map.IndexOfValue("boo"), Is.EqualTo(2));    // -> Expected 2 but was 1
map.IndexOfValue("boo").ShouldBe(2);                    // -> map.IndexOfValue("boo") should be 2 but was 1

Shouldly uses the code before the ShouldBe statement to report on errors, which makes diagnosing easier.

Read more about Shouldly and its features at http://docs.shouldly-lib.net/

Installation

You can install Shouldly by copying and pasting the following command into your Package Manager Console within Visual Studio (Tools > NuGet Package Manager > Package Manager Console).

Install-Package Shouldly

Contributing

Getting started with Git and GitHub

• Setting up Git for Windows and connecting to GitHub
• Forking a GitHub repository
• The simple guide to GIT guide
• Open an issue if you encounter a bug or have a suggestion for improvements/features
• Submit documentation improvements by submitting pull requests, the docs are in the docs folder in this repo

Once you're familiar with Git and GitHub, clone the repository and start contributing.

If you need inspiration for which issue to pick up have a look for the Jump-In label on issues which are put on issues which are ready to be picked up by anyone.

Pre-requisites for running on build server

Shouldly uses the source code to make its error messages better. Hence, on the build server you will need to have the "full" pdb files available where the tests are being run.

What is meant by "full" is that when you set up your "release" configuration in Visual Studio and you go to Project Properties > Build > Advanced > Debug, you should set it to "full" rather than "pdb-only".

History Change

A test results database (~50mb) got accidently commited in a972872888925205c9655cb540455d23d1891148, we removed this from history. The commit was only in master for <24 hours but if you happened to pull then you may need to reset master to get back in line

Icon

Star created by Luboš Volkov from The Noun Project