Crockpot

A very simple templater for Cucumber files, using mustache.

Installation

As per standard npm installs...

npm i cucumber-crockpot -D

Change -D to -S is this is not a devDependency.

Import to your project as follows:

const crockpot = require('cucumber-crockpot');

File format

A .crock file is merely a valid .feature file with some templated contents using mustache.

An example file might look like:

@{{name}}
Feature: {{nameCapital}} Display

  Scenario: Buying {{indefiniteArticle}} {{name}}

    Given we have 50 {{namePlural}}
    When we sell {{indefiniteArticle}} {{name}}
    Then we receieve {{price}}
    And we have 49 {{namePlural}} remaining

with a paired .view.json file as such:

[
    {
        "name": "apple",
        "namePlural": "apples",
        "indefiniteArticle": "an",
        "nameCapital": "Apple",
        "price": "$0.76"
    },
    {
        "name": "banana",
        "namePlural": "bananas",
        "indefiniteArticle": "a",
        "nameCapital": "Banana",
        "price": "$0.16"
    },
    {
        "name": "currant",
        "namePlural": "currants",
        "indefiniteArticle": "a",
        "nameCapital": "Currant",
        "price": "$0.06"
    },
    {
        "name": "durian",
        "namePlural": "durians",
        "indefiniteArticle": "a",
        "nameCapital": "Durian",
        "price": "$1.56"
    }
]

NOTE: the name property is the lone required part of a any given view item, must be unique, and valid for use in a filename.

And this would result in .feature files like this:

@apple
Feature: Apple Display

  Scenario: Buying an apple

    Given we have 50 apples
    When we sell an apple
    Then we receieve $0.76
    And we have 49 apples remaining

API

Currently, only two functions are exposed:

• parse: Takes an object with two properties: crock and view, each are paths to their respective files. Each view item must have a unique name property that will be used to generate .feature file names.
• setFeaturePath: This changes the path for exporting resulting .feature files to whatever path you provide. Without using this, the default is the ./features folder in your project.

Example use of API

This example will take a ./crockpots/ directory, that contains a folder for each featureset, and process every .crock & .view.js file.

const crockpot = require('cucumber-crockpot');
const { readdirSync, statSync } = require('fs');
const { join } = require('path');

const dirs = p =>
    readdirSync(p).filter(f => statSync(join(p, f)).isDirectory());

const crockpots = dirs('./crockpots/');

crockpot.setFeaturePath('./product-features/');

crockpots.map(pot =>
    crockpot.parse({
        crock: `./crockpots/${pot}/${pot}.crock`,
        view: `./crockpots/${pot}/${pot}.view.json`
    })
);

Recommendations

Since the crock files are the "source of truth" for your Cucumber tests when using it, I recommend you have Crockpot export its files into a directory not tracked by Git or any source control systems. As long as you keep your crock & view files, you can always regenerate these files.

Roadmap

I don't currently foresee adding any more complexity to the .crock file beyond how it is for now, but I am open to suggestions.

Development

Source is written in TypeScript. Run tests via npm run test.

MIT License

Copyright 2018-2019 Robert Gerald Porter [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.