Skip to main content

Plugins

Plugins provide a way to extend and refine the runtime and execution behavior of your properties. In the same way building custom arbitraries gives you the flexibility to tweak the generation flows, plugins gives you ways to customize how your properties run.

Plugins are designed to support things such as:

  • Executing something before the predicate
  • Stopping a predicate running for too long
  • Capturing key insights about the execution flows including timings for observability

Using plugins​

Plugins can be passed as part of the customizations accepted by the fc.assert runner.

await fc.assert(fc.asyncProperty(...arbs, predicate), {
  plugins: [pluginA(...paramsForPluginA), pluginB(...paramsForPluginB)],
});

Installing plugins globally​

Plugins needed by all your properties can be installed once, typically in a setup file, with installGlobalPlugin.

fc.installGlobalPlugin(pluginA());

Installed plugins run before the ones passed to the runner, so the snippet above followed by fc.assert(myProp, { plugins: [pluginB()] }) is equivalent to plugins: [pluginA(), pluginB()].

The plugins​

We come up with a set of plugins to extend the library using built-in plugins. The following pages provide extended details and deep dive into each of them.

Last updated on by Nicolas DUBIEN