Development setup

Deployment scripts

To set up a development environment using scripts, look at the readme under /deployment_scripts. If you want to set it up manually or run into problems, keep reading.

The Infection Monkey Agent

The agent (which we sometimes refer to as the Infection Monkey) is a single Python project under the infection_monkey folder. The Infection Monkey agent was built for Python 3.7. You can get it up and running by setting up a virtual environment and installing the requirements listed in the requirements.txt inside it.

In order to compile the Infection Monkey for distribution by the Monkey Island, you’ll need to run the instructions listed in the readme.txt on each supported environment.

This means setting up an environment with Linux 32/64-bit with Python installed and a Windows 64-bit machine with developer tools, along with 32/64-bit Python versions.

The Monkey Island

The Monkey Island is a Python backend React frontend project. Similar to the agent, the backend’s requirements are listed in the matching requirements.txt.

To setup a working front environment, run the instructions listed in the readme.txt

Pre-commit

Pre-commit is a multi-language package manager for pre-commit hooks. It will run a set of checks when you attempt to commit. If your commit does not pass all checks, it will be reformatted and/or you’ll be given a list of errors and warnings that need to be fixed before you can commit.

Our CI system runs the same checks when pull requests are submitted. This system may report that the build has failed if the pre-commit hooks have not been run or all issues have not been resolved.

To install and configure pre-commit, run pip install --user pre-commit. Next, go to the top level directory of this repository and run pre-commit install -t pre-commit -t pre-push. Pre-commit will now run automatically whenever you git commit.

Swimm

Infection Monkey has development tutorials that use swimm.io to help teach new developers how to perform common code tasks in the Infection Monkey codebase and accelerate the ramp-up process. The tutorials include adding new configuration values, new system info collectors and more.

In order to pass the pre-commit checks, you’ll have to install Swimm successfully. Both the Linux and Windows deployment scrips will install Swimm, but you’ll have to sign up here to complete the process.