Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BlinkUX/sequelize-mock
A simple mock interface specifically for testing code relying on Sequelize models
https://github.com/BlinkUX/sequelize-mock
mock-models sequelize sequelize-models unit-testing
Last synced: 2 months ago
JSON representation
A simple mock interface specifically for testing code relying on Sequelize models
- Host: GitHub
- URL: https://github.com/BlinkUX/sequelize-mock
- Owner: BlinkUX
- License: mit
- Created: 2016-10-07T20:00:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T18:55:28.000Z (over 1 year ago)
- Last Synced: 2024-05-23T02:03:05.549Z (8 months ago)
- Topics: mock-models, sequelize, sequelize-models, unit-testing
- Language: JavaScript
- Homepage: https://sequelize-mock.readthedocs.io
- Size: 233 KB
- Stars: 137
- Watchers: 8
- Forks: 73
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Sequelize Mock
[](https://www.npmjs.com/package/sequelize-mock) [](https://circleci.com/gh/BlinkUX/sequelize-mock) [](https://coveralls.io/github/BlinkUX/sequelize-mock) [](https://github.com/BlinkUX/sequelize-mock) [](http://sequelize-mock.readthedocs.io/en/stable/?badge=stable)
A mocking interface designed for testing code that uses [Sequelize](http://sequelizejs.com).
Documentation at [sequelize-mock.readthedocs.io](https://sequelize-mock.readthedocs.io/)
## Install
```
npm i sequelize-mock --save-dev
```
## Getting Started
The Mock Models created with this library function as drop in replacements for your unit testing.
Start by importing the library
```javascript
var SequelizeMock = require('sequelize-mock');
```
Initialize the library as you would Sequelize
```javascript
var DBConnectionMock = new SequelizeMock();
```
Define your models
```javascript
var UserMock = DBConnectionMock.define('users', {
'email': '[email protected]',
'username': 'blink',
'picture': 'user-picture.jpg',
}, {
instanceMethods: {
myTestFunc: function () {
return 'Test User';
},
},
});
```
Once Mock models have been defined, you can use them as drop-in replacements for your Sequelize model objects. Data is not retrieved from a database and instead is returned based on the setup of the mock objects, the query being made, and other applied or included information.
For example, your code might look something like this
```javascript
UserMock.findOne({
where: {
username: 'my-user',
},
}).then(function (user) {
// `user` is a Sequelize Model-like object
user.get('id'); // Auto-Incrementing ID available on all Models
user.get('email'); // '[email protected]'; Pulled from default values
user.get('username'); // 'my-user'; Pulled from the `where` in the query
user.myTestFunc(); // Will return 'Test User' as defined above
});
```
## Contributing
This library is under active development, so you should feel free to submit issues, questions, or pull requests.
## License
Created by Blink UX and licensed under the MIT license. Check the LICENSE file for more information.