Metadata-Version: 2.1
Name: chaoswm
Version: 0.2.1
Summary: chaostoolkit driver for wiremock
Home-page: https://github.com/sky-uk/chaostoolkit-wiremock
Author: Marco Masetti
Author-email: marco.masetti@sky.uk
License: Apache License, v2.0
Description: chaostoolkit-wiremock
        =====================
        
        [![image](https://img.shields.io/pypi/v/chaoswm.svg)](https://pypi.python.org/pypi/chaoswm)
        
        Chaos Toolkit driver for the WireMock service API
        
        Package installation
        --------------------
        
        To install the package from pypi.org:
        
            pip install chaoswm
        
        Installation from source
        ------------------------
        
        In order to use it, you need python 3.5+ in your environment.
        Once downloaded the project, cd into it and run:
        
            pip install -r requirements.txt
            pip install -r requirements_dev.txt
            make clean && make test && make install
        
        Configuration
        -------------
        
        The following keys can be configured in the experiment global
        configuration section, under the \"wiremock\" key:
        
        -   **host**: the wiremock server host
        -   **port**: the wiremock server port
        -   **contextPath**: the contextPath for your wiremock server (optional)
        -   **timeout**: accepted timeout (defaults to 1 sec)
        -   **down**: the delayDistribution section used by the `down` action
        
        Configuration example:
        
            {
                "configuration": {
                    "wiremock": {
                        "host": "localhost",
                        "port": 8080,
                        "contextPath": "/wiremock",
                        "timeout": 10,
                        "down": {
                            "type": "lognormal",
                            "median": 3000,
                            "sigma": 0.2
                        }
                    }
                }
            }
        
        Exported Actions
        ----------------
        
        Adding a list of mappings:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "adding a mapping",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "add_mapping",
                      "arguments": [{
                          "request": {
                              "method": "GET",
                              "url": "/some/thing"
                          },
                          "response": {
                              "status": 200,
                              "body": "Hello world!",
                              "headers": {
                                  "Content-Type": "text/plain"
                              }
                          } 
                      }]
                  }
                }
              ]
            }
        
        Deleting a list of mappings:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "deleting a mapping",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "delete_mapping",
                      },
                      "arguments": [{
                          "method": "GET",
                          "url": "/some/thing"
                      }]
                  }
              ]
            }
        
        Adding a global fixed delay:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Adding a global fixed delay",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "global_fixed_delay"
                      },
                      "arguments": {
                          "fixedDelay": 10
                      }
                  }
              ]
            }
        
        Adding a global random delay:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Adding a global random delay",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "global_random_delay"
                      },
                      "arguments": {
                        "delayDistribution": {
                            "type": "lognormal",
                            "median": 20,
                            "sigma": 0.1
                        }
                      }
                  }
              ]
            }
        
        Adding a fixed delay to a list of mappings:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Adding a fixed delay to a mapping",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "fixed_delay"
                      },
                      "arguments": {[{
                              "method": "GET",
                              "url": "/some/thing"
                          }],
                          "fixedDelayMilliseconds": 100
                      }
                  }
              ]
            }
        
        Adding a fixed delay to a list of mappings If a consistent number of
        mappings have to be delayed, the following action might be useful:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Adding a fixed delay to a set of mappings",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "fixed_delay_to_many_mappings"
                      },
                      "arguments": {[{
                            "method": "GET",
                            "url": "/some/thing",
                          },{
                            "method": "POST",
                            "url": "/some/thing/else",
                          }],
                          "fixedDelayMilliseconds": 100
                      }
                  }
              ]
            }
        
        Adding a random delay to a list of mappings:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Adding a random delay to a mapping",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "random_delay"
                      },
                      "arguments": {[{
                              "method": "GET",
                              "url": "/some/thing",
                          }],
                          "delayDistribution": {
                              "type": "lognormal",
                              "median": 80,
                              "sigma": 0.4
                          }
                      }
                  }
              ]
            }
        
        Adding a ChunkedDribbleDelay to a list of mappings:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Adding a ChunkedDribbleDelay to a mapping",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "chunked_dribble_delay"
                      },
                      "arguments": {[{
                            "method": "GET",
                            "url": "/some/thing",
                          }],
                          "chunkedDribbleDelay": {
                              "numberOfChunks": 5,
                              "totalDuration": 1000
                          }
                      }
                  }
              ]
            }
        
        Taking a list of mappings down (heavy distribution delay). This action
        will use the parameters specified in the \"down\" key of the
        configuration section:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Taking a mapping down",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "down"
                      },
                      "arguments": [{
                          "method": "GET",
                          "url": "/some/thing",
                      }]
                  }
              ]
            }
        
        Taking a list of mappings up back again:
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Taking a mapping down",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "up"
                      },
                      "arguments": [{
                          "method": "GET",
                          "url": "/some/thing",
                      }]
                  }
              ]
            }
        
        Resetting the wiremock server (deleting all mappings):
        
            {
              "method": [
                {
                  "type": "action",
                  "name": "Taking a mapping down",
                  "provider": {
                      "type": "python",
                      "module": "chaoswm.actions",
                      "func": "reset"
                  }
                }
              ]
            }
        
        ### Discovery
        
        You may use the Chaos Toolkit to discover the capabilities of this
        extension:
        
            $ chaos discover chaostoolkit-wiremock  --no-install
        
        Credits
        -------
        
        This package was created with
        [Cookiecutter](https://github.com/audreyr/cookiecutter) and the
        [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)
        project template.
        
Keywords: chaoswm
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
