Mock server to return static response.

Install

python3 -m pip install pymocky

Check with command:

pymocky -h

How to use

pymocky -p extras/sample/

Test with command (need curl):

curl http://localhost:9000/login

To change from default scenario to other use (server need be running):

pymocky --update-scenario "login-error"

Test again with command (need curl):

curl http://localhost:9000/login

Example of YAML file

mappings:
- id: hello_world
   scenario: login-success
   request:
      url: .*pymocky_hello_world.*
      method: post
      query_string: .*param1=value&param2=value2
      form_fields:
      username: .*demo
      password: .*12345
      headers:
         "Content-Type": "application/json"
      body: .*Hello World.*
   response:
      headers:
         "Content-Type": "application/json"
      body_raw: Hello world from pymocky!
      body_file: files/dummy.xml
      body_json:
         success: false
         data:
         errors: []
      body_image: images/image1.png
      body_python: files/dummy.py
      sys_path: ["auto"]

You can use "body_raw", "body_file", "body_json", "body_image" or "body_python" as response type.

When you use "body_python" you can add array "sys_path" and pymocky will add these paths to "sys.path" list. The list of "sys.path" is reloaded to original (when pymocky start is stored a copy of this list) everytime that YAML files are parsed again. When you use "auto" in the array, the path will be the directory of python file to be execute.

body_raw: Raw text as response
body_file: File content with mimetype discovery by extension
body_json: Json as YAML object or string
body_image: Image file with mimetype discovery by extension
body_python: Python file to be executed

Change scenario

To change from default scenario to other use (server need be running):

pymocky --update-scenario "login-error"

Testing

You need install test dependencies with the command:

python3 -m pip install -r requirements_tests.txt

To execute all tests use the command:

python3 -m pytest tests

To coverage test use the command:

python3 -m pytest --cov=. --cov-report=xml --cov-report=html tests

To install locally during development:

python3 setup.py install

or:

python3 -m pip install -e .

Packaging

To package and upload for distribution on PyPi server use:

python3 setup.py upload

Contributing

• Fork the project and clone locally.
• Create a new branch for what you're going to work on.
• Push to your origin repository.
• Create a new pull request in GitHub.

Buy me a coffee

Supported By Jetbrains IntelliJ IDEA

License

MIT

Copyright (c) 2020-2024, Paulo Coutinho