https://github.com/gemini-testing/testplane-mocks

Testplane plugin that allows you to mock HTTP requests. Works only with browsers that support the CDP protocol
https://github.com/gemini-testing/testplane-mocks

testplane-plugin

Last synced: about 2 months ago
JSON representation

Testplane plugin that allows you to mock HTTP requests. Works only with browsers that support the CDP protocol

• Host: GitHub
• URL: https://github.com/gemini-testing/testplane-mocks
• Owner: gemini-testing
• License: mit
• Created: 2022-11-02T11:42:04.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-24T10:48:45.000Z (4 months ago)
• Last Synced: 2024-11-07T20:51:10.406Z (2 months ago)
• Topics: testplane-plugin
• Language: TypeScript
• Homepage:
• Size: 642 KB
• Stars: 0
• Watchers: 11
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @testplane/mocks

A [testplane](https://github.com/gemini-testing/testplane) plugin that allows you to save/read data dumps from network requests. 

This can increase the stability of tests, allows testing time-dependent scenarios, and reduces the load on the server.

**Works only with browsers that support the CDP protocol**.

## Installation

```bash

npm install @testplane/mocks --save-dev

```

## Usage

* **enabled** (optional) `Boolean` – enable/disable the plugin. By default plugin is disabled;

* **patterns** (optional) `{url: string, resources: string[] | "*"}[]`:

  - `url` (`string`) - A url pattern of mocking host. Example - "https://nodejs.org/*"

  - `resources` (`"*"` | `string[]`) - An array of resource types to be mocked. Supported resource types: `"Document", "Stylesheet", "Image", "Media", "Script", "XHR", "Fetch"`. You can also use "*" instead of array, it will work the same way as array of all mentioned resource types

* **browsers** (optional) `string[]` - array of `browserId` (from Testplane config) to intercept requests for. Each of them should be using chrome-devtools protocol. Default - `[]`

* **mode** (optional) `"play" | "save" | "create"` - plugin's mode. Default - `"save"`. Available modes:

   - `"play"`: Reads dumps from fs (dumps should exist) 

   - `"save"`: Writes dumps to fs. **Overwrites** existing dumps

   - `"create"`: Writes dumps to fs. **Doesn't overwrite** existing dumps

* **dumpsDir** (optional) `string | (test: Test) => string` -  dumps' directory. Default - `"testplane-dumps"`. Available types:

   - `string`: (ex: `"testplane-dumps"`). All your dumps will be located in `testplane-dumps` in the root of the project.

   - `(test: Test) => string`: (ex: `path.join(path.dirname(test.file), "testplane-dumps")`. `testplane-dumps` directories will be located next to each Testplane test). Saves tests' dumps to directories by path, returned by the function

* **dumpsKey** (optional) `(requestUrl: string) => string` - function to create dumps key from request url. Сan be used to remove query parameters that unique every time. If you dont remove unique query params, you will encounter an error `Cache is empty: key=...` on `play` mode.

* **gzipDumps** (optional) `Boolean` - enable/disable dump compressing. By default dumps are written and read in compressed form

Also there is ability to override plugin parameters by CLI options or environment variables (see [configparser](https://github.com/gemini-testing/configparser)).

Use `testplane_mocks_` prefix for the environment variables and `--mocks-` for the cli options.

* Add `@testplane/mocks` plugin to your `testplane` config file:

```js

// .testplane.conf.js

module.exports = {

    plugins: {

        '@testplane/mocks': {

            enabled: true,

            patterns: [

                {

                    url: "https://www.npmjs.com/*",

                    resources: ["Document", "Stylesheet", "Image", "Media", "Script", "XHR", "Fetch"]

                },

                {

                    url: "https://www.github.com/*",

                    resources: "*"

                }

            ]

            browsers: ["chrome"],

            mode: "save",

            dumpsDir: "testplane-dumps",

            dumpsKey: (requestUrl) => {

                const urlObj = new URL(requestUrl);

                urlObj.searchParams.delete('uniqRequestId');

                return urlObj.toString();

            },

            gzipDumps: true

        },

        // other Testplane plugins...

    },

    // other Testplane settings...

}

```