Extension chaosspring¶

This project is a collection of actions and probes, gathered as an extension to the Chaos Toolkit.

Install¶

This package requires Python 3.6+

To be used from your experiment, this package must be installed in the Python environment where chaostoolkit already lives.

$ pip install -U chaostoolkit-spring

Usage¶

Currently this driver supports interactions with a Spring Boot-based service that has included the 2.0.0.-SNAPSHOT release of the Chaos Monkey for Spring Boot. This snapshot includes the necessary Spring Boot Actuator HTTP endpoints so that the Chaos Toolkit to interact with the chaos features at runtime.

Once you have added the Chaos Monkey for Spring Boot and enabled the Spring Boot Actuator HTTP endpoints you can then use the probes and actions from this driver.

To use the probes and actions from this package, add the following to your experiment file:

{
    "name": "enable_chaosmonkey",
    "provider": {
        "arguments": {
            "base_url": "http://localhost:8080/actuator"
        },
        "func": "enable_chaosmonkey",
        "module": "chaosspring.actions",
        "type": "python"
    },
    "type": "action"
}

This will interact with the specified service and enable the Chaos Monkey features. You can also turn off the Chaos Monkey if you wish by specifying the following action:

{
    "name": "disable_chaosmonkey",
    "provider": {
        "arguments": {
            "base_url": "http://localhost:8080/actuator"
        },
        "func": "disable_chaosmonkey",
        "module": "chaosspring.actions",
        "type": "python"
    },
    "type": "action"
}

You can then manipulate the Chaos Monkey assaults active on your service by specifing the following action:

{
    "name": "configure_assaults",
    "provider": {
        "arguments": {
            "base_url": "http://localhost:8080/actuator",
            "assaults_configuration": {
                "level": 5,
                "latencyRangeStart": 2000,
                "latencyRangeEnd": 5000,
                "latencyActive": false,
                "exceptionsActive": false,
                "killApplicationActive": true,
                "restartApplicationActive": false
            }
        },
        "func": "change_assaults_configuration",
        "module": "chaosspring.actions",
        "type": "python"
    },
    "type": "action"
}

That’s it!

Please explore the code to use further probes and actions.

SSL Verification¶

If you do not wish to have SSL Verification performed during your actions/probes then you can pass the argument "verify_ssl": false to the individual activities.

If you wish to provide a CA_BUNDLE or directory of trusted CAs certificates, provide the environment variables specified in the requests documentation here: Requests SSL Cert Verification.

Contribute¶

If you wish to contribute more functions to this package, you are more than welcome to do so. Please, fork this project, write unit tests to cover the proposed changes, implement the changes, ensure they meet the formatting standards set out by black, flake8, and isort, and then raise a PR to the repository for review.

Please refer to the formatting section for more information on the formatting standards.

The Chaos Toolkit projects require all contributors must sign a Developer Certificate of Origin on each commit they would like to merge into the master branch of the repository. Please, make sure you can abide by the rules of the DCO before submitting a PR.

Develop¶

If you wish to develop on this project, make sure to install the development dependencies. But first, create a virtual environment and then install those dependencies.

$ make install-dev

Now, you can edit the files and they will be automatically be seen by your environment, even when running from the chaos command locally.

Tests¶

To run the tests for the project execute the following:

$ make tests

Formatting and Linting¶

We use a combination of black, flake8, and isort to both lint and format this repositories code.

Before raising a Pull Request, we recommend you run formatting against your code with:

$ make format

This will automatically format any code that doesn’t adhere to the formatting standards.

As some things are not picked up by the formatting, we also recommend you run:

$ make lint

To ensure that any unused import statements/strings that are too long, etc. are also picked up.

Exported Activities¶

actions¶

change_assaults_configuration¶

Change Assaults configuration on a specific service.

Signature:

