Extract utils repository

[mssalvatore]

Goal

Extract classes, constants, and functions that make up the set of miscellaneous utilities used by all 3 of the agent, Island, and plugin components.

Motivation

In order for 3rd-party developers to develop their own plugins efficiently, plugins' dependencies should be installable with pip. Extracting utilities into their own repository as we did with monkeytypes, #3756 helps enable this.

See also #3725.

Details

• A "best effort" approach will be taken to preserve the git history of the files that are moved. See monkeytypes for an example
• The script and artifacts used to migrate monkeytypes is linked below for reference
• Boilerplate for setting up the new project can be created from the infection monkey cookiecutter template.
• cruft should be used to apply the cookiecutter to the migrated project
• The new package will be published to PyPI so it can be installed via pip. @mssalvatore can help.
• An effort has been made to identify the components that should be moved to this new repository. The "Utils" box in this diagram contains that information, but may be incomplete or outdated.

Resources

• https://github.com/guardicore/monkey/issues/3798
• https://drive.google.com/file/d/1KTrOcWd8jPrmOLu_3mkeGPAfx-OTjfyc/view?usp=sharing
• https://github.com/guardicore/monkey/files/12929661/extract-monkeytypes.zip

[mssalvatore]

monkeytoolbox has been published.

https://github.com/guardicode/monkeytoolbox https://pypi.org/project/monkeytoolbox/