Package: chaostoolkit-spring
Chaos Toolkit Driver for Spring ChaosThis project is a collection ofactionsandprobes, gathered as an
extension to theChaos Toolkit.InstallThis package requires Python 3.6+To be used from your experiment, this package must be installed in the Python
environment wherechaostoolkitalready lives.$ pip install -U chaostoolkit-springUsageCurrently this driver supports interactions with aSpring Boot-basedservice that has included the2.0.0.-SNAPSHOTrelease 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 Bootandenabled the Spring Boot Actuator HTTP endpointsyou 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 theChaos Monkey assaultsactive 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 VerificationIf you do not wish to have SSL Verification performed during your actions/probes
then you can pass the argument"verify_ssl": falseto the individual activities.If you wish to provide aCA_BUNDLEor directory of trusted CAs certificates,
provide the environment variables specified in therequestsdocumentation here:Requests SSL Cert Verification.ContributeIf 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 byblack,flake8, andisort, and then raise a PR to the repository for review.Please refer to theformattingsection for more information
on the formatting standards.The Chaos Toolkit projects require all contributors must sign aDeveloper Certificate of Originon 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.DevelopIf you wish to develop on this project, make sure to install the development
dependencies. But first,create a virtual environmentand then install
those dependencies.$makeinstall-devNow, you can edit the files and they will be automatically be seen by your
environment, even when running from thechaoscommand locally.TestsTo run the tests for the project execute the following:$maketestsFormatting and LintingWe use a combination ofblack,flake8, andisortto both
lint and format this repositories code.Before raising a Pull Request, we recommend you run formatting against your code with:$makeformatThis 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:$makelintTo ensure that any unused import statements/strings that are too long, etc. are also picked up.