def change_assaults_configuration(
        base_url: str,
        assaults_configuration: Dict[str, Any],
        headers: Dict[str, Any] = None,
        timeout: float = None,
        verify_ssl: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> str:
    pass

Arguments:

Usage:

{
  "name": "change-assaults-configuration",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosspring.actions",
    "func": "change_assaults_configuration",
    "arguments": {
      "base_url": "",
      "assaults_configuration": {}
    }
  }
}

name: change-assaults-configuration
provider:
  arguments:
    assaults_configuration: {}
    base_url: ''
  func: change_assaults_configuration
  module: chaosspring.actions
  type: python
type: action

disable_chaosmonkey¶

Disable Chaos Monkey on a specific service.

Signature:

def disable_chaosmonkey(base_url: str,
                        headers: Dict[str, Any] = None,
                        timeout: float = None,
                        verify_ssl: bool = True,
                        configuration: Dict[str, Dict[str, str]] = None,
                        secrets: Dict[str, Dict[str, str]] = None) -> str:
    pass

Arguments:

Usage:

{
  "name": "disable-chaosmonkey",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosspring.actions",
    "func": "disable_chaosmonkey",
    "arguments": {
      "base_url": ""
    }
  }
}

name: disable-chaosmonkey
provider:
  arguments:
    base_url: ''
  func: disable_chaosmonkey
  module: chaosspring.actions
  type: python
type: action

enable_chaosmonkey¶

Enable Chaos Monkey on a specific service.

Signature:

def enable_chaosmonkey(base_url: str,
                       headers: Dict[str, Any] = None,
                       timeout: float = None,
                       verify_ssl: bool = True,
                       configuration: Dict[str, Dict[str, str]] = None,
                       secrets: Dict[str, Dict[str, str]] = None) -> str:
    pass

Arguments:

Usage:

{
  "name": "enable-chaosmonkey",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosspring.actions",
    "func": "enable_chaosmonkey",
    "arguments": {
      "base_url": ""
    }
  }
}

name: enable-chaosmonkey
provider:
  arguments:
    base_url: ''
  func: enable_chaosmonkey
  module: chaosspring.actions
  type: python
type: action

probes¶

assaults_configuration¶

Get the current assaults configuraton from the specified service.

Signature:

def assaults_configuration(
        base_url: str,
        headers: Dict[str, Any] = None,
        timeout: float = None,
        verify_ssl: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "assaults-configuration",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosspring.probes",
    "func": "assaults_configuration",
    "arguments": {
      "base_url": ""
    }
  }
}

name: assaults-configuration
provider:
  arguments:
    base_url: ''
  func: assaults_configuration
  module: chaosspring.probes
  type: python
type: probe

chaosmonkey_enabled¶

Enquire whether Chaos Monkey is enabled on the specified service.

Signature:

def chaosmonkey_enabled(base_url: str,
                        headers: Dict[str, Any] = None,
                        timeout: float = None,
                        verify_ssl: bool = True,
                        configuration: Dict[str, Dict[str, str]] = None,
                        secrets: Dict[str, Dict[str, str]] = None) -> bool:
    pass

Arguments:

Usage:

{
  "name": "chaosmonkey-enabled",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosspring.probes",
    "func": "chaosmonkey_enabled",
    "arguments": {
      "base_url": ""
    }
  }
}

name: chaosmonkey-enabled
provider:
  arguments:
    base_url: ''
  func: chaosmonkey_enabled
  module: chaosspring.probes
  type: python
type: probe

watcher_configuration¶

Get the current watcher configuraton from the specified service.

Signature:

def watcher_configuration(
        base_url: str,
        headers: Dict[str, Any] = None,
        timeout: float = None,
        verify_ssl: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Arguments:

Usage:

{
  "name": "watcher-configuration",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosspring.probes",
    "func": "watcher_configuration",
    "arguments": {
      "base_url": ""
    }
  }
}

name: watcher-configuration
provider:
  arguments:
    base_url: ''
  func: watcher_configuration
  module: chaosspring.probes
  type: python
type: probe