Test engine for JavaScript that plays nicely with promises, intended for use with mochajs but plays nicely with any test framework.
This is intended to replace expect.js, etc with a new concept.
Key features:
- Plays nicely with promises. If a value is a promise, it'll can await the resolution of the promise transparently.
- Can await multiple promises at once, while still respecting a dependency chain. If one test depends on the results of previous tests, it can be forced to await the resolution of previous tests before continuing.
- Does not throw exceptions on the first error. Instead, it captures as many errors as it can in a single run.
This is very much a start right now, as I expect to add a lot of tests to this in the near future.
npm install --save-dev test-batteryimport TestBattery from `test-battery`;In constructed form (preferred)
async function runTestBattery() {
let battery = new TestBattery();
battery.test('array should be empty').value([]).is.array;
battery.test('integer array should be an array').value([1,2,3]).is.array;
// will quietly refuse further tests if any of the previous tests resulted
// in errors. MUST be awaited.
await battery.endIfErrors();
// if a test value is a promise, it'll test the value the promise resolves
// with.
battery.test('Promise should resolve to a boolean')
.value(Promise.resolve(false))
.is.boolean;
// error strings can be parameterized.
battery.test('null test number %s', 1).is.empty;
battery.done(result => {
// result is undefined if success, or an object that contains errors
// and refusedTests if failed
console.log(result);
});
}Or in simple form
async function runTestBattery() {
let test = new TestBattery();
test.isArray([], 'empty array');
test.isArray([1,2,3], 'integer array');
// will quietly refuse further tests if any of the previous tests resulted
// in errors. MUST be awaited.
await test.endIfErrors();
// if a test value is a promise, it'll test the value the promise resolves
// with.
test.isBoolean(Promise.resolve(false), 'boolean false');
// error strings can be parameterized.
test.isEmptyString('', 'null test number %s', 1);
test.done(result => {
// result is undefined if success, or an object that contains errors
// and refusedTests if failed
console.log(result);
});
}Using with mocha:
describe('File tests', function() {
it('Files exist', function(done) {
const filenames = [
'foo/bar.yaml',
'foo/bar.js',
'foo/bar.csv',
'foo/bar.txt'
];
let test = new TestBattery();
// test each of the files
for (let filename of filenames) {
// the error message is parameterized
test.test('%s should be a file', filename)
.value([process.cwd(), '..', filename])
.is.a.file;
}
// note we pass mocha's `done` to `tests.done` to report all errors in
// this test.
test.done(done);
});
});The constructed form has four distinct clauses:
- Creating the test
battery.test('description') - Adding values
.value(v1).value(v2) - Verb (optional, default
is).is.not - Test
.equal
battery.test('values should not equal`)
.value(v1)
.value(v2)
.is.not.equal; let test = battery.test('The "%s" file should exist', filename);This creates a Test object that sets up a single test. The first parameter is a description of the test that will appear in the error message if the test either fails or is refused. This message can be a .
In the examples below, each clause is broken out, but they are chainable.
test = test.value(filename)lCall .value once for every value you need to add. This is an infix notation.
This can accept Promises; it'll test on the value the Promise resolves to.
test.is;The verb .is or .are is assumed, if not provided. Also acceptable is .is.not which would, obviously test for the negative.
test.file;This is what to test for. This completes the test.
This format is, of course, simpler, but it's also more limited in capability.
battery.isFile(filename, 'The "%s" file should exist', filename);The first parameter is the test value (two parameters for isEqual), and the remaining parameters are for the description. Again, this nessge can be parameterized for format.