Git Product home page Git Product logo

pickler's Introduction

pickler

Turn your React+Jest+Enzyme unit tests into Gherkin.

Overview

Pickler is a tool which allows one to convert their unit tests into Gherkin. It was developed with the need to meet a job requirement which was to write all requirements in Gherkin so they could be both requirement documentation and functional tests.

How it Works

The pickler tool will parse your unit tests and convert them to Gherkin using this basic approach:

describe('As a user, I want to pickle my cucumbers, so that I can eat pickles', () => {
  // 🥒 Scenario: As a user, I want to pickle my cucumbers, so that I can eat pickles

  it('should have a jar of water, salt, and enzymes', () => {
  // 🥒 Given I should have a jar of salt water and enzymes

    const water = '1 pint';
    const salt = '1 cup';
    const enzymes = '1 tbsp';
    const cucumbers = '5';

    const wrapper = shallow(<PickleJar water={water} salt={salt} enzymes={enzymes} cucumbers={cucumbers}/>);
    // 🥒 And I gather water, salt, enzymes, and cucumbers to PickleJar

    wrapper.find('btn.add-water').simulate('click')
    // 🥒 When I click "btn.add-water"
    wrapper.find('btn.add-salt').simulate('click')
    // 🥒 And I click "btn.add-salt"
    wrapper.find('btn.add-enzymes').simulate('click')
    // 🥒 And I click "btn.add-enzymes"
    wrapper.find('btn.stir').simulate('click')
    // 🥒 And I click "btn.stir"
    wrapper.find('btn.add-cucumbers').simulate('click')
    // 🥒 And I click "btn.add-cucumbers"

    expect(wrapper.find('ul.jar-contents').containsAllMatchingElements([
      `<li>1 pint of water</li>`,
      // 🥒 Then I expect "ul.jar-contents" to contain "<li>1 pint of water</li>"
      `<li>1 cup of salt</li>`,
      // 🥒 And I expect "ul.jar-contents" to contain "<li>1 cup of salt</li>"
      `<li>1 tbsp of enzymes</li>`,
      // 🥒 And I expect "ul.jar-contents" to contain "<li>1 tbsp of enzymes</li>"
      `<li>5 cucumbers</li>`
      // 🥒 And I expect "ul.jar-contents" to contain "<li>5 cucumbers</li>"
    ])
  })
})

Install

npm -g install pickler

# or

yarn global add pickler

Usage

See man

pickler's People

Contributors

jrschumacher avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.