Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axios/moxios
Mock axios requests for testing
https://github.com/axios/moxios
Last synced: 30 days ago
JSON representation
Mock axios requests for testing
- Host: GitHub
- URL: https://github.com/axios/moxios
- Owner: axios
- License: mit
- Created: 2016-05-25T03:03:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-26T14:36:41.000Z (over 1 year ago)
- Last Synced: 2024-04-14T02:32:47.740Z (7 months ago)
- Language: JavaScript
- Size: 708 KB
- Stars: 1,415
- Watchers: 23
- Forks: 89
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# moxios [](https://travis-ci.org/axios/moxios)
Mock [axios](https://github.com/axios/axios) requests for testing
## Installing
```bash
$ npm install moxios --save-dev
```
## Example
```js
import axios from 'axios'
import moxios from 'moxios'
import sinon from 'sinon'
import { equal } from 'assert'
describe('mocking axios requests', function () {
describe('across entire suite', function () {
beforeEach(function () {
// import and pass your custom axios instance to this method
moxios.install()
})
afterEach(function () {
// import and pass your custom axios instance to this method
moxios.uninstall()
})
it('specify response for a specific request', function (done) {
let input = document.querySelector('.UserList__Filter__Input')
let button = document.querySelector('.UserList__Filter__Button')
input.value = 'flintstone'
button.click()
// Elsewhere in your code axios.get('/users/search', { params: { q: 'flintstone' } }) is called
moxios.wait(function () {
let request = moxios.requests.mostRecent()
request.respondWith({
status: 200,
response: [
{ id: 1, firstName: 'Fred', lastName: 'Flintstone' },
{ id: 2, firstName: 'Wilma', lastName: 'Flintstone' }
]
})
.then(function () {
let list = document.querySelector('.UserList__Data')
equal(list.rows.length, 2)
equal(list.rows[0].cells[0].innerHTML, 'Fred')
equal(list.rows[1].cells[0].innerHTML, 'Wilma')
done()
})
})
})
it('stub response for any matching request URL', function (done) {
// Match against an exact URL value
moxios.stubRequest('/say/hello', {
status: 200,
responseText: 'hello'
})
// Alternatively URL can be a RegExp
moxios.stubRequest(/say.*/, {/* … */})
let onFulfilled = sinon.spy()
axios.get('/say/hello').then(onFulfilled)
moxios.wait(function () {
equal(onFulfilled.getCall(0).args[0].data, 'hello')
done()
})
})
})
it('just for a single spec', function (done) {
moxios.withMock(function () {
let onFulfilled = sinon.spy()
axios.get('/users/12345').then(onFulfilled)
moxios.wait(function () {
let request = moxios.requests.mostRecent()
request.respondWith({
status: 200,
response: {
id: 12345, firstName: 'Fred', lastName: 'Flintstone'
}
})
.then(function () {
equal(onFulfilled.called, true)
done()
})
})
})
})
it('Should reject the request', function (done) {
const errorResp = {
status: 400,
response: { message: 'invalid data' }
}
moxios.wait(function () {
let request = moxios.requests.mostRecent()
request.reject(errorResp)
})
.catch(function (err) {
equal(err.status, errorResp.status)
equal(err.response.message, errorResp.response.message)
done()
})
})
})
```
## Mocking a axios.create() instance
```js
describe('some-thing', () => {
let axiosInstance;
beforeEach(() => {
axiosInstance = axios.create();
moxios.install(axiosInstance);
})
afterEach(() => {
moxios.uninstall(axiosInstance)
})
it('should axios a thing', (done) => {
moxios.stubRequest('http://www.somesite.com/awesome-url', {
status: 200,
responseText: '…'
})
axiosInstance.get('http://www.somesite.com/awesome-url')
.then(res => assert(res.status === 200))
.finally(done)
})
})
```
## Thanks
moxios is heavily inspired by [jasmine-ajax](https://github.com/jasmine/jasmine-ajax)
## License
MIT