sequelize-mock-v5 1.2.3 → 1.3.4

package/test/model.spec.js

@@ -14,9 +14,9 @@ var UtilsMock = {
 
 var QueryInterfaceMock = function () { this._args = arguments; };
 QueryInterfaceMock.prototype = {
-	$queueResult: function () {},
-	$queueFailure: function () {},
-	$clearQueue: function () {},
+	$queueResult: function () { },
+	$queueFailure: function () { },
+	$clearQueue: function () { },
 	$query: function (q) { return q; },
 };
 
@@ -27,7 +27,7 @@ var Model = proxyquire('../src/model', {
 });
 
 describe('Model', function () {
-	
+
 	describe('__constructor', function () {
 		var pluralize;
 		beforeEach(function () {
@@ -36,21 +36,21 @@ describe('Model', function () {
 		afterEach(function () {
 			UtilsMock.pluralize = pluralize;
 		});
-		
+
 		it('should assign a name to a model', function () {
 			var mdl = new Model('foo');
 			mdl.name.should.equal('foo');
 		});
-		
+
 		it('should accept an object of default values', function () {
 			var mdl = new Model('baz', {
 				'foo': 'bar',
 			});
-			
+
 			mdl.name.should.equal('baz');
 			mdl._defaults.should.have.property('foo').which.is.exactly('bar');
 		});
-		
+
 		it('should accept default object as first argument', function () {
 			var mdl = new Model({
 				'foo': 'bar',
@@ -58,14 +58,14 @@ describe('Model', function () {
 			mdl.name.should.equal('');
 			mdl._defaults.should.have.property('foo').which.is.exactly('bar');
 		});
-		
+
 		it('should have callable Instance property', function () {
 			var mdl = new Model('foo'),
 				inst = new mdl.Instance('bar');
 			inst.should.be.Object();
 			inst._args[0].should.equal('bar');
 		});
-		
+
 		it('should assign instanceMethods functions to Instance prototype', function () {
 			var fooFn = function () { return 'bar'; },
 				mdl = new Model('baz', {}, {
@@ -73,10 +73,10 @@ describe('Model', function () {
 						foo: fooFn,
 					},
 				});
-			
+
 			mdl.Instance.prototype.should.have.property('foo').which.is.exactly(fooFn);
 		});
-		
+
 		it('should have a default set of options assigned', function () {
 			var mdl = new Model('foo');
 			mdl.options.timestamps.should.be.true();
@@ -87,11 +87,11 @@ describe('Model', function () {
 			mdl.options.createdDefault.should.be.true();
 			mdl.options.autoQueryFallback.should.be.true();
 		});
-		
+
 		it('should inherit options from a passed in sequelize object', function () {
 			var mdl = new Model('foo', {}, {
 				sequelize: {
-					getQueryInterface: function () {},
+					getQueryInterface: function () { },
 					options: {
 						autoQueryFallback: false,
 						stopPropagation: true,
@@ -105,14 +105,14 @@ describe('Model', function () {
 			mdl.options.fallbackFn.should.equal('foo');
 			mdl.options.should.not.have.property('bar');
 		});
-		
+
 		it('should save options from passed in object object', function () {
 			var mdl = new Model('foo', {}, {
 				foo: 'bar'
 			});
 			mdl.options.should.have.property('foo').which.is.exactly('bar');
 		});
-		
+
 		it('should save table name if passed in from options', function () {
 			var mdl = new Model('foo', {}, {
 				tableName: 'bar',
@@ -120,7 +120,7 @@ describe('Model', function () {
 			mdl.name.should.equal('foo');
 			mdl.tableName.should.equal('bar');
 		});
-		
+
 		it('should use a "pluralized" table name if no table name is provided', function () {
 			UtilsMock.pluralize = function () {
 				return 'bar';
@@ -129,7 +129,7 @@ describe('Model', function () {
 			mdl.name.should.equal('foo');
 			mdl.tableName.should.equal('bar');
 		});
-		
+
 		it('should not use a "pluralized" table name if options indicate to freeze table name', function () {
 			UtilsMock.pluralize = function () {
 				return 'bar';
@@ -140,10 +140,10 @@ describe('Model', function () {
 			mdl.name.should.equal('foo');
 			mdl.tableName.should.equal('foo');
 		});
-		
+
 		it('should return an object with the proper API functions', function () {
 			var mdl = new Model('foo');
-			
+
 			// Test API functions
 			mdl.should.have.property('$queryInterface').which.is.an.Object();
 			mdl.should.have.property('$queueResult').which.is.a.Function();
@@ -152,9 +152,9 @@ describe('Model', function () {
 			mdl.should.have.property('$clearQueue').which.is.a.Function();
 			mdl.should.have.property('$queueClear').which.is.a.Function();
 			mdl.should.have.property('$query').which.is.a.Function();
-			
+
 			// Not yet supported functions are commented out
-			
+
 			// mdl.should.have.property('removeAttributes').which.is.a.Function();
 			mdl.should.have.property('sync').which.is.a.Function();
 			// mdl.should.have.property('drop').which.is.a.Function();
@@ -188,138 +188,167 @@ describe('Model', function () {
 			mdl.should.have.property('update').which.is.a.Function();
 			// mdl.should.have.property('describe').which.is.a.Function();
 		});
+
+		it('should store the model definition for access', function () {
+			var modelDef = {
+				'name': 'VARCHAR(255)',
+				'email': 'VARCHAR(255)',
+				'age': 'INTEGER',
+			};
+			var mdl = new Model('User', modelDef);
+
+			mdl.should.have.property('modelDefinition').which.is.an.Object();
+			mdl.modelDefinition.should.equal(modelDef);
+			mdl.modelDefinition.should.have.property('name').which.is.exactly('VARCHAR(255)');
+			mdl.modelDefinition.should.have.property('email').which.is.exactly('VARCHAR(255)');
+			mdl.modelDefinition.should.have.property('age').which.is.exactly('INTEGER');
+		});
+
+		it('should have modelDefinition accessible through instances', function () {
+			var modelDef = {
+				'title': 'VARCHAR(255)',
+				'content': 'TEXT',
+			};
+			var mdl = new Model('Post', modelDef);
+			var instance = mdl.build();
+
+			instance.Model.should.have.property('modelDefinition').which.is.an.Object();
+			instance.Model.modelDefinition.should.equal(modelDef);
+			instance.Model.modelDefinition.should.have.property('title').which.is.exactly('VARCHAR(255)');
+			instance.Model.modelDefinition.should.have.property('content').which.is.exactly('TEXT');
+		});
 	});
-	
+
 	describe('#scope', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should return a mock Model object', function () {
 			mdl.scope().should.be.instanceOf(Model);
 		});
 	});
-	
+
 	describe('#sync', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should return a promise', function () {
 			mdl.sync().should.be.instanceOf(Promise);
 		});
 	});
-	
+
 	describe('#drop', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should return a promise', function () {
 			mdl.drop().should.be.instanceOf(Promise);
 		});
 	});
-	
+
 	describe('#build', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should pass along the default values and the override values to Instance in a combined object', function () {
 			mdl._defaults = {
 				'foo': 'bar'
 			};
 			var vals = {
-				'baz' : 'bin'
+				'baz': 'bin'
 			};
-			
+
 			var inst = mdl.build(vals);
 			var passed = inst._args[0];
 			passed.should.have.property('foo').which.is.exactly('bar');
 			passed.should.have.property('baz').which.is.exactly('bin');
 		});
-		
+
 		it('should build Instance with Instance.prototype functions', function () {
-			mdl.Instance.prototype.bar = function () {};
-			
+			mdl.Instance.prototype.bar = function () { };
+
 			var inst = mdl.build();
 			inst.should.be.instanceOf(InstanceMock);
 			inst.should.have.property('bar').which.is.exactly(mdl.Instance.prototype.bar);
 		});
 	});
-	
+
 	describe('#create', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should create Instance with Instance.prototype functions', async function () {
 			var vals = {
-				'baz' : 'bin'
+				'baz': 'bin'
 			};
-			
+
 			let query = await mdl.create(vals);
 			let inst = await query.fallbackFn();
 			inst.should.be.instanceOf(InstanceMock);
 			inst._args[0].should.have.property('baz').which.is.exactly('bin');
-			
+
 		});
 	});
-	
+
 	describe('#update', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should pass back default of 1 row updated', async function () {
 			var vals = {
-				'baz' : 'bin'
+				'baz': 'bin'
 			};
 			let res = await mdl.update(vals);
 			let [number, rows] = await res.fallbackFn()
 			number.should.equal(1);
 		});
-		
+
 		it('should pass back row updated when returning option is included', async function () {
 			var vals = {
-				'baz' : 'bin'
+				'baz': 'bin'
 			};
-			
-			let res = await mdl.update(vals, {returning: true});
+
+			let res = await mdl.update(vals, { returning: true });
 			let [number, rows] = await res.fallbackFn()
 			rows.should.be.Array();
 			rows[0]._args[0].should.have.property('baz').which.is.exactly('bin');
-			
+
 		});
 
 		it('should not pass back row updated when returning option is set to false', async function () {
 			var vals = {
-				'baz' : 'bin'
+				'baz': 'bin'
 			};
-			
-			let res = await mdl.update(vals, {returning: false});
+
+			let res = await mdl.update(vals, { returning: false });
 			let [number, rows] = await res.fallbackFn()
 			number.should.be.equal(1);
 			should.not.exist(rows);
 		});
-			
-		
+
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.update().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var vals = {};
 			var opts = {};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('update');
 				options.queryOptions.length.should.equal(2);
 				options.queryOptions[0].should.equal(vals);
@@ -329,45 +358,45 @@ describe('Model', function () {
 			mdl.update(vals, opts);
 		});
 	});
-	
+
 	describe('#findOne', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
-		it('should find a row with no options given', async function() {
-			let res  = await mdl.findOne()
+
+		it('should find a row with no options given', async function () {
+			let res = await mdl.findOne()
 			let inst = await res.fallbackFn()
 			should.exist(inst)
 			inst.should.be.instanceOf(InstanceMock);
 		});
-		
+
 		it('should find a row with the values from the `where` query', async function () {
 			var options = {
 				where: {
 					'foo': 'bar',
 				},
 			};
-			
+
 			let res = await mdl.findOne(options)
 			let inst = await res.fallbackFn()
 			inst._args[0].should.have.property('foo').which.is.exactly('bar');
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.findOne().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var queryOptions = {
 				where: {
 					'foo': 'bar',
 				},
 			};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('findOne');
 				options.queryOptions.length.should.equal(1);
 				options.queryOptions[0].should.equal(queryOptions);
@@ -376,26 +405,26 @@ describe('Model', function () {
 			mdl.findOne(queryOptions);
 		});
 	});
-	
+
 	describe('#findById', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
-		it('should find a row with the given id', async function() {
+
+		it('should find a row with the given id', async function () {
 			let res = await mdl.findById(1234);
 			let inst = await res.fallbackFn();
 			inst._args[0].id.should.equal(1234);
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.findById().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
-			mdl.$query = function(options) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
+			mdl.$query = function (options) {
 				options.query.should.equal('findById');
 				options.queryOptions.length.should.equal(1);
 				options.queryOptions[0].should.equal(123);
@@ -404,30 +433,30 @@ describe('Model', function () {
 			mdl.findById(123);
 		});
 	});
-	
+
 	describe('#<sum/min/max>', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should return the default value for the field', async function () {
 			mdl._defaults.foo = 1234;
-			
+
 			let res = await mdl.sum('foo')
 			let count = await res.fallbackFn()
 			count.should.equal(1234);
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.sum().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var queryOptions = {};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('sum');
 				options.queryOptions.length.should.equal(1);
 				options.queryOptions[0].should.equal(queryOptions);
@@ -436,28 +465,28 @@ describe('Model', function () {
 			mdl.sum(queryOptions);
 		});
 	});
-	
+
 	describe('#upsert', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
-		it('should return the createdDefault value for the model', async function() {
+
+		it('should return the createdDefault value for the model', async function () {
 			let res = await mdl.upsert();
 			let created = await res.fallbackFn();
 			created.should.equal(mdl.options.createdDefault);
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.upsert().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var queryOptions = {};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('upsert');
 				options.queryOptions.length.should.equal(1);
 				options.queryOptions[0].should.equal(queryOptions);
@@ -466,40 +495,40 @@ describe('Model', function () {
 			mdl.upsert(queryOptions);
 		});
 	});
-	
+
 	describe('#findOrCreate', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should pass along where value to Instance creation', async function () {
 			var options = {
 				where: {
 					'foo': 'bar',
 				},
 			};
-			
+
 			let res = await mdl.findOrCreate(options)
-			let [inst, created] =	await res.fallbackFn()
+			let [inst, created] = await res.fallbackFn()
 			inst._args[0].should.have.property('foo').which.is.exactly('bar');
 		});
-		
+
 		it('should return the createdDefault value for the model', async function () {
 			let res = await mdl.findOrCreate({})
 			let [inst, created] = await res.fallbackFn();
 			created.should.equal(mdl.options.createdDefault);
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.findOrCreate().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var queryOptions = {};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('findOrCreate');
 				options.queryOptions.length.should.equal(1);
 				options.queryOptions[0].should.equal(queryOptions);
@@ -508,40 +537,40 @@ describe('Model', function () {
 			mdl.findOrCreate(queryOptions);
 		});
 	});
-	
+
 	describe('#bulkCreate', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should create each model in the passed array', async function () {
 			var vals = [
 				{
-					'baz' : 'bin'
+					'baz': 'bin'
 				},
 				{
-					'qux' : 'quuz'
+					'qux': 'quuz'
 				},
 			];
-			
+
 			let res = await mdl.bulkCreate(vals);
 			let arr = await res.fallbackFn();
 			arr.should.be.an.Array();
 			arr[0]._args[0].should.have.property('baz').which.is.exactly('bin');
 			arr[1]._args[0].should.have.property('qux').which.is.exactly('quuz');
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.bulkCreate().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var set = {};
 			var opt = {};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('bulkCreate');
 				options.queryOptions.length.should.equal(2);
 				options.queryOptions[0].should.equal(set);
@@ -551,41 +580,41 @@ describe('Model', function () {
 			mdl.bulkCreate(set, opt);
 		});
 	});
-	
+
 	describe('#findAll', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should pass along where value to Instance creation', async function () {
 			var options = {
 				where: {
 					'foo': 'bar',
 				},
 			};
-			
+
 			let query = await mdl.findAll(options);
 			let rows = await query.fallbackFn()
 			rows.length.should.equal(1);
 			rows[0]._args[0].should.have.property('foo').which.is.exactly('bar');
 		});
-		
-		it('should still find results if there is not options', async function() {
+
+		it('should still find results if there is not options', async function () {
 			let query = await mdl.findAll();
 			let rows = await query.fallbackFn();
 			rows.length.should.equal(1);
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.findAll().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var queryOptions = {};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('findAll');
 				options.queryOptions.length.should.equal(1);
 				options.queryOptions[0].should.equal(queryOptions);
@@ -594,43 +623,43 @@ describe('Model', function () {
 			mdl.findAll(queryOptions)
 		});
 	});
-	
+
 	describe('#findAndCountAll', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
-		it('should pass along where value to Instance creation', async function() {
+
+		it('should pass along where value to Instance creation', async function () {
 			var options = {
 				where: {
 					'foo': 'bar',
 				},
 			};
-			
+
 			let query = await mdl.findAndCountAll(options);
-			let result =await query.fallbackFn()
+			let result = await query.fallbackFn()
 			result.rows.length.should.equal(1);
 			result.count.should.equal(1);
 			result.rows[0]._args[0].should.have.property('foo').which.is.exactly('bar');
 		});
-		
+
 		it('should still find results if there is not options', async function () {
 			let query = await mdl.findAndCountAll()
 			let result = await query.fallbackFn()
 			result.count.should.equal(1);
 			result.rows.length.should.equal(1);
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.findAndCountAll().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var queryOptions = {};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('findAndCountAll');
 				options.queryOptions.length.should.equal(1);
 				options.queryOptions[0].should.equal(queryOptions);
@@ -645,31 +674,31 @@ describe('Model', function () {
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should return a default value of 1 for number of rows destroyed', async function () {
 			let query = await mdl.destroy();
 			let rows = await query.fallbackFn()
 			rows.should.equal(1);
-			
+
 		});
-		
+
 		it('should return the limit for number of rows destroyed if that is passed in', async function () {
 			let query = await mdl.destroy({
 				limit: 5
 			})
 			let rows = await query.fallbackFn()
-			rows.should.equal(5);	
+			rows.should.equal(5);
 		});
-		
+
 		it('should not pass along a fallback function if auto fallback is turned off', function () {
 			mdl.options.autoQueryFallback = false;
 			should.not.exist(mdl.destroy().fallbackFn);
 		});
-		
-		it('should pass query info to the QueryInterface instance', function(done) {
+
+		it('should pass query info to the QueryInterface instance', function (done) {
 			var queryOptions = {};
-			
-			mdl.$query = function(options) {
+
+			mdl.$query = function (options) {
 				options.query.should.equal('destroy');
 				options.queryOptions.length.should.equal(1);
 				options.queryOptions[0].should.equal(queryOptions);
@@ -678,18 +707,18 @@ describe('Model', function () {
 			mdl.destroy(queryOptions);
 		});
 	});
-	
+
 	describe('#getTableName', function () {
 		var mdl;
 		beforeEach(function () {
 			mdl = new Model('foo');
 		});
-		
+
 		it('should return a default value of 1 for number of rows destroyed', function () {
 			mdl.tableName = 'bar';
-			
+
 			mdl.getTableName().should.equal('bar');
 		});
 	});
-	
+
 });