A Sequelize extension to deal with mocking for tests. 

A Sequelize extension to deal with mocking for tests

rochejul

sequelize-mocking

 * Base service for mocking with Sequelize

const sequelizeFixtures = require('sequelize-fixtures');

const FAKE_DATABASE_NAME = 'sqlite://test-database';

const AFTER_DEFINE_EVENT = 'afterDefine';

const AFTER_DEFINE_EVENT_NAME = 'sequelizeMockAfterDefine';

 * @property {Function} [transformFixtureDataFn] Allow an external caller to do some transforms to the data. See https://github.com/domasx2/sequelize-fixtures/commit/cffbfb1c67c8e05d5099b4455b99ac3aadd0089d

     * @param {Sequelize} sequelizeInstance

     * @param {SequelizeMockingOptions} [options]

     * @returns {Sequelize} Mocked Sequelize object

    static adaptSequelizeOptions(sequelizeInstance, options) {

            { 'logging': options && !options.logging ? false : console.log }

    static copyModel(sequelizeInstance, model) {

        class TempModel extends Sequelize.Model {

            _.merge({ }, model.attributes),

            _.merge({ }, model.options, { 'sequelize': sequelizeInstance, 'modelName': model.name })

        // Let's recreate a new instance of the datatype

        for (let att of _.values(newModel.attributes)) {

            att.type = new Sequelize.DataTypes[att.type.key]();

     * @param {Sequelize} originalSequelize

     * @param {Sequelize} mockedSequelize

    static copyCurrentModels(originalSequelize, mockedSequelize) {

        originalSequelize.modelManager.all.forEach(function (model) {

            SequelizeMocking.copyModel(mockedSequelize, model);

    static create(originalSequelize, options) {

        let logging = !options || options.logging;

        let mockedSequelize = new Sequelize(FAKE_DATABASE_NAME, null, null, SequelizeMocking.adaptSequelizeOptions(originalSequelize, options));

        mockedSequelize.__originalSequelize = originalSequelize;

        SequelizeMocking.copyCurrentModels(originalSequelize, mockedSequelize);

        SequelizeMocking.modifyConnection(originalSequelize, mockedSequelize);

        SequelizeMocking.modifyModelReferences(originalSequelize, mockedSequelize);

        SequelizeMocking.hookNewModel(originalSequelize, mockedSequelize, options);

        logging && console.log('SequelizeMocking - Mock the context');

                logging && console.log('SequelizeMocking - Database construction done');

     * @param {string | Array.<String>} fixtureFilePath

    static createAndLoadFixtureFile(originalSequelize, fixtureFilePath, options) {

            .create(originalSequelize, options)

            .then(function (mockedSequelize) {

                    .loadFixtureFile(mockedSequelize, fixtureFilePath, options)

                        logging && console.log('SequelizeMocking - Mocked data injected');

                        return mockedSequelize;

    static hookNewModel(originalSequelize, mockedSequelize, options) {

        originalSequelize.addHook(AFTER_DEFINE_EVENT, AFTER_DEFINE_EVENT_NAME, function (newModel) {

                    SequelizeMocking.copyModel(mockedSequelize, newModel)

                    logging && console.log(`Model ${newModel.name} was declared into the database`);

                    logging && console.error(`An error occured when initializing the model ${newModel.name}`);

                    console.error(err && err.stack ? err.stack : err);

    static loadFixtureFile(sequelize, fixtureFilePath, options) {

        let transformFixtureDataFn = !options || options.transformFixtureDataFn;

            'log': logging ? null : _.noop

  "description": "A Sequelize extension to deal with mocking for tests",

    "delete": "node node_modules/rimraf/bin.js",

    "checkstyle": "npm run delete ./target/eslint-reporter-checkstyle.xml && node node_modules/eslint/bin/eslint.js --config=.eslintrc --output-file ./target/eslint-reporter-checkstyle.xml --format checkstyle ./lib",

    "generate-shrinkwrap": "npm prune && npm shrinkwrap --only=prod",

    "test": "node ./node_modules/mocha/bin/mocha --recursive --ui bdd --colors ./test",

    "bumping": "node ./node_modules/npmversion/bin/npmversion",

    "bump-release": "npm test && npm run bumping -- --unpreid",

    "bump-major": "npm test && npm run bumping -- --increment major",

    "bump-minor": "npm test && npm run bumping -- --increment minor",

    "bump-patch": "npm test && npm run bumping -- --increment patch",

    "bump-major-beta": "npm run bumping -- --increment major --preid beta",

    "bump-minor-beta": "npm run bumping -- --increment minor --preid beta",

    "bump-patch-beta": "npm run bumping -- --increment patch --preid beta"

    "url": "git+https://github.com/rochejul/sequelize-mocking.git"

    "url": "https://github.com/rochejul/sequelize-mocking/issues"

  "homepage": "https://github.com/rochejul/sequelize-mocking#readme",

		{
		"name": "sequelize-mocking",
		"version": "1.3.1",
		"version": "1.3.2",
		"description": "A Sequelize extension to deal with mocking for tests",
		@@ -45,3 +45,3 @@ "main": "index.js",
		"sequelize-fixtures": "0.6.0",
		"sqlite3": "3.1.11"
		"sqlite3": "3.1.13"
		},
		@@ -57,3 +57,3 @@ "engines": {
		"mysql2": "1.3.5",
		"npmversion": "1.3.4",
		"npmversion": "1.6.0",
		"rimraf": "2.6.1",
		@@ -60,0 +60,0 @@ "sequelize": "4.13.10",

Improved metrics

Dependency changes

		@@ -66,2 +66,8 @@ /**
		);

		// Let's recreate a new instance of the datatype
		for (let att of _.values(newModel.attributes)) {
		att.type = new Sequelize.DataTypes[att.type.key]();
		}

		return newModel;
		@@ -68,0 +74,0 @@ }