@restqa/plugin

The plugin factory enhance developer experience regarding the creation of custom step definition (with state and hooks).

If you're not familiar with these notions you should take a look into the Cucumber documentation.

Install

With npm:

$ npm i @restqa/plugin

With yarn:

$ yarn add @restqa/plugin

Usage

Create an instance,

const PluginFactory = require("@restqa/plugin");

const pf = new PluginFactory("plugin-name");

Then add steps definition:

  const db = require("../my-db");

  const stepDefinition = "Then the db should contains {int} users";
  function handlerFunc(expectedUserCount) {
    const users = db.find({});
    const currentUserCount = users.length;

    return expectedUserCount === currentUserCount
  }
  const description = "Check the number of users in the db";
  const tags = ["db"] // optional, the name of the plugin is added by default

  pf
    .addThenStep(
      stepDefinition,
      handlerFunc,
      descriptions,
      tags
    )
    // Similar api for the following methods
    .addWhenStep(...)
    .addGivenStep(...);

💡 Note: all handler functions SHOULD BE function expressions and NOT arrow functions (aiming to access to this).

Or add hooks:

  function beforeHook() {
    console.log("Before hook");
  }

  pf
    .addBeforeHook(beforeHook)
    .addBeforeHook("@foo", beforeHook)
    .addBeforeHook({ tags: "@foo" }, beforeHook)
    // Similar api for the following method
    .addAfterHook(...)

Interface is a bit different for addBeforeAllHook and addAfterAllHook:

  function beforeAllHook() {
    console.log("Before all hook");
  }

  pf
    .addBeforeAllHook(beforeAllHook)
    // Similar api for the following method
    .addAfterAllHook(...)

You can add state too:

To access state you have to use the name of your plugin

// in function handlers:
const state = this.state.key;

Real world case:

  pf
    .addState("user", { name: "tony", age: Infinity })
    // then use it elsewhere
    .addThenStep(
      "then user age should be {int}",
      function(expectedUserAge) {
        return this.state.user.age === expectedUserAge
      }
    )

Use a config

When you declare your plugin in RestQA you can add a config:

- name: "<your-super-plugin-path>"
  config:
    foo: 'bar'

Then, you can use it in your hooks, or steps handlers:

  function handler() {
    const config = this.getConfig(pf.name);
  };

Declare your plugin in RestQA

// in your plugin code

// cjs export
module.exports = pf;

// or esm export
export default pf;

Then, in the restqa.yml:

- name: "<your-super-plugin-path>"
  config:
    locale: 'fr'

API

Check the full API documentation.

Types

Check the index.d.ts file