https://github.com/omermorad/jest-gherkin

Jest Gherkin Plugin (For BDD Testing)
https://github.com/omermorad/jest-gherkin

bdd bdd-framework integration-testing jest jest-plugin unit-testing

Last synced: 21 days ago
JSON representation

Jest Gherkin Plugin (For BDD Testing)

• Host: GitHub
• URL: https://github.com/omermorad/jest-gherkin
• Owner: omermorad
• Created: 2021-07-26T21:37:50.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-07-27T13:29:10.000Z (over 3 years ago)
• Last Synced: 2024-11-14T14:27:54.868Z (about 1 month ago)
• Topics: bdd, bdd-framework, integration-testing, jest, jest-plugin, unit-testing
• Language: JavaScript
• Homepage:
• Size: 139 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Jest Gherkin Plugin

This is a plugin for Jest that helps you write your tests more easily

with the awesome Gherkin language (by Cucumber).

This plugin is not a replacement for cucumber, it is just uses the same vocabulary of Cucumber and the Gherkin language

## Installation

```bash

npm i -D jest-gherkin

```

## How is it different from `jest-cucumber`?

`jest-cucumber` is looking for feature files that needs to be defined for the test to run.

Besides, it suggests a weird syntax which is not nested like you can see in the following example.

You can see the full example of `jest-cucumber` here and see if it works for you

https://www.npmjs.com/package/jest-cucumber.

### A word about Cucumber tests

It's a bit difficult to work fully with Cucumber's testing system.

The tests carry with them state between different methods, and many IDEs have difficulty providing a holistic solution, which also makes it difficult to debug.

Bottom line is Cucumber tests can be complicated to maintain and to work with.

## Example

```js

import { PasswordValidator } from './password-validator';

describe('The title of you test', () => {

  let passwordValidator = new PasswordValidator();

  let accessGranted = false;

  beforeEach(() => {

    passwordValidator = new PasswordValidator();

  });

  scenario('Entering a correct password', () => {

    given('I have previously created a password', () => {

      passwordValidator.setPassword('1234');

      when('I enter my password correctly', () => {

        accessGranted = passwordValidator.validatePassword('1234');

        then('I should be granted access', () => {

          expect(accessGranted).toBeTruthy();

        });

      });

    });

  });

});

```

## Setup

In your jest config file add the following property:

```json

"setupFiles": [

  "jest-gherkin",

]

```

If you are using TypeScript you have to add the following to add the types:

`tsconfig.json` file:

```json

{

  "compilerOptions": {

    ...,

    "types": [

      ...,

      "jest",

      "jest-gherkin"

    ]

  }

}

```

## Acknowledgements

[Gherkin Reference](https://cucumber.io/docs/gherkin/reference/)