Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some docs on using jest.mock(...) #5648

Merged
merged 7 commits into from
Mar 1, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
### Features

* `[jest-jasmine2]` Adds error throwing and descriptive errors to `it`/ `test`
for invalid arguements. `[jest-circus]` Adds error throwing and descriptive
errors to `it`/ `test` for invalid arguements.
for invalid arguments. `[jest-circus]` Adds error throwing and descriptive
errors to `it`/ `test` for invalid arguments
([#5558](https://github.com/facebook/jest/pull/5558))
* `[jest-matcher-utils]` Add `isNot` option to `matcherHint` function
([#5512](https://github.com/facebook/jest/pull/5512))

Expand All @@ -21,6 +22,11 @@
* `[jest-cli]` Fix update snapshot issue when using watchAll
([#5696](https://github.com/facebook/jest/pull/5696))

### Chore & Maintenance

* `[docs]` Add docs on using `jest.mock(...)`
([#5648](https://github.com/facebook/jest/pull/5648))

## 22.4.2

### Fixes
Expand Down
45 changes: 45 additions & 0 deletions docs/MockFunctions.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,51 @@ dependent component and configuring that, but the technique is the same. In
these cases, try to avoid the temptation to implement logic inside of any
function that's not directly being tested.

## Mocking Modules

Suppose we have a class that fetches users from our API. The class uses
[axios](https://github.com/axios/axios) to call the API then returns the `data`
attribute which contains all the users:

```js
// users.js
import axios from 'axios';

class Users {
static all() {
return axios.get('/users.json').then(resp => resp.data);
}
}

export default Users;
```

Now, in order to test this method without actually hitting the API (and thus
creating slow and fragile tests), we can use the `jest.mock(...)` function to
automatically mock the axios module.

Once we mock the module we can provide a `mockReturnValue` for `.get` that
returns the data we want our test to assert against. In effect, we are saying
that we want axios.get('/users.json') to return a fake response.

```js
// users.test.js
import axios from 'axios';
import Users from './users';

jest.mock('axios');

test('should fetch users', () => {
const resp = {data: [{name: 'Bob'}]};
axios.get.mockResolvedValue(resp);

// or you could use the follwing depending on your use case:
// axios.get.mockImpementation(() => Promise.resolve(resp))

return Users.all().then(users => expect(users).toEqual(resp.data));
});
```

## Mock Implementations

Still, there are cases where it's useful to go beyond the ability to specify
Expand Down