MaSch0212 / easy-network-stub

An easy class to mock a lot of network requests in e2e testing frameworks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

npm Build Status Sonar Quality Gate bundle size

easy-network-stub

An easy class to mock a lot of network requests in any e2e framework.

Framework specific packages πŸ§ͺ

Motivation πŸ’₯

When running tests in e2e frameworks, 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

βœ… ESM & CJS exports

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 πŸ”§

Usage Example πŸš€

You can find usage examples in the existing framework-specific wrappers for this package: Playwright or Cypress

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 - linkedin

Project Link: https://github.com/LoaderB0T/easy-network-stub

About

An easy class to mock a lot of network requests in e2e testing frameworks

License:MIT License


Languages

Language:TypeScript 99.3%Language:JavaScript 0.7%