Skip to main content

Property based testing in C#–Part 4

In this multipart blog post I want to introduce you in the world of property-based testing and how to do this in C#.

In the first part, I gave you an introduction on what property-based testing is, why it useful and how it can help you write better code. In the second post, I showed you a concrete example on how to start writing property-based tests in C# using FsCheck. In a third post I explained how property-based tests can help  to find edge cases and to understand a codebase better.

In this post I continue the journey by having a look at how to write our own generators. If you didn’t read my previous post, generators are the tool that helps you to select a value from an interval. For some of the available types in .NET, a default generator (and shrinker) exists but sometimes it is necessary to create your own generators.

Create your own FsCheck generator in C#

Creating your own generator for FsCheck is easy in C#, the only thing you need is a public static class with a public static method that returns an Arbitrary<T>.

In our previous post, we used a Filter() in our test to return only positive dates:

Let’s see how we can do the same thing using a custom generator:

To use this generator, we need to specify it as a parameter of the [FsCheck.NUnit.Property] attribute:

As the library that we were testing allows you to generate National Registration Numbers, we can take our sample above one step further and create a generator for it:

Now we can improve our test code to use this generator:

Remark: It is possible to add multiple static Generator methods to one static class.

Generator utilities

In the example above, we started every time from an existing generator and expanded from there. But it is also possible to start from scratch. In that case, there are a few utility functions that can help you along the way.

One of the most used utility functions is Gen.Choose(), which makes a random choice of a value from an interval, with a uniform distribution.

Here is an example where we use this to generate a month in a specific year:

Create your own FsCheck Shrinker in C#

So far the generators either used the default shrinker for the type or had no shrinker defined. Writing your own shrinker is easy thanks to the support of iterators in C# (through yield return).

One way to add a shrinker is to use an overload of the Arb.From() method:

Another option is to create your own Arbitrary<T> instance and override the Shrinker method:

If we run our tests again, we see that the results are shrinked to 1/01/2000. This is a good indication that there is something wrong with National Registration Numbers generated after that date.

Popular posts from this blog

DevToys–A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Color B

Help! I accidently enabled HSTS–on localhost

I ran into an issue after accidently enabling HSTS for a website on localhost. This was not an issue for the original website that was running in IIS and had a certificate configured. But when I tried to run an Angular app a little bit later on http://localhost:4200 the browser redirected me immediately to https://localhost . Whoops! That was not what I wanted in this case. To fix it, you need to go the network settings of your browser, there are available at: chrome://net-internals/#hsts edge://net-internals/#hsts brave://net-internals/#hsts Enter ‘localhost’ in the domain textbox under the Delete domain security policies section and hit Delete . That should do the trick…

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.