mock-knex

A mock knex adapter for simulating a database during testing, especially useful when used in combination
with fixture-factory.

Knex Support

Currently tested on knex 0.8 through 3.0, should operate on any version of knex but may have issues with untested releases. Please file an issue if you come across any issues.

Installation

``sh
$ npm install mock-knex --save-dev
`

Usage

$3

`js
var knex = require('knex');
var mockDb = require('mock-knex');
var db = knex({
client: 'sqlite',
});

mockDb.mock(db);

... run tests ...
`

$3

`js
... run tests ...

mockDb.unmock(db);
`

$3

`js
... mock knex ...

var tracker = require('mock-knex').getTracker();

tracker.install();

tracker.on('query', function checkResult(query) {
expect(query.method).to.equal('first');
query.response([
{
fielda : 'A',
fieldb : 'B'
},
{
fielda : 'C',
fieldb : 'D'
},
{
fielda : 'E',
fieldb : 'F'
}
]);
});

knex.table('table').first('fielda', 'fieldb').then(function checkFirstArrResults(model) {
expect(model.fielda).to.equal('A');
expect(model.fieldb).to.equal('B');
tracker.uninstall();
done();
});
`

$3

`js
... mock knex ...

var tracker = require('mock-knex').getTracker();

tracker.install();

tracker.on('query', function sendResult(query) {
query.response([
{
id : 1,
foo : 'bar'
}
]);
});

Model.forge({ id : 1 }).fetch()
.then(function fetchResult(model) {
expect(model).to.be.an.instanceof(Model);
expect(model.get('id')).to.equal(1);
expect(model.get('foo')).to.equal('bar');
tracker.uninstall();
done();
});
`

$3

`js
... mock knex ...
... enable tracking ...

tracker.on('query', function sendResult(query, step) {
[
function firstQuery() {
expect(query.sql).to.equal(... some SQL string ...);
query.response([{id: 1}]);
},
function secondQuery() {
expect(query.sql).to.equal(... some SQL string ...);
query.response([{id: 2}]);
}
][step - 1]();
});
`

$3

Checkout the Tests

API

$3

$3

The tracker enables you to catch and respond to queries that occur during testing, see Test for more
examples.

$3

The object containing query details that is being sent to knex database dialect on query execution. Object properties signature matches with knex toSQL() output with additional method returns(values).

Running Tests

`sh
$ npm install
$ docker-compose up -d
$ make test-suite
``