Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

jest-cucumber

3.0.0 • Public • Published

Jest Cucumber

Execute Gherkin scenarios in Jest

Build Status Greenkeeper badge npm downloads

Cucumber Jest Demo

Overview

jest-cucumber is an alternative to Cucumber.js that runs on top on Jest. Instead of using describe and it blocks, you instead write a Jest test for each scenario, and then define Given, When, and Then step definitions inside of your Jest tests. jest-cucumber then allows you to link these Jest tests to your feature files and ensure that they always stay in sync.

Motivation

Jest is an excellent test runner with great features like parallel test execution, mocking, snapshots, code coverage, etc. If you're using VS Code, there's also a terrific Jest extension that allows you get realtime feedback as you're writing your tests and easily debug failing tests individually. Cucumber is a popular tool for doing Acceptance Test-Driven Development and creating business-readable executable specifications. This library aims to achieve the best of both worlds, and even run your unit tests and acceptance tests in the same test runner.

Getting Started

Install Jest Cucumber:

npm install jest-cucumber --save-dev

Add a Feature file:

Feature: Logging in
 
Scenario: Entering a correct password
    Given I have previously created a password
    When I enter my password correctly
    Then I should be granted access

Add the following to your Jest configuration:

  "testMatch": [
    "**/*.steps.js"
  ],

Add a step definition file that links to your feature file:

// logging-in.steps.js
 
import { defineFeature, loadFeature } from 'jest-cucumber';
 
const feature = loadFeature('./features/LoggingIn.feature');

Add a Jest test for each scenario into your step definition file:

// logging-in.steps.js
 
import { defineFeature, loadFeature } from 'jest-cucumber';
 
const feature = loadFeature('./features/LoggingIn.feature');
 
defineFeature(feature, test => {
  test('Entering a correct password', ({ given, when, then }) => {
 
  });
});

Add step definitions to your scenario Jest tests:

// logging-in.steps.js
 
import { loadFeature, defineFeature } from '../../../../src/';
import { PasswordValidator } from '../../src/password-validator';
 
const feature = loadFeature('./examples/typescript/specs/features/basic-scenarios.feature');
 
defineFeature(feature, (test) => {
  let passwordValidator = new PasswordValidator();
  let accessGranted = false;
 
  beforeEach(() => {
    passwordValidator = new PasswordValidator();
  });
 
  test('Entering a correct password', ({ given, when, then }) => {
    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).toBe(true);
    });
  });
});

Additional Documentation

Install

npm i jest-cucumber

DownloadsWeekly Downloads

48,295

Version

3.0.0

License

MIT

Unpacked Size

220 kB

Total Files

173

Last publish

Collaborators

  • avatar