https://github.com/nimasoroush/mockeer
Mocking library for Puppeteer!
https://github.com/nimasoroush/mockeer
Last synced: about 1 month ago
JSON representation
Mocking library for Puppeteer!
- Host: GitHub
- URL: https://github.com/nimasoroush/mockeer
- Owner: NimaSoroush
- License: mit
- Created: 2019-03-03T14:21:44.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T23:19:52.000Z (over 2 years ago)
- Last Synced: 2025-02-27T09:46:48.140Z (about 2 months ago)
- Language: JavaScript
- Size: 1.07 MB
- Stars: 34
- Watchers: 2
- Forks: 4
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Mockeer
Mocking library for Puppeteer!
## About
Mockeer is a [Puppeteer](https://github.com/GoogleChrome/puppeteer) helper library to run chrome headless browser in isolation.
## How it works
Mockeer works by overriding Puppeteer's Request event and providing mock responses.
Mockeer works in `Record` and `Play` mode. In record mode it intercepts browser requests and saves them as json fixtures. In play mode it just replay those saved responses.
## Installation
```bash
$ npm install mockeer
```
## Usage
```js
const mockeer = require('mockeer');
const puppeteer = require('puppeteer');
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await mockeer(browser);
await page.goto('https://www.example.com');
await page.close();
await browser.close();
})();
```
Save above script as `index.js`
- `Record` mode
```bash
> node index.js
```
- `Play` mode
```bash
> CI=true node index.js
```
See more examples [here](./src/tests/integration/integration.int.test.js)
See full list of configs [below](https://github.com/NimaSoroush/mockeer#globaloptions)
## API
See [API.md](API.md) for full list of API calls
## GlobalOptions
|Parameter|type|required|description|default|
|---------|----|--------|-----------|-------|
|`page`|`object`|no|If puppeteer page object passed, only mock responses for that page will be recorded|null|
|`fixturesDir`|`string`|no|Path to generated fixture files|`./__mockeer_fixture__`|
|`fixtureName`|`string`|no|Path to generated fixture name|`chrome-http-mocks`|
|`replaceImage`|`boolean`|no|Replace images with template image|false|
|`replaceIfExists`|`boolean`|no|Replace fixtures even when they already recorded|true|
|`allowImageRecourses`|`boolean`|no|If enabled image resources will be fetched from origin and not intercepted in play mode|false|
|`svgTemplate`|`string`|no|A SVG image template that will replace images in the page|A solid gray svg image. Source [here](src/utils/svg-template.js)|
## Links
See [examples](./src/integration.tests) for usages and CI integration with jest
Visit project [Slack Chat](https://mockeer.slack.com) for general Q/A around project
See [CONTRIBUTING.md](CONTRIBUTING.md) if you want to contribute.
[Gist example](https://gist.github.com/NimaSoroush/f611dcdf8911b2d9e903267324214562) with vanilla node