darkyen / baddsert

baddsert

Framework for baseline acceptance driven development in JavaScript.

General idea: It's annoying to maintain tests. Every time you change an api, all the tests fail and they need to be manually updated.

BADD keeps tracks of the new info on failures and allows you to automagically update the expected data.

Use

baddsert replaces your old assert library. Write your tests as usual, using baddsert as the assert. Step one is to init the whole shebang:

import {baddsert} from 'baddsert';

let docTests = baddsert('docTests');

You'll need to init once per file. Try and make it descriptive of that particular test battery.

Now that everything's all init-ifyed, let's use baddsert:

it('runs a superfluous demo test', () => {
  let result = hammertime(`can't touch this`);
  docTests('I am a steg-o-sarus', result);
});

The first param describes this particular assertion - what are you testing?

The second is the thing you want asserted.

And now, the magic happens. When you run your tests, baddsert will take the result from the first test and save it under the badd-baseline directory (in this case, as the file docTests). Future runs will throw if the value passed in is not deepStrictEqual to the original one.

When you inevitably change something that makes the tests fail (because your function is correctly returning a new value) run baddsert in the same dir as your badd-baseline directory. This will run through all of your asserts, letting you replace the old data with the data that was passed in during the failing test.

--- Checking docTests ---
   I am a steg-o-sarus: AGH THEY DON'T MATCH DOOOOOOOM
Stored result: result
Latest: NEW SWEET DATAS
Should I replace this? [y/n] :

Installation

You can either install the baddsert cli globally

$npm install -g baddsert

or by adding it as a dev dependency

$npm install --save --only=dev baddsert

When installing as a dev dependency it is recommended you add this to your npm scripts in your package.json

{
  "scripts": {
    "baddsert": "./node_modules/.bin/baddsert"
  }
}

Then you can run baddsert by doing

$npm run baddsert

Easy as pie.

Further reading: https://medium.com/@tinganho/baseline-acceptance-driven-development-f39f7010a04#.d1fdg36x0