Repository files navigation

This project is a collection ofactions andprobes, gathered as anextension to theChaos Toolkit.

This package requires Python 3.6+

To be used from your experiment, this package must be installed in the Pythonenvironment wherechaostoolkit already lives.

$ pip install -U chaostoolkit-spring

Currently this driver supports interactions with aSpring Boot-based service that has included the2.0.0.-SNAPSHOT release of theChaos 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 haveadded the Chaos Monkey for Spring Boot andenabled 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 yourexperiment 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 theChaos 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.

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

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

If you wish to contribute more functions to this package, you are more thanwelcome 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 byblack,flake8, andisort, and then raise a PR to the repository for review.

Please refer to theformatting section for more informationon the formatting standards.

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

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

$make install-dev

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

To run the tests for the project execute the following:

$make tests

We use a combination ofblack,flake8, andisort to bothlint 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.