Property Based Testing Framework for Node

Perceive how fast-check works with a sensible instance

Picture by pine watt on Unsplash

The Pragmatic Programmer introduces a technique of testing known as property-based testing, during which an instance is given in Python, utilizing the framework hypothesis.

The utilization of the speculation may be very intuitive and easy and presents the idea of property-based testing completely. So I additionally wished to search out an equal various in Node. Two of them have excessive star scores on Github, JSVerify with 1.6K stars and fast-check with 2.8K stars. So I took a while to check fast-check just a little bit and attempt to get nearer to my day by day work.

This text is a recap, and a easy instance to doc the expertise.

Earlier than offering examples, let’s clarify why we use property-based checks. In truth, I don’t just like the time period property-based. In my phrases, “extraordinarily high-volume” testing.

Everyone knows that Take a look at Pyramid is as follows.

Take a look at Pyramid

And in my earlier article, I discussed what’s the difference between unit tests and integration tests. On the decrease ranges of the pyramid, extra take a look at circumstances are required.

Even so, it’s tough to generate numerous take a look at circumstances. We normally write corresponding checks based mostly on recognized situations or product specs, typically we might bear in mind to write down boundary checks (typically not), and typically we might depend on easy random verification of performance, e.g. faker.

Nevertheless, normally, even when we attempt laborious to give you take a look at circumstances, we can’t cowl all eventualities, and we name this testing technique example-based testing. It is because the take a look at circumstances we give you are mainly prolonged from a sure instance and can’t cowl all of the unknown contexts nor can we take a look at all of the boundary situations.

At this level, we want to have a framework robotically generate sufficient eventualities (affordable eventualities or not) to confirm the code we write, and the take a look at circumstances we write solely want to make sure their “properties” are appropriate. That is the origin of property-based testing.

The truth is that integration testing is roughly the identical as unit testing.

I’ve labored in lots of organizations, from massive nationwide enterprises to small startups. Whether or not I’m a developer or a mentor, from previous expertise, unit testing is about as related as integration testing.

For many builders, it’s not a simple process to correctly divide unit testing and integration testing. To have the ability to cut up take a look at circumstances completely they should have the talents of design patterns, dependency injection, dependency inversion, and so forth. to have the ability to do it nicely. Due to this fact, most take a look at environments are based mostly on a particular take a look at surroundings, equivalent to utilizing docker-compose to generate a one-time database and take a look at knowledge and take a look at on it.

The paperwork of fast-check is written based mostly on the usual of unit take a look at, and it appears that evidently solely the verification boolean is offered, that’s, fc.assert, so I took a while to analysis to write down a take a look at case near day by day use.

Typically, I would like a number of talents.

  1. Have the ability to take a look at async/await.
  2. Have the ability to confirm extra contexts, equivalent to assertEqual.

Earlier than we begin writing take a look at circumstances, let’s take a look on the fundamental utilization of fast-check.

First, let’s introduce the construction of fast-check.

  • Assertion (fc.assert)
  • Properties ( or fc.asyncProperty)

The operate of fc.assert is to confirm that each one the checks robotically generated by the properties are appropriate. The properties are wanted to explain two necessary blocks.

Runner is the context to be examined, i.e., the goal. Alternatively, the arbitraries are the enter parameters of the goal, that are robotically generated by the properties, and all we now have to do is to offer guidelines for them, e.g., solely integers.

The next is an easy instance.

fc.assert(, fc.integer(), (i, j) =>
return i + j === add(i, j);

The 2 fc.integer() are arbitraries, and the later nameless operate is the runner, which takes two arguments i and j, akin to the earlier arbitraries. We wish to confirm whether or not the operate add actually sums the 2 arguments appropriately, so the results of add needs to be in line with +.

Let’s overview the 2 necessities we simply talked about.

  1. fast-check is ready to take a look at async/await, runner could be a promise, and fc.assert itself can also be a promise.
  2. Though our take a look at goal is add, however a very good integration with some situations within the runner could make not solely the impact of boolean.

Now let’s come to a extra sensible instance. Suppose I’ve a database desk with cash for every person.

There’s a operate async operate getMoney(restrict) which is able to type cash in ascending order and likewise decide how a lot cash to return based mostly on the parameters.

Now we wish to take a look at this black field.

Let me clarify briefly.

  1. Simply merely confirm the operate actually works, there isn’t any use of fast-check.
  2. Given an arbitrary integer, the size of the return consequence needs to be between 0 and 10, as a result of we solely created ten data in earlier than.
  3. Given a variety of integers, the size of the return needs to be equal to the given size.
  4. Confirm the order of the entire array is certainly ascending. From this runner might be seen, even very advanced situations might be verified, however watch out to not make bugs within the take a look at case ensuing within the want for a take a look at case of the take a look at case.

If an issue is detected, fast-check can even let you know what sort of arbitraries it makes use of to detect the issue. For instance,

Counterexample: [-1234567890]

This implies the take a look at case failed when i = -1234567890. It’s potential the damaging quantity isn’t dealt with appropriately or the “massive” damaging quantity isn’t dealt with appropriately. That is the time to write down an actual unit take a look at (or integration take a look at) and confirm -1234567890 in order that such a failed case can be utilized as a regression take a look at afterward.

Ideally, when testing database conduct like this, we’d use strategies equivalent to dependency injection to isolate the bodily database in an effort to enhance testing efficiency. However as I mentioned earlier, it’s not straightforward to correctly separate code from exterior dependencies relying on the expertise and talent of the developer.

So in lots of organizations, we nonetheless see that a lot of the take a look at circumstances need to depend on the bodily database for testing. However I’ve to say that is incorrect.

On this article, I clarify the utilization of fast-check by a real-life instance and the way it’s near follow. Nonetheless, I hope we don’t need to face this once more, at the very least after studying my previous article, let’s attempt to flip over these unreasonable take a look at circumstances.

More Posts