Welcome to playback-proxy
👋
A proxy tool that records communication (requests, websockets) between client and server. This recording can later be used for tests as a mock backend. It works in 2 modes, RECORD and PLAYBACK, capturing and reproducing the server responses respectively.
Supported Features
- Record multiple calls to the same endpoint. These will be reproduced in the same order during PLAYBACK as they were requested.
- Record web socket events. These will be reproduced based on the last request and time before socket was received. This means that if the socket was received 2 seconds after a particular call in RECORD mode, during PLAYBACK it will be sent 2 seconds after that particular call is requested.
- Specify a list of endpoints that are recorded only once. Same response will be used during PLAYBACK for every call. See
SAVE_SINGLEparameter in the.envfile - Specify a list of endpoints that are not printed to the log. See
IGNORE_LOGparameter in the.envfile
Unsupported (yet) Features
- Saving responses in any other format (json, plaintext) than binary
- Using
httpsandwssprotocols - Support for HAR files as records
- Support for optional delay
- Any other ideas people might have
Install
git clone https://github.com/kaphacius/playback-proxy.git
Setup
Install all dependencies with
pip3 install -r requirements.txt
🚀
Usage
There are 2 modes of running the tool: RECORD and PLAYBACK.
- During RECORD, all communication between client and server is stored.
- Duruing PLAYBACK, the socket uses previously stored responses when being requested.
Firstly, set up an .env file with mandatory and optional parameters. Copy the and rename template.env to a desired name. Mandatory parameters:
PROTOCOL- protocol used for communication (only http for now)ENDPOINT- the address of the server to which the proxy will connect toMODE- current mode. Can be changed later during when launching the proxy.RECORDS_PATH- relative path to where all of the recordings will be stored. Must exists before running.RECORDING- name of the current recording. This will be appended to RECORDS_PATH and a folder will be created to store saved data. Can be changed later when launching the proxy.
Make the starter script executable:
chmod +x proxy-starter.sh
Then, run the proxy in RECORD mode. Specify the name of the current recording RECORDING. This will create a folder (or use an existing one) where the responses will be saved. Set relative path to your specific .env file via PATH_TO_ENV_FILE. Specify address and port where the client will be connecting via PROXY_SERVER_ADDRESS and PROXY_PORT.
./proxy-starter.sh -m RECORD -r {RECORDING} -e {PATH_TO_ENV_FILE} -a {PROXY_SERVER_ADDRESS} -p {PROXY_PORT}
Perform necessary interactions with the backend and stop the proxy by pressing Ctrl+C.
Finally, run the proxy in PLAYBACK mode. Interact with the server the same way as during recording - receive the same responses.
./proxy-starter.sh -m PLAYBACK -r {RECORDING} -e {PATH_TO_ENV_FILE} -a {PROXY_SERVER_ADDRESS} -p {PROXY_PORT}
Author
- Github: @kaphacius
🤝
Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Show your support
Give a
📝
License
Copyright © 2021 Yurii Zadoianchuk.
This project is MIT licensed.
This README was generated with
716 Dec 26, 2022
9 Sep 20, 2021
3 Oct 17, 2021
2 Nov 5, 2021
3 Mar 7, 2022
12 Dec 20, 2022
1 Jan 5, 2022
12 Sep 29, 2022
18 Dec 24, 2022
3 Dec 29, 2022
24 Sep 29, 2022
18 Nov 12, 2022
107 Oct 28, 2022
12 Jul 02, 2022
1 Mar 29, 2022
19 May 06, 2022
61 Dec 25, 2022
1 Dec 21, 2021
513 Dec 31, 2022
27 Oct 01, 2022
8 Sep 27, 2022
37 May 11, 2022
4 Aug 18, 2022
12 Jul 28, 2022
5 Nov 12, 2022
127 Dec 23, 2022
7 Sep 06, 2022
998 Jan 03, 2023