Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loaderb0t/cypress-easy-network-stub
An easy class to mock a lot of network requests in cypress
https://github.com/loaderb0t/cypress-easy-network-stub
Last synced: 10 days ago
JSON representation
An easy class to mock a lot of network requests in cypress
- Host: GitHub
- URL: https://github.com/loaderb0t/cypress-easy-network-stub
- Owner: LoaderB0T
- License: mit
- Created: 2021-04-22T12:09:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-28T13:31:01.000Z (about 1 month ago)
- Last Synced: 2024-10-03T06:26:05.068Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 232 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/cypress-easy-network-stub)
[](https://github.com/LoaderB0T/cypress-easy-network-stub/actions/workflows/build.yml)
[](https://sonarcloud.io/summary/new_code?id=LoaderB0T_cypress-easy-network-stub)
[](https://bundlephobia.com/package/cypress-easy-network-stub)
# cypress-easy-network-stub
An easy class to mock a lot of network requests in cypress.
## See also 🔬
The base class of this package is:
[https://github.com/LoaderB0T/easy-network-stub](https://github.com/LoaderB0T/easy-network-stub)
## Motivation 💥
When running tests in cypress, sometimes you want to mock all network requests. Especially when running tests in a CI environment. This package provides an easy and type safe way to mock network requests for a whole API.
## Features 🔥
✅ Easy to setup and use
✅ Type safe url and query parameters
✅ Add your own parameter matchers
✅ Works asynchronously (Promise based)
✅ Supports failing of stubbed requests
✅ No production dependencies (You need to have cypress installed, of course)
The primary use case for this package is to create a mock server for your tests so that they do not need real network requests.
## Built With 🔧
- [TypeScript](https://www.typescriptlang.org/)
## Usage Example 🚀
```typescript
const posts = [0, 1, 2, 3, 4, 5].map(x => ({ postId: x, text: `test${x}` }));
const blogStub = new CypressEasyNetworkStub(/MyServer\/api\/Blog/);
blogStub.init();
blogStub.stub('GET', 'posts', () => {
return posts;
});
// Match Example: GET: /MyServer/api/Blog/posts/123
blogStub.stub('GET', 'posts/{id:number}', ({ params }) => {
return posts.find(x => x.postId === params.id);
});
// Match Example: POST: /MyServer/api/post
blogStub.stub('POST', 'posts', ({ body, params }) => {
posts.push({ postId: body.postId, text: body.text });
});
// Match Example: POST: /MyServer/api/Blog/test/true?query=myValue&secondQuery=myOtherValue
// Note: The order of the query parameters is not important
blogStub.stub('POST', 'test/{something:boolean}?{query:string}&{secondQuery:number}', ({ body, params }) => {
console.log(params.something);
console.log(params.query);
console.log(params.secondQuery);
console.log(body);
});
// Here we use the stub2<>() method to create a stub with a typed body
blogStub.stub2()('POST', 'test', ({ body }) => {
console.log(body.myValue);
});
// You can mark query params as optional with a '?'
// Match Example: GET: /MyServer/api/Blog/test
// Match Example: GET: /MyServer/api/Blog/test?refresh=true
blogStub.stub('GET', 'test?{refresh?:boolean}', ({ body, params }) => {
if (params.refresh) {
console.log('Refreshing');
}
console.log(body.myValue);
});
// You can mark query params as arrays with a '[]'
// Match Example: GET: /MyServer/api/Blog/test?props=1
// Match Example: GET: /MyServer/api/Blog/test?props=1&props=2
blogStub.stub('GET', 'test?{props:number[]}', ({ params }) => {
params.props.forEach(x => console.log(x));
});
```
## Strongly typed api parameters:
You can add types to parameters and they will be parsed. Out of box 'string', 'number' and 'boolean' are supported. You can add your own types and parsers though.
## Contributing 🧑🏻💻
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License 🔑
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact 📧
Janik Schumacher - [@LoaderB0T](https://twitter.com/LoaderB0T) - [linkedin](https://www.linkedin.com/in/janikschumacher/)
Project Link: [https://github.com/LoaderB0T/cypress-easy-network-stub](https://github.com/LoaderB0T/cypress-easy-network-stub)