@bahmutov/data-driven

@bahmutov/data-driven

Transforms BDD input into data-driven snapshot

Install

Requires Node version 6 or above.

npm install --save @bahmutov/data-driven

Use

Data-driven snapshot testing takes as an input a pure function and a bunch of arguments.

// is this data-driven test? for example
snapshot(isPrime, 1, 2, 3, 4, 5)
// or
snapshot(add, [1, 2], [-5, 5], [4, 6])

This module detects the above cases, and also has a utility method to compute the expected result. From snap-shot frameworks, like snap-shot and snap-shot-it when getting a value check if user wants data-driven value, and if yes, compute it.

const {isDataDriven, dataDriven} = require('@bahmutov/data-driven')
function snapshot(what) {
  if (isDataDriven(arguments)) {
    what = dataDriven(what, Array.from(arguments).slice(1))
  }
}

A typical value transformation would be

const results = dataDriven(isPrime, [1, 2, 3])
/* results is
{
  name: 'isPrime',
  behavior: [
    {
      given: 1,
      expect: false
    },
    {
      given: 2,
      expect: true
    },
    {
      given: 3,
      expect: true
    }
  ]
}
*/

Small print

Author: Gleb Bahmutov <[e-mail]> © 2017

• @bahmutov
• glebbahmutov.com
• blog

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2017 Gleb Bahmutov <[e-mail]>

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.