Add ability to attach notes to test results

[hueniverse]

There are times when a test passes (or fails) but you want to draw attention to some other data about it. My specific need is to record performance numbers (my tests confirm performance is under n milliseconds but I also want to see the actual numbers).

In order to keep the interface and implementation simple, we can just piggyback the done argument:

it('runs faster than 500ms', function (done) {
    expect(elapsed).to.be.below(500);
    done.note('Took: ' + elapsed + 'ms');
    done();
});

If we make note() return done we can also chain:

it('runs faster than 500ms', function (done) {
    expect(elapsed).to.be.below(500);
    done.note('Took: ' + elapsed + 'ms')();
});

[AdriVanHoudt]

note would practically be a console.log but only when verbose is on? Or do you also want to export this or something?

[hueniverse]

It will console log but at the end of the console report, and with the titles of the tests which generated them, and in the JSON output for other reporters to potentially include.

[Marsup]

I don't really care for that feature but I'm not sure it should be a simple string. It might as well be useful to call it multiple times for different information. But then the reporters should know how to deal with it. Ideas ?

[hueniverse]

You can call it with anything you want. It is free form reference. If you call it multiple times it will just add them to an array. I would just console log them if you specify a command flag. Otherwise just add them to the JSON output.

[lock]

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